diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docbook/manpages/testparm.1.sgml | 168 | ||||
| -rw-r--r-- | docs/docbook/manpages/testprns.1.sgml | 143 | ||||
| -rw-r--r-- | docs/htmldocs/testparm.1.html | 405 | ||||
| -rw-r--r-- | docs/htmldocs/testprns.1.html | 350 | ||||
| -rw-r--r-- | docs/manpages/testparm.1 | 204 | ||||
| -rw-r--r-- | docs/manpages/testprns.1 | 175 |
6 files changed, 1043 insertions, 402 deletions
diff --git a/docs/docbook/manpages/testparm.1.sgml b/docs/docbook/manpages/testparm.1.sgml new file mode 100644 index 0000000000..da90dc6e6c --- /dev/null +++ b/docs/docbook/manpages/testparm.1.sgml @@ -0,0 +1,168 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="testparm"> + +<refmeta> + <refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>testparm</refname> + <refpurpose>check an smb.conf configuration file for + internal correctness</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>testparm</command> + <arg choice="opt">-s</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-L <servername></arg> + <arg choice="req">config filename</arg> + <arg choice="opt">hostname hostIP</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> + + <para><command>testparm</command> is a very simple test program + to check an <command>smbd</command> configuration file for + internal correctness. If this program reports no problems, you + can use the configuration file with confidence that <command>smbd + </command> will successfully load the configuration file.</para> + + + <para>Note that this is <emphasis>NOT</emphasis> a guarantee that + the services specified in the configuration file will be + available or will operate as expected. </para> + + <para>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. </para> + + <para>If <command>testparm</command> finds an error in the <filename> + smb.conf</filename> 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 <command>testparm</command>.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s</term> + <listitem><para>Without this option, <command>testparm</command> + will prompt for a carriage return after printing the service + names and before dumping the service definitions.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-h</term> + <listitem><para>Print usage message </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-L servername</term> + <listitem><para>Sets the value of the %L macro to servername. + This is useful for testing include files specified with the + %L macro. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>configfilename</term> + <listitem><para>This is the name of the configuration file + to check. If this parameter is not present then the + default <filename>smb.conf</filename> file will be checked. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostname</term> + <listitem><para>If this parameter and the following are + specified, then testparm will examine the <parameter>hosts + allow</parameter> and <parameter>hosts deny</parameter> + parameters in the <filename>smb.conf</filename> file to + determine if the hostname with this IP address would be + allowed access to the <command>smbd</command> server. If + this parameter is supplied, the hostIP parameter must also + be supplied.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostIP</term> + <listitem><para>This is the IP address of the host specified + in the previous parameter. This address must be supplied + if the hostname parameter is supplied. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>smb.conf</filename></term> + <listitem><para>This is usually the name of the configuration + file used by <command>smbd</command>. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>The program will issue a message saying whether the + configuration file loaded OK or not. This message may be preceeded 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. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 2.2 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><ulink url="smb.conf.5.html"><filename>smb.conf(5)</filename></ulink>, + <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>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.</para> + + <para>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 + <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</para> +</refsect1> + +</refentry> + diff --git a/docs/docbook/manpages/testprns.1.sgml b/docs/docbook/manpages/testprns.1.sgml new file mode 100644 index 0000000000..cd99494a9a --- /dev/null +++ b/docs/docbook/manpages/testprns.1.sgml @@ -0,0 +1,143 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="testprns"> + +<refmeta> + <refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>testprns</refname> + <refpurpose>check printer name for validity with smbd</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>testprns</command> + <arg choice="req">printername</arg> + <arg choice="opt">printcapname</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> + + <para><command>testprns</command> is a very simple test program + to determine whether a given printer name is valid for use in + a service to be provided by <ulink url="smbd.8.html"><command> + smbd(8)</command></ulink>. </para> + + <para>"Valid" in this context means "can be found in the + printcap specified". This program is very stupid - so stupid in + fact that it would be wisest to always specify the printcap file + to use. </para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>printername</term> + <listitem><para>The printer name to validate.</para> + + <para>Printer names are taken from the first field in each + record in the printcap file, single printer names and sets + of aliases separated by vertical bars ("|") are recognized. + Note that no validation or checking of the printcap syntax is + done beyond that required to extract the printer name. It may + be that the print spooling system is more forgiving or less + forgiving than <command>testprns</command>. However, if + <command>testprns</command> finds the printer then + <command>smbd</command> should do so as well. </para></listitem> + </varlistentry> + + <varlistentry> + <term>printcapname</term> + <listitem><para>This is the name of the printcap file within + which to search for the given printer name. </para> + + <para>If no printcap name is specified <command>testprns + </command> will attempt to scan the printcap file name + specified at compile time. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/printcap</filename></term> + <listitem><para>This is usually the default printcap + file to scan. See <filename>printcap (5)</filename>. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>If a printer is found to be valid, the message + "Printer name <printername> is valid" will be + displayed. </para> + + <para>If a printer is found to be invalid, the message + "Printer name <printername> is not valid" will be + displayed. </para> + + <para>All messages that would normally be logged during + operation of the Samba daemons are logged by this program to the + file <filename>test.log</filename> in the current directory. The + program runs at debuglevel 3, so quite extensive logging + information is written. The log should be checked carefully + for errors and warnings. </para> + + <para>Other messages are self-explanatory. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 2.2 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><filename>printcap(5)</filename>, + <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>, + <ulink url="smbclient.1.html"><command>smbclient(1)</command></ulink> + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>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.</para> + + <para>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 + <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</para> +</refsect1> + +</refentry> + diff --git a/docs/htmldocs/testparm.1.html b/docs/htmldocs/testparm.1.html index 8babecbcfa..d1a1e4333a 100644 --- a/docs/htmldocs/testparm.1.html +++ b/docs/htmldocs/testparm.1.html @@ -1,114 +1,291 @@ - - - - - - -<html><head><title>testparm (1)</title> - -<link rev="made" href="mailto:samba@samba.org"> -</head> -<body> - -<hr> - -<h1>testparm (1)</h1> -<h2>Samba</h2> -<h2>23 Oct 1998</h2> - - - -<p><a name="NAME"></a> -<h2>NAME</h2> - testparm - check an smb.conf configuration file for internal correctness -<p><a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> - -<p><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><a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> - -<p>This program is part of the <strong>Samba</strong> suite. -<p><strong>testparm</strong> is a very simple test program to check an -<a href="smbd.8.html"><strong>smbd</strong></a> configuration file for internal -correctness. If this program reports no problems, you can use the -configuration file with confidence that <a href="smbd.8.html"><strong>smbd</strong></a> -will successfully load the configuration file. -<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>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>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><a name="OPTIONS"></a> -<h2>OPTIONS</h2> - -<p><dl> -<p><a name="minuss"></a> -<p></p><dt><strong><strong>-s</strong></strong><dd> Without this option, <strong>testparm</strong> will prompt for a -carriage return after printing the service names and before dumping -the service definitions. -<p><a name="minush"></a> -<p></p><dt><strong><strong>-h</strong></strong><dd> Print usage message -<p><a name="minusL"></a> -<p></p><dt><strong><strong>-L servername</strong></strong><dd> Sets the value of the %L macro to servername. This -is useful for testing include files specified with the %L macro. -<p><a name="configfilename"></a> -<p></p><dt><strong><strong>configfilename</strong></strong><dd> This is the name of the configuration file to -check. If this parameter is not present then the default -<a href="smb.conf.5.html"><strong>smb.conf</strong></a> file will be checked. -<p><a name="hostname"></a> -<p></p><dt><strong><strong>hostname</strong></strong><dd> If this parameter and the following are specified, -then testparm will examine the <a href="smb.conf.5.html#hostsallow"><strong>"hosts -allow"</strong></a> and <a href="smb.conf.5.html#hostsdeny"><strong>"hosts -deny"</strong></a> parameters in the -<a href="smb.conf.5.html"><strong>smb.conf</strong></a> file to determine if the hostname -with this IP address would be allowed access to the -<a href="smbd.8.html"><strong>smbd</strong></a> server. If this parameter is supplied, the -<a href="testparm.1.html#hostIP">hostIP</a> parameter must also be supplied. -<p><a name="hostIP"></a> -<p></p><dt><strong><strong>hostIP</strong></strong><dd> 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></dl> -<p><a name="FILES"></a> -<h2>FILES</h2> - -<p><a href="smb.conf.5.html"><strong>smb.conf</strong></a>. This is usually the name of the -configuration file used by <a href="smbd.8.html"><strong>smbd</strong></a>. -<p><a name="DIAGNOSTICS"></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><a name="VERSION"></a> -<h2>VERSION</h2> - -<p>This man page is correct for version 2.0 of the Samba suite. -<p><a name="SEEALSO"></a> -<h2>SEE ALSO</h2> - -<p><a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a>, <a href="smbd.8.html"><strong>smbd (8)</strong></a> -<p><a name="AUTHOR"></a> -<h2>AUTHOR</h2> - -<p>The original Samba software and related utilities were created by -Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed. -<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/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>) -and updated for the Samba2.0 release by Jeremy Allison. -<a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. -<p>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc. -</body> -</html> +<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 <I +CLASS="EMPHASIS" +>NOT</I +> 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 servername. + 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 testparm 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="AEN64" +></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="AEN73" +></A +><H2 +>DIAGNOSTICS</H2 +><P +>The program will issue a message saying whether the + configuration file loaded OK or not. This message may be preceeded 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="AEN76" +></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="AEN79" +></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="AEN86" +></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 diff --git a/docs/htmldocs/testprns.1.html b/docs/htmldocs/testprns.1.html index 42f5aebe74..94ab41c98d 100644 --- a/docs/htmldocs/testprns.1.html +++ b/docs/htmldocs/testprns.1.html @@ -1,98 +1,252 @@ - - - - - - -<html><head><title>testprns (1)</title> - -<link rev="made" href="mailto:samba@samba.org"> -</head> -<body> - -<hr> - -<h1>testprns (1)</h1> -<h2>Samba</h2> -<h2>23 Oct 1998</h2> - - - -<p><a name="NAME"></a> -<h2>NAME</h2> - testprns - check printer name for validity with smbd -<p><a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> - -<p><strong>testprns</strong> <a href="testprns.1.html#printername">printername</a> [<a href="testprns.1.html#printcapname">printcapname</a>] -<p><a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> - -<p>This program is part of the <strong>Samba</strong> suite. -<p><strong>testprns</strong> is a very simple test program to determine whether a -given printer name is valid for use in a service to be provided by -<a href="smbd.8.html"><strong>smbd</strong></a>. -<p>"Valid" in this context means "can be found in the printcap -specified". This program is very stupid - so stupid in fact that it -would be wisest to always specify the printcap file to use. -<p><a name="OPTIONS"></a> -<h2>OPTIONS</h2> - -<p><dl> -<p><a name="printername"></a> -<p></p><dt><strong><strong>printername</strong></strong><dd> The printer name to validate. -<p>Printer names are taken from the first field in each record in the -printcap file, single printer names and sets of aliases separated by -vertical bars ("|") are recognized. Note that no validation or -checking of the printcap syntax is done beyond that required to -extract the printer name. It may be that the print spooling system is -more forgiving or less forgiving than <strong>testprns</strong>. However, if -<strong>testprns</strong> finds the printer then <a href="smbd.8.html"><strong>smbd</strong></a> should -do so as well. -<p><a name="printcapname"></a> -<p></p><dt><strong><strong>printcapname</strong></strong><dd> This is the name of the printcap file within -which to search for the given printer name. -<p>If no printcap name is specified <strong>testprns</strong> will attempt to scan the -printcap file name specified at compile time. -<p></dl> -<p><a name="FILES"></a> -<h2>FILES</h2> - -<p><strong>/etc/printcap</strong> This is usually the default printcap file to -scan. See <strong>printcap (5)</strong>. -<p><a name="DIAGNOSTICS"></a> -<h2>DIAGNOSTICS</h2> - -<p>If a printer is found to be valid, the message "Printer name -<printername> is valid" will be displayed. -<p>If a printer is found to be invalid, the message "Printer name -<printername> is not valid" will be displayed. -<p>All messages that would normally be logged during operation of the -<a href="samba.7.html"><strong>Samba</strong></a> daemons are logged by this program to the -file <code>test.log</code> in the current directory. The program runs at -debuglevel 3, so quite extensive logging information is written. The -log should be checked carefully for errors and warnings. -<p>Other messages are self-explanatory. -<p><a name="SEEALSO"></a> -<h2>SEE ALSO</h2> - -<p><strong>printcap (5)</strong>, <a href="smbd.8.html"><strong>smbd (8)</strong></a>, <a href="smbclient.1.html"><strong>smbclient -(1)</strong></a> -<p><a name="AUTHOR"></a> -<h2>AUTHOR</h2> - -<p>The original Samba software and related utilities were created by -Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed. -<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/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>) -and updated for the Samba2.0 release by Jeremy Allison. -<a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. -<p>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc. -</body> -</html> +<HTML +><HEAD +><TITLE +>testprns</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="TESTPRNS" +>testprns</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5" +></A +><H2 +>Name</H2 +>testprns -- check printer name for validity with smbd</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN8" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>testprns</B +> {printername} [printcapname]</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN13" +></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" +>testprns</B +> is a very simple test program + to determine whether a given printer name is valid for use in + a service to be provided by <A +HREF="smbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +> smbd(8)</B +></A +>. </P +><P +>"Valid" in this context means "can be found in the + printcap specified". This program is very stupid - so stupid in + fact that it would be wisest to always specify the printcap file + to use. </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN22" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>printername</DT +><DD +><P +>The printer name to validate.</P +><P +>Printer names are taken from the first field in each + record in the printcap file, single printer names and sets + of aliases separated by vertical bars ("|") are recognized. + Note that no validation or checking of the printcap syntax is + done beyond that required to extract the printer name. It may + be that the print spooling system is more forgiving or less + forgiving than <B +CLASS="COMMAND" +>testprns</B +>. However, if + <B +CLASS="COMMAND" +>testprns</B +> finds the printer then + <B +CLASS="COMMAND" +>smbd</B +> should do so as well. </P +></DD +><DT +>printcapname</DT +><DD +><P +>This is the name of the printcap file within + which to search for the given printer name. </P +><P +>If no printcap name is specified <B +CLASS="COMMAND" +>testprns + </B +> will attempt to scan the printcap file name + specified at compile time. </P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN39" +></A +><H2 +>FILES</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><TT +CLASS="FILENAME" +>/etc/printcap</TT +></DT +><DD +><P +>This is usually the default printcap + file to scan. See <TT +CLASS="FILENAME" +>printcap (5)</TT +>. + </P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN48" +></A +><H2 +>DIAGNOSTICS</H2 +><P +>If a printer is found to be valid, the message + "Printer name <printername> is valid" will be + displayed. </P +><P +>If a printer is found to be invalid, the message + "Printer name <printername> is not valid" will be + displayed. </P +><P +>All messages that would normally be logged during + operation of the Samba daemons are logged by this program to the + file <TT +CLASS="FILENAME" +>test.log</TT +> in the current directory. The + program runs at debuglevel 3, so quite extensive logging + information is written. The log should be checked carefully + for errors and warnings. </P +><P +>Other messages are self-explanatory. </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN55" +></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="AEN58" +></A +><H2 +>SEE ALSO</H2 +><P +><TT +CLASS="FILENAME" +>printcap(5)</TT +>, + <A +HREF="smbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbd(8)</B +></A +>, + <A +HREF="smbclient.1.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbclient(1)</B +></A +> + </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN66" +></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 diff --git a/docs/manpages/testparm.1 b/docs/manpages/testparm.1 index e02b887394..a5aa932aa1 100644 --- a/docs/manpages/testparm.1 +++ b/docs/manpages/testparm.1 @@ -1,104 +1,100 @@ -.TH "testparm " "1" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" -testparm \- check an smb\&.conf configuration file for internal correctness -.PP -.SH "SYNOPSIS" -.PP -\fBtestparm\fP [-s] [-h] [-L servername] [configfilename] [hostname hostIP] -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBtestparm\fP is a very simple test program to check an -\fBsmbd\fP configuration file for internal -correctness\&. If this program reports no problems, you can use the -configuration file with confidence that \fBsmbd\fP -will successfully load the configuration file\&. -.PP -Note that this is \fINOT\fP 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\fP finds an error in the \fBsmb\&.conf\fP -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\fP\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fB-s\fP" -Without this option, \fBtestparm\fP will prompt for a -carriage return after printing the service names and before dumping -the service definitions\&. -.IP -.IP "\fB-h\fP" -Print usage message -.IP -.IP "\fB-L servername\fP" -Sets the value of the %L macro to servername\&. This -is useful for testing include files specified with the %L macro\&. -.IP -.IP "\fBconfigfilename\fP" -This is the name of the configuration file to -check\&. If this parameter is not present then the default -\fBsmb\&.conf\fP file will be checked\&. -.IP -.IP "\fBhostname\fP" -If this parameter and the following are specified, -then testparm will examine the \fB"hosts -allow"\fP and \fB"hosts -deny"\fP parameters in the -\fBsmb\&.conf\fP file to determine if the hostname -with this IP address would be allowed access to the -\fBsmbd\fP server\&. If this parameter is supplied, the -hostIP parameter must also be supplied\&. -.IP -.IP "\fBhostIP\fP" -This is the IP address of the host specified in the -previous parameter\&. This address must be supplied if the hostname -parameter is supplied\&. -.IP -.PP -.SH "FILES" -.PP -\fBsmb\&.conf\fP\&. This is usually the name of the -configuration file used by \fBsmbd\fP\&. -.PP -.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\&. -.PP -.SH "VERSION" -.PP -This man page is correct for version 2\&.0 of the Samba suite\&. -.PP -.SH "SEE ALSO" -.PP -\fBsmb\&.conf (5)\fP, \fBsmbd (8)\fP -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. 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 -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc\&. +.\" 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/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "TESTPARM" "1" "22 February 2001" "" "" +.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 ] +.SH "DESCRIPTION" +.PP +This tool is part of the Samba <URL:samba.7.html> 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 +\fRwill 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 servername. +This is useful for testing include files specified with the +%L macro. +.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 testparm 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 preceeded 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 <URL:smb.conf.5.html>, +\fBsmbd(8)\fR <URL:smbd.8.html> +.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 diff --git a/docs/manpages/testprns.1 b/docs/manpages/testprns.1 index a9753d7637..91738ebcfe 100644 --- a/docs/manpages/testprns.1 +++ b/docs/manpages/testprns.1 @@ -1,87 +1,90 @@ -.TH "testprns " "1" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" -testprns \- check printer name for validity with smbd -.PP -.SH "SYNOPSIS" -.PP -\fBtestprns\fP printername [printcapname] -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBtestprns\fP is a very simple test program to determine whether a -given printer name is valid for use in a service to be provided by -\fBsmbd\fP\&. -.PP -"Valid" in this context means "can be found in the printcap -specified"\&. This program is very stupid - so stupid in fact that it -would be wisest to always specify the printcap file to use\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fBprintername\fP" -The printer name to validate\&. -.IP -Printer names are taken from the first field in each record in the -printcap file, single printer names and sets of aliases separated by -vertical bars ("|") are recognized\&. Note that no validation or -checking of the printcap syntax is done beyond that required to -extract the printer name\&. It may be that the print spooling system is -more forgiving or less forgiving than \fBtestprns\fP\&. However, if -\fBtestprns\fP finds the printer then \fBsmbd\fP should -do so as well\&. -.IP -.IP "\fBprintcapname\fP" +.\" 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/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "TESTPRNS" "1" "22 February 2001" "" "" +.SH NAME +testprns \- check printer name for validity with smbd +.SH SYNOPSIS +.sp +\fBtestprns\fR \fBprintername\fR [ \fBprintcapname\fR ] +.SH "DESCRIPTION" +.PP +This tool is part of the Samba <URL:samba.7.html> suite. +.PP +\fBtestprns\fR is a very simple test program +to determine whether a given printer name is valid for use in +a service to be provided by \fB smbd(8)\fR <URL:smbd.8.html>. +.PP +"Valid" in this context means "can be found in the +printcap specified". This program is very stupid - so stupid in +fact that it would be wisest to always specify the printcap file +to use. +.SH "OPTIONS" +.TP +\fBprintername\fR +The printer name to validate. + +Printer names are taken from the first field in each +record in the printcap file, single printer names and sets +of aliases separated by vertical bars ("|") are recognized. +Note that no validation or checking of the printcap syntax is +done beyond that required to extract the printer name. It may +be that the print spooling system is more forgiving or less +forgiving than \fBtestprns\fR. However, if +\fBtestprns\fR finds the printer then +\fBsmbd\fR should do so as well. +.TP +\fBprintcapname\fR This is the name of the printcap file within -which to search for the given printer name\&. -.IP -If no printcap name is specified \fBtestprns\fP will attempt to scan the -printcap file name specified at compile time\&. -.IP -.PP -.SH "FILES" -.PP -\fB/etc/printcap\fP This is usually the default printcap file to -scan\&. See \fBprintcap (5)\fP\&. -.PP -.SH "DIAGNOSTICS" -.PP -If a printer is found to be valid, the message "Printer name -<printername> is valid" will be displayed\&. -.PP -If a printer is found to be invalid, the message "Printer name -<printername> is not valid" will be displayed\&. -.PP -All messages that would normally be logged during operation of the -\fBSamba\fP daemons are logged by this program to the -file \f(CWtest\&.log\fP in the current directory\&. The program runs at -debuglevel 3, so quite extensive logging information is written\&. The -log should be checked carefully for errors and warnings\&. -.PP -Other messages are self-explanatory\&. -.PP -.SH "SEE ALSO" -.PP -\fBprintcap (5)\fP, \fBsmbd (8)\fP, \fBsmbclient -(1)\fP -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. 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 -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc\&. +which to search for the given printer name. + +If no printcap name is specified \fBtestprns +\fRwill attempt to scan the printcap file name +specified at compile time. +.SH "FILES" +.TP +\fB\fI/etc/printcap\fB\fR +This is usually the default printcap +file to scan. See \fIprintcap (5)\fR. +.SH "DIAGNOSTICS" +.PP +If a printer is found to be valid, the message +"Printer name <printername> is valid" will be +displayed. +.PP +If a printer is found to be invalid, the message +"Printer name <printername> is not valid" will be +displayed. +.PP +All messages that would normally be logged during +operation of the Samba daemons are logged by this program to the +file \fItest.log\fR in the current directory. The +program runs at debuglevel 3, so quite extensive logging +information is written. The log should be checked carefully +for errors and warnings. +.PP +Other messages are self-explanatory. +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "SEE ALSO" +.PP +\fIprintcap(5)\fR, +\fBsmbd(8)\fR <URL:smbd.8.html>, +\fBsmbclient(1)\fR <URL:smbclient.1.html> +.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 |