INN commit: trunk/doc/pod (4 files)

Thu Aug 2 10:24:05 UTC 2007

Date: Thursday, August 2, 2007 @ 03:24:05
  Author: iulius
Revision: 7622

Improve POD documentation and correct typos.

Modified:
  trunk/doc/pod/active.times.pod
  trunk/doc/pod/archive.pod
  trunk/doc/pod/auth_krb5.pod
  trunk/doc/pod/auth_smb.pod

------------------+
 active.times.pod |   11 ++++++-----
 archive.pod      |   10 +++++-----
 auth_krb5.pod    |    6 +++---
 auth_smb.pod     |   16 ++++++++--------
 4 files changed, 22 insertions(+), 21 deletions(-)

Modified: active.times.pod
===================================================================

--- active.times.pod	2007-08-01 21:46:49 UTC (rev 7621)
+++ active.times.pod	2007-08-02 10:24:05 UTC (rev 7622)
@@ -19,7 +19,7 @@
 The third field is the e-mail address of the person who created the group,
 as specified in the control message or on the B<ctlinnd> command line, or
 the newsmaster specified at configure time if no creator argument was
-given to B<ctlinnd>.
+given to B<ctlinnd> (by default, it is C<usenet>).
 
 =head1 EXAMPLE
 
@@ -28,12 +28,13 @@
    news.admin.moderation 1175716803 group-admin at isc.org
 
 shows that the newsgroup news.admin.moderation was created on April 4th 2007
-at 20:00:03 UTC.  This date can be obtained for instance with C<convdate -c 1175716803> or
+at 20:00:03 UTC.  This date can be obtained for instance with
+C<convdate -c 1175716803> (convdate(1) is shipped with INN) or
 C<date -u -d "Jan 1, 1970 00:00:00 +0000 + 1175716803 seconds">.  It is
-when the newsgroup was locally created; in this example, it is when the
+when the newsgroup was locally created; in this example, it is when a
 control message sent by C<group-admin at isc.org> was received and processed
-by the news server.  Therefore, the time is not necessarily the same on
-every news server.
+by the news server (see control.ctl(5) for more details).  Therefore,
+the time is not necessarily the same on every news server.
 
 =head1 HISTORY
 

Modified: archive.pod
===================================================================
--- archive.pod	2007-08-01 21:46:49 UTC (rev 7621)
+++ archive.pod	2007-08-02 10:24:05 UTC (rev 7622)
@@ -10,7 +10,7 @@
 =head1 DESCRIPTION
 
 B<archive> makes copies of files specified on its standard input.  It is
-normally run either as a channel feed under B<innd> or or by a script
+normally run either as a channel feed under B<innd> or by a script
 before B<news.daily> is run.
 
 B<archive> reads the named I<input> file, or standard input if no file is
@@ -48,7 +48,7 @@
 If the B<-c> flag is given, directory names will be flattened as described
 under the B<-f> option.  Then, additionally, all posts will be
 concatenated into a single file, appending to that file if it already
-exists.  The file name will be YYYYMM, formed from the current time when
+exists.  The file name will be C<YYYYMM>, formed from the current time when
 B<archive> is run.  In other words, if given an article in
 comp.sources.unix on December 14, 1998, the article would be appended to
 the file:
@@ -73,7 +73,7 @@
 
 If the B<-i> flag is used, B<archive> will append one line to the file
 I<index> for each article that it archives.  This line will contain the
-destination file name, the message ID header, and the Subject header of
+destination file name, the Message-ID: header, and the Subject: header of
 the message, separated by spaces.  If either header is missing (normally
 not possible if the article was accepted by B<innd>), it will be replaced
 by C<< <none> >>.  The headers will be transformed using the same rules as
@@ -96,7 +96,7 @@
 =head1 RETURN VALUE
 
 If the input is exhausted, B<archive> will exit with a zero status.  If an
-I/O error occures, it will try to spool its input, copying it to a file.
+I/O error occurs, it will try to spool its input, copying it to a file.
 If there was no input filename, the standard input will be copied to
 I<pathoutgoing>/archive and the program will exit.  If an input filename
 was given, a temporary file named I<input>.bch (if I<input> is an absolute
@@ -110,7 +110,7 @@
 A typical newsfeeds(5) entry to archive most source newsgroups is as
 follows:
 
-    source-archive\
+    source-archive!\
         :!*,*sources*,!*wanted*,!*.d\
         :Tc,Wn\
         :<pathbin>/archive -f -i <patharchive>/INDEX

Modified: auth_krb5.pod
===================================================================
--- auth_krb5.pod	2007-08-01 21:46:49 UTC (rev 7621)
+++ auth_krb5.pod	2007-08-02 10:24:05 UTC (rev 7622)
@@ -61,7 +61,7 @@
 gaining access to the news server via it.  However, this is also something
 that people may wish to do under some circumstances, so there should be a
 better way of handling it (such as, perhaps, a list of acceptable realms
-or a -r flag specifying the realm in which to attempt authentication).
+or a B<-r> flag specifying the realm in which to attempt authentication).
 
 It's not clear the right thing to do when the username passed in contains
 a C</> and B<-i> was also given.  Right now, B<auth_krb5> will create a
@@ -73,13 +73,13 @@
 
 Originally written by Christopher P. Lindsey.  This documentation was
 written by Russ Allbery <rra at stanford.edu> based on Christopher's original
-README file.
+F<README> file.
 
 $Id$
 
 =head1 SEE ALSO
 
-nnrpd(8), readers.conf(5)
+nnrpd(8), readers.conf(5).
 
 The latest version of Christopher's original B<nnrpkrb5auth> may be found
 on his web site at L<http://www.mallorn.com/tools/>.

Modified: auth_smb.pod
===================================================================
--- auth_smb.pod	2007-08-01 21:46:49 UTC (rev 7621)
+++ auth_smb.pod	2007-08-02 10:24:05 UTC (rev 7622)
@@ -4,14 +4,14 @@
 
 =head1 SYNOPSIS
 
-B<auth_smb> B<server> [B<backup_server>] B<domain>
+B<auth_smb> I<server> [I<backup_server>] I<domain>
 
 =head1 DESCRIPTION
 
 This program does authentication for B<nnrpd> against an SMB server.  It
-passes the received username and password to B<server> for validation in
-the specified SMB B<domain>.  A backup server may optionally be
-supplied; if it is missing, only B<server> is used.
+passes the received username and password to I<server> for validation in
+the specified SMB I<domain>.  A backup server may optionally be
+supplied; if it is missing, only I<server> is used.
 
 If authentication is successful, the original username is returned as
 the authentication identity.  Brief errors, including incorrect password
@@ -24,7 +24,7 @@
 
     auth windows {
         auth: "auth_smb pdc.example.com bdc.example.com USERS"
-	default-domain: "users.example.com"
+        default-domain: "users.example.com"
     }
 
     access internal {
@@ -42,14 +42,14 @@
 
 =head1 HISTORY
 
-Originally written October 2000 by Krischan Jodies <krischan at jodies.cx>,
-based heavily on pam_smb v1.1.6 by David Airlie <airlied at samba.org>.
+Originally written in October 2000 by Krischan Jodies <krischan at jodies.cx>,
+based heavily on B<pam_smb> v1.1.6 by David Airlie <airlied at samba.org>.
 This documentation was written by Jeffrey M. Vinocur <jeff at litech.org>.
 
 $Id$
 
 =head1 SEE ALSO
 
-nnrpd(8), readers.conf(5)
+nnrpd(8), readers.conf(5).
 
 =cut

