summaryrefslogtreecommitdiff
path: root/docs/yodldocs/testparm.1.yo
diff options
context:
space:
mode:
Diffstat (limited to 'docs/yodldocs/testparm.1.yo')
-rw-r--r--docs/yodldocs/testparm.1.yo94
1 files changed, 94 insertions, 0 deletions
diff --git a/docs/yodldocs/testparm.1.yo b/docs/yodldocs/testparm.1.yo
new file mode 100644
index 0000000000..3cde640f79
--- /dev/null
+++ b/docs/yodldocs/testparm.1.yo
@@ -0,0 +1,94 @@
+mailto(samba-bugs@samba.anu.edu.au)
+
+manpage(testparm)(1)(23 Oct 1998)(Samba)(SAMBA)
+
+label(NAME)
+manpagename(testparm)(check an smb.conf configuration file for internal correctness)
+
+label(SYNOPSIS)
+manpagesynopsis()
+
+bf(testparm) [configfilename [hostname hostIP] ]
+
+label(DESCRIPTION)
+manpagedescription()
+
+This program is part of the bf(Samba) suite.
+
+bf(testparm) is a very simple test program to check an
+url(bf(smbd))(smbd.8.html) configuration file for internal
+correctness. If this program reports no problems, you can use the
+configuration file with confidence that url(bf(smbd))(smbd.8.html)
+will successfully load the configuration file.
+
+Note that this is em(NOT) a guarantee that the services specified in the
+configuration file will be available or will operate as expected.
+
+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.
+
+label(OPTIONS)
+manpageoptions()
+
+startdit()
+
+dit(bf(configfilename)) This is the name of the configuration file to
+check. If this parameter is not present then the default
+url(bf(smb.conf))(smb.conf.5.html) file will be checked.
+
+dit(bf(hostname)) If this parameter and the following are specified,
+then testparm will examine the url(bf("hosts
+allow"))(smb.conf.5.html#hosts_allow) and url(bf("hosts
+deny"))(smb.conf.5.html#hosts_deny) parameters in the
+url(bf(smb.conf))(smb.conf.5.html) file to determine if the hostname
+with this IP address would be allowed acces to the
+url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the
+hostIP parameter must also be supplied.
+
+dit(bf(hostIP)) This is the IP address of the host specified in the
+previous parameter. This address must be supplied if the hostname
+parameter is supplied.
+
+enddit()
+
+label(FILES)
+manpagesection(FILES)
+
+url(bf(smb.conf))(smb.conf.5.html). This is usually the name of the
+configuration file used by url(bf(smbd))(smbd.8.html).
+
+label(DIAGNOSTICS)
+manpagesection(DIAGNOSTICS)
+
+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.
+
+label(VERSION)
+manpagesection(VERSION)
+
+This man page is correct for version 2.0 of the Samba suite.
+
+label(SEEALSO)
+manpageseealso()
+
+url(bf(smb.conf (5)))(smb.conf.5.html), url(bf(smbd (8)))(smbd.8.html)
+
+label(AUTHOR)
+manpageauthor()
+
+The original Samba software and related utilities were created by
+Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
+by the Samba Team as an Open Source project similar to the way the
+Linux kernel is developed.
+
+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) and updated for the Samba2.0 release by Jeremy
+Allison, email(samba-bugs@samba.anu.edu.au).
+
+See url(bf(samba (8)))(samba.7.html) to find out how to get a full
+list of contributors and details on how to submit bug reports,
+comments etc.