docs/manpages-3/testparm.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="testparm.1">
   4
   5 <refmeta>
   6         <refentrytitle>testparm</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>testparm</refname>
  13         <refpurpose>check an smb.conf configuration file for
  14         internal correctness</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv>
  18         <cmdsynopsis>
  19                 <command>testparm</command>
  20                 <arg choice="opt">-s</arg>
  21                 <arg choice="opt">-h</arg>
  22                 <arg choice="opt">-v</arg>
  23                 <arg choice="opt">-L &lt;servername&gt;</arg>
  24                 <arg choice="opt">-t &lt;encoding&gt;</arg>
  25                 <arg choice="req">config filename</arg>
  26                 <arg choice="opt">hostname hostIP</arg>
  27         </cmdsynopsis>
  28 </refsynopsisdiv>
  29
  30 <refsect1>
  31         <title>DESCRIPTION</title>
  32
  33         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  34         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  35
  36         <para><command>testparm</command> is a very simple test program
  37         to check an <citerefentry><refentrytitle>smbd</refentrytitle>
  38         <manvolnum>8</manvolnum></citerefentry> configuration file for
  39         internal correctness. If this program reports no problems, you
  40         can use the configuration file with confidence that <command>smbd
  41         </command> will successfully load the configuration file.</para>
  42
  43
  44         <para>Note that this is <emphasis>NOT</emphasis> a guarantee that
  45         the services specified in the configuration file will be
  46         available or will operate as expected. </para>
  47
  48         <para>If the optional host name and host IP address are
  49         specified on the command line, this test program will run through
  50         the service entries reporting whether the specified host
  51         has access to each service. </para>
  52
  53         <para>If <command>testparm</command> finds an error in the <filename>
  54         smb.conf</filename> file it returns an exit code of 1 to the calling
  55         program, else it returns an exit code of 0. This allows shell scripts
  56         to test the output from <command>testparm</command>.</para>
  57 </refsect1>
  58
  59 <refsect1>
  60         <title>OPTIONS</title>
  61
  62         <variablelist>
  63                 <varlistentry>
  64                 <term>-s</term>
  65                 <listitem><para>Without this option, <command>testparm</command>
  66                 will prompt for a carriage return after printing the service
  67                 names and before dumping the service definitions.</para></listitem>
  68                 </varlistentry>
  69
  70                 &stdarg.help;
  71                 &stdarg.version;
  72
  73                 <varlistentry>
  74                 <term>-L servername</term>
  75                 <listitem><para>Sets the value of the %L macro to <replaceable>servername</replaceable>.
  76                 This is useful for testing include files specified with the
  77                 %L macro. </para></listitem>
  78                 </varlistentry>
  79
  80                 <varlistentry>
  81                 <term>-v</term>
  82                 <listitem><para>If this option is specified, testparm
  83                 will also output all options that were not used in <citerefentry>
  84                 <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
  85                 </citerefentry> and are thus set to their defaults.</para></listitem>
  86                 </varlistentry>
  87
  88                 <varlistentry>
  89                 <term>-t encoding</term>
  90                 <listitem><para>
  91                 Output data in specified encoding.
  92                 </para></listitem>
  93                 </varlistentry>
  94
  95                 <varlistentry>
  96                 <term>--parameter-name</term>
  97                 <listitem><para>
  98                 Dumps the named parameter.  If no section-name is set the view
  99                 is limited by default to the global section.
 100                 </para></listitem>
 101                 </varlistentry>
 102
 103                 <varlistentry>
 104                 <term>--section-name</term>
 105                 <listitem><para>
 106                 Dumps the named section.
 107                 </para></listitem>
 108                 </varlistentry>
 109
 110                 <varlistentry>
 111                 <term>configfilename</term>
 112                 <listitem><para>This is the name of the configuration file
 113                 to check. If this parameter is not present then the
 114                 default <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 115                 </citerefentry> file will be checked.
 116                 </para></listitem>
 117                 </varlistentry>
 118
 119
 120                 <varlistentry>
 121                 <term>hostname</term>
 122                 <listitem><para>If this parameter and the following are
 123                 specified, then <command>testparm</command> will examine the <parameter>hosts
 124                 allow</parameter> and <parameter>hosts deny</parameter>
 125                 parameters in the <citerefentry>
 126                 <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 127                 </citerefentry> file to
 128                 determine if the hostname with this IP address would be
 129                 allowed access to the <command>smbd</command> server.  If
 130                 this parameter is supplied, the hostIP parameter must also
 131                 be supplied.</para></listitem>
 132                 </varlistentry>
 133
 134
 135                 <varlistentry>
 136                 <term>hostIP</term>
 137                 <listitem><para>This is the IP address of the host specified
 138                 in the previous parameter.  This address must be supplied
 139                 if the hostname parameter is supplied. </para></listitem>
 140                 </varlistentry>
 141         </variablelist>
 142 </refsect1>
 143
 144 <refsect1>
 145         <title>FILES</title>
 146
 147         <variablelist>
 148                 <varlistentry>
 149                 <term><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 150                 </citerefentry></term>
 151                 <listitem><para>This is usually the name of the configuration
 152                 file used by <citerefentry><refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
 153                 </citerefentry>.
 154                 </para></listitem>
 155                 </varlistentry>
 156         </variablelist>
 157 </refsect1>
 158
 159 <refsect1>
 160         <title>DIAGNOSTICS</title>
 161
 162         <para>The program will issue a message saying whether the
 163         configuration file loaded OK or not. This message may be preceded by
 164         errors and warnings if the file did not load. If the file was
 165         loaded OK, the program then dumps all known service details
 166         to stdout. </para>
 167 </refsect1>
 168
 169
 170 <refsect1>
 171         <title>VERSION</title>
 172
 173         <para>This man page is correct for version 3.0 of
 174         the Samba suite.</para>
 175 </refsect1>
 176
 177 <refsect1>
 178         <title>SEE ALSO</title>
 179         <para><citerefentry>
 180                 <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 181                 </citerefentry>, <citerefentry>
 182                 <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
 183                 </citerefentry></para>
 184 </refsect1>
 185
 186 <refsect1>
 187         <title>AUTHOR</title>
 188
 189         <para>The original Samba software and related utilities
 190         were created by Andrew Tridgell. Samba is now developed
 191         by the Samba Team as an Open Source project similar
 192         to the way the Linux kernel is developed.</para>
 193
 194         <para>The original Samba man pages were written by Karl Auer.
 195         The man page sources were converted to YODL format (another
 196         excellent piece of Open Source software, available at <ulink noescape="1" url="ftp://ftp.icce.rug.nl/pub/unix/">
 197         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 198         release by Jeremy Allison.  The conversion to DocBook for
 199         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 200         for Samba 3.0 was done by Alexander Bokovoy.</para>
 201 </refsect1>
 202
 203 </refentry>