Factor trim format function out

[mmh] / man / mh-profile.man5

diff --git a/man/mh-profile.man5 b/man/mh-profile.man5
index c652428..dd8196f 100644 (file)
--- a/man/mh-profile.man5
+++ b/man/mh-profile.man5
@@ -3,11 +3,7 @@
 .\"
 .TH MH-PROFILE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 .\"
 .TH MH-PROFILE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME

-mh-profile \- user profile customization for mmh message handler
-.SH SYNOPSIS
-.I $HOME/.mmh/profile
-.br
-.I $HOME/.mmh/context
+mh-profile \- user customization for the mmh message handler

 .SH DESCRIPTION
 Each user of
 .B mmh
 .SH DESCRIPTION
 Each user of
 .B mmh

@@ -38,7 +34,7 @@ context, and indicates what the default value is.
 .BR Path :
 Mail
 .RS 5
 .BR Path :
 Mail
 .RS 5

-Sets the user's mail storage to \*(lqMail\*(rq.  This is the
+Sets the user's mail storage to `Mail'.  This is the

 only mandatory profile entry.  (profile, no default)
 .RE
 .PP
 only mandatory profile entry.  (profile, no default)
 .RE
 .PP

@@ -59,7 +55,7 @@ section below.
 inbox
 .RS 5
 Keeps track of the current open folder.
 inbox
 .RS 5
 Keeps track of the current open folder.

