samba-mirror/docs/manpages/testparm.1

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "TESTPARM" 1 "" "" ""
.SH NAME
testparm \- check an smb.conf configuration file for internal correctness
.SH "SYNOPSIS"

.nf
\fBtestparm\fR [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname
         hostIP]
.fi

.SH "DESCRIPTION"

.PP
This tool is part of the \fBSamba\fR(7) suite\&.

.PP
\fBtestparm\fR is a very simple test program to check an \fBsmbd\fR(8) 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
-s
Without this option, \fBtestparm\fR will prompt for a carriage return after printing the service names and before dumping the service definitions\&.


.TP
-h|--help
Print a summary of command line options\&.


.TP
-V
Prints the version number for \fBsmbd\fR\&.


.TP
-L servername
Sets the value of the %L macro to \fIservername\fR\&. This is useful for testing include files specified with the %L macro\&.


.TP
-v
If this option is specified, testparm will also output all options that were not used in \fBsmb.conf\fR(5) and are thus set to their defaults\&.


.TP
-t encoding
Output data in specified encoding\&.


.TP
configfilename
This is the name of the configuration file to check\&. If this parameter is not present then the default \fBsmb.conf\fR(5) file will be checked\&.


.TP
hostname
If this parameter and the following are specified, then \fBtestparm\fR will examine the \fIhosts allow\fR and \fIhosts deny\fR parameters in the \fBsmb.conf\fR(5) 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
hostIP
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
\fBsmb.conf\fR(5)
This is usually the name of the configuration file used by \fBsmbd\fR(8)\&.


.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 3\&.0 of the Samba suite\&.

.SH "SEE ALSO"

.PP
\fBsmb.conf\fR(5), \fBsmbd\fR(8)

.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/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.