Reworked attach to add charset to Content-Type string for

[nmh] / man / mh-profile.man

diff --git a/man/mh-profile.man b/man/mh-profile.man
index 0e92a5fea6bfc2b7f858bb1790cab7df33c35d23..9f0190f56d89b06adbc64a90da324d6c5e214eb9 100644 (file)
--- a/man/mh-profile.man
+++ b/man/mh-profile.man
@@ -1,11 +1,9 @@
-.TH MH-PROFILE %manext5% "October 15, 2012" "%nmhversion%"
+.TH MH-PROFILE %manext5% "April 14, 2013" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .SH NAME
 mh-profile \- user profile customization for nmh message handler
 .\"
 .\" %nmhwarning%
 .\"
 .SH NAME
 mh-profile \- user profile customization for nmh message handler

-.SH SYNOPSIS
-.I $HOME/.mh\(ruprofile

 .SH DESCRIPTION
 Each user of
 .B nmh
 .SH DESCRIPTION
 Each user of
 .B nmh


@@ -31,6 +29,9 @@ This is a comment.
 .PP
 Blank lines are not permitted in
 .IR \&.mh\(ruprofile.
 .PP
 Blank lines are not permitted in
 .IR \&.mh\(ruprofile.

+The shell quoting conventions are not available in the
+.IR \&.mh\(ruprofile ;
+each token is separated by whitespace.

 .SS "Standard Profile Entries"
 The possible profile components are exemplified below.  The only mandatory
 entry is `Path:'.  The others are optional; some have default values if
 .SS "Standard Profile Entries"
 The possible profile components are exemplified below.  The only mandatory
 entry is `Path:'.  The others are optional; some have default values if


@@ -142,7 +143,7 @@ man page for details about private sequences.
 .RE
 .PP
 .BR Editor :
 .RE
 .PP
 .BR Editor :

-/usr/bin/vi
+vi

 .RS 5
 Defines the editor to be used by the commands
 .BR comp ,
 .RS 5
 Defines the editor to be used by the commands
 .BR comp ,


@@ -150,7 +151,9 @@ Defines the editor to be used by the commands
 .BR forw ,
 and
 .BR repl .
 .BR forw ,
 and
 .BR repl .

-(profile, default: %default_editor%)
+If not set in profile the value will be taken from the VISUAL and
+EDITOR environment variables.
+(profile, default: vi)

 .RE
 .PP
 .BR automimeproc :
 .RE
 .PP
 .BR automimeproc :


@@ -184,6 +187,28 @@ for an explanation of the octal number.
 (profile, default: 700)
 .RE
 .PP
 (profile, default: 700)
 .RE
 .PP

+.BR datalocking :
+fcntl
+.RS 5
+The locking algorithm used to lock changes to any
+.B nmh
+data files, such as sequences or the context.  The locking algorithm is
+any one of the following entries:
+.PP
+.RS 5
+.nf
+%supported_locks%
+.fi
+.RE
+.PP
+Available locking algorithms can vary depending on what is supported by
+the operating system.  Note: currently transactional locking is only
+supported on public sequences; see
+.IR mh\-sequence (5)
+for more information.
+(profile, default: fcntl)
+.RE
+.PP

 .IR program :
 .I default switches
 .RS 5
 .IR program :
 .I default switches
 .RS 5


@@ -235,7 +260,7 @@ by the default component files by tools like
 and
 .B repl
 to construct your default \*(lqFrom\*(rq header.  The text used here will
 and
 .B repl
 to construct your default \*(lqFrom\*(rq header.  The text used here will

-be copied exactly to your From: header, so it should already be RFC-822
+be copied exactly to your From: header, so it should already be RFC 822

 compliant.  If this is set, the
 .B Signature
 profile entry is NOT used, so it should include a signature as well.  (profile,
 compliant.  If this is set, the
 .B Signature
 profile entry is NOT used, so it should include a signature as well.  (profile,


@@ -347,6 +372,92 @@ puts in the \*(lqFrom:\*(rq header; do not include an address in the
 signature text.  The \*(lqLocal\-Mailbox\*(rq profile component
 supersedes all of this.  (profile, no default)
 .RE
 signature text.  The \*(lqLocal\-Mailbox\*(rq profile component
 supersedes all of this.  (profile, no default)
 .RE

+.PP
+.BR credentials :
+\&legacy
+.RS 5
+Indicates how the username and password credentials will be retrieved
+for access to external servers, such as those that provide SMTP or POP
+service.  The supported entry values are \*(lqlegacy\*(rq and
+.RI \*(lqfile: netrc \*(rq.
+With \*(lqlegacy\*(rq, or if there is no credentials entry, the
+username is the first of:
+.PP
+.RS 5
+1)
+.B \-user
+switch to
+.BR send ,
+.BR post ,
+.BR whom ,
+.BR inc ,
+or
+.B msgchk
+program
+.br
+2) the login name on the local machine
+.RE
+.PP
+The password for SMTP services is the first of:
+.PP
+.RS 5
+1) password value from matching entry in file named \*(lq.netrc\*(rq
+in the user's home directory
+.br
+2) password obtained by interactively prompting the user
+.RE
+.PP
+The password for POP service when the
+.B \-sasl
+switch is used with one of these programs is the login name on the
+local machine.
+.PP
+With a
+.RI \*(lqfile: netrc \*(rq
+.B credentials
+entry, the username is the first of:
+.PP
+.RS 5
+1)
+.B \-user
+switch to program
+.br
+2) login name from matching entry in
+.I netrc
+file
+.br
+3) value provided by user in response to interactive query
+.RE
+.PP
+Similarly, the password is provided either in the
+.I netrc
+file or interactively.
+.I netrc
+can be any valid filename, either absolute or relative to Path or
+$HOME.  The
+.I netrc
+file contains authentication information, for each server,
+using a line of the following form.  Replace the words
+.IR myserver ,
+.IR mylogin ,
+and
+.I mypassword
+with your own account information:
+.PP
+.RS 5
+.B machine
+.I myserver
+.B login
+.I mylogin
+.B password
+.I mypassword
+.RE
+.PP
+This
+.I netrc
+file must be owned and readable only by you.
+(profile, default: legacy)
+.RE

 .SS "Process Profile Entries"
 The following profile elements are used whenever an
 .B nmh
 .SS "Process Profile Entries"
 The following profile elements are used whenever an
 .B nmh


@@ -356,6 +467,13 @@ The
 .I \&.mh\(ruprofile
 can be used to select alternate programs if the
 user wishes.  The default values are given in the examples.
 .I \&.mh\(ruprofile
 can be used to select alternate programs if the
 user wishes.  The default values are given in the examples.

+.PP
+If the profile element contains spaces, the element is split at spaces
+into tokens and each token is given as a seperate argument to the
+.IR execvp (2)
+system call.  If the element contains shell metacharacters then the entire
+element is executed using
+.BR /bin/sh .

 .RE
 .PP
 .BR buildmimeproc :
 .RE
 .PP
 .BR buildmimeproc :


@@ -405,16 +523,8 @@ to incorporate new mail when it
 is invoked with no arguments.
 .RE
 .PP
 is invoked with no arguments.
 .RE
 .PP

-.BR installproc :
-%libdir%/install\-mh
-.RS 5
-This program is called to initialize the environment for
-new users of
-.BR nmh .
-.RE
-.PP

 .BR lproc :
 .BR lproc :

-%default_pager%
+more

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


@@ -479,7 +589,7 @@ that is sent to \*(lqBcc:\*(rq recipients.
 .RE
 .PP
 .BR moreproc :
 .RE
 .PP
 .BR moreproc :

-%default_pager%
+more

 .RS 5
 This is the program used by
 .B mhl
 .RS 5
 This is the program used by
 .B mhl


@@ -531,9 +641,10 @@ to do address verification.
 none
 .RS 5
 This is the program used by
 none
 .RS 5
 This is the program used by

-.B rmm
+.BR rmm ,
+.BR refile ,

 and
 and

-.B refile
+.B mhfixmsg

 to delete a message from a folder.
 .RE
 .PP
 to delete a message from a folder.
 .RE
 .PP


@@ -678,7 +789,7 @@ With this environment variable, you can specify
 the native character set you are using.  You must be able to display
 this character set on your terminal.
 .PP
 the native character set you are using.  You must be able to display
 this character set on your terminal.
 .PP

-This variable is checked to see if a RFC-2047 header field should be
+This variable is checked to see if a RFC 2047 header field should be

 decoded (in
 .BR inc ,
 .BR scan ,
 decoded (in
 .BR inc ,
 .BR scan ,


@@ -846,9 +957,13 @@ and
 .B repl
 during edit sessions so you can
 peruse the message being distributed or replied to.  The message is also
 .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 in the current directory if
+available, when the
+.B \-atfile
+switch is used,
+through a link called \*(lq@\*(rq in the current directory if

 your current working directory and the folder the message lives in are
 your current working directory and the folder the message lives in are

-on the same UNIX filesystem.
+on the same UNIX filesystem, and if your current working directory is
+writable.

 .RE
 .PP
 .B $mhdraft
 .RE
 .PP
 .B $mhdraft


@@ -1004,10 +1119,6 @@ lower-case).  If the entry is not absolute (does not start with a
 directory.  As a result, you can actually have more than one set of
 private sequences by using different context files.
 .SH BUGS
 directory.  As a result, you can actually have more than one set of
 private sequences by using different context files.
 .SH BUGS

-The shell quoting conventions are not available in the
-.IR \&.mh\(ruprofile .
-Each token is separated by whitespace.
-.PP

 There is some question as to what kind of arguments should be placed
 in the profile as options.  In order to provide a clear answer, recall
 command line semantics of all
 There is some question as to what kind of arguments should be placed
 in the profile as options.  In order to provide a clear answer, recall
 command line semantics of all