| 1 | <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.71.0"></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 class="refnamediv"><h2>Name</h2><p>testparm — check an smb.conf configuration file for |
|---|
| 2 | internal correctness</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">testparm</code> [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]</p></div></div><div class="refsect1" lang="en"><a name="id259558"></a><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><span><strong class="command">testparm</strong></span> is a very simple test program |
|---|
| 3 | to check an <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> configuration file for |
|---|
| 4 | internal correctness. If this program reports no problems, you |
|---|
| 5 | can use the configuration file with confidence that <span><strong class="command">smbd |
|---|
| 6 | </strong></span> will successfully load the configuration file.</p><p>Note that this is <span class="emphasis"><em>NOT</em></span> a guarantee that |
|---|
| 7 | the services specified in the configuration file will be |
|---|
| 8 | available or will operate as expected. </p><p>If the optional host name and host IP address are |
|---|
| 9 | specified on the command line, this test program will run through |
|---|
| 10 | the service entries reporting whether the specified host |
|---|
| 11 | has access to each service. </p><p>If <span><strong class="command">testparm</strong></span> finds an error in the <code class="filename"> |
|---|
| 12 | smb.conf</code> file it returns an exit code of 1 to the calling |
|---|
| 13 | program, else it returns an exit code of 0. This allows shell scripts |
|---|
| 14 | to test the output from <span><strong class="command">testparm</strong></span>.</p></div><div class="refsect1" lang="en"><a name="id259384"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s</span></dt><dd><p>Without this option, <span><strong class="command">testparm</strong></span> |
|---|
| 15 | will prompt for a carriage return after printing the service |
|---|
| 16 | 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. |
|---|
| 17 | </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. |
|---|
| 18 | </p></dd><dt><span class="term">-L servername</span></dt><dd><p>Sets the value of the %L macro to <em class="replaceable"><code>servername</code></em>. |
|---|
| 19 | This is useful for testing include files specified with the |
|---|
| 20 | %L macro. </p></dd><dt><span class="term">-v</span></dt><dd><p>If this option is specified, testparm |
|---|
| 21 | 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> |
|---|
| 22 | Output data in specified encoding. |
|---|
| 23 | </p></dd><dt><span class="term">--parameter-name parametername</span></dt><dd><p> |
|---|
| 24 | Dumps the named parameter. If no section-name is set the view |
|---|
| 25 | is limited by default to the global section. |
|---|
| 26 | |
|---|
| 27 | It is also possible to dump a parametrical option. Therfore |
|---|
| 28 | the option has to be separated by a colon from the |
|---|
| 29 | parametername. |
|---|
| 30 | </p></dd><dt><span class="term">--section-name sectionname</span></dt><dd><p> |
|---|
| 31 | Dumps the named section. |
|---|
| 32 | </p></dd><dt><span class="term">configfilename</span></dt><dd><p>This is the name of the configuration file |
|---|
| 33 | to check. If this parameter is not present then the |
|---|
| 34 | default <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file will be checked. |
|---|
| 35 | </p></dd><dt><span class="term">hostname</span></dt><dd><p>If this parameter and the following are |
|---|
| 36 | specified, then <span><strong class="command">testparm</strong></span> will examine the <em class="parameter"><code>hosts |
|---|
| 37 | allow</code></em> and <em class="parameter"><code>hosts deny</code></em> |
|---|
| 38 | parameters in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file to |
|---|
| 39 | determine if the hostname with this IP address would be |
|---|
| 40 | allowed access to the <span><strong class="command">smbd</strong></span> server. If |
|---|
| 41 | this parameter is supplied, the hostIP parameter must also |
|---|
| 42 | be supplied.</p></dd><dt><span class="term">hostIP</span></dt><dd><p>This is the IP address of the host specified |
|---|
| 43 | in the previous parameter. This address must be supplied |
|---|
| 44 | if the hostname parameter is supplied. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id260139"></a><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 |
|---|
| 45 | file used by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>. |
|---|
| 46 | </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id260174"></a><h2>DIAGNOSTICS</h2><p>The program will issue a message saying whether the |
|---|
| 47 | configuration file loaded OK or not. This message may be preceded by |
|---|
| 48 | errors and warnings if the file did not load. If the file was |
|---|
| 49 | loaded OK, the program then dumps all known service details |
|---|
| 50 | to stdout. </p></div><div class="refsect1" lang="en"><a name="id260186"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of |
|---|
| 51 | the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id260197"></a><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"><a name="id300446"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities |
|---|
| 52 | were created by Andrew Tridgell. Samba is now developed |
|---|
| 53 | by the Samba Team as an Open Source project similar |
|---|
| 54 | to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. |
|---|
| 55 | The man page sources were converted to YODL format (another |
|---|
| 56 | excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> |
|---|
| 57 | ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 |
|---|
| 58 | release by Jeremy Allison. The conversion to DocBook for |
|---|
| 59 | Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 |
|---|
| 60 | for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html> |
|---|
