Added internal cross references for all man pages.
[samba.git] / docs / yodldocs / testparm.1.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(testparm)(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(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(configfilename)
37 dit(bf(configfilename)) This is the name of the configuration file to
38 check. If this parameter is not present then the default
39 url(bf(smb.conf))(smb.conf.5.html) file will be checked.
40
41 label(hostname)
42 dit(bf(hostname)) If this parameter and the following are specified,
43 then testparm will examine the url(bf("hosts
44 allow"))(smb.conf.5.html#hostsallow) and url(bf("hosts
45 deny"))(smb.conf.5.html#hostsdeny) parameters in the
46 url(bf(smb.conf))(smb.conf.5.html) file to determine if the hostname
47 with this IP address would be allowed acces to the
48 url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the
49 hostIP parameter must also be supplied.
50
51 label(hostIP)
52 dit(bf(hostIP)) This is the IP address of the host specified in the
53 previous parameter. This address must be supplied if the hostname
54 parameter is supplied.
55
56 enddit()
57
58 label(FILES)
59 manpagesection(FILES)
60
61 url(bf(smb.conf))(smb.conf.5.html). This is usually the name of the
62 configuration file used by url(bf(smbd))(smbd.8.html).
63
64 label(DIAGNOSTICS)
65 manpagesection(DIAGNOSTICS)
66
67 The program will issue a message saying whether the configuration file
68 loaded OK or not. This message may be preceded by errors and warnings
69 if the file did not load. If the file was loaded OK, the program then
70 dumps all known service details to stdout.
71
72 label(VERSION)
73 manpagesection(VERSION)
74
75 This man page is correct for version 2.0 of the Samba suite.
76
77 label(SEEALSO)
78 manpageseealso()
79
80 url(bf(smb.conf (5)))(smb.conf.5.html), url(bf(smbd (8)))(smbd.8.html)
81
82 label(AUTHOR)
83 manpageauthor()
84
85 The original Samba software and related utilities were created by
86 Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
87 by the Samba Team as an Open Source project similar to the way the
88 Linux kernel is developed.
89
90 The original Samba man pages were written by Karl Auer. The man page
91 sources were converted to YODL format (another excellent piece of Open
92 Source software) and updated for the Samba2.0 release by Jeremy
93 Allison, email(samba-bugs@samba.anu.edu.au).
94
95 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
96 list of contributors and details on how to submit bug reports,
97 comments etc.