new.c: Order two return statements to match comment.

[nmh] / man / folder.man

diff --git a/man/folder.man b/man/folder.man
index 50f0290793dc8d25789a0c6b4dbcab3f4ee2c22c..ad8fbeed3f9d1480433feb1f58f699e118ecf578 100644 (file)
--- a/man/folder.man
+++ b/man/folder.man
@@ -1,16 +1,17 @@
-.\"
+.TH FOLDER %manext1% 2016-08-29 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\" $Id$
-.\"
-.TH FOLDER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-folder, folders \- set/list current folder/message
+folder, folders \- set/list current nmh folder/message

 .SH SYNOPSIS
 .HP 5
 .na
 .B folder
 .SH SYNOPSIS
 .HP 5
 .na
 .B folder

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ +folder ]

-.RI [ msgs ]
+.RI [ msg ]

 .RB [ \-all " | " \-noall ]
 .RB [ \-create " | " \-nocreate ]
 .RB [ \-fast " | " \-nofast ]
 .RB [ \-all " | " \-noall ]
 .RB [ \-create " | " \-nocreate ]
 .RB [ \-fast " | " \-nofast ]


@@ -22,9 +23,6 @@ folder, folders \- set/list current folder/message
 .RB [ \-pack " | " \-nopack ]
 .RB [ \-print ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-pack " | " \-nopack ]
 .RB [ \-print ]
 .RB [ \-verbose " | " \-noverbose ]

-.RB [ \-version ]
-.RB [ \-help ]
-.PP

 .HP 5
 .B folders
 is equivalent to
 .HP 5
 .B folders
 is equivalent to


@@ -32,19 +30,14 @@ is equivalent to
 .B \-all
 .ad
 .SH DESCRIPTION
 .B \-all
 .ad
 .SH DESCRIPTION

-Since the
-.B nmh
-environment is the shell, it is easy to lose track
-of the current folder from day to day.  When
+When

 .B folder
 is given the
 .B \-print
 .B folder
 is given the
 .B \-print

-switch (the default),
-.B folder
-will list the current folder,
-the number of messages in it, the range of the messages (low\-high),
-and the current message within the folder, and will flag extra files if
-they exist.  An example of this summary is:
+switch (the default), it lists: the current folder, the number
+of messages in it and their range (low-high), the folder's
+current message, and an indication of extra files, if any.
+For example:

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf


@@ -57,55 +50,53 @@ If a
 .I +folder
 and/or
 .I msg
 .I +folder
 and/or
 .I msg

