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.74.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="literal">testparm</code> [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]</p></div></div><div class="refsect1" lang="en"><a name="id2483356"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">testparm</code> is a very simple test program
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.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="testparm"><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" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">testparm</code> [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2489320"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">testparm</code> is a very simple test program
3
3
to check an <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> configuration file for
4
4
internal correctness. If this program reports no problems, you
5
5
can use the configuration file with confidence that <code class="literal">smbd
11
11
has access to each service. </p><p>If <code class="literal">testparm</code> finds an error in the <code class="filename">
12
12
smb.conf</code> file it returns an exit code of 1 to the calling
13
13
program, else it returns an exit code of 0. This allows shell scripts
14
to test the output from <code class="literal">testparm</code>.</p></div><div class="refsect1" lang="en"><a name="id2483556"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s</span></dt><dd><p>Without this option, <code class="literal">testparm</code>
14
to test the output from <code class="literal">testparm</code>.</p></div><div class="refsect1" title="OPTIONS"><a name="id2489527"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s</span></dt><dd><p>Without this option, <code class="literal">testparm</code>
15
15
will prompt for a carriage return after printing the service
16
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.
17
</p></dd><dt><span class="term">-V|--version</span></dt><dd><p>Prints the program version number.
18
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
19
This is useful for testing include files specified with the
20
20
%L macro. </p></dd><dt><span class="term">-v</span></dt><dd><p>If this option is specified, testparm
41
41
this parameter is supplied, the hostIP parameter must also
42
42
be supplied.</p></dd><dt><span class="term">hostIP</span></dt><dd><p>This is the IP address of the host specified
43
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="id2483766"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><a class="citerefentry" 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
44
if the hostname parameter is supplied. </p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="id2489737"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><a class="citerefentry" 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
45
file used by <a class="citerefentry" 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="id2483801"></a><h2>DIAGNOSTICS</h2><p>The program will issue a message saying whether the
46
</p></dd></dl></div></div><div class="refsect1" title="DIAGNOSTICS"><a name="id2489773"></a><h2>DIAGNOSTICS</h2><p>The program will issue a message saying whether the
47
47
configuration file loaded OK or not. This message may be preceded by
48
48
errors and warnings if the file did not load. If the file was
49
49
loaded OK, the program then dumps all known service details
50
to stdout. </p></div><div class="refsect1" lang="en"><a name="id2481491"></a><h2>VERSION</h2><p>This man page is correct for version 3 of
51
the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2481502"></a><h2>SEE ALSO</h2><p><a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id2481528"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
50
to stdout. </p></div><div class="refsect1" title="VERSION"><a name="id2487456"></a><h2>VERSION</h2><p>This man page is correct for version 3 of
51
the Samba suite.</p></div><div class="refsect1" title="SEE ALSO"><a name="id2487466"></a><h2>SEE ALSO</h2><p><a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a></p></div><div class="refsect1" title="AUTHOR"><a name="id2487492"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
52
52
were created by Andrew Tridgell. Samba is now developed
53
53
by the Samba Team as an Open Source project similar
54
54
to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.