blob: 03adba0f384d1f20b584a1fb938f4a7aba95ac71 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<?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 <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. </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. </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 <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.</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. </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.
</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 <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 <command moreinfo="none">smbd</command> server. If
this parameter is supplied, the hostIP parameter must also
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. </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. </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.</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 <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.</para>
</refsect1>
</refentry>
|
