X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/1b5a1bd2244d3e1c12b7c9e1f48e445de5ad2ea2..1af5da59464f700ce154b26d88a402e3c51301e8:/man/folder.man diff --git a/man/folder.man b/man/folder.man index deded862..4a75b6ec 100644 --- a/man/folder.man +++ b/man/folder.man @@ -1,16 +1,17 @@ +.TH FOLDER %manext1% "August 29, 2016" "%nmhversion%" .\" .\" %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 +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] -.RI [ msgs ] +.RI [ msg ] .RB [ \-all " | " \-noall ] .RB [ \-create " | " \-nocreate ] .RB [ \-fast " | " \-nofast ] @@ -22,8 +23,6 @@ folder, folders \- set/list current folder/message .RB [ \-pack " | " \-nopack ] .RB [ \-print ] .RB [ \-verbose " | " \-noverbose ] -.RB [ \-version ] -.RB [ \-help ] .PP .HP 5 .B folders @@ -81,16 +80,14 @@ use later.) Specifying .B \-nocreate will cause .B folder -to exit -without creating a non-existant folder. +to print an error message and exit +without creating a non-existent folder. .\" .\" note - this doesn't work at present .\" 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. - -.SS "Multiple Folders" +.\" but the folder summary will not be printed..SS "Multiple Folders" Specifying .B \-all will produce a summary line for each top-level folder @@ -123,7 +120,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 - TOTAL = 339 messages in 7 folders .fi .RE @@ -169,10 +165,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 @@ -257,53 +260,75 @@ and .B \-list 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" -refile(1), mhpath(1) - +.IR mhpath (1), +.IR refile (1), +.IR rmf (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 and/or .I msg are given, they will become the current folder and/or message. - .SH BUGS There is no way to restore the default behavior -(to ask the user whether to create a non-existant folder) +(to ask the user whether to create a non-existent folder) after .B \-create or