update testparm with -s option so it doesn't require a carriage return
[samba.git] / 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.anu.edu.au">
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#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><a name="OPTIONS"></a>
43 <h2>OPTIONS</h2>
44     
45 <p><br><ul>
46 <p><br><a name="minuss"></a>
47 <li><strong><strong>-s</strong></strong> Without this option, <strong>testparm</strong> will prompt for a
48 carriage return after printing the service names and before dumping
49 the service definitions.
50 <p><br><a name="configfilename"></a>
51 <li><strong><strong>configfilename</strong></strong> This is the name of the configuration file to
52 check. If this parameter is not present then the default
53 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file will be checked.
54 <p><br><a name="hostname"></a>
55 <li><strong><strong>hostname</strong></strong> If this parameter and the following are specified,
56 then testparm will examine the <a href="smb.conf.5.html#hostsallow"><strong>"hosts
57 allow"</strong></a> and <a href="smb.conf.5.html#hostsdeny"><strong>"hosts
58 deny"</strong></a> parameters in the
59 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file to determine if the hostname
60 with this IP address would be allowed access to the
61 <a href="smbd.8.html"><strong>smbd</strong></a> server. If this parameter is supplied, the
62 <a href="testparm.1.html#hostIP">hostIP</a> parameter must also be supplied.
63 <p><br><a name="hostIP"></a>
64 <li><strong><strong>hostIP</strong></strong> This is the IP address of the host specified in the
65 previous parameter. This address must be supplied if the hostname
66 parameter is supplied.
67 <p><br></ul>
68 <p><br><a name="FILES"></a>
69 <h2>FILES</h2>
70     
71 <p><br><a href="smb.conf.5.html"><strong>smb.conf</strong></a>. This is usually the name of the
72 configuration file used by <a href="smbd.8.html"><strong>smbd</strong></a>.
73 <p><br><a name="DIAGNOSTICS"></a>
74 <h2>DIAGNOSTICS</h2>
75     
76 <p><br>The program will issue a message saying whether the configuration file
77 loaded OK or not. This message may be preceded by errors and warnings
78 if the file did not load. If the file was loaded OK, the program then
79 dumps all known service details to stdout.
80 <p><br><a name="VERSION"></a>
81 <h2>VERSION</h2>
82     
83 <p><br>This man page is correct for version 2.0 of the Samba suite.
84 <p><br><a name="SEEALSO"></a>
85 <h2>SEE ALSO</h2>
86     
87 <p><br><a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a>, <a href="smbd.8.html"><strong>smbd (8)</strong></a>
88 <p><br><a name="AUTHOR"></a>
89 <h2>AUTHOR</h2>
90     
91 <p><br>The original Samba software and related utilities were created by
92 Andrew Tridgell <a href="mailto:samba-bugs@samba.anu.edu.au"><em>samba-bugs@samba.anu.edu.au</em></a>. Samba is now developed
93 by the Samba Team as an Open Source project similar to the way the
94 Linux kernel is developed.
95 <p><br>The original Samba man pages were written by Karl Auer. The man page
96 sources were converted to YODL format (another excellent piece of Open
97 Source software, available at
98 <a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
99 and updated for the Samba2.0 release by Jeremy Allison.
100 <a href="mailto:samba-bugs@samba.anu.edu.au"><em>samba-bugs@samba.anu.edu.au</em></a>.
101 <p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
102 list of contributors and details on how to submit bug reports,
103 comments etc.
104 </body>
105 </html>