Return to folder.me CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / mh / doc

Annotation of 43BSDReno/contrib/mh/doc/folder.me, revision 1.1

1.1     ! root        1: .\"    This file is automatically generated.  Do not edit!
        !             2: .TH FOLDER 1 "April 22, 1986" MH [mh.6]
        !             3: .UC 6
        !             4: .SH NAME
        !             5: folder, folders \- set/list current folder/message
        !             6: .SH SYNOPSIS
        !             7: .in +.5i
        !             8: .ti -.5i
        !             9: folder
        !            10: \%[+folder] \%[msg]
        !            11: \%[\-all]
        !            12: \%[\-fast] \%[\-nofast]
        !            13: \%[\-header] \%[\-noheader]
        !            14: \%[\-pack] \%[\-nopack]
        !            15: \%[\-recurse] \%[\-norecurse]
        !            16: \%[\-total] \%[\-nototal]
        !            17: \%[\-print] \%[\-noprint]
        !            18: \%[\-list] \%[\-nolist]
        !            19: \%[\-push] \%[\-pop]
        !            20: \%[\-help]
        !            21: 
        !            22: .ti .5i
        !            23: folders
        !            24: .in -.5i
        !            25: .SH DESCRIPTION
        !            26: Since the \fIMH\fR environment is the shell, it is easy to lose
        !            27: track of the current folder from day to day.
        !            28: 
        !            29: When \fIfolder\fR is given the `\-print' switch (the default),
        !            30: the current folder and/or message may be set,
        !            31: or all folders may be listed.
        !            32: When a `+folder' argument is given,
        !            33: this corresponds to a \*(lqcd\*(rq operation in the \fICShell\fR;
        !            34: when no `+folder' argument is given,
        !            35: this corresponds roughly to a \*(lqpwd\*(rq operation in the \fICShell\fR.
        !            36: 
        !            37: \fIFolder\fR will
        !            38: list the current folder, the number of messages in it, the
        !            39: range of the messages (low\-high), and the current message within
        !            40: the folder, and will flag extra files if they exist.
        !            41: An example of the output is:
        !            42: 
        !            43: .nf
        !            44: .if t .in +.5i
        !            45: .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
        !            46: inbox+ has \016 messages       (\0\03\-\022);  cur=\0\05.
        !            47: .re
        !            48: .if t .in -.5i
        !            49: .fi
        !            50: 
        !            51: If a `+folder' and/or `msg' are specified, they will
        !            52: become the current folder and/or message.
        !            53: Specifying `\-all'
        !            54: will produce a line for each folder in the user's MH directory,
        !            55: sorted alphabetically.
        !            56: These folders are preceded by the read\-only folders,
        !            57: which occur as \*(lqatr\-cur\-\*(rq entries in the user's \fIMH\fR context.
        !            58: For example,
        !            59: 
        !            60: .nf
        !            61: .if t .in +.5i
        !            62: .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
        !            63: Folder \0\0\0# of messages     (\0range\0)     cur msg (other files)
        !            64: /fsd/rs/m/tacc has \035 messages       (\0\01\-\035);  cur=\023.
        !            65: /rnd/phyl/Mail/EP      has \082 messages       (\0\01\-108);   cur=\082.
        !            66: ff     has \0no messages.
        !            67: inbox+ has \016 messages       (\0\03\-\022);  cur=\0\05.
        !            68: mh     has \076 messages       (\0\01\-\076);  cur=\070.
        !            69: notes  has \0\02 messages      (\0\01\-\0\02); cur=\0\01.
        !            70: ucom   has 124 messages        (\0\01\-124);   cur=\0\06; (others).
        !            71: .ta \w'/rnd/phyl/Mail/EP has 'u
        !            72: \0\0\0\0\0\0\0\0\0\0TOTAL=     339 messages in 7 folders
        !            73: .re
        !            74: .if t .in -.5i
        !            75: .fi
        !            76: 
        !            77: The \*(lq+\*(rq after inbox indicates that it is the current folder.
        !            78: The \*(lq(others)\*(rq indicates that the folder `ucom' has files
        !            79: which aren't messages.
        !            80: These files may either be sub\-folders,
        !            81: or files that don't belong under the MH file naming scheme.
        !            82: 
        !            83: The header is output if either an `\-all' or a `\-header' switch
        !            84: is specified; it is suppressed by `\-noheader'.
        !            85: Also, if \fIfolder\fR
        !            86: is invoked by a name ending with \*(lqs\*(rq (e.g., \fIfolders\fR\0),
        !            87: `\-all' is assumed.
        !            88: A `\-total' switch will produce only the
        !            89: summary line.
        !            90: 
        !            91: If a `+folder' and/or `msg' is given along with the `\-all' switch,
        !            92: \fIfolder\fR will,
        !            93: in addition to setting the current folder and/or message,
        !            94: list the top\-level folders for the current folder (with `\-norecurse')
        !            95: or list all folders under the current folder recursively (with `\-recurse').
        !            96: 
        !            97: If `\-fast' is given, only the folder name (or names in the
        !            98: case of `\-all') will be listed.
        !            99: (This is faster because the
        !           100: folders need not be read.)
        !           101: 
        !           102: The `\-pack' switch will compress the message names in a folder, removing
        !           103: holes in message numbering.
        !           104: 
        !           105: The `\-recurse' switch will list each folder recursively.
        !           106: Use of this option effectively defeats the speed enhancement of the `\-fast'
        !           107: option,
        !           108: since each folder must be searched for subfolders.
        !           109: Nevertheless, the combination of these options is useful.
        !           110: 
        !           111: If the specified (or default) folder doesn't exist,
        !           112: the user will be queried if the folder should be created.
        !           113: (This is the easy way to create an empty folder for use later.)
        !           114: 
        !           115: The `\-push' switch directs \fIfolder\fR to push the current folder onto the
        !           116: \fIfolder\-stack\fR,
        !           117: and make the `+folder' argument the current folder.
        !           118: If `+folder' is not given,
        !           119: the current folder and the top of the \fIfolder\-stack\fR are exchanged.
        !           120: This corresponds to the \*(lqpushd\*(rq operation in the \fICShell\fR.
        !           121: 
        !           122: The `\-pop' switch directs \fIfolder\fR to discard the top of the
        !           123: \fIfolder\-stack\fR,
        !           124: after setting the current folder to that value.
        !           125: No `+folder' argument is allowed.
        !           126: This corresponds to the \*(lqpopd\*(rq operation in the \fICShell\fR.
        !           127: The `\-push' switch and the `\-pop' switch are mutually exclusive:
        !           128: the last occurrence of either one overrides any previous occurrence of the
        !           129: other.
        !           130: 
        !           131: The `\-list' switch directs \fIfolder\fR to list the contents of the
        !           132: \fIfolder\-stack\fR.
        !           133: No `+folder' argument is allowed.
        !           134: After a successful `\-push' or `\-pop', the `\-list' action is taken.
        !           135: This corresponds to the \*(lqdirs\*(rq operation in the \fICShell\fR.
        !           136: .Fi
        !           137: ^$HOME/\&.mh\(ruprofile~^The user profile
        !           138: .Pr
        !           139: ^Path:~^To determine the user's MH directory
        !           140: .Ps
        !           141: ^Current\-Folder:~^To find the default current folder
        !           142: .Ps
        !           143: ^Folder\-Protect:~^To set mode when creating a new folder
        !           144: .Ps
        !           145: ^Folder\-Stack:~^To determine the folder stack
        !           146: .Ps
        !           147: ^lsproc:~^Program to list the contents of a folder
        !           148: .Sa
        !           149: refile(1), mhpath(1)
        !           150: .De
        !           151: `+folder' defaults to the current folder
        !           152: .Ds
        !           153: `msg' defaults to none
        !           154: .Ds
        !           155: `\-nofast'
        !           156: .Ds
        !           157: `\-noheader'
        !           158: .Ds
        !           159: `\-nototal'
        !           160: .Ds
        !           161: `\-nopack'
        !           162: .Ds
        !           163: `\-norecurse'
        !           164: .Ds
        !           165: `\-print' is the default if no `\-list', `\-push', or `\-pop' is specified
        !           166: .Co
        !           167: If `+folder' and/or `msg' are given, they will become the
        !           168: current folder and/or message.
        !           169: .Hi
        !           170: In previous versions of \fIMH\fR,
        !           171: the `\-fast' switch prevented context changes from
        !           172: occurring for the current folder.
        !           173: This is no longer the case: if `+folder' is given,
        !           174: then \fIfolder\fR will always change the current folder to that.
        !           175: .En

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.