X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/5548c9aa00ddf0989b2a0471a16e9d2f6d434983..07661005b9a36338ab158bcbe7762788a1df4030:/man/mh-profile.man?ds=sidebyside diff --git a/man/mh-profile.man b/man/mh-profile.man index e7eb611b..14d1c5ab 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -1,11 +1,9 @@ +.TH MH-PROFILE %manext5% "April 14, 2013" "%nmhversion%" .\" .\" %nmhwarning% .\" -.TH MH-PROFILE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mh-profile \- user profile customization for nmh message handler -.SH SYNOPSIS -.I $HOME/.mh\(ruprofile .SH DESCRIPTION Each user of .B nmh @@ -31,7 +29,9 @@ This is a comment. .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 @@ -90,7 +90,7 @@ command. If not present or empty, no such sequences are defined. Otherwise, for each name given, the sequence is first zero'd and then each message is added to the sequence. Read the -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for the details about this sequence. (profile, no default) .RE .PP @@ -100,7 +100,7 @@ not Defines the string which, when prefixed to a sequence name, negates that sequence. Hence, \*(lqnotseen\*(rq means all those messages that are not a member of the sequence \*(lqseen\*(rq. Read the -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for the details. (profile, no default) .RE .PP @@ -118,7 +118,7 @@ will add or remove messages from these sequences when they are incorporated or read. If not present or empty, no such sequences are defined. Otherwise, each message is added to, or removed from, each sequence name given. Read the -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for the details about this sequence. (profile, no default) .RE @@ -137,13 +137,13 @@ entry blank. (profile, default: \&.mh\(rusequences) Keeps track of the private sequence called \*(lqseq\*(rq in the specified folder. Private sequences are generally used for read\-only folders. See the -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for details about private sequences. (context, no default) .RE .PP .BR Editor : -/usr/bin/vi +vi .RS 5 Defines the editor to be used by the commands .BR comp , @@ -151,17 +151,9 @@ Defines the editor to be used by the commands .BR forw , and .BR repl . -(profile, default: %default_editor%) -.RE -.PP -.BR automimeproc : -.RS 5 -If defined and set to 1, then the -.B whatnow -program will automatically -invoke the buildmimeproc (discussed below) to process each message as a MIME -composition draft before it is sent. -(profile, no default) +If not set in profile the value will be taken from the VISUAL and +EDITOR environment variables. +(profile, default: vi) .RE .PP .BR Msg\-Protect : @@ -169,7 +161,7 @@ composition draft before it is sent. .RS 5 An octal number which defines the permission bits for new message files. See -.BR chmod (1) +.IR chmod (1) for an explanation of the octal number. Note that some filesystems, such as FAT32, do not support removal of read file permissions. (profile, default: 0600) @@ -180,11 +172,33 @@ such as FAT32, do not support removal of read file permissions. .RS 5 An octal number which defines the permission bits for new folder directories. See -.BR chmod (1) +.IR chmod (1) for an explanation of the octal number. (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 @@ -236,7 +250,7 @@ by the default component files by tools like 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, @@ -292,7 +306,7 @@ Indicates a default draft folder for and .BR repl . Read the -.BR mh\-draft (5) +.IR mh\-draft (5) man page for details. (profile, no default) .RE .PP @@ -348,7 +362,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 - +.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 @@ -358,6 +457,13 @@ The .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 : @@ -394,7 +500,7 @@ Program called by .B mhl to filter a component when it is tagged with the \*(lqformat\*(rq variable in the mhl filter. See -.BR mhl (5) +.IR mhl (5) for more information. .RE .PP @@ -407,16 +513,8 @@ to incorporate new mail when it 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 : -%default_pager% +more .RS 5 This program is used to list the contents of a message in response to the @@ -481,7 +579,7 @@ that is sent to \*(lqBcc:\*(rq recipients. .RE .PP .BR moreproc : -%default_pager% +more .RS 5 This is the program used by .B mhl @@ -533,9 +631,10 @@ to do address verification. none .RS 5 This is the program used by -.B rmm +.BR rmm , +.BR refile , and -.B refile +.B mhfixmsg to delete a message from a folder. .RE .PP @@ -582,7 +681,6 @@ This is the program used by .B whatnow to determine to whom a message would be sent. .RE - .SS "Environment Variables" The operation of .B nmh @@ -675,48 +773,6 @@ additional user profile (file) to be read by in addition to the mhn.defaults profile. .RE .PP -.B $MM_CHARSET -.RS 5 -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 -This variable is checked to see if a RFC-2047 header field should be -decoded (in -.BR inc , -.BR scan , -.BR mhl ). -This variable is -checked by -.B show -to see if the -.I showproc -or -.I showmimeproc -should -be called, since showmimeproc will be called if a text message uses -a character set that doesn't match -.BR $MM_CHARSET . -This variable is -checked by -.B mhshow -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 -.B mhbuild -to decide what character set to specify in the charset -parameter of text contents containing 8\-bit characters. -.PP -When decoding text in such an alternate character set, -.B nmh -must be able to determine which characters are alphabetic, which -are control characters, etc. For many operating systems, this -will require enabling the support for locales (such as setting -the environment variable -.B $LC_CTYPE -to iso_8859_1). -.RE -.PP .B $MAILDROP .RS 5 This variable tells @@ -849,9 +905,13 @@ 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 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 -on the same UNIX filesystem. +on the same UNIX filesystem, and if your current working directory is +writable. .RE .PP .B $mhdraft @@ -964,7 +1024,6 @@ and .B repl if annotations are to occur. .RE - .SH FILES .fc ^ ~ .nf @@ -975,10 +1034,10 @@ if annotations are to occur. ^or $MHCONTEXT~^Rather than the standard context ^/\&.mh\(rusequences~^Public sequences for .fi - .SH "SEE ALSO" -nmh(7), environ(5), mh-sequence(5) - +.IR environ (5), +.IR mh-sequence (5), +.IR nmh (7) .SH HISTORY The .I \&.mh\(ruprofile @@ -1007,12 +1066,7 @@ lower-case). If the entry is not absolute (does not start with a .B nmh 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