diff options
Diffstat (limited to 'docs/htmldocs/testparm.1.html')
| -rw-r--r-- | docs/htmldocs/testparm.1.html | 298 |
1 files changed, 298 insertions, 0 deletions
diff --git a/docs/htmldocs/testparm.1.html b/docs/htmldocs/testparm.1.html new file mode 100644 index 0000000000..bae907c687 --- /dev/null +++ b/docs/htmldocs/testparm.1.html @@ -0,0 +1,298 @@ +<HTML +><HEAD +><TITLE +>testparm</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="TESTPARM" +>testparm</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5" +></A +><H2 +>Name</H2 +>testparm -- check an smb.conf configuration file for + internal correctness</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN8" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>testparm</B +> [-s] [-h] [-L <servername>] {config filename} [hostname hostIP]</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN16" +></A +><H2 +>DESCRIPTION</H2 +><P +>This tool is part of the <A +HREF="samba.7.html" +TARGET="_top" +> Samba</A +> suite.</P +><P +><B +CLASS="COMMAND" +>testparm</B +> is a very simple test program + to check an <B +CLASS="COMMAND" +>smbd</B +> configuration file for + internal correctness. If this program reports no problems, you + can use the configuration file with confidence that <B +CLASS="COMMAND" +>smbd + </B +> will successfully load the configuration file.</P +><P +>Note that this is <EM +>NOT</EM +> a guarantee that + the services specified in the configuration file will be + available or will operate as expected. </P +><P +>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 +><P +>If <B +CLASS="COMMAND" +>testparm</B +> finds an error in the <TT +CLASS="FILENAME" +> smb.conf</TT +> 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 <B +CLASS="COMMAND" +>testparm</B +>.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN31" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>-s</DT +><DD +><P +>Without this option, <B +CLASS="COMMAND" +>testparm</B +> + will prompt for a carriage return after printing the service + names and before dumping the service definitions.</P +></DD +><DT +>-h</DT +><DD +><P +>Print usage message </P +></DD +><DT +>-L servername</DT +><DD +><P +>Sets the value of the %L macro to <TT +CLASS="REPLACEABLE" +><I +>servername</I +></TT +>. + This is useful for testing include files specified with the + %L macro. </P +></DD +><DT +>configfilename</DT +><DD +><P +>This is the name of the configuration file + to check. If this parameter is not present then the + default <TT +CLASS="FILENAME" +>smb.conf</TT +> file will be checked. + </P +></DD +><DT +>hostname</DT +><DD +><P +>If this parameter and the following are + specified, then <B +CLASS="COMMAND" +>testparm</B +> will examine the <TT +CLASS="PARAMETER" +><I +>hosts + allow</I +></TT +> and <TT +CLASS="PARAMETER" +><I +>hosts deny</I +></TT +> + parameters in the <TT +CLASS="FILENAME" +>smb.conf</TT +> file to + determine if the hostname with this IP address would be + allowed access to the <B +CLASS="COMMAND" +>smbd</B +> server. If + this parameter is supplied, the hostIP parameter must also + be supplied.</P +></DD +><DT +>hostIP</DT +><DD +><P +>This is the IP address of the host specified + in the previous parameter. This address must be supplied + if the hostname parameter is supplied. </P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN66" +></A +><H2 +>FILES</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><TT +CLASS="FILENAME" +>smb.conf</TT +></DT +><DD +><P +>This is usually the name of the configuration + file used by <B +CLASS="COMMAND" +>smbd</B +>. + </P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN75" +></A +><H2 +>DIAGNOSTICS</H2 +><P +>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. </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN78" +></A +><H2 +>VERSION</H2 +><P +>This man page is correct for version 2.2 of + the Samba suite.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN81" +></A +><H2 +>SEE ALSO</H2 +><P +><A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf(5)</TT +></A +>, + <A +HREF="smbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbd(8)</B +></A +> + </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN88" +></A +><H2 +>AUTHOR</H2 +><P +>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.</P +><P +>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 + <A +HREF="ftp://ftp.icce.rug.nl/pub/unix/" +TARGET="_top" +> ftp://ftp.icce.rug.nl/pub/unix/</A +>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</P +></DIV +></BODY +></HTML +>
\ No newline at end of file |