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