summaryrefslogtreecommitdiffstats
path: root/docs/manpages/testparm.1
blob: 2b4f0568a5dca04c9d643aabf189e240b503c87f (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
.TH TESTPARM 1 "31 Aug 1998" "testparm 2.0.0-alpha1"
.SH NAME
testparm \- check an smbd configuration file for internal correctness
.SH SYNOPSIS
.B testparm
[
.I configfilename
[
.I hostname
.I hostIP
]
]
.SH DESCRIPTION
This program is part of the Samba suite.

.B testparm
is a very simple test program to check an
.B smbd
configuration
file for internal correctness. If this program reports no problems, you can use
the configuration file with confidence that
.B smbd
will successfully
load the configuration file.

Note that this is NOT a guarantee that the services specified in the
configuration file will be available or will operate as expected.

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.
.SH OPTIONS
.I configfilename

.RS 3
This is the name of the configuration file to check.
.RE

.I hostname

.RS 3
This is the name of the host to check access on.

If this parameter is supplied, the
.I hostIP
parameter must also be supplied, or strange things may happen.
.RE

.I hostIP

.RS 3
This is the IP number of the host specified in the previous parameter.

This number must be supplied if the
.I hostname
parameter is supplied, or strange things may happen.
.RE
.SH FILES
.B smb.conf
.RS 3
This is usually the name of the configuration file used by
.BR smbd .
.RE
.SH ENVIRONMENT VARIABLES
Not applicable.
.SH INSTALLATION
The location of the server and its support files is a matter for individual
system administrators. The following are thus suggestions only.

It is recommended that the
.B testparm
program be installed under the /usr/local/samba hierarchy, in a directory readable
by all, writeable only by root. The program itself should be executable by all.
The program should NOT be setuid or setgid!
.SH VERSION
This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
of the recent patches to it. These notes will necessarily lag behind 
development of the software, so it is possible that your version of 
the program has extensions or parameter semantics that differ from or are not 
covered by this man page. Please notify these to the address below for 
rectification.
.SH SEE ALSO
.BR smb.conf (5),
.BR smbd (8)
.SH DIAGNOSTICS
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.

If a host name is specified but no host IP number, all bets are off.

Other messages are self-explanatory.
.SH BUGS
None known.
.SH CREDITS
The original Samba software and related utilities were created by 
Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
of the Source for this project.

The
.B testparm
program and this man page were written by Karl Auer. Bug reports to
samba-bugs@samba.anu.edu.au.

See
.BR samba (7)
for a full list of contributors and details on how to 
submit bug reports, comments etc.