Penguin
Recent Changes
Annotated edit history of testparm(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 TESTPARM
2 !!!TESTPARM
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 FILES
8 DIAGNOSTICS
9 VERSION
10 SEE ALSO
11 AUTHOR
12 ----
13 !!NAME
14
15
16 testparm - check an smb.conf configuration file for internal correctness
17 !!SYNOPSIS
18
19
20 __testparm__ [[ __-s__ ] [[ __-h__ ] [[ __-L
21 __ ] __config filename__ [[
22 __hostname hostIP__ ]
23 !!DESCRIPTION
24
25
26 This tool is part of the Sambasuite.
27
28
29 __testparm__ is a very simple test program to check an
30 __smbd__ configuration file for internal correctness. If
31 this program reports no problems, you can use the
32 configuration file with confidence that __smbd__ will
33 successfully load the configuration file.
34
35
36 Note that this is __NOT__ a guarantee that the services
37 specified in the configuration file will be available or
38 will operate as expected.
39
40
41 If the optional host name and host IP address are specified
42 on the command line, this test program will run through the
43 service entries reporting whether the specified host has
44 access to each service.
45
46
47 If __testparm__ finds an error in the ''smb.conf''
48 file it returns an exit code of 1 to the calling program,
49 else it returns an exit code of 0. This allows shell scripts
50 to test the output from __testparm__.
51 !!OPTIONS
52
53
54 __-s__
55
56
57 Without this option, __testparm__ will prompt for a
58 carriage return after printing the service names and before
59 dumping the service definitions.
60
61
62 __-h__
63
64
65 Print usage message
66
67
68 __-L servername__
69
70
71 Sets the value of the %L macro to ''servername''. This is
72 useful for testing include files specified with the %L
73 macro.
74
75
76 __configfilename__
77
78
79 This is the name of the configuration file to check. If this
80 parameter is not present then the default ''smb.conf''
81 file will be checked.
82
83
84 __hostname__
85
86
87 If this parameter and the following are specified, then
88 __testparm__ will examine the ''hosts allow'' and
89 ''hosts deny'' parameters in the ''smb.conf'' file to
90 determine if the hostname with this IP address would be
91 allowed access to the __smbd__ server. If this parameter
92 is supplied, the hostIP parameter must also be
93 supplied.
94
95
96 __hostIP__
97
98
99 This is the IP address of the host specified in the previous
100 parameter. This address must be supplied if the hostname
101 parameter is supplied.
102 !!FILES
103
104
105 ''smb.conf''
106
107
108 This is usually the name of the configuration file used by
109 __smbd__.
110 !!DIAGNOSTICS
111
112
113 The program will issue a message saying whether the
114 configuration file loaded OK or not. This message may be
115 preceded by errors and warnings if the file did not load. If
116 the file was loaded OK, the program then dumps all known
117 service details to stdout.
118 !!VERSION
119
120
121 This man page is correct for version 2.2 of the Samba
122 suite.
123 !!SEE ALSO
124
125
126 ''smb.conf(5)'', __smbd(8)__
127 !!AUTHOR
128
129
130 The original Samba software and related utilities were
131 created by Andrew Tridgell. Samba is now developed by the
132 Samba Team as an Open Source project similar to the way the
133 Linux kernel is developed.
134
135
136 The original Samba man pages were written by Karl Auer. The
137 man page sources were converted to YODL format (another
138 excellent piece of Open Source software, available at
139 ftp://ftp.icce.rug.nl/pub/unix/
140 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.