Removed note from BUGS section of several man pages saying

[mmh] / man / inc.man

diff --git a/man/inc.man b/man/inc.man
index 54ace52..4c471fc 100644 (file)
--- a/man/inc.man
+++ b/man/inc.man
@@ -1,12 +1,12 @@
+.TH INC %manext1% "November 6, 2012" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\" %nmhwarning%

-.\" $Id$

 .\"
 .\"

-.TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 inc \- incorporate new mail
 .SH SYNOPSIS
 .HP 5
 .SH NAME
 inc \- incorporate new mail
 .SH SYNOPSIS
 .HP 5

+.na

 .B inc
 .RI [ +folder ]
 .RB [ \-audit
 .B inc
 .RI [ +folder ]
 .RB [ \-audit

@@ -15,7 +15,7 @@ inc \- incorporate new mail
 .RB [ \-changecur " | " \-nochangecur ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-changecur " | " \-nochangecur ]
 .RB [ \-form
 .IR formfile ]

-..RB [ \-format
+.RB [ \-format

 .IR string ]
 .RB [ \-file
 .IR name ]
 .IR string ]
 .RB [ \-file
 .IR name ]

@@ -23,7 +23,6 @@ inc \- incorporate new mail
 .RB [ \-truncate " | " \-notruncate ]
 .RB [ \-width
 .IR columns ]
 .RB [ \-truncate " | " \-notruncate ]
 .RB [ \-width
 .IR columns ]

-%nmhbeginpop%

 .RB [ \-host
 .IR hostname ]
 .RB [ \-user
 .RB [ \-host
 .IR hostname ]
 .RB [ \-user

@@ -31,21 +30,29 @@ inc \- incorporate new mail
 .RB [ \-pack
 .IR file ]
 .RB [ \-nopack ]
 .RB [ \-pack
 .IR file ]
 .RB [ \-nopack ]

-.RB [ \-apop " | " \-noapop ]
-.RB [ \-kpop ]
+.RB [ \-proxy
+.IR command ]

 .RB [ \-sasl ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-snoop ]
 .RB [ \-sasl ]
 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-snoop ]

-%nmhendpop%

 .RB [ \-version ]
 .RB [ \-help ]
 .RB [ \-version ]
 .RB [ \-help ]

+.ad

 .SH DESCRIPTION
 .B Inc
 incorporates mail from the user's incoming mail drop into
 an
 .B nmh
 folder.
 .SH DESCRIPTION
 .B Inc
 incorporates mail from the user's incoming mail drop into
 an
 .B nmh
 folder.

+If the mail drop is a file, it can be in
+.B mbox
+or
+.B MMDF
+format.
+If the mail drop is a directory it will considered to be a
+.B Maildir
+format mail drop.

 .PP
 You may specify which folder to use with
 .IR +folder .
 .PP
 You may specify which folder to use with
 .IR +folder .

@@ -66,12 +73,12 @@ listing of the new mail is produced.
 .PP
 If the user's profile contains a
 .RI \*(lq "Msg\-Protect: nnn" \*(rq
 .PP
 If the user's profile contains a
 .RI \*(lq "Msg\-Protect: nnn" \*(rq

-entry, it
-will be used as the protection on the newly created messages, otherwise
-the
+entry, it will be used as the protection on the newly created
+messages, otherwise the

 .B nmh
 .B nmh

-default of 0644 will be used.  For all subsequent operations
-on these messages, this initially assigned protection will be preserved.
+default of 0600 will be used (on filesystems that support it).  For
+all subsequent operations on these messages, this initially assigned
+protection will be preserved.

 .PP
 If the switch
 .B \-audit
 .PP
 If the switch
 .B \-audit

@@ -84,7 +91,7 @@ line per message to the end of the specified audit\-file with the format:
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-\*(<<inc\*(>> date
+<<inc>> date

 <scan line for first message>
 <scan line for second message>
 <etc.>
 <scan line for first message>
 <scan line for second message>
 <etc.>

@@ -171,7 +178,6 @@ switch directs
 to be quiet and not ask any questions at all.  This is useful for putting
 .B inc
 in the background and going on to other things.
 to be quiet and not ask any questions at all.  This is useful for putting
 .B inc
 in the background and going on to other things.

-%nmhbeginpop%

 .PP
 .SS "Using POP"
 .B inc
 .PP
 .SS "Using POP"
 .B inc

@@ -229,6 +235,16 @@ This
 .RI \*(lq .netrc \*(rq
 file should be owned and readable only by you.
 .PP
 .RI \*(lq .netrc \*(rq
 file should be owned and readable only by you.
 .PP

+If passed the
+.B \-proxy
+.I command
+switch,
+.B inc
+will use the specified command to establish the connection to the POP
+server. The string
+.IR %h
+in the command will be substituted by the hostname to connect to.
+.PP

 If
 .B inc
 uses POP, then the
 If
 .B inc
 uses POP, then the

@@ -250,42 +266,6 @@ between you and the POP server.
 .PP
 If
 .B nmh
 .PP
 If
 .B nmh

-has been compiled with APOP support, the
-.B \-apop
-switch will cause
-.B inc
-to use APOP rather than standard POP3 authentication.  Under APOP, a
-unique string (generally of the format
-.RI < pid . timestamp @ hostname >
-) is announced by the POP server.
-Rather than `USER
-.IR user ',
-`PASS
-.IR password ',
-.B inc
-sends `APOP
-.I user
-.IR digest ',
-where digest is the MD5 hash of the unique string followed by a
-`secret' shared by client and server, essentially equivalent to the user's
-password (though an APOP-enabled POP3 server could have separate APOP and plain
-POP3 passwords for a single user).
-.B \-noapop
-disables APOP in cases where it'd otherwise be used.
-.PP
-If
-.B nmh
-has been compiled with KPOP support, the
-.B \-kpop
-switch will allow
-.B inc
-to use Kerberized POP rather than standard POP3 on a given invocation.
-If POPSERVICE was also #defined to "kpop",
-.B inc
-will be hardwired to always use KPOP.
-.PP
-If
-.B nmh

 has been compiled with SASL support, the
 .B \-sasl
 switch will enable
 has been compiled with SASL support, the
 .B \-sasl
 switch will enable

@@ -303,17 +283,14 @@ Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 when viewing the POP transaction with the
 .B \-snoop
 switch.
 when viewing the POP transaction with the
 .B \-snoop
 switch.

-%nmhendpop%
-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u

 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^%etcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^%etcdir%/mts.conf~^nmh mts configuration file
 ^%mailspool%/$USER~^Location of mail drop
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf

@@ -326,10 +303,11 @@ switch.
 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi
 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-mhmail(1), scan(1), mh\-mail(5), post(8)
-
+.IR mhmail (1),
+.IR scan (1),
+.IR mh\-mail (5),
+.IR post (8)

 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"

@@ -339,11 +317,8 @@ mhmail(1), scan(1), mh\-mail(5), post(8)
 .RB ` \-nosilent '
 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 .RB ` \-width "' defaulted to the width of the terminal"
 .RB ` \-nosilent '
 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 .RB ` \-width "' defaulted to the width of the terminal"

-%nmhbeginpop%

 .RB ` \-nopack '
 .RB ` \-nopack '

-%nmhendpop%

 .fi
 .fi

-

 .SH CONTEXT
 The folder into which messages are being incorporated will become the
 current folder.  The first message incorporated will become the current
 .SH CONTEXT
 The folder into which messages are being incorporated will become the
 current folder.  The first message incorporated will become the current

@@ -352,12 +327,3 @@ message, unless the
 option is specified.  This leaves the context ready for a
 .B show
 of the first new message.
 option is specified.  This leaves the context ready for a
 .B show
 of the first new message.

-
-.SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single
-token by the shell that invokes
-.BR inc .
-Therefore, one must usually place the argument to this switch inside
-double\-quotes.