1mailto(samba@samba.org) 
2
3manpage(testparm htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA)
4
5label(NAME)
6manpagename(testparm)(check an smb.conf configuration file for internal correctness)
7
8label(SYNOPSIS)
9manpagesynopsis() 
10
11bf(testparm) [link(-s)(minuss)] [link(-h)(minush)] [link(-L servername)(minusL)] [link(configfilename)(configfilename)] [link(hostname)(hostname) link(hostIP)(hostIP)]
12
13label(DESCRIPTION)
14manpagedescription()
15
16This program is part of the bf(Samba) suite.
17
18bf(testparm) is a very simple test program to check an
19url(bf(smbd))(smbd.8.html) configuration file for internal
20correctness. If this program reports no problems, you can use the
21configuration file with confidence that url(bf(smbd))(smbd.8.html)
22will successfully load the configuration file.
23
24Note that this is em(NOT) a guarantee that the services specified in the
25configuration file will be available or will operate as expected.
26
27If the optional host name and host IP address are specified on the
28command line, this test program will run through the service entries
29reporting whether the specified host has access to each service.
30
31If bf(testparm) finds an error in the url(bf(smb.conf))(smb.conf.5.html)
32file it returns an exit code of 1 to the calling program, else it returns
33an exit code of 0. This allows shell scripts to test the output from
34bf(testparm).
35
36label(OPTIONS)
37manpageoptions()
38
39startdit()
40
41label(minuss)
42dit(bf(-s)) Without this option, bf(testparm) will prompt for a
43carriage return after printing the service names and before dumping
44the service definitions.
45
46label(minush)
47dit(bf(-h)) Print usage message
48
49label(minusL)
50dit(bf(-L servername)) Sets the value of the %L macro to servername. This
51is useful for testing include files specified with the %L macro.
52
53label(configfilename)
54dit(bf(configfilename)) This is the name of the configuration file to
55check. If this parameter is not present then the default
56url(bf(smb.conf))(smb.conf.5.html) file will be checked.
57
58label(hostname)
59dit(bf(hostname)) If this parameter and the following are specified,
60then testparm will examine the url(bf("hosts
61allow"))(smb.conf.5.html#hostsallow) and url(bf("hosts
62deny"))(smb.conf.5.html#hostsdeny) parameters in the
63url(bf(smb.conf))(smb.conf.5.html) file to determine if the hostname
64with this IP address would be allowed access to the
65url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the
66link(hostIP)(hostIP) parameter must also be supplied.
67
68label(hostIP)
69dit(bf(hostIP)) This is the IP address of the host specified in the
70previous parameter. This address must be supplied if the hostname
71parameter is supplied.
72
73enddit()
74
75label(FILES)
76manpagesection(FILES)
77
78url(bf(smb.conf))(smb.conf.5.html). This is usually the name of the
79configuration file used by url(bf(smbd))(smbd.8.html).
80
81label(DIAGNOSTICS)
82manpagesection(DIAGNOSTICS)
83
84The program will issue a message saying whether the configuration file
85loaded OK or not. This message may be preceded by errors and warnings
86if the file did not load. If the file was loaded OK, the program then
87dumps all known service details to stdout.
88
89label(VERSION)
90manpagesection(VERSION)
91
92This man page is correct for version 2.0 of the Samba suite.
93
94label(SEEALSO)
95manpageseealso()
96
97url(bf(smb.conf (5)))(smb.conf.5.html), url(bf(smbd (8)))(smbd.8.html)
98
99label(AUTHOR)
100manpageauthor()
101
102The original Samba software and related utilities were created by
103Andrew Tridgell email(samba@samba.org). Samba is now developed
104by the Samba Team as an Open Source project similar to the way the
105Linux kernel is developed.
106
107The original Samba man pages were written by Karl Auer. The man page
108sources were converted to YODL format (another excellent piece of Open
109Source software, available at
110url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
111and updated for the Samba2.0 release by Jeremy Allison.
112email(samba@samba.org).
113
114See url(bf(samba (7)))(samba.7.html) to find out how to get a full
115list of contributors and details on how to submit bug reports,
116comments etc.
117