diff options
Diffstat (limited to 'docs/htmldocs/testparm.1.html')
| -rw-r--r-- | docs/htmldocs/testparm.1.html | 214 |
1 files changed, 183 insertions, 31 deletions
diff --git a/docs/htmldocs/testparm.1.html b/docs/htmldocs/testparm.1.html index 3732b53f4c..03adba0f38 100644 --- a/docs/htmldocs/testparm.1.html +++ b/docs/htmldocs/testparm.1.html @@ -1,51 +1,203 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>testparm</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="testparm.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>testparm — check an smb.conf configuration file for - internal correctness</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">testparm</tt> [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">testparm</b> is a very simple test program - to check an <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> configuration file for +<?xml version="1.0"?> + +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + + <!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities; + ]> +<refentry id="testparm.1"> + +<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 sepchar=" "> + <command moreinfo="none">testparm</command> + <arg rep="norepeat" choice="opt">-s</arg> + <arg rep="norepeat" choice="opt">-h</arg> + <arg rep="norepeat" choice="opt">-v</arg> + <arg rep="norepeat" choice="opt">-L <servername></arg> + <arg rep="norepeat" choice="opt">-t <encoding></arg> + <arg rep="norepeat" choice="req">config filename</arg> + <arg rep="norepeat" choice="opt">hostname hostIP</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command moreinfo="none">testparm</command> is a very simple test program + to check an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> 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 <span class="emphasis"><em>NOT</em></span> a guarantee that + can use the configuration file with confidence that <command moreinfo="none">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. </p><p>If the optional host name and host IP address are + 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. </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 + has access to each service. </para> + + <para>If <command moreinfo="none">testparm</command> finds an error in the <filename moreinfo="none"> + 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 <b class="command">testparm</b>.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s</span></dt><dd><p>Without this option, <b class="command">testparm</b> + to test the output from <command moreinfo="none">testparm</command>.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s</term> + <listitem><para>Without this option, <command moreinfo="none">testparm</command> will prompt for a carriage return after printing the service - names and before dumping the service definitions.</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. -</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for -<b class="command">smbd</b>.</p></dd><dt><span class="term">-L servername</span></dt><dd><p>Sets the value of the %L macro to <i class="replaceable"><tt>servername</tt></i>. + names and before dumping the service definitions.</para></listitem> + </varlistentry> + + +<varlistentry> +<term>-h|--help</term> +<listitem><para>Print a summary of command line options. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-V</term> +<listitem><para>Prints the version number for +<command moreinfo="none">smbd</command>.</para></listitem> +</varlistentry> + + <varlistentry> + <term>-L servername</term> + <listitem><para>Sets the value of the %L macro to <replaceable>servername</replaceable>. This is useful for testing include files specified with the - %L macro. </p></dd><dt><span class="term">-v</span></dt><dd><p>If this option is specified, testparm - will also output all options that were not used in <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> and are thus set to their defaults.</p></dd><dt><span class="term">-t encoding</span></dt><dd><p> + %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 <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> and are thus set to their defaults.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-t encoding</term> + <listitem><para> Output data in specified encoding. - </p></dd><dt><span class="term">configfilename</span></dt><dd><p>This is the name of the configuration file + </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 <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file will be checked. - </p></dd><dt><span class="term">hostname</span></dt><dd><p>If this parameter and the following are - specified, then <b class="command">testparm</b> will examine the <i class="parameter"><tt>hosts - allow</tt></i> and <i class="parameter"><tt>hosts deny</tt></i> - parameters in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file to + default <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file will be checked. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostname</term> + <listitem><para>If this parameter and the following are + specified, then <command moreinfo="none">testparm</command> will examine the <parameter moreinfo="none">hosts + allow</parameter> and <parameter moreinfo="none">hosts deny</parameter> + parameters in the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file to determine if the hostname with this IP address would be - allowed access to the <b class="command">smbd</b> server. If + allowed access to the <command moreinfo="none">smbd</command> server. If this parameter is supplied, the hostIP parameter must also - be supplied.</p></dd><dt><span class="term">hostIP</span></dt><dd><p>This is the IP address of the host specified + 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. </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></span></dt><dd><p>This is usually the name of the configuration - file used by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>. - </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>DIAGNOSTICS</h2><p>The program will issue a message saying whether the + if the hostname parameter is supplied. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry></term> + <listitem><para>This is usually the name of the configuration + file used by <citerefentry><refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </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 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" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of - the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + to stdout. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry></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.</p><p>The original Samba man pages were written by Karl Auer. + 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 <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 + 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. The conversion to DocBook XML 4.2 - for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> |