-(context, default: folder specified by \*(lqInbox\*(rq)
+(context, default: folder specified by `Inbox')

 .RE
 .PP
 .BR Inbox :
 .RE
 .PP
 .BR Inbox :

@@ -87,8 +83,8 @@ man page for the details about this sequence. (profile, no default)
 \&!
 .RS 5
 Defines the string which, when prefixed to a sequence name, negates
 \&!
 .RS 5
 Defines the string which, when prefixed to a sequence name, negates

-that sequence.  Hence, \*(lq!foo\*(rq means all those messages that
-are not a member of the sequence \*(lqfoo\*(rq.
+that sequence.  Hence, `!foo' means all those messages that
+are not a member of the sequence `foo'.

 To deactivate this mechanism, define Sequence\-Negation to an empty value.
 Read the
 .BR mh\-sequence (7)
 To deactivate this mechanism, define Sequence\-Negation to an empty value.
 Read the
 .BR mh\-sequence (7)

@@ -102,7 +98,6 @@ Names the sequence or sequences which shall contain any unread messages.
 The commands
 .BR inc ,
 .BR rcvstore ,
 The commands
 .BR inc ,
 .BR rcvstore ,

-.BR mhshow ,

 and
 .B show
 will add or remove messages from these
 and
 .B show
 will add or remove messages from these

@@ -125,7 +120,7 @@ entry blank.  (profile, default: \&.mh_sequences)
 .BI atr\- seq \- folder :
 172\0178\-181\0212
 .RS 5
 .BI atr\- seq \- folder :
 172\0178\-181\0212
 .RS 5

-Keeps track of the private sequence called \*(lqseq\*(rq in the specified
+Keeps track of the private sequence called `seq' in the specified

 folder.  Private sequences are generally used for read\-only folders.
 See the
 .BR mh\-sequence (7)
 folder.  Private sequences are generally used for read\-only folders.
 See the
 .BR mh\-sequence (7)

@@ -156,7 +151,7 @@ to page the
 .B mhl
 formatted message when displaying to a terminal.  It is also the default
 program used by
 .B mhl
 formatted message when displaying to a terminal.  It is also the default
 program used by

-.B mhshow
+.B show

 to display message bodies (or message parts) of type text/plain.
 This profile entry overrides the $PAGER environment variable, but gets
 overridden by the $MMHPAGER environment variable.
 to display message bodies (or message parts) of type text/plain.
 This profile entry overrides the $PAGER environment variable, but gets
 overridden by the $MMHPAGER environment variable.

@@ -174,22 +169,6 @@ to send mail.
 (profile, default: %sendmailpath%)
 .RE
 .PP
 (profile, default: %sendmailpath%)
 .RE
 .PP

-.BR Backup-Prefix :
-,
-.RS 5
-The prefix that is prepended to the name of message files when they
-are ``removed'' by rmm. This should typically be `,' or `#'.
-(profile, default: `,')
-.RE
-.PP
-.BR AltMsg-Link :
-@
-.RS 5
-Name of the link to the file to which you are replying or which you are
-redistributing. See `$mhaltmsg' below.
-(profile, default: `@')
-.RE
-.PP

 .BR Attachment-Header :
 Attach
 .RS 5
 .BR Attachment-Header :
 Attach
 .RS 5

@@ -199,37 +178,61 @@ If you like to type a lot, name it `X-MH-Attachment'.
 (profile, default: `Attach')
 .RE
 .PP
 (profile, default: `Attach')
 .RE
 .PP

+.BR Sign-Header :
+Sign
+.RS 5
+The (pseudo) header in draft messages, that requests the message to be
+signed automatically by
+.BR send ,
+using
+.BR mhsign .
+If you like to type a lot, name it `X-MH-Sign-This-Message'.
+(profile, default: `Sign')
+.RE
+.PP
+.BR Enc-Header :
+Enc
+.RS 5
+The (pseudo) header in draft messages, that requests the message to be
+signed and encrypted by
+.BR send ,
+using
+.BR mhsign .
+If you like to type a lot, name it `X-MH-Encrypt-This-Message'.
+(profile, default: `Enc')
+.RE
+.PP

 .BR Mime-Type-Query :
 file \-b \-\-mime
 .RS 5
 .BR Mime-Type-Query :
 file \-b \-\-mime
 .RS 5

-A command that prints the MIME type of a file.
-The file name gets appended to the command line.
-Note: Older GNU versions of file(1) won't generate the desired
-output. GNU file-4.26, for instance, omits a required semicolon.
-GNU file-5.04 is known to work. Non-GNU version likely need different
-options or don't provide this function at all. Alternatively, you can use
+A command that prints the MIME type of a given file.
+The file name is appended to the command line.
+Note: Older versions of file(1) won't generate the desired output.
+file-4.26, for instance, omits a required semicolon.
+file-5.04 is known to work.
+Alternatively, you can use

 .BR print\-mimetype ,
 which is part of mmh, but guesses MIME types by file name extensions only.
 .RE
 .PP
 .BR Msg\-Protect :
 .BR print\-mimetype ,
 which is part of mmh, but guesses MIME types by file name extensions only.
 .RE
 .PP
 .BR Msg\-Protect :

-644
+0644

 .RS 5
 An octal number which defines the permission bits for new message files.
 See
 .BR chmod (1)
 for an explanation of the octal number.
 .RS 5
 An octal number which defines the permission bits for new message files.
 See
 .BR chmod (1)
 for an explanation of the octal number.

-(profile, default: 0644)
+(profile, default: 0600)

 .RE
 .PP
 .BR Folder\-Protect :
 .RE
 .PP
 .BR Folder\-Protect :

-750
+0750

 .RS 5
 An octal number which defines the permission bits for new folder
 directories.  See
 .BR chmod (1)
 for an explanation of the octal number.
 .RS 5
 An octal number which defines the permission bits for new folder
 directories.  See
 .BR chmod (1)
 for an explanation of the octal number.

-(profile, default: 700)
+(profile, default: 0700)

 .RE
 .PP
 .IR program :
 .RE
 .PP
 .IR program :

@@ -237,7 +240,7 @@ for an explanation of the octal number.
 .RS 5
 Sets default switches to be used whenever the mmh program
 .I program
 .RS 5
 Sets default switches to be used whenever the mmh program
 .I program

-is invoked.  For example, one could override the \*(lqEditor:\*(rq profile
+is invoked.  For example, one could override the `Editor:' profile

 component when replying to messages by adding a component such as:
 .PP
 .RS 5
 component when replying to messages by adding a component such as:
 .PP
 .RS 5

@@ -250,8 +253,8 @@ repl: \-editor /bin/ed
 .IB lasteditor "-next:"
 .I nexteditor
 .RS 5
 .IB lasteditor "-next:"
 .I nexteditor
 .RS 5

-Names \*(lqnexteditor\*(rq to be the default editor after using
-\*(lqlasteditor\*(rq.  This takes effect at \*(lqWhat now?\*(rq prompt
+Names `nexteditor' to be the default editor after using
+`lasteditor'.  This takes effect at `What now?' prompt

 in
 .BR comp ,
 .BR dist ,
 in
 .BR comp ,
 .BR dist ,

@@ -259,9 +262,9 @@ in
 and
 .BR repl .
 After editing
 and
 .BR repl .
 After editing

-the draft with \*(lqlasteditor\*(rq, the default editor is set to be
-\*(lqnexteditor\*(rq.  If the user types \*(lqedit\*(rq without any
-arguments to \*(lqWhat now?\*(rq, then \*(lqnexteditor\*(rq is used.
+the draft with `lasteditor', the default editor is set to be
+`nexteditor'.  If the user types `edit' without any
+arguments to `What now?', then `nexteditor' is used.

 (profile, no default)
 .RE
 .PP
 (profile, no default)
 .RE
 .PP

@@ -274,21 +277,6 @@ command.
 (context, no default)
 .RE
 .PP
 (context, no default)
 .RE
 .PP

-.BR mhe :
-.RS 5
-If present, tells
-.B inc
-to compose an
-.I MHE
-auditfile in addition to its other tasks.
-.I MHE
-is Brian Reid's
-.B emacs
-front-end for
-.BR mmh .
-(profile, no default)
-.RE
-.PP

 .BR Alternate\-Mailboxes :
 mh@uci\-750a, bug-mh*
 .RS 5
 .BR Alternate\-Mailboxes :
 mh@uci\-750a, bug-mh*
 .RS 5

@@ -304,7 +292,7 @@ reply, and
 scan
 knows if the message really originated from you.
 Addresses must be separated by a comma, and the hostnames listed should
 scan
 knows if the message really originated from you.
 Addresses must be separated by a comma, and the hostnames listed should

-be the \*(lqofficial\*(rq hostnames for the mailboxes you indicate, as
+be the `official' hostnames for the mailboxes you indicate, as

 local nicknames for hosts are not replaced with their official site names.
 For each address, if a host is not given, then that address on any host is
 considered to be you.  In addition, an asterisk (`*') may appear at either
 local nicknames for hosts are not replaced with their official site names.
 For each address, if a host is not given, then that address on any host is
 considered to be you.  In addition, an asterisk (`*') may appear at either

@@ -312,18 +300,27 @@ or both ends of the mailbox and host to indicate wild-card matching.
 (profile, default: your user-id)
 .RE
 .PP
 (profile, default: your user-id)
 .RE
 .PP

+.BR Default-From :
+Philipp Takacs <philipp@bureaucracy.de>
+.RS 5
+Tells
+.B spost
+which address to use, if the draft dosn't contain a
+.RI ` From '
+Header or the draft is not from the user.
+(profile, no default)
+.RE
+.PP

 .BR Aliasfile :
 aliases
 .I other-alias
 .RS 5
 Indicates aliases files for
 .BR Aliasfile :
 aliases
 .I other-alias
 .RS 5
 Indicates aliases files for

-.BR ali
-and
+.BR ali ,

 .BR send .
 .BR send .

-This may be used instead of the
-.B \-alias
-.I file
-switch.  (profile, no default)
+and
+.BR spost .
+(profile, no default)

 .RE
 .PP
 .BR Draft\-Folder :
 .RE
 .PP
 .BR Draft\-Folder :

@@ -334,6 +331,15 @@ Changes the default draft folder.  Read the
 man page for details. (profile, default: +drafts)
 .RE
 .PP
 man page for details. (profile, default: +drafts)
 .RE
 .PP

+.BR Trash\-Folder :
+trash
+.RS 5
+Changes the default folder for removed messages.  Read the
+.BR rmm (1)
+man page for details.
+(profile, default: +trash)
+.RE
+.PP

 .BI digest\-issue\- list :
 1
 .RS 5
 .BI digest\-issue\- list :
 1
 .RS 5

@@ -375,66 +381,36 @@ environment variable
 .BR $SIGNATURE .
 If
 .B $SIGNATURE
 .BR $SIGNATURE .
 If
 .B $SIGNATURE

-is not set and this profile entry is not present, the \*(lqgcos\*(rq field of
+is not set and this profile entry is not present, the `gcos' field of

 the \fI/etc/passwd\fP file will be used.
 Your signature will be added to the address
 .B send
 the \fI/etc/passwd\fP file will be used.
 Your signature will be added to the address
 .B send

-puts in the \*(lqFrom:\*(rq header; do not include an address in the
+puts in the `From:' header; do not include an address in the

 signature text.  (profile, no default)
 .RE
 
 .SS "Process Profile Entries"
 The following profile elements are used whenever an
 signature text.  (profile, no default)
 .RE
 
 .SS "Process Profile Entries"
 The following profile elements are used whenever an

-.B nmh
+.B mmh

 program invokes some other program such as
 .BR more .
 The profile can be used to select alternate programs if the
 user wishes.  The default values are given in the examples.
 .RE
 .PP
 program invokes some other program such as
 .BR more .
 The profile can be used to select alternate programs if the
 user wishes.  The default values are given in the examples.
 .RE
 .PP

-.BR fileproc :
-%bindir%/refile
-.RS 5
-This program is used to refile or link a message to another folder.
-It is used by
-.B post
-to file a copy of a message into a folder given
-by a \*(lqFcc:\*(rq field.  It is used by the draft folder facility in
-.BR comp ,
-.BR dist ,
-.BR forw ,
-and
-.B repl
-to refile a draft
-message into another folder.  It is used to refile a draft message in
-response to the
-.B refile
-directive at the \*(lqWhat now?\*(rq prompt.
-.RE
-.PP

 .BR listproc :
 .BR listproc :

-show \-file
+show

 .RS 5
 This program is used to list the contents of a message in response
 to the
 .B list
 and
 .B display
 .RS 5
 This program is used to list the contents of a message in response
 to the
 .B list
 and
 .B display

-directive at the \*(lqWhat now?\*(rq prompt.
+directive at the `What now?' prompt.

 The absolute pathname of the message to list will be appended to
 the command line given.
 .RE
 .PP
 The absolute pathname of the message to list will be appended to
 the command line given.
 .RE
 .PP

-.BR rmmproc :
-none
-.RS 5
-This is the program used by
-.B rmm
-and
-.B refile
-to delete a message from a folder.
-.RE
-.PP

 .BR whatnowproc :
 %bindir%/whatnow
 .RS 5
 .BR whatnowproc :
 %bindir%/whatnow
 .RS 5

@@ -454,9 +430,9 @@ and its commands it also controlled by the
 presence of certain environment variables.
 .PP
 Many of these environment variables are used internally by the
 presence of certain environment variables.
 .PP
 Many of these environment variables are used internally by the

-\*(lqWhat now?\*(rq interface.  It's amazing all the information
+`What now?' interface.  It's amazing all the information

 that has to get passed via environment variables to make the
 that has to get passed via environment variables to make the

-\*(lqWhat now?\*(rq interface look squeaky clean to the
+`What now?' interface look squeaky clean to the

 .B mmh
 user, isn't it?  The reason for all this is that the
 .B mmh
 .B mmh
 user, isn't it?  The reason for all this is that the
 .B mmh

@@ -547,7 +523,7 @@ a character set that doesn't match
 .BR $MM_CHARSET .
 This variable is
 checked by
 .BR $MM_CHARSET .
 This variable is
 checked by

-.B mhshow
+.B show

 for matches against the charset parameter
 of text contents to decide it the text content can be displayed
 without modifications to your terminal.  This variable is checked by
 for matches against the charset parameter
 of text contents to decide it the text content can be displayed
 without modifications to your terminal.  This variable is checked by

@@ -569,7 +545,7 @@ to iso_8859_1).
 .RS 5
 This variable tells
 .B inc
 .RS 5
 This variable tells
 .B inc

-the default maildrop. This supersedes the \*(lqMailDrop\*(rq profile entry.
+the default maildrop. This supersedes the `MailDrop' profile entry.

 .RE
 .PP
 .B $SIGNATURE
 .RE
 .PP
 .B $SIGNATURE

@@ -578,7 +554,7 @@ This variable tells
 .B send
 and
 .B post
 .B send
 and
 .B post

-your mail signature. This supersedes the \*(lqSignature\*(rq profile entry.
+your mail signature. This supersedes the `Signature' profile entry.

 .RE
 .PP
 .B $HOME
 .RE
 .PP
 .B $HOME

@@ -630,22 +606,6 @@ how many
 lines long your terminal screen is.
 .RE
 .PP
 lines long your terminal screen is.
 .RE
 .PP

-.B $editalt
-.RS 5
-This is the alternate message.
-.PP
-This is set by
-.B dist
-and
-.B repl
-during edit sessions so you can peruse the message being distributed or
-replied to.  The message is also available through a link called
-\*(lq@\*(rq (if not changed by
-.BR altmsg-link )
-in the current directory if your current working directory
-and the message's folder are on the same UNIX filesystem.
-.RE
-.PP

 .B $mhdraft
 .RS 5
 This is the path to the working draft.
 .B $mhdraft
 .RS 5
 This is the path to the working draft.

@@ -658,20 +618,10 @@ and
 .B repl
 to tell the
 .I whatnowproc
 .B repl
 to tell the
 .I whatnowproc

-which file to ask \*(lqWhat now?\*(rq
+which file to ask `What now?'

 questions about.
 .RE
 .PP
 questions about.
 .RE
 .PP

-.B $mhfolder
-.RS 5
-This is set by
-.BR dist ,
-.BR forw ,
-and
-.BR repl ,
-if appropriate.
-.RE
-.PP

 .B $mhaltmsg
 .RS 5
 .B dist
 .B $mhaltmsg
 .RS 5
 .B dist

@@ -683,6 +633,13 @@ to tell the
 .I whatnowproc
 about an alternate message associated with the
 draft (the message being distributed or replied to).
 .I whatnowproc
 about an alternate message associated with the
 draft (the message being distributed or replied to).

+It is also set during edit sessions so you can peruse the
+message being distributed or replied to.
+This variable replaces the older
+.B $editalt
+variable.
+There used to be a link named `@' in the working directory, pointing
+to the alternate message, there is no such link anymore.

 .RE
 .PP
 .B $mhdist
 .RE
 .PP
 .B $mhdist

@@ -746,15 +703,7 @@ and
 .B repl
 during edit sessions so you
 can peruse other messages in the current folder besides the one being
 .B repl
 during edit sessions so you
 can peruse other messages in the current folder besides the one being

-distributed or replied to.  The environment variable
-.B $mhfolder
-is also set by
-.BR show ,
-.BR prev ,
-and
-.B next
-for use by
-.BR mhl .
+distributed or replied to.

 .RE
 
 .SH FILES
 .RE
 
 .SH FILES

@@ -763,10 +712,13 @@ for use by
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/.mmh~^The user's mmh directory
 ^or $MMH~^Rather than the standard mmh directory
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/.mmh~^The user's mmh directory
 ^or $MMH~^Rather than the standard mmh directory

+.sp

 ^$HOME/.mmh/profile~^The user's profile
 ^or $MMHP~^Rather than the standard profile
 ^$HOME/.mmh/profile~^The user's profile
 ^or $MMHP~^Rather than the standard profile

+.sp

 ^$HOME/.mmh/context~^The user's context
 ^or $MMHC~^Rather than the standard context
 ^$HOME/.mmh/context~^The user's context
 ^or $MMHC~^Rather than the standard context

+.sp

 ^<folder>/.mh_sequences~^Public sequences for <folder>
 .fi
 
 ^<folder>/.mh_sequences~^Public sequences for <folder>
 .fi
 

@@ -783,15 +735,15 @@ programs will
 update.  Changes in context are made to the
 .I $HOME/.mmh/context
 file.
 update.  Changes in context are made to the
 .I $HOME/.mmh/context
 file.

-This includes, but is not limited to: the \*(lqCurrent\-Folder\*(rq entry
+This includes, but is not limited to: the `Current\-Folder' entry

 and all private sequence information.  Public sequence information is
 and all private sequence information.  Public sequence information is

-kept in each folder in the file determined by the \*(lqMh\-Sequences\*(rq
+kept in each folder in the file determined by the `Mh\-Sequences'

 profile entry (default is
 .IR \&.mh_sequences ).
 .PP
 The profile may override the path of the
 .I context
 profile entry (default is
 .IR \&.mh_sequences ).
 .PP
 The profile may override the path of the
 .I context

-file, by specifying a \*(lqContext\*(rq entry.
+file, by specifying a `Context' entry.

 As a result, you can actually have more than one set of
 private sequences by using different context files.
 
 As a result, you can actually have more than one set of
 private sequences by using different context files.