1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document. docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
4 .\" Please send any bug reports, improvements, comments, patches,
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH TESTPARM 1 "23 Jun 2001" "testparm 2.2.0a"
8 testparm \- check an smb.conf configuration file for internal correctness
11 \fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-L <servername>\fR ] \fBconfig filename\fR [ \fBhostname hostIP\fR ]
14 This tool is part of the Sambasuite.
16 \fBtestparm\fR is a very simple test program
17 to check an \fBsmbd\fR configuration file for
18 internal correctness. If this program reports no problems, you
19 can use the configuration file with confidence that \fBsmbd
20 \fRwill successfully load the configuration file.
22 Note that this is \fBNOT\fR a guarantee that
23 the services specified in the configuration file will be
24 available or will operate as expected.
26 If the optional host name and host IP address are
27 specified on the command line, this test program will run through
28 the service entries reporting whether the specified host
29 has access to each service.
31 If \fBtestparm\fR finds an error in the \fI smb.conf\fR file it returns an exit code of 1 to the calling
32 program, else it returns an exit code of 0. This allows shell scripts
33 to test the output from \fBtestparm\fR.
37 Without this option, \fBtestparm\fR
38 will prompt for a carriage return after printing the service
39 names and before dumping the service definitions.
45 Sets the value of the %L macro to servername.
46 This is useful for testing include files specified with the
50 This is the name of the configuration file
51 to check. If this parameter is not present then the
52 default \fIsmb.conf\fR file will be checked.
55 If this parameter and the following are
56 specified, then testparm will examine the \fIhosts
57 allow\fR and \fIhosts deny\fR
58 parameters in the \fIsmb.conf\fR file to
59 determine if the hostname with this IP address would be
60 allowed access to the \fBsmbd\fR server. If
61 this parameter is supplied, the hostIP parameter must also
65 This is the IP address of the host specified
66 in the previous parameter. This address must be supplied
67 if the hostname parameter is supplied.
71 This is usually the name of the configuration
72 file used by \fBsmbd\fR.
75 The program will issue a message saying whether the
76 configuration file loaded OK or not. This message may be preceeded by
77 errors and warnings if the file did not load. If the file was
78 loaded OK, the program then dumps all known service details
82 This man page is correct for version 2.2 of
87 \fBsmbd(8)\fR.SH "AUTHOR"
89 The original Samba software and related utilities
90 were created by Andrew Tridgell. Samba is now developed
91 by the Samba Team as an Open Source project similar
92 to the way the Linux kernel is developed.
94 The original Samba man pages were written by Karl Auer.
95 The man page sources were converted to YODL format (another
96 excellent piece of Open Source software, available at
97 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
98 release by Jeremy Allison. The conversion to DocBook for
99 Samba 2.2 was done by Gerald Carter