docs/htmldocs/testparm.1.html

   1
   2
   3
   4
   5
   6 <html><head><title>testparm (1)</title>
   7
   8 <link rev="made" href="mailto:samba-bugs@samba.org">
   9 </head>
  10 <body>
  11
  12 <hr>
  13
  14 <h1>testparm (1)</h1>
  15 <h2>Samba</h2>
  16 <h2>23 Oct 1998</h2>
  17
  18
  19
  20
  21 <p><br><a name="NAME"></a>
  22 <h2>NAME</h2>
  23     testparm - check an smb.conf configuration file for internal correctness
  24 <p><br><a name="SYNOPSIS"></a>
  25 <h2>SYNOPSIS</h2>
  26
  27 <p><br><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>]
  28 <p><br><a name="DESCRIPTION"></a>
  29 <h2>DESCRIPTION</h2>
  30
  31 <p><br>This program is part of the <strong>Samba</strong> suite.
  32 <p><br><strong>testparm</strong> is a very simple test program to check an
  33 <a href="smbd.8.html"><strong>smbd</strong></a> configuration file for internal
  34 correctness. If this program reports no problems, you can use the
  35 configuration file with confidence that <a href="smbd.8.html"><strong>smbd</strong></a>
  36 will successfully load the configuration file.
  37 <p><br>Note that this is <em>NOT</em> a guarantee that the services specified in the
  38 configuration file will be available or will operate as expected.
  39 <p><br>If the optional host name and host IP address are specified on the
  40 command line, this test program will run through the service entries
  41 reporting whether the specified host has access to each service.
  42 <p><br>If <strong>testparm</strong> finds an error in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a>
  43 file it returns an exit code of 1 to the calling program, else it returns
  44 an exit code of 0. This allows shell scripts to test the output from
  45 <strong>testparm</strong>.
  46 <p><br><a name="OPTIONS"></a>
  47 <h2>OPTIONS</h2>
  48
  49 <p><br><ul>
  50 <p><br><a name="minuss"></a>
  51 <li><strong><strong>-s</strong></strong> Without this option, <strong>testparm</strong> will prompt for a
  52 carriage return after printing the service names and before dumping
  53 the service definitions.
  54 <p><br><a name="minush"></a>
  55 <li><strong><strong>-h</strong></strong> Print usage message
  56 <p><br><a name="minusL"></a>
  57 <li><strong><strong>-L servername</strong></strong> Sets the value of the %L macro to servername. This
  58 is useful for testing include files specified with the %L macro.
  59 <p><br><a name="configfilename"></a>
  60 <li><strong><strong>configfilename</strong></strong> This is the name of the configuration file to
  61 check. If this parameter is not present then the default
  62 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file will be checked.
  63 <p><br><a name="hostname"></a>
  64 <li><strong><strong>hostname</strong></strong> If this parameter and the following are specified,
  65 then testparm will examine the <a href="smb.conf.5.html#hostsallow"><strong>"hosts
  66 allow"</strong></a> and <a href="smb.conf.5.html#hostsdeny"><strong>"hosts
  67 deny"</strong></a> parameters in the
  68 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file to determine if the hostname
  69 with this IP address would be allowed access to the
  70 <a href="smbd.8.html"><strong>smbd</strong></a> server. If this parameter is supplied, the
  71 <a href="testparm.1.html#hostIP">hostIP</a> parameter must also be supplied.
  72 <p><br><a name="hostIP"></a>
  73 <li><strong><strong>hostIP</strong></strong> This is the IP address of the host specified in the
  74 previous parameter. This address must be supplied if the hostname
  75 parameter is supplied.
  76 <p><br></ul>
  77 <p><br><a name="FILES"></a>
  78 <h2>FILES</h2>
  79
  80 <p><br><a href="smb.conf.5.html"><strong>smb.conf</strong></a>. This is usually the name of the
  81 configuration file used by <a href="smbd.8.html"><strong>smbd</strong></a>.
  82 <p><br><a name="DIAGNOSTICS"></a>
  83 <h2>DIAGNOSTICS</h2>
  84
  85 <p><br>The program will issue a message saying whether the configuration file
  86 loaded OK or not. This message may be preceded by errors and warnings
  87 if the file did not load. If the file was loaded OK, the program then
  88 dumps all known service details to stdout.
  89 <p><br><a name="VERSION"></a>
  90 <h2>VERSION</h2>
  91
  92 <p><br>This man page is correct for version 2.0 of the Samba suite.
  93 <p><br><a name="SEEALSO"></a>
  94 <h2>SEE ALSO</h2>
  95
  96 <p><br><a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a>, <a href="smbd.8.html"><strong>smbd (8)</strong></a>
  97 <p><br><a name="AUTHOR"></a>
  98 <h2>AUTHOR</h2>
  99
 100 <p><br>The original Samba software and related utilities were created by
 101 Andrew Tridgell <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>. Samba is now developed
 102 by the Samba Team as an Open Source project similar to the way the
 103 Linux kernel is developed.
 104 <p><br>The original Samba man pages were written by Karl Auer. The man page
 105 sources were converted to YODL format (another excellent piece of Open
 106 Source software, available at
 107 <a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
 108 and updated for the Samba2.0 release by Jeremy Allison.
 109 <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>.
 110 <p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
 111 list of contributors and details on how to submit bug reports,
 112 comments etc.
 113 </body>
 114 </html>