diff options
author | Gerald Carter <jerry@samba.org> | 2001-02-22 22:49:43 +0000 |
---|---|---|
committer | Gerald Carter <jerry@samba.org> | 2001-02-22 22:49:43 +0000 |
commit | 8c098397f1946f1572dba30bd7f019d8b04bb9e5 (patch) | |
tree | 2568838aff8631ec2306ad91ed30bad4ee4004c4 /docs/manpages | |
parent | cbf0f980c9cbc6ae3fd067c506e8062c4399d7b0 (diff) | |
download | samba-8c098397f1946f1572dba30bd7f019d8b04bb9e5.tar.gz samba-8c098397f1946f1572dba30bd7f019d8b04bb9e5.tar.bz2 samba-8c098397f1946f1572dba30bd7f019d8b04bb9e5.zip |
make it stop...please, make it stop....
(This used to be commit 3d8f4113ebb178e2f8281edfce968d7035f443af)
Diffstat (limited to 'docs/manpages')
-rw-r--r-- | docs/manpages/testparm.1 | 204 | ||||
-rw-r--r-- | docs/manpages/testprns.1 | 175 |
2 files changed, 189 insertions, 190 deletions
diff --git a/docs/manpages/testparm.1 b/docs/manpages/testparm.1 index e02b887394..a5aa932aa1 100644 --- a/docs/manpages/testparm.1 +++ b/docs/manpages/testparm.1 @@ -1,104 +1,100 @@ -.TH "testparm " "1" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" -testparm \- check an smb\&.conf configuration file for internal correctness -.PP -.SH "SYNOPSIS" -.PP -\fBtestparm\fP [-s] [-h] [-L servername] [configfilename] [hostname hostIP] -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBtestparm\fP is a very simple test program to check an -\fBsmbd\fP configuration file for internal -correctness\&. If this program reports no problems, you can use the -configuration file with confidence that \fBsmbd\fP -will successfully load the configuration file\&. -.PP -Note that this is \fINOT\fP a guarantee that the services specified in the -configuration file will be available or will operate as expected\&. -.PP -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\&. -.PP -If \fBtestparm\fP finds an error in the \fBsmb\&.conf\fP -file it returns an exit code of 1 to the calling program, else it returns -an exit code of 0\&. This allows shell scripts to test the output from -\fBtestparm\fP\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fB-s\fP" -Without this option, \fBtestparm\fP will prompt for a -carriage return after printing the service names and before dumping -the service definitions\&. -.IP -.IP "\fB-h\fP" -Print usage message -.IP -.IP "\fB-L servername\fP" -Sets the value of the %L macro to servername\&. This -is useful for testing include files specified with the %L macro\&. -.IP -.IP "\fBconfigfilename\fP" -This is the name of the configuration file to -check\&. If this parameter is not present then the default -\fBsmb\&.conf\fP file will be checked\&. -.IP -.IP "\fBhostname\fP" -If this parameter and the following are specified, -then testparm will examine the \fB"hosts -allow"\fP and \fB"hosts -deny"\fP parameters in the -\fBsmb\&.conf\fP file to determine if the hostname -with this IP address would be allowed access to the -\fBsmbd\fP server\&. If this parameter is supplied, the -hostIP parameter must also be supplied\&. -.IP -.IP "\fBhostIP\fP" -This is the IP address of the host specified in the -previous parameter\&. This address must be supplied if the hostname -parameter is supplied\&. -.IP -.PP -.SH "FILES" -.PP -\fBsmb\&.conf\fP\&. This is usually the name of the -configuration file used by \fBsmbd\fP\&. -.PP -.SH "DIAGNOSTICS" -.PP -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\&. -.PP -.SH "VERSION" -.PP -This man page is correct for version 2\&.0 of the Samba suite\&. -.PP -.SH "SEE ALSO" -.PP -\fBsmb\&.conf (5)\fP, \fBsmbd (8)\fP -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed\&. -.PP -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, available at -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc\&. +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "TESTPARM" "1" "22 February 2001" "" "" +.SH NAME +testparm \- check an smb.conf configuration file for internal correctness +.SH SYNOPSIS +.sp +\fBtestparm\fR [ \fB-s\fR ] [ \fB-h\fR ] [ \fB-L <servername>\fR ] \fBconfig filename\fR [ \fBhostname hostIP\fR ] +.SH "DESCRIPTION" +.PP +This tool is part of the Samba <URL:samba.7.html> suite. +.PP +\fBtestparm\fR is a very simple test program +to check an \fBsmbd\fR configuration file for +internal correctness. If this program reports no problems, you +can use the configuration file with confidence that \fBsmbd +\fRwill successfully load the configuration file. +.PP +Note that this is \fBNOT\fR a guarantee that +the services specified in the configuration file will be +available or will operate as expected. +.PP +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. +.PP +If \fBtestparm\fR finds an error in the \fI smb.conf\fR file it returns an exit code of 1 to the calling +program, else it returns an exit code of 0. This allows shell scripts +to test the output from \fBtestparm\fR. +.SH "OPTIONS" +.TP +\fB-s\fR +Without this option, \fBtestparm\fR +will prompt for a carriage return after printing the service +names and before dumping the service definitions. +.TP +\fB-h\fR +Print usage message +.TP +\fB-L servername\fR +Sets the value of the %L macro to servername. +This is useful for testing include files specified with the +%L macro. +.TP +\fBconfigfilename\fR +This is the name of the configuration file +to check. If this parameter is not present then the +default \fIsmb.conf\fR file will be checked. +.TP +\fBhostname\fR +If this parameter and the following are +specified, then testparm will examine the \fIhosts +allow\fR and \fIhosts deny\fR +parameters in the \fIsmb.conf\fR file to +determine if the hostname with this IP address would be +allowed access to the \fBsmbd\fR server. If +this parameter is supplied, the hostIP parameter must also +be supplied. +.TP +\fBhostIP\fR +This is the IP address of the host specified +in the previous parameter. This address must be supplied +if the hostname parameter is supplied. +.SH "FILES" +.TP +\fB\fIsmb.conf\fB\fR +This is usually the name of the configuration +file used by \fBsmbd\fR. +.SH "DIAGNOSTICS" +.PP +The program will issue a message saying whether the +configuration file loaded OK or not. This message may be preceeded 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. +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "SEE ALSO" +.PP +\fIsmb.conf(5)\fR <URL:smb.conf.5.html>, +\fBsmbd(8)\fR <URL:smbd.8.html> +.SH "AUTHOR" +.PP +The original Samba software and related utilities +were created by Andrew Tridgell. Samba is now developed +by the Samba Team as an Open Source project similar +to the way the Linux kernel is developed. +.PP +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, available at +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/testprns.1 b/docs/manpages/testprns.1 index a9753d7637..91738ebcfe 100644 --- a/docs/manpages/testprns.1 +++ b/docs/manpages/testprns.1 @@ -1,87 +1,90 @@ -.TH "testprns " "1" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" -testprns \- check printer name for validity with smbd -.PP -.SH "SYNOPSIS" -.PP -\fBtestprns\fP printername [printcapname] -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBtestprns\fP is a very simple test program to determine whether a -given printer name is valid for use in a service to be provided by -\fBsmbd\fP\&. -.PP -"Valid" in this context means "can be found in the printcap -specified"\&. This program is very stupid - so stupid in fact that it -would be wisest to always specify the printcap file to use\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fBprintername\fP" -The printer name to validate\&. -.IP -Printer names are taken from the first field in each record in the -printcap file, single printer names and sets of aliases separated by -vertical bars ("|") are recognized\&. Note that no validation or -checking of the printcap syntax is done beyond that required to -extract the printer name\&. It may be that the print spooling system is -more forgiving or less forgiving than \fBtestprns\fP\&. However, if -\fBtestprns\fP finds the printer then \fBsmbd\fP should -do so as well\&. -.IP -.IP "\fBprintcapname\fP" +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "TESTPRNS" "1" "22 February 2001" "" "" +.SH NAME +testprns \- check printer name for validity with smbd +.SH SYNOPSIS +.sp +\fBtestprns\fR \fBprintername\fR [ \fBprintcapname\fR ] +.SH "DESCRIPTION" +.PP +This tool is part of the Samba <URL:samba.7.html> suite. +.PP +\fBtestprns\fR is a very simple test program +to determine whether a given printer name is valid for use in +a service to be provided by \fB smbd(8)\fR <URL:smbd.8.html>. +.PP +"Valid" in this context means "can be found in the +printcap specified". This program is very stupid - so stupid in +fact that it would be wisest to always specify the printcap file +to use. +.SH "OPTIONS" +.TP +\fBprintername\fR +The printer name to validate. + +Printer names are taken from the first field in each +record in the printcap file, single printer names and sets +of aliases separated by vertical bars ("|") are recognized. +Note that no validation or checking of the printcap syntax is +done beyond that required to extract the printer name. It may +be that the print spooling system is more forgiving or less +forgiving than \fBtestprns\fR. However, if +\fBtestprns\fR finds the printer then +\fBsmbd\fR should do so as well. +.TP +\fBprintcapname\fR This is the name of the printcap file within -which to search for the given printer name\&. -.IP -If no printcap name is specified \fBtestprns\fP will attempt to scan the -printcap file name specified at compile time\&. -.IP -.PP -.SH "FILES" -.PP -\fB/etc/printcap\fP This is usually the default printcap file to -scan\&. See \fBprintcap (5)\fP\&. -.PP -.SH "DIAGNOSTICS" -.PP -If a printer is found to be valid, the message "Printer name -<printername> is valid" will be displayed\&. -.PP -If a printer is found to be invalid, the message "Printer name -<printername> is not valid" will be displayed\&. -.PP -All messages that would normally be logged during operation of the -\fBSamba\fP daemons are logged by this program to the -file \f(CWtest\&.log\fP in the current directory\&. The program runs at -debuglevel 3, so quite extensive logging information is written\&. The -log should be checked carefully for errors and warnings\&. -.PP -Other messages are self-explanatory\&. -.PP -.SH "SEE ALSO" -.PP -\fBprintcap (5)\fP, \fBsmbd (8)\fP, \fBsmbclient -(1)\fP -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed\&. -.PP -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, available at -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc\&. +which to search for the given printer name. + +If no printcap name is specified \fBtestprns +\fRwill attempt to scan the printcap file name +specified at compile time. +.SH "FILES" +.TP +\fB\fI/etc/printcap\fB\fR +This is usually the default printcap +file to scan. See \fIprintcap (5)\fR. +.SH "DIAGNOSTICS" +.PP +If a printer is found to be valid, the message +"Printer name <printername> is valid" will be +displayed. +.PP +If a printer is found to be invalid, the message +"Printer name <printername> is not valid" will be +displayed. +.PP +All messages that would normally be logged during +operation of the Samba daemons are logged by this program to the +file \fItest.log\fR in the current directory. The +program runs at debuglevel 3, so quite extensive logging +information is written. The log should be checked carefully +for errors and warnings. +.PP +Other messages are self-explanatory. +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "SEE ALSO" +.PP +\fIprintcap(5)\fR, +\fBsmbd(8)\fR <URL:smbd.8.html>, +\fBsmbclient(1)\fR <URL:smbclient.1.html> +.SH "AUTHOR" +.PP +The original Samba software and related utilities +were created by Andrew Tridgell. Samba is now developed +by the Samba Team as an Open Source project similar +to the way the Linux kernel is developed. +.PP +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, available at +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for +Samba 2.2 was done by Gerald Carter |