added QNX entry to MIRRORS
[ira/wip.git] / docs / manpages / testparm.1
1 .TH TESTPARM 1 17/1/1995 testparm testparm
2 .SH NAME
3 testparm \- check an smbd configuration file for internal correctness
4 .SH SYNOPSIS
5 .B testparm
6 [
7 .I configfilename
8 [
9 .I hostname
10 .I hostIP
11 ]
12 ]
13 .SH DESCRIPTION
14 This program is part of the Samba suite.
15
16 .B testparm
17 is a very simple test program to check an
18 .B smbd
19 configuration
20 file for internal correctness. If this program reports no problems, you can use
21 the configuration file with confidence that smbd will successfully
22 load the configuration file.
23
24 Note that this is NOT a guarantee that the services specified in the
25 configuration file will be available or will operate as expected.
26
27 If the optional host name and host IP address are specified on the
28 command line, this test program will run through the service entries
29 reporting whether the specified host has access to each service.
30 .SH OPTIONS
31 .I configfilename
32
33 .RS 3
34 This is the name of the configuration file to check.
35 .RE
36
37 .I hostname
38
39 .RS 3
40 This is the name of the host to check access on.
41
42 If this parameter is supplied, the
43 .I hostIP
44 parameter must also be supplied, or strange things may happen.
45 .RE
46
47 .I hostIP
48
49 .RS 3
50 This is the IP number of the host specified in the previous parameter.
51
52 This number must be supplied if the
53 .I hostname
54 parameter is supplied, or strange things may happen.
55 .RE
56 .SH FILES
57 .B smb.conf
58 .RS 3
59 This is usually the name of the configuration file used by smbd.
60 .RE
61 .SH ENVIRONMENT VARIABLES
62 Not applicable.
63
64 .SH INSTALLATION
65 The location of the server and its support files is a matter for individual
66 system administrators. The following are thus suggestions only.
67
68 It is recommended that the
69 .B testparm
70 program be installed under the /usr/local hierarchy, in a directory readable
71 by all, writeable only by root. The program itself should be executable by all.
72 The program should NOT be setuid or setgid!
73 .SH VERSION
74 This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
75 of the recent patches to it. These notes will necessarily lag behind 
76 development of the software, so it is possible that your version of 
77 the program has extensions or parameter semantics that differ from or are not 
78 covered by this man page. Please notify these to the address below for 
79 rectification.
80 .SH SEE ALSO
81 .B smb.conf(5),
82 .B smbd(8)
83 .SH DIAGNOSTICS
84 The program will issue a message saying whether the configuration file loaded
85 OK or not. This message may be preceded by errors and warnings if the file
86 did not load. If the file was loaded OK, the program then dumps all known
87 service details to stdout.
88
89 If a host name is specified but no host IP number, all bets are off.
90
91 Other messages are self-explanatory.
92 .SH BUGS
93 None known.
94 .SH CREDITS
95 The original Samba software and related utilities were created by 
96 Andrew Tridgell (samba-bugs@anu.edu.au). Andrew is also the Keeper
97 of the Source for this project.
98
99 The testparm program and this man page were written by Karl Auer
100 (Karl.Auer@anu.edu.au)
101
102 See
103 .B samba(7) for a full list of contributors and details on how to 
104 submit bug reports, comments etc.