Updated all man pages and renamed install-mh.man to mmh.man.
[mmh] / man / folder.man
index 5444581..4858486 100644 (file)
@@ -1,15 +1,15 @@
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
 .TH FOLDER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 folder, folders \- set/list current folder/message
 .SH SYNOPSIS
 .HP 5
+.na
 .B folder
 .RI [ +folder ]
-.RI [ msgs ]
+.RI [ msg ]
 .RB [ \-all " | " \-noall ]
 .RB [ \-create " | " \-nocreate ]
 .RB [ \-fast " | " \-nofast ]
@@ -24,11 +24,12 @@ folder, folders \- set/list current folder/message
 .RB [ \-version ]
 .RB [ \-help ]
 .PP
-.HP
+.HP 5
 .B folders
 is equivalent to
 .B folder
 .B \-all
+.ad
 .SH DESCRIPTION
 Since the
 .B nmh
@@ -83,7 +84,7 @@ to exit
 without creating a non-existant folder.
 .\"
 .\" 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.
@@ -92,7 +93,7 @@ without creating a non-existant folder.
 Specifying
 .B \-all
 will produce a summary line for each top-level folder
-in the user's nmh directory, sorted alphabetically.  (If
+in the user's mmh directory, sorted alphabetically.  (If
 .B folder
 is invoked by a name ending with \*(lqs\*(rq (e.g.
 .BR folders ),
@@ -106,7 +107,7 @@ produce a line for all sub-folders.  These folders are all preceded by
 the read\-only folders, which occur as
 .RI \*(lq atr\-cur\- \*(rq
 entries in the user's
-.B nmh
+.B mmh
 context.  For example:
 .PP
 .RS 5
@@ -167,10 +168,17 @@ for the current folder (with
 .BR \-norecurse )
 or list all sub-folders under the current folder recursively (with
 .BR \-recurse ).
-In this case, if a
+.PP
+If
 .I msg
-is also supplied, it will become the current message of
-.IR +folder .
+is supplied, together with
+.IR +folder
+or without
+.BR \-all ,
+it will become the current message of
+.IR +folder
+(if it had been supplied)
+or the current folder.
 .PP
 The
 .B \-recurse
@@ -259,24 +267,26 @@ switches turn off
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^$HOME/.mmh/profile~^The user profile
+.fi
 
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .ta 2.4i
 .ta \w'ExtraBigProfileName  'u
-^Path:~^To determine the user's nmh directory
+^Path:~^To determine the user's mail storage
 ^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
 .\" ^lsproc:~^Program to list the contents of a folder
+.fi
 
 .SH "SEE ALSO"
 refile(1), mhpath(1)
 
-.SH "DEFAULTS"
+.SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msg "' defaults to none"
@@ -288,6 +298,7 @@ refile(1), mhpath(1)
 .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
 
 .SH CONTEXT
 If
@@ -297,7 +308,7 @@ and/or
 are given, they will become the current folder and/or message.
 
 .SH BUGS
-There is no way to restore the default behavior 
+There is no way to restore the default behavior
 (to ask the user whether to create a non-existant folder)
 after
 .B \-create