X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/81498ba3222c3731cae33bf76ca04a8257b06d3d..07661005b9a36338ab158bcbe7762788a1df4030:/man/mh-profile.man diff --git a/man/mh-profile.man b/man/mh-profile.man index 8d77900d..14d1c5ab 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -1,11 +1,9 @@ -.TH MH-PROFILE %manext5% "November 6, 2012" "%nmhversion%" +.TH MH-PROFILE %manext5% "April 14, 2013" "%nmhversion%" .\" .\" %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 @@ -145,7 +143,7 @@ man page for details about private sequences. .RE .PP .BR Editor : -/usr/bin/vi +vi .RS 5 Defines the editor to be used by the commands .BR comp , @@ -153,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 : @@ -187,6 +177,28 @@ 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 @@ -238,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, @@ -350,6 +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 @@ -359,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 : @@ -408,14 +513,6 @@ 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 : more .RS 5 @@ -534,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 @@ -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