From: Lyndon Nerenberg Date: Fri, 1 Feb 2013 08:20:44 +0000 (-0800) Subject: Update manpages to use .TP for tagged paragraphs (part I). X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/ae9b723f054219598687babf6ae16b5177604460?hp=-c Update manpages to use .TP for tagged paragraphs (part I). This replaces .fc/.nf and friends with the man(7) .TP macro. This commit covers about half of the man pages. The rest will follow in a couple of days. --- ae9b723f054219598687babf6ae16b5177604460 diff --git a/man/ali.man b/man/ali.man index a67cad14..1b54e0f1 100644 --- a/man/ali.man +++ b/man/ali.man @@ -59,30 +59,33 @@ switch will be read. Each is processed as described in .IR mh\-alias (5). .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^/etc/passwd~^List of users -^/etc/group~^List of groups -.fi +.TP 20 +$HOME/.mh\-profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Aliasfile:~^For a default alias file -.fi +.PP +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory +.TP +Aliasfile: +For a default alias file +.PD .SH "SEE ALSO" .IR mh\-alias (5) .SH DEFAULTS -.nf -.RB ` aliasfiles "' defaults to %etcdir%/MailAliases" -.RB ` \-nolist ' -.RB ` \-nonormalize ' -.RB ` \-nouser ' -.fi +.PD 0 +.TP 20 +aliasfile +%etcdir%/MailAliases +.TP +\-nolist +.TP +\-nonormalize +.TP +\-nouser +.PD .SH CONTEXT None .SH BUGS diff --git a/man/anno.man b/man/anno.man index ce1942b6..2842d40b 100644 --- a/man/anno.man +++ b/man/anno.man @@ -151,30 +151,35 @@ A matching option exists that allows time preservation to be turned off if enabled in the profile. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/\&.mh\(ruprofile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.PD .SH "SEE ALSO" .IR dist (1), .IR forw (1), .IR repl (1) .SH DEFAULTS -.nf -.RI ` +folder "' defaults to the current folder" -.RI ` msgs "' defaults to cur" -.RB ` \-inplace ' -.RB ` \-date ' -.fi +.PD 0 +.TP 20 ++folder +The current folder. +.TP +msgs +The current message. +.TP +-inplace +.TP +-date +.PD .SH CONTEXT If a folder is given, it will become the current folder. The first message annotated will become the current message. diff --git a/man/ap.man b/man/ap.man index f1b6faa4..52d6c522 100644 --- a/man/ap.man +++ b/man/ap.man @@ -78,12 +78,14 @@ which says that if an error was detected, print the error, a `:', and the address in error. Otherwise, output the 822\-proper format of the address. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^%etcdir%/mts.conf~^nmh mts configuration file -.fi +.PD 0 +.TP 20 +$HOME/\&.mh\(ruprofile +The user's profile. +.TP +%etcdir%/mts.conf +The mts configuration file. +.PD .SH "PROFILE COMPONENTS" None .SH "SEE ALSO" @@ -93,10 +95,15 @@ None Standard for the Format of ARPA Internet Text Messages (RFC\-822) .SH DEFAULTS -.nf -.RB ` \-format "' defaults as described above" -.RB ` \-normalize ' -.RB ` \-width "' defaults to the width of the terminal" -.fi +.PD 0 +.TP 20 +-format +As described above. +.TP +\-normalize +.TP +\-width +The width of the terminal. +.PD .SH CONTEXT None diff --git a/man/burst.man b/man/burst.man index 4e2d0cc0..526870ca 100644 --- a/man/burst.man +++ b/man/burst.man @@ -59,20 +59,21 @@ former two were generated by or .BR send . .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh\-profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -^Msg\-Protect:~^To set mode when creating a new message -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.TP +Msg\-Protect: +To set mode when creating a new message. +.PD .SH "SEE ALSO" .IR inc (1), .IR msh (1), @@ -82,13 +83,20 @@ or Proposed Standard for Message Encapsulation (RFC\-934) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msgs "' defaults to cur" -.RB ` \-noinplace ' -.RB ` \-noquiet ' -.RB ` \-noverbose ' -.fi +.PD 0 +.TP 20 ++folder +The current folder. +.TP +msgs +The current message. +.TP +\-noinplace +.TP +\-noquiet +.TP +\-noverbose +.PD .SH CONTEXT If a folder is given, it will become the current folder. If .B \-inplace diff --git a/man/comp.man b/man/comp.man index bd0a762e..387ec129 100644 --- a/man/comp.man +++ b/man/comp.man @@ -231,26 +231,38 @@ program which starts the initial edit. Hence, .B \-nowhatnowproc will prevent any edit from occurring.) .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^%etcdir%/components~^The standard message skeleton -^or /components~^Rather than the standard skeleton -^$HOME/\&.mh\(ruprofile~^The user profile -^/draft~^The draft file -.fi +.PD 0 +.TP 20 +%etcdir%/components +The standard message skeleton. +.TP +/components +An alternative to the standard skeleton. +.TP +$HOME/.mh\-profile +The user's profile. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Draft\-Folder:~^To find the default draft\-folder -^Editor:~^To override the default editor -^Msg\-Protect:~^To set mode when creating a new message (draft) -^fileproc:~^Program to refile the message -^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Draft\-Folder: +To find the default draft\-folder. +.TP +Editor: +To override the default editor. +.TP +Msg\-Protect: +To set mode when creating a new message (draft). +.TP +fileproc: +Program to refile the message. +.TP +whatnowproc: +Program to ask the \*(lqWhat now?\*(rq questions +.PD .SH "SEE ALSO" .IR dist (1), .IR forw (1), @@ -259,12 +271,18 @@ will prevent any edit from occurring.) .IR whatnow (1), .IR mh-profile (5) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msg "' defaults to the current message" -.RB ` \-nodraftfolder ' -.RB ` \-nouse ' -.fi +.PD 0 +.TP 20 ++folder +The current folder. +.TP +msg +The current message. +.TP +\-nodraftfolder +.TP +\-nouse +.PD .SH CONTEXT None .SH BUGS diff --git a/man/dp.man b/man/dp.man index 3f98913a..7998c2d0 100644 --- a/man/dp.man +++ b/man/dp.man @@ -62,11 +62,9 @@ which says that if an error was detected, print the error, a `:', and the date in error. Otherwise, output the 822\-proper format of the date. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh\-profile +The user's profile. .SH "PROFILE COMPONENTS" None .SH "SEE ALSO" @@ -75,9 +73,13 @@ None .I "Standard for the Format of ARPA Internet Text Messages" (RFC\-822) .SH DEFAULTS -.nf -.RB ` \-format "' default as described above" -.RB ` \-width "' default to the width of the terminal" -.fi +.PD 0 +.TP 20 +\-format +As described above. +.TP +\-width +The width of the terminal. +.PD .SH CONTEXT None diff --git a/man/flist.man b/man/flist.man index 49b45021..a3ad8798 100644 --- a/man/flist.man +++ b/man/flist.man @@ -174,35 +174,45 @@ addressed to you personally, those about a pet project, and those about mh-related things. It places uninteresting folders at the end, and it puts everything else in the middle in alphabetical order. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh\-profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^mh-sequences:~^File that contains public sequences -^Unseen-Sequence:~^The name of the unseen message sequence -^Flist-Order:~^To sort folders by priority -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +mh-sequences: +File that contains public sequences. +.TP +Unseen-Sequence: +The name of the unseen message sequence. +.TP +Flist-Order: +To sort folders by priority. +.PD .SH "SEE ALSO" .IR folder (1), .IR rcvstore (1), .IR slocal (1), .IR mh\-sequence (5) .SH DEFAULTS -.nf -.RB ` -sequence "' defaults to Unseen-Sequence profile entry" -.RB ` \-showzero ' -.RB ` \-noall ' -.RB ` \-norecurse ' -.RB ` \-noalpha ' -.RB ` \-nofast ' -.fi +.PD 0 +.TP 20 +-sequence +The Unseen-Sequence profile entry. +.TP +\-showzero +.TP +\-noall +.TP +\-norecurse +.TP +\-noalpha +.TP +\-nofast +.PD .SH CONTEXT If .I +folder diff --git a/man/fmtdump.man b/man/fmtdump.man index 9a71ac94..42cb3df2 100644 --- a/man/fmtdump.man +++ b/man/fmtdump.man @@ -36,19 +36,18 @@ See .IR mh-format (5) for the details. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^%etcdir%/scan.default~^The default format file -.fi +.PD 0 +.TP 20 +$HOME/.mh\-profile +The user's profile. +.TP +%etcdir%/scan.default +The default format file. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -.fi +.TP 20 +Path: +To determine the user's nmh directory. .SH "SEE ALSO" .IR mh-format (5), .IR mh-sequences (8) diff --git a/man/folder.man b/man/folder.man index dadabbf5..401ab5b8 100644 --- a/man/folder.man +++ b/man/folder.man @@ -261,38 +261,64 @@ and switches turn off .BR \-print . .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh\-profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -^Folder\-Protect:~^To set mode when creating a new folder -^Folder\-Stack:~^To determine the folder stack +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.TP +Folder\-Protect: +To set mode when creating a new folder. +.TP +Folder\-Stack: +To determine the folder stack. .\" ^lsproc:~^Program to list the contents of a folder -.fi +.PD .SH "SEE ALSO" .IR mhpath (1), .IR refile (1) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msg "' defaults to none" -.RB ` \-nofast ' -.RB ` \-noheader ' -.RB ` \-nototal ' -.RB ` \-nopack ' -.RB ` \-norecurse ' -.RB ` \-noverbose ' -.RB ` \-print "' is the default if no " \-list ", " \-push ", or " \-pop " is specified" -.RB ` \-list "' is the default if " \-push ", or " \-pop " is specified" -.fi +.PD 0 +.TP 20 ++folder +The current folder. +.TP +msg +\*(lqnone\*(rq +.TP +\-nofast +.TP +\-noheader +.TP +\-nototal +.TP +\-nopack +.TP +\-norecurse +.TP +\-noverbose +.TP +\-print +is the default if no +.BR -list , +.BR \-push , +or +.B \-pop +is specified. +.TP +\-list +is the default if +.BR \-push , +or +.B \-pop +is specified. +.PD .SH CONTEXT If .I +folder diff --git a/man/forw.man b/man/forw.man index 2efa5413..1e0c0c39 100644 --- a/man/forw.man +++ b/man/forw.man @@ -395,32 +395,58 @@ section of the .B nmh User's Manual for more information on making digests. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^%etcdir%/forwcomps~^The standard message skeleton -^or /forwcomps~^Rather than the standard skeleton -^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given -^or /digestcomps~^Rather than the standard skeleton -^%etcdir%/mhl.forward~^The standard message filter -^or /mhl.forward~^Rather than the standard filter -^$HOME/\&.mh\(ruprofile~^The user profile -^/draft~^The draft file -.fi +.PD 0 +.TP 25 +%etcdir%/forwcomps +The standard message skeleton. +.TP +/forwcomps +Rather than the standard skeleton. +.TP +%etcdir%/digestcomps +The message skeleton if +.B \-digest +is given. +.TP +/digestcomps +Rather than the standard skeleton. +.TP +^%etcdir%/mhl.forward +The standard message filter. +.TP +/mhl.forward +Rather than the standard filter. +.TP +^$HOME/.mh\-profile +The user's profile. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -^Draft\-Folder:~^To find the default draft\-folder -^Editor:~^To override the default editor -^Msg\-Protect:~^To set mode when creating a new message (draft) -^fileproc:~^Program to refile the message -^mhlproc:~^Program to filter messages being forwarded -^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions -.fi +.PD 0 +.TP 25 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.TP +Draft\-Folder: +To find the default draft\-folder. +.TP +Editor: +To override the default editor. +.TP +Msg\-Protect: +To set mode when creating a new message (draft). +.TP +fileproc: +Program to refile the message. +.TP +mhlproc: +Program to filter messages being forwarded. +.TP +whatnowproc: +Program to ask the \*(lqWhat now?\*(rq questions. +.PD .SH "SEE ALSO" .IR comp (1), .IR mhbuild (1), @@ -433,16 +459,26 @@ User's Manual for more information on making digests. Proposed Standard for Message Encapsulation (RFC\-934) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msgs "' defaults to cur" -.RB ` \-noannotate ' -.RB ` \-nodraftfolder ' -.RB ` \-noformat ' -.RB ` \-inplace ' -.RB ` \-dashstuffing ' -.RB ` \-nomime ' -.fi +.PD 0 +.TP 25 ++folder +The current folder. +.TP +msgs +The current message. +.TP +\-noannotate +.TP +\-nodraftfolder +.TP +\-noformat +.TP +\-inplace +.TP +\-dashstuffing +.TP +\-nomime +.PD .SH CONTEXT If a folder is given, it will become the current folder. The first message forwarded will become the current message. diff --git a/man/inc.man b/man/inc.man index 627c20ed..328b5b3d 100644 --- a/man/inc.man +++ b/man/inc.man @@ -289,42 +289,72 @@ when viewing the POP transaction with the .B \-snoop switch. .SH FILES -.fc ^ ~ -.nf -.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 +.PD 0 +.TP 20 +$HOME/.mh\-profile +The user's profile. +.TP +%etcdir%/mts.conf +mts configuration file. +.TP +%mailspool%/$USER +Location of the system mail drop. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Alternate\-Mailboxes:~^To determine the user's mailboxes -^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq -^Folder\-Protect:~^To set mode when creating a new folder -^Msg\-Protect:~^To set mode when creating a new message and audit\-file -^Unseen\-Sequence:~^To name sequences denoting unseen messages -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Alternate\-Mailboxes: +To determine the user's mailboxes. +.TP +Inbox: +To determine the inbox. +.TP +Folder\-Protect: +To set mode when creating a new folder. +.TP +Msg\-Protect: +To set mode when creating a new message and audit\-file. +.TP +Unseen\-Sequence: +To name sequences denoting unseen messages. +.PD .SH "SEE ALSO" .IR mhmail (1), .IR scan (1), .IR mh\-mail (5), .IR post (8) .SH DEFAULTS -.nf -.RB ` +folder "' defaulted by \*(lqInbox\*(rq above" -.RB ` \-noaudit ' -.RB ` \-changecur ' -.RB ` \-format "' defaulted as described above" -.RB ` \-nosilent ' -.RB ` \-nosasl ' -.RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise" -.RB ` \-width "' defaulted to the width of the terminal" -.RB ` \-nopack ' -.fi +.PD 0 +.TP 20 ++folder +defaulted by \*(lqInbox\*(rq above. +.TP +\-noaudit +.TP +\-changecur +.TP +\-format +As described above. +.TP +\-nosilent +.TP +\-nosasl +.TP +\-truncate +If +.B \-file +.I name +not given, +\-notruncate otherwise. +.TP +\-width +The width of the terminal. +.TP +\-nopack +.PD .SH CONTEXT The folder into which messages are being incorporated will become the current folder. The first message incorporated will become the current diff --git a/man/install-mh.man b/man/install-mh.man index 33262d2d..25a7fdbe 100644 --- a/man/install-mh.man +++ b/man/install-mh.man @@ -67,19 +67,18 @@ been installed. This can be used by other programs to determine whether or not nmh has been installed without their having to know the internals of nmh. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^%etcdir%/mh.profile~^Used to initialize user profile -.fi +.PD 0 +.TP 20 +$HOME/.mh\-profile +The user's profile. +.TP +%etcdir%/mh.profile +Used to initialize user's profile. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To set the user's nmh directory -.fi +.TP 20 +Path: +To set the user's nmh directory. .SH CONTEXT With .BR \-auto , diff --git a/man/mark.man b/man/mark.man index 500fdb16..74bdfe6c 100644 --- a/man/mark.man +++ b/man/mark.man @@ -164,29 +164,44 @@ to the first or last `n' messages of the sequence `name', respectively. Constructs of the form \*(lqname1\-name2\*(rq are forbidden for user defined sequences. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh\-profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.PD .SH "SEE ALSO" .IR flist (1), .IR pick (1), .IR mh-sequence (5) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` \-add "' if " \-sequence " is specified, " \-list " otherwise" -.RB ` msgs "' defaults to cur (or all if " \-list " is specified)" -.RB ` \-nozero ' +.PD 0 +.TP 20 ++folder +The current folder. +.TP +\-add +If +.B \-sequence +is specified, +.B \-list +otherwise. +.TP +msgs +The current message, or +.B all +if +.B \-list +is specified. +.TP +\-nozero +.PD .SH CONTEXT If a folder is given, it will become the current folder. .SH "HELPFUL HINTS"