-.TH TESTPARM 1 "26 Oct 1997" "testparm 1.9.18alpha5"
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "TESTPARM" "1" "01 October 2002" "" ""
.SH NAME
-testparm \- check an smbd configuration file for internal correctness
+testparm \- check an smb.conf configuration file for internal correctness
.SH SYNOPSIS
-.B testparm
-[
-.I configfilename
-[
-.I hostname
-.I hostIP
-]
-]
-.SH DESCRIPTION
-This program is part of the Samba suite.
-.B testparm
-is a very simple test program to check an
-.B smbd
-configuration
-file for internal correctness. If this program reports no problems, you can use
-the configuration file with confidence that
-.B smbd
-will successfully
-load the configuration file.
+\fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-v\fR ] [ \fB-L <servername>\fR ] \fBconfig filename\fR [ \fBhostname hostIP\fR ]
-Note that this is NOT a guarantee that the services specified in the
-configuration file will be available or will operate as expected.
-
-If the optional host name and host IP address are specified on the
-command line, this test program will run through the service entries
-reporting whether the specified host has access to each service.
-.SH OPTIONS
-.I configfilename
-
-.RS 3
-This is the name of the configuration file to check.
-.RE
-
-.I hostname
-
-.RS 3
-This is the name of the host to check access on.
-
-If this parameter is supplied, the
-.I hostIP
-parameter must also be supplied, or strange things may happen.
-.RE
-
-.I hostIP
-
-.RS 3
-This is the IP number of the host specified in the previous parameter.
-
-This number must be supplied if the
-.I hostname
-parameter is supplied, or strange things may happen.
-.RE
-.SH FILES
-.B smb.conf
-.RS 3
-This is usually the name of the configuration file used by
-.BR smbd .
-.RE
-.SH ENVIRONMENT VARIABLES
-Not applicable.
-.SH INSTALLATION
-The location of the server and its support files is a matter for individual
-system administrators. The following are thus suggestions only.
-
-It is recommended that the
-.B testparm
-program be installed under the /usr/local/samba hierarchy, in a directory readable
-by all, writeable only by root. The program itself should be executable by all.
-The program should NOT be setuid or setgid!
-.SH VERSION
-This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
-of the recent patches to it. These notes will necessarily lag behind
-development of the software, so it is possible that your version of
-the program has extensions or parameter semantics that differ from or are not
-covered by this man page. Please notify these to the address below for
-rectification.
-.SH SEE ALSO
-.BR smb.conf (5),
-.BR smbd (8)
-.SH DIAGNOSTICS
-The program will issue a message saying whether the configuration file loaded
-OK or not. This message may be preceded by errors and warnings if the file
-did not load. If the file was loaded OK, the program then dumps all known
-service details to stdout.
-
-If a host name is specified but no host IP number, all bets are off.
-
-Other messages are self-explanatory.
-.SH BUGS
-None known.
-.SH CREDITS
-The original Samba software and related utilities were created by
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
-of the Source for this project.
-
-The
-.B testparm
-program and this man page were written by Karl Auer. Bug reports to
-samba-bugs@samba.anu.edu.au.
-
-See
-.BR samba (7)
-for a full list of contributors and details on how to
-submit bug reports, comments etc.
+.SH "DESCRIPTION"
+.PP
+This tool is part of the Samba suite.
+.PP
+\fBtestparm\fR is a very simple test program
+to check an \fBsmbd\fR configuration file for
+internal correctness. If this program reports no problems, you
+can use the configuration file with confidence that \fBsmbd
+\fR will successfully load the configuration file.
+.PP
+Note that this is \fBNOT\fR a guarantee that
+the services specified in the configuration file will be
+available or will operate as expected.
+.PP
+If the optional host name and host IP address are
+specified on the command line, this test program will run through
+the service entries reporting whether the specified host
+has access to each service.
+.PP
+If \fBtestparm\fR finds an error in the \fI smb.conf\fR file it returns an exit code of 1 to the calling
+program, else it returns an exit code of 0. This allows shell scripts
+to test the output from \fBtestparm\fR.
+.SH "OPTIONS"
+.TP
+\fB-s\fR
+Without this option, \fBtestparm\fR
+will prompt for a carriage return after printing the service
+names and before dumping the service definitions.
+.TP
+\fB-h\fR
+Print usage message
+.TP
+\fB-L servername\fR
+Sets the value of the %L macro to \fIservername\fR.
+This is useful for testing include files specified with the
+%L macro.
+.TP
+\fB-v\fR
+If this option is specified, testparm
+will also output all options that were not used in
+\fIsmb.conf\fR and are thus set to
+their defaults.
+.TP
+\fBconfigfilename\fR
+This is the name of the configuration file
+to check. If this parameter is not present then the
+default \fIsmb.conf\fR file will be checked.
+.TP
+\fBhostname\fR
+If this parameter and the following are
+specified, then \fBtestparm\fR will examine the \fIhosts
+allow\fR and \fIhosts deny\fR
+parameters in the \fIsmb.conf\fR file to
+determine if the hostname with this IP address would be
+allowed access to the \fBsmbd\fR server. If
+this parameter is supplied, the hostIP parameter must also
+be supplied.
+.TP
+\fBhostIP\fR
+This is the IP address of the host specified
+in the previous parameter. This address must be supplied
+if the hostname parameter is supplied.
+.SH "FILES"
+.TP
+\fB\fIsmb.conf\fB\fR
+This is usually the name of the configuration
+file used by \fBsmbd\fR.
+.SH "DIAGNOSTICS"
+.PP
+The program will issue a message saying whether the
+configuration file loaded OK or not. This message may be preceded by
+errors and warnings if the file did not load. If the file was
+loaded OK, the program then dumps all known service details
+to stdout.
+.SH "VERSION"
+.PP
+This man page is correct for version 2.2 of
+the Samba suite.
+.SH "SEE ALSO"
+.PP
+\fIsmb.conf(5)\fR
+\fBsmbd(8)\fR
+.SH "AUTHOR"
+.PP
+The original Samba software and related utilities
+were created by Andrew Tridgell. Samba is now developed
+by the Samba Team as an Open Source project similar
+to the way the Linux kernel is developed.
+.PP
+The original Samba man pages were written by Karl Auer.
+The man page sources were converted to YODL format (another
+excellent piece of Open Source software, available at
+ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
+release by Jeremy Allison. The conversion to DocBook for
+Samba 2.2 was done by Gerald Carter
git.samba.org / sfrench / samba-autobuild / .git / blobdiff