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
|
.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "TESTPARM" "1" "19 april 2003" "" ""
.SH NAME
testparm \- check an smb.conf configuration file for internal correctness
.SH SYNOPSIS
\fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-v\fR ] [ \fB-L <servername>\fR ] [ \fB-t <encoding>\fR ] \fBconfig filename\fR [ \fBhostname hostIP\fR ]
.SH "DESCRIPTION"
.PP
This tool is part of the \fBSamba\fR(7) suite.
.PP
\fBtestparm\fR is a very simple test program
to check an \fBsmbd\fR(8) configuration file for
internal correctness. If this program reports no problems, you
can use the configuration file with confidence that \fBsmbd
\fR will successfully load the configuration file.
.PP
Note that this is \fBNOT\fR a guarantee that
the services specified in the configuration file will be
available or will operate as expected.
.PP
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.
.PP
If \fBtestparm\fR finds an error in the \fI smb.conf\fR 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 \fBtestparm\fR.
.SH "OPTIONS"
.TP
\fB-s\fR
Without this option, \fBtestparm\fR
will prompt for a carriage return after printing the service
names and before dumping the service definitions.
.TP
\fB-h|--help\fR
Print a summary of command line options.
.TP
\fB-V\fR
Prints the version number for
\fBsmbd\fR.
.TP
\fB-L servername\fR
Sets the value of the %L macro to \fIservername\fR.
This is useful for testing include files specified with the
%L macro.
.TP
\fB-v\fR
If this option is specified, testparm
will also output all options that were not used in \fBsmb.conf\fR(5) and are thus set to their defaults.
.TP
\fB-t encoding\fR
Output data in specified encoding.
.TP
\fBconfigfilename\fR
This is the name of the configuration file
to check. If this parameter is not present then the
default \fBsmb.conf\fR(5) file will be checked.
.TP
\fBhostname\fR
If this parameter and the following are
specified, then \fBtestparm\fR will examine the \fIhosts
allow\fR and \fIhosts deny\fR
parameters in the \fBsmb.conf\fR(5) file to
determine if the hostname with this IP address would be
allowed access to the \fBsmbd\fR server. If
this parameter is supplied, the hostIP parameter must also
be supplied.
.TP
\fBhostIP\fR
This is the IP address of the host specified
in the previous parameter. This address must be supplied
if the hostname parameter is supplied.
.SH "FILES"
.TP
\fBsmb.conf(5)\fR
This is usually the name of the configuration
file used by \fBsmbd\fR(8).
.SH "DIAGNOSTICS"
.PP
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.
.SH "VERSION"
.PP
This man page is correct for version 3.0 of
the Samba suite.
.SH "SEE ALSO"
.PP
\fBsmb.conf\fR(5), \fBsmbd\fR(8)
.SH "AUTHOR"
.PP
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.
.PP
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 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) 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.
|
