From dcb2ae194335bf75993d622e65c9f1210162fdc0 Mon Sep 17 00:00:00 2001 From: Jeff Bigler Date: Thu, 29 Aug 1996 20:34:11 +0000 Subject: [PATCH] man page tweak from Cygnus git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@9005 dc483132-0cff-0310-8789-dd5450dbe970 --- src/appl/mailquery/mailquery.M | 3 +- src/appl/popper/popper.M | 107 +++++++++++++++--------------- src/appl/sample/sclient/sclient.M | 3 +- src/appl/sample/sserver/sserver.M | 20 +++--- 4 files changed, 67 insertions(+), 66 deletions(-) diff --git a/src/appl/mailquery/mailquery.M b/src/appl/mailquery/mailquery.M index 113146f40..5f17678b8 100644 --- a/src/appl/mailquery/mailquery.M +++ b/src/appl/mailquery/mailquery.M @@ -15,7 +15,8 @@ .\" .\" $Id .\" -.TH mailquery 1 +.so man1/header.doc +.TH mailquery 1 \*h .SH NAME mailquery \- queries a pop server about how much mail is available .SH SYNTAX diff --git a/src/appl/popper/popper.M b/src/appl/popper/popper.M index 390809ac4..eecf96fde 100644 --- a/src/appl/popper/popper.M +++ b/src/appl/popper/popper.M @@ -9,8 +9,9 @@ .\" is provided ``as is'' without express or implied warranty. .\" .\" @(#)@(#)popper.8 2.3 2.3 (CCS) 4/2/91 Copyright (c) 1990 Regents of the University of California.\nAll rights reserved.\n -.\" -.TH popper 8 "August 1990" +.\" " +.so man1/header.doc +.TH popper 8 \*h .UC 6 .ad .SH NAME @@ -22,16 +23,16 @@ popper \- pop 3 server .SH DESCRIPTION .I Popper is an implementation of the Post Office Protocol server that runs on a -variety of Unix computers to manage electronic mail for Macintosh -and MS-DOS computers. The server was developed at the University of +variety of Unix computers to manage electronic mail for Macintosh and +MS-DOS computers. The server was developed at the University of California at Berkeley and conforms fully to the specifications in RFC -1081 and RFC 1082. The Berkeley server also has extensions to -send electronic mail on behalf of a client. +1081 and RFC 1082. The Berkeley server also has extensions to send +electronic mail on behalf of a client. .PP The .B \-d flag sets the socket to debugging and turns on debugging. All debugging -information is saved using syslog(8). The +information is saved using syslog(8). The .B \-t trace\-file flag turns on debugging and saves the trace information in .I trace\-file @@ -40,9 +41,8 @@ using fprintf(s). .PP The POP server is available via anonymous ftp from ftp.CC.Berkeley.EDU (128.32.136.9, 128.32.206.12). It is in two files in the pub directory: -a compressed -tar file popper.tar.Z and a Macintosh StuffIt archive in BinHex format -called MacPOP.sit.hqx. +a compressed tar file popper.tar.Z and a Macintosh StuffIt archive in +BinHex format called MacPOP.sit.hqx. .SH THE POP TRANSACTION CYCLE .PP The Berkeley POP server is a single program (called popper) that is @@ -60,36 +60,36 @@ if a cannonical name lookup for the client returns the same peer IP address, logging a warning message if it does not. The the server enters the authorization state, during which the client must correctly identify itself by providing a valid Unix userid and password on the -server's host machine. No other exchanges are allowed during this -state (other than a request to quit.) If authentication fails, a -warning message is logged and the session ends. Once the user is -identified, popper changes its user and group ids to match that of the -user and enters the transaction state. The server makes a temporary -copy of the user's maildrop (ordinarily in /usr/spool/mail) which is -used for all subsequent transactions. These include the bulk of POP -commands to retrieve mail, delete mail, undelete mail, and so forth. A -Berkeley extension also allows the user to submit a mail parcel to the -server who mails it using the sendmail program (this extension is -supported in the HyperMail client distributed with the server). When -the client quits, the server enters the final update state during which -the network connection is terminated and the user's maildrop is updated -with the (possibly) modified temporary maildrop. +server's host machine. No other exchanges are allowed during this state +(other than a request to quit.) If authentication fails, a warning +message is logged and the session ends. Once the user is identified, +popper changes its user and group ids to match that of the user and +enters the transaction state. The server makes a temporary copy of the +user's maildrop (ordinarily in /usr/spool/mail) which is used for all +subsequent transactions. These include the bulk of POP commands to +retrieve mail, delete mail, undelete mail, and so forth. A Berkeley +extension also allows the user to submit a mail parcel to the server who +mails it using the sendmail program (this extension is supported in the +HyperMail client distributed with the server). When the client quits, +the server enters the final update state during which the network +connection is terminated and the user's maildrop is updated with the +(possibly) modified temporary maildrop. .SH LOGGING .PP The POP server uses syslog to keep a record of its activities. On systems with BSD 4.3 syslogging, the server logs (by default) to the -"local0" facility at priority "notice" for all messages except -debugging which is logged at priority "debug". The default log file is -/usr/spool/mqueue/POPlog. These can be changed, if desired. On -systems with 4.2 syslogging all messages are logged to the local log -file, usually /usr/spool/mqueue/syslog. +"local0" facility at priority "notice" for all messages except debugging +which is logged at priority "debug". The default log file is +/usr/spool/mqueue/POPlog. These can be changed, if desired. On systems +with 4.2 syslogging all messages are logged to the local log file, +usually /usr/spool/mqueue/syslog. .SH DEBUGGING .PP The popper program will log debugging information when the -d parameter is specified after its invocation in the inetd.conf file. Care should -be exercised in using this option since it generates considerable -output in the syslog file. Alternatively, the "-t " option -will place debugging information into file "" using fprintf +be exercised in using this option since it generates considerable output +in the syslog file. Alternatively, the "-t " option will +place debugging information into file "" using fprintf instead of syslog. .PP For SunOS version 3.5, the popper program is launched by inetd from @@ -111,35 +111,34 @@ quit Connection closed by foreign host. .fi .SH VERSION 1.7 RELEASE NOTES -Extensive re-write of the maildrop processing code contributed by -Viktor Dukhovni that greatly reduces the +Extensive re-write of the maildrop processing code contributed by Viktor +Dukhovni that greatly reduces the possibility that the maildrop can be corrupted as the result of simultaneous access by two or more processes. .PP -Added "pop_dropcopy" module to create a temporary maildrop from -the existing, standard maildrop as root before the setuid and -setgid for the user is done. This allows the temporary maildrop -to be created in a mail spool area that is not world read-writable. +Added "pop_dropcopy" module to create a temporary maildrop from the +existing, standard maildrop as root before the setuid and setgid for the +user is done. This allows the temporary maildrop to be created in a +mail spool area that is not world read-writable. .PP -This version does *not* send the sendmail "From " delimiter line -in response to a TOP or RETR command. +This version does *not* send the sendmail "From " delimiter line in +response to a TOP or RETR command. .PP -Encased all debugging code in #ifdef DEBUG constructs. This code can -be included by specifying the DEGUG compiler flag. Note: You still -need to use the -d or -t option to obtain debugging output. +Encased all debugging code in #ifdef DEBUG constructs. This code can be +included by specifying the DEGUG compiler flag. Note: You still need +to use the -d or -t option to obtain debugging output. .SH LIMITATIONS -The POP server copies the user's entire maildrop to /tmp and -then operates on that copy. If the maildrop is particularly -large, or inadequate space is available in /tmp, then the -server will refuse to continue and terminate the connection. +The POP server copies the user's entire maildrop to /tmp and then +operates on that copy. If the maildrop is particularly large, or +inadequate space is available in /tmp, then the server will refuse to +continue and terminate the connection. .PP -Simultaneous modification of a single maildrop can result in -confusing results. For example, manipulating messages in a -maildrop using the Unix /usr/ucb/mail command while a copy of -it is being processed by the POP server can cause the changes -made by one program to be lost when the other terminates. This -problem is being worked on and will be fixed in a later -release. +Simultaneous modification of a single maildrop can result in confusing +results. For example, manipulating messages in a maildrop using the +Unix /usr/ucb/mail command while a copy of it is being processed by the +POP server can cause the changes made by one program to be lost when the +other terminates. This problem is being worked on and will be fixed in +a later release. .SH FILES .nf /usr/spool/mail mail files diff --git a/src/appl/sample/sclient/sclient.M b/src/appl/sample/sclient/sclient.M index 64d634d91..cce2930d7 100644 --- a/src/appl/sample/sclient/sclient.M +++ b/src/appl/sample/sclient/sclient.M @@ -19,7 +19,8 @@ .\" or implied warranty. .\" .\" -.TH SCLIENT 1 "Kerberos Version 5.0" "MIT Project Athena" +.so man1/header.doc +.TH SCLIENT 1 \*h .SH NAME sclient \- sample Kerberos version 5 client .SH SYNOPSIS diff --git a/src/appl/sample/sserver/sserver.M b/src/appl/sample/sserver/sserver.M index 04df56133..023786f4a 100644 --- a/src/appl/sample/sserver/sserver.M +++ b/src/appl/sample/sserver/sserver.M @@ -17,9 +17,9 @@ .\" permission. M.I.T. makes no representations about the suitability of .\" this software for any purpose. It is provided "as is" without express .\" or implied warranty. -.\" -.\" -.TH SSERVER 8 "Kerberos Version 5.0" "MIT Project Athena" +.\" " +.so man1/header.doc +.TH SSERVER 8 \*h .SH NAME sserver \- sample Kerberos version 5 server .SH SYNOPSIS @@ -42,16 +42,16 @@ principal which was used for the Kerberos authentication. It makes a good test that Kerberos has been successfully installed on a machine. .PP The service name used by \fIsserver\fP and \fIsclient\fP is -\fBsample\fP. Hence, \fIsserver\fP will require that there be a srvtab entry for the service -"sample/hostname.mit.edu@REALM.NAME". This srvtab is generated using -the +\fBsample\fP. Hence, \fIsserver\fP will require that there be a keytab +entry for the service "sample/hostname.domain.name@REALM.NAME". This +keytab is generated using the .IR krb5_edit(8) -program. The srvtab file is installed in whatever +program. The keytab file is installed in whatever directory is defined by V5Srvtabdir (usually /etc) as "v5srvtab". .PP The .B \-S -option allows for a different srvtab than the default. +option allows for a different keytab than the default. .PP \fIsserver\fP is normally invoked out of .IR inetd(8), @@ -114,7 +114,7 @@ didn't restart \fIinetd\fP after editing inetd.conf. .PP This means that the "sample/hostname@LOCAL.REALM" service was not defined in the Kerberos database; it should be created using \fIkdb5_edit,\fP -and a srvtab file needs to be generated to make the key for that service +and a keytab file needs to be generated to make the key for that service principal available for \fIssclient\fP. .PP 5) \fIsclient\fP returns the error: @@ -122,7 +122,7 @@ principal available for \fIssclient\fP. sendauth rejected, error reply is: " No such file or directory" .PP -This probably means \fIsserver\fP couldn't find the srvtab file. It was +This probably means \fIsserver\fP couldn't find the keytab file. It was probably not installed in the proper directory. .br .SH SEE ALSO -- 2.26.2