-are specified, they will become the current
-folder and/or message.  By comparison, when a
+are specified, they will become the current folder and/or message.
+(When a

 .I +folder
 argument is given, this corresponds to a \*(lqcd\*(rq operation
 in the shell; when no
 .I +folder
 argument is given, this corresponds roughly to a \*(lqpwd\*(rq
 .I +folder
 argument is given, this corresponds to a \*(lqcd\*(rq operation
 in the shell; when no
 .I +folder
 argument is given, this corresponds roughly to a \*(lqpwd\*(rq

-operation in the shell.
+operation in the shell.)

 .PP
 .PP

-If the specified (or default) folder doesn't exist, the default action
-is to query the user as to whether the folder should be created; when
-standard input is not a tty, the answer to the query is assumed to be
+If the specified (or default) folder doesn't exist,
+.B folder
+will ask the user if the folder should be created; when
+standard input is not a tty, the answer is assumed to be

 \*(lqyes\*(rq.
 \*(lqyes\*(rq.

-.PP
-Specifying
+The

 .B \-create
 .B \-create

-will cause
+switch tells

 .B folder
 .B folder

-to create new folders
-without any query.  (This is the easy way to create an empty folder for
-use later.)  Specifying
+to create new folders without query.
+(This is an easy way to create an empty folder for later use.)
+Specifying

 .B \-nocreate
 will cause
 .B folder
 .B \-nocreate
 will cause
 .B folder

-to exit
-without creating a non-existant folder.
+to print an error message and exit without creating a folder.

 .\"
 .\" note - this doesn't work at present
 .\"
 .\" note - this doesn't work at present

-.\" If `\-noprint' is specified, 
+.\" If `\-noprint' is specified,

 .\" a `+folder' and/or `msg' may still be specified
 .\" to set the current folder and/or message,
 .\" but the folder summary will not be printed.
 .\" a `+folder' and/or `msg' may still be specified
 .\" to set the current folder and/or message,
 .\" but the folder summary will not be printed.

-

 .SS "Multiple Folders"
 Specifying
 .B \-all
 .SS "Multiple Folders"
 Specifying
 .B \-all

-will produce a summary line for each top-level folder
-in the user's nmh directory, sorted alphabetically.  (If
+will produce a summary line for each top-level folder in the user's
+.B nmh
+directory, sorted alphabetically.  (If

 .B folder
 is invoked by a name ending with \*(lqs\*(rq (e.g.
 .BR folders ),
 .B \-all
 .B folder
 is invoked by a name ending with \*(lqs\*(rq (e.g.
 .BR folders ),
 .B \-all

-is assumed).  Specifying
+is assumed.)  Specifying

 .B \-recurse
 with
 .B \-all
 .B \-recurse
 with
 .B \-all

-will also
-produce a line for all sub-folders.  These folders are all preceded by
-the read\-only folders, which occur as
+will include a line for all sub-folders.
+These folders are all preceded by any read-only folders, which occur as

 .RI \*(lq atr\-cur\- \*(rq
 entries in the user's
 .B nmh
 .RI \*(lq atr\-cur\- \*(rq
 entries in the user's
 .B nmh


@@ -123,7 +114,6 @@ mh  has \076 messages       (15\-\076);     cur=70.
 notes  has \0\02 messages      (\01\-\0\02);   cur=\01.
 ucom   has 124 messages        (\01\-124);     cur=\06; (others).
 .ta \w'/rnd/phyl/Mail/EP has 'u
 notes  has \0\02 messages      (\01\-\0\02);   cur=\01.
 ucom   has 124 messages        (\01\-124);     cur=\06; (others).
 .ta \w'/rnd/phyl/Mail/EP has 'u

-

 TOTAL = 339 messages in 7 folders
 .fi
 .RE
 TOTAL = 339 messages in 7 folders
 .fi
 .RE


@@ -133,67 +123,72 @@ The \*(lq+\*(rq after
 indicates that it is the current folder.
 The \*(lq(others)\*(rq indicates that the folder
 .I ucom
 indicates that it is the current folder.
 The \*(lq(others)\*(rq indicates that the folder
 .I ucom

-has files which
-aren't messages.  These files may either be sub\-folders, or files that
-don't belong under the nmh file naming scheme.
+contains files which aren't messages;
+these may either be sub-folders, or files that
+don't belong under the
+.B nmh
+file naming scheme.

 .PP
 .PP

-The header is output if either a
+The header is output if either the

 .B \-all
 .B \-all

-or a
+or

 .B \-header
 .B \-header

-switch is specified.  It is suppressed by
+switches are specified.  It is suppressed by

 .BR \-noheader .
 .PP
 .BR \-noheader .
 .PP

-The folder and message totals are output if either a
+The folder and message totals are output if either the

 .B \-all
 .B \-all

-or a
+or

 .B \-total
 .B \-total

-switch is specified.  It is suppressed by
+switches are specified.  They are suppressed by

 .BR \-nototal .
 .PP
 If
 .B \-fast
 .BR \-nototal .
 .PP
 If
 .B \-fast

-is given, only the folder name (or names in the case of
+is given, only the folder name (or names, in the case of

 .BR \-all )
 .BR \-all )

-will be listed.  (This is faster because the folders need not
-be read.)
+will be listed.
+(This is faster because the folders need not be read.)

 .PP
 If a
 .I +folder
 .PP
 If a
 .I +folder

-is given along with the
+is given with the

 .B \-all
 switch,
 .B folder
 .B \-all
 switch,
 .B folder

-will, in addition to setting the current folder, list the top\-level subfolders
-for the current folder (with
+will, in addition to setting the current folder, list the top-level
+sub-folders for the current folder (with

 .BR \-norecurse )
 or list all sub-folders under the current folder recursively (with
 .BR \-recurse ).
 .BR \-norecurse )
 or list all sub-folders under the current folder recursively (with
 .BR \-recurse ).

-In this case, if a
+.PP
+If

 .I msg
 .I msg

-is also supplied, it will become the current message of
-.IR +folder .
+is supplied, together with
+.I +folder
+or without
+.BR \-all ,
+it will become the current message of
+.I +folder
+(if it had been supplied)
+or the current folder.

 .PP
 The
 .B \-recurse
 .PP
 The
 .B \-recurse

-switch lists each folder recursively, so use of this
-option effectively defeats the speed enhancement of the
-.B \-fast
-option,
-since each folder must be searched for subfolders.  Nevertheless, the
-combination of these options is useful.
-.PP
+switch lists each folder recursively, so its use effectively
+defeats the speed enhancement of
+.BR \-fast ,
+since each folder must be searched for sub-folders.
+Nevertheless, the combination of these options is useful.

 .SS "Compacting a Folder"
 The
 .B \-pack
 .SS "Compacting a Folder"
 The
 .B \-pack

-switch will compress the message names in the designated
-folders, removing holes in message numbering.  The
+switch will compress the message names in the designated folders,
+removing holes in message numbering.  The

 .B \-verbose
 switch directs
 .B folder
 .B \-verbose
 switch directs
 .B folder

-to tell the user the general actions that it is
-taking to compress the folder.
-.PP
+to tell the user the general actions it is taking to compress the folder.

 .SS "The Folder Stack"
 The
 .B \-push
 .SS "The Folder Stack"
 The
 .B \-push


@@ -201,14 +196,14 @@ switch directs
 .B folder
 to push the current folder
 onto the
 .B folder
 to push the current folder
 onto the

-.IR folder\-stack ,
+.IR folder-stack ,

 and make the
 .I +folder
 argument the current folder.  If
 .I +folder
 is not given, the current folder and the
 top of the
 and make the
 .I +folder
 argument the current folder.  If
 .I +folder
 is not given, the current folder and the
 top of the

-.I folder\-stack
+.I folder-stack

 are exchanged.  This corresponds to the
 \*(lqpushd\*(rq operation in the shell.
 .PP
 are exchanged.  This corresponds to the
 \*(lqpushd\*(rq operation in the shell.
 .PP


@@ -217,28 +212,27 @@ The
 switch directs
 .B folder
 to discard the top of the
 switch directs
 .B folder
 to discard the top of the

-.IR folder\-stack ,
+.IR folder-stack ,

 after setting the current folder to that value.
 No
 .I +folder
 argument is allowed.  This corresponds to the \*(lqpopd\*(rq
 operation in the shell.  The
 .B \-push
 after setting the current folder to that value.
 No
 .I +folder
 argument is allowed.  This corresponds to the \*(lqpopd\*(rq
 operation in the shell.  The
 .B \-push

-switch and the
+and

 .B \-pop
 .B \-pop

-switch
-are mutually exclusive: the last occurrence of either one overrides
-any previous occurrence of the other.  Both of these switches also set
-.B \-list
+switches are mutually exclusive: the last occurrence of either one
+overrides any previous occurrence of the other.
+The use of either of these switches also sets
+.BR \-list ,

 by default.
 .PP
 The
 .B \-list
 switch directs
 .B folder
 by default.
 .PP
 The
 .B \-list
 switch directs
 .B folder

-to list the contents of
-the
-.IR folder\-stack .
+to list the
+.IR folder-stack .

 No
 .I +folder
 argument is allowed.  After a successful
 No
 .I +folder
 argument is allowed.  After a successful


@@ -255,55 +249,77 @@ to the \*(lqdirs\*(rq operation in the shell.  The
 .BR \-pop ,
 and
 .B \-list
 .BR \-pop ,
 and
 .B \-list

-switches turn off
+switches all disable

 .BR \-print .
 .BR \-print .

-

 .SH FILES
 .SH FILES

-.fc ^ ~
-.nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
-.fi
-
+.TP 20
+$HOME/.mh_profile
+The user's profile.

 .SH "PROFILE COMPONENTS"
 .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
 .\" ^lsproc:~^Program to list the contents of a folder

-.fi
-
+.PD

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-refile(1), mhpath(1)
-
+.IR mhpath (1),
+.IR refile (1),
+.IR rmf (1)

 .SH DEFAULTS
 .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
 and/or
 .I msg
 are given, they will become the current folder and/or message.
 .SH CONTEXT
 If
 .I +folder
 and/or
 .I msg
 are given, they will become the current folder and/or message.

-

 .SH BUGS
 .SH BUGS

-There is no way to restore the default behavior 
-(to ask the user whether to create a non-existant folder)
+There is no way to restore the default behavior
+(to ask the user whether to create a non-existent folder)

 after
 .B \-create
 or
 after
 .B \-create
 or