Document -v option
authorJelmer Vernooij <jelmer@samba.org>
Wed, 21 Aug 2002 21:00:40 +0000 (21:00 +0000)
committerJelmer Vernooij <jelmer@samba.org>
Wed, 21 Aug 2002 21:00:40 +0000 (21:00 +0000)
(This used to be commit a8936762967643a935ae45f468ad70e206406190)

docs/docbook/manpages/testparm.1.sgml
docs/manpages/testparm.1

index 320e39e6f5827547b4d3e62099d48032388b642c..350683eb5743cf642487693b0189089d2fd00598 100644 (file)
@@ -18,6 +18,7 @@
                <command>testparm</command>
                <arg choice="opt">-s</arg>
                <arg choice="opt">-h</arg>
+               <arg choice="opt">-v</arg>
                <arg choice="opt">-L &lt;servername&gt;</arg>
                <arg choice="req">config filename</arg>
                <arg choice="opt">hostname  hostIP</arg>
                %L macro. </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>-v</term>
+               <listitem><para>If this option is specified, testparm 
+               will also output all options that were not used in 
+               <filename>smb.conf</filename> and are thus set to
+               their defaults.</para></listitem>
+               </varlistentry>
 
                <varlistentry>
                <term>configfilename</term>
index 21b6666133159ea80eba7836964c4afc7835fac0..d463db78b15c26e237a6bdbb617a55f78b4081c8 100644 (file)
@@ -1,14 +1,15 @@
-.\" This manpage has been automatically generated by docbook2man-spec
-.\" from a DocBook document.  docbook2man-spec can be found at:
-.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
+.\" 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" "28 January 2002" "" ""
+.TH "TESTPARM" "1" "21 August 2002" "" ""
 .SH NAME
 testparm \- check an smb.conf configuration file for  internal correctness
 .SH SYNOPSIS
-.sp
-\fBtestparm\fR [ \fB-s\fR ]  [ \fB-h\fR ]  [ \fB-L <servername>\fR ]  \fBconfig filename\fR [ \fBhostname hostIP\fR ] 
+
+\fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-v\fR ] [ \fB-L <servername>\fR ] \fBconfig filename\fR [ \fBhostname  hostIP\fR ]
+
 .SH "DESCRIPTION"
 .PP
 This tool is part of the  Sambasuite.
@@ -17,7 +18,7 @@ This tool is part of the  Sambasuite.
 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
-\fRwill successfully load the configuration file.
+\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 
@@ -46,10 +47,16 @@ 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. 
+default \fIsmb.conf\fR file will be checked.  
 .TP
 \fBhostname\fR
 If this parameter and the following are 
@@ -57,13 +64,13 @@ 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 
+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 
+in the previous parameter.  This address must be supplied 
 if the hostname parameter is supplied. 
 .SH "FILES"
 .TP
@@ -95,6 +102,6 @@ to the way the Linux kernel is developed.
 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 
+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