first pass at updating head branch to be to be the same as the SAMBA_2_0 branch
[nivanova/samba-autobuild/.git] / docs / htmldocs / testparm.1.html
index 00db2316266aded52fe42c7cf6e8b0f91c4a2ffc..1e0396af33788518ee79a39aa902b860c157a8af 100644 (file)
@@ -24,7 +24,7 @@
 <p><br><a name="SYNOPSIS"></a>
 <h2>SYNOPSIS</h2>
      
-<p><br><strong>testparm</strong> [<a href="testparm.1.html#minuss">-s</a>] [<a href="testparm.1.html#configfilename">configfilename</a>] [<a href="testparm.1.html#hostname">hostname</a> <a href="testparm.1.html#hostIP">hostIP</a>]
+<p><br><strong>testparm</strong> [<a href="testparm.1.html#minuss">-s</a>] [<a href="testparm.1.html#minush">-h</a>] [<a href="testparm.1.html#minusL">-L servername</a>] [<a href="testparm.1.html#configfilename">configfilename</a>] [<a href="testparm.1.html#hostname">hostname</a> <a href="testparm.1.html#hostIP">hostIP</a>]
 <p><br><a name="DESCRIPTION"></a>
 <h2>DESCRIPTION</h2>
     
@@ -39,6 +39,10 @@ configuration file will be available or will operate as expected.
 <p><br>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.
+<p><br>If <strong>testparm</strong> finds an error in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a>
+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
+<strong>testparm</strong>.
 <p><br><a name="OPTIONS"></a>
 <h2>OPTIONS</h2>
     
@@ -47,6 +51,11 @@ reporting whether the specified host has access to each service.
 <li><strong><strong>-s</strong></strong> Without this option, <strong>testparm</strong> will prompt for a
 carriage return after printing the service names and before dumping
 the service definitions.
+<p><br><a name="minush"></a>
+<li><strong><strong>-h</strong></strong> Print usage message
+<p><br><a name="minusL"></a>
+<li><strong><strong>-L servername</strong></strong> Sets the value of the %L macro to servername. This
+is useful for testing include files specified with the %L macro.
 <p><br><a name="configfilename"></a>
 <li><strong><strong>configfilename</strong></strong> This is the name of the configuration file to
 check. If this parameter is not present then the default