1TESTPARM(1) User Commands TESTPARM(1)
2
6 testparm - check an smb.conf configuration file for internal
7 correctness
8
10 testparm [-s] [-h] [-v] [-L <servername>] [-t <encoding>]
11 {config filename} [hostname hostIP]
12
14 This tool is part of the samba(7) suite.
15 testparm is a very simple test program to check an smbd(8)
17 configuration file for internal correctness. If this program reports no
18 problems, you can use the configuration file with confidence that smbd
19 will successfully load the configuration file.
20 Note that this is NOT a guarantee that the services specified in the
22 configuration file will be available or will operate as expected.
23 If the optional host name and host IP address are specified on the
25 command line, this test program will run through the service entries
26 reporting whether the specified host has access to each service.
27 If testparm finds an error in the smb.conf file it returns an exit code
29 of 1 to the calling program, else it returns an exit code of 0. This
30 allows shell scripts to test the output from testparm.
31
33 -s
34 Without this option, testparm will prompt for a carriage return
35 after printing the service names and before dumping the service
36 definitions.
37 -h|--help
39 Print a summary of command line options.
40 -V|--version
42 Prints the program version number.
43 -L servername
45 Sets the value of the %L macro to servername. This is useful for
46 testing include files specified with the %L macro.
47 -v
49 If this option is specified, testparm will also output all options
50 that were not used in smb.conf(5) and are thus set to their
51 defaults.
52 -t encoding
54 Output data in specified encoding.
55 --parameter-name parametername
57 Dumps the named parameter. If no section-name is set the view is
58 limited by default to the global section. It is also possible to
59 dump a parametrical option. Therfore the option has to be separated
60 by a colon from the parametername.
61 --section-name sectionname
63 Dumps the named section.
64 configfilename
66 This is the name of the configuration file to check. If this
67 parameter is not present then the default smb.conf(5) file will be
68 checked.
69 hostname
71 If this parameter and the following are specified, then testparm
72 will examine the hosts allow and hosts deny parameters in the
73 smb.conf(5) file to determine if the hostname with this IP address
74 would be allowed access to the smbd server. If this parameter is
75 supplied, the hostIP parameter must also be supplied.
76 hostIP
78 This is the IP address of the host specified in the previous
79 parameter. This address must be supplied if the hostname parameter
80 is supplied.
81
83 smb.conf(5)
84 This is usually the name of the configuration file used by smbd(8).
85
87 The program will issue a message saying whether the configuration file
88 loaded OK or not. This message may be preceded by errors and warnings
89 if the file did not load. If the file was loaded OK, the program then
90 dumps all known service details to stdout.
91
93 This man page is correct for version 3 of the Samba suite.
94
96 smb.conf(5), smbd(8)
97
99 The original Samba software and related utilities were created by
100 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
101 Source project similar to the way the Linux kernel is developed.
102 The original Samba man pages were written by Karl Auer. The man page
104 sources were converted to YODL format (another excellent piece of Open
105 Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) and
106 updated for the Samba 2.0 release by Jeremy Allison. The conversion to
107 DocBook for Samba 2.2 was done by Gerald Carter. The conversion to
108 DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
109Samba 3.5 08/02/2011 TESTPARM(1)