diplodocus.org Git - nmh/blob - docs/historical/mh-nov-1983/man/folder.1

   1 .TH FOLDER 1 "3 August 1983"
   2 .UC 4
   3 .SH NAME
   4 folder \- set/list current folder/message
   5 .SH SYNOPSIS
   6 .B folder
   7 [ +folder ] [ msg ] [ \-all ] [ \-fast ] [ \-nofast ] [ \-up ] [ \-down ]
   8 [ \-header ] [ \-noheader ] [ \-total ] [ \-nototal ] [ \-pack ] [ \-nopack ]
   9 [ \-help ]
  10 .PP
  11 folders  <equivalent to 'folder \-all'>
  12 .SH DESCRIPTION
  13 Since the MH environment is the shell, it is easy to lose
  14 track of the current folder from day to day.
  15 \fIFolder\fR will
  16 list the current folder, the number of messages in it, the
  17 range of the messages (low-high), and the current message within
  18 the folder, and will flag a selection list or extra files if they
  19 exist.
  20 An example of the output is:
  21 .nf
  22
  23       inbox+ has 16 messages ( 3\- 22); cur= 5.
  24
  25 .fi
  26 If a `+folder' and/or `msg' are specified, they will
  27 become the current folder and/or message.
  28 An `\-all' switch
  29 will produce a line for each folder in the user's MH directory,
  30 sorted alphabetically.
  31 These folders are preceded by the read-only
  32 folders, which occur as \*.mh\(ruprofile \*(lqcur\-\*(rq entries.
  33 For example,
  34 .nf
  35
  36 .fc ^ ~
  37 .ta 1.5i 2.1i 2.7i 3.5i
  38 ^~Folder\ \ ^^~#\ of\ ^^messages~^^(~\ range\~ );\ ^cur msg (other files)
  39 ^~/fsd/rs/m/tacc\ \ ^^has~35\ ^^messages~^^(~1\-\035);\ ^cur=\ 23.
  40 ^~/rnd/phyl/Mail/EP\ \ ^^has~82\ ^^messages~^^(~1\-108);\ ^cur=\ 82.
  41 ^~f\&f\ \ ^^has~4\ ^^messages~^^(~1\-\0\04);\ ^cur=\ \01.
  42 ^~inbox+\ ^^has~16\ ^^messages~^^(~3\-\022);\ ^cur=\ \05.
  43 ^~mh\ \ ^^has~76\ ^^messages~^^(~1\-\076);\ ^cur=\ 70.
  44 ^~notes\ \ ^^has~2\ ^^messages~^^(~1\-\0\02);\ ^cur=\ \01.
  45 ^~ucom\ \ ^^has~124\ ^^messages~^^(~1\-124);\ ^cur=\ \06; (select).
  46
  47 ^^^~TOTAL=\0339\ ^messages\0in\0\07\0Folders.
  48 .re
  49 .fi
  50 .PP
  51 The \*(lq+\*(rq after inbox indicates that it is the current folder.
  52 The \*(lq(select)\*(rq indicates that the folder ucom has a selection
  53 list produced by \fIpick\fR.
  54 If \*(lqothers\*(rq had appeared in parentheses at
  55 the right of a line, it would indicate that there are files in
  56 the folder directory that don't belong under the MH file naming
  57 scheme.
  58 .PP
  59 The header is output if either an `\-all' or a `\-header' switch
  60 is specified; it is suppressed by `\-noheader'.
  61 Also, if \fIfolder\fR
  62 is invoked by a name ending with \*(lqs\*(rq (e.g., \fIfolders\fR),
  63 `\-all' is assumed.
  64 A `\-total' switch will produce only the
  65 summary line.
  66 .PP
  67 If `\-fast' is given, only the folder name (or names in the
  68 case of `\-all') will be listed.
  69 (This is faster because the
  70 folders need not be read.)
  71 .PP
  72 The switches `\-up' and `\-down' change the folder to be the
  73 one above or below the current folder.
  74 That is, \*(lqfolder \-down\*(rq
  75 will set the folder to \*(lq<current\-folder>/select\*(rq, and if the
  76 current folder is a selection-list folder, \*(lqfolder \-up\*(rq will
  77 set the current folder to the parent of the selection-list.
  78 (See \fIpick\fR for details on selection-lists.)
  79 .PP
  80 The `\-pack' switch will compress the message names in a folder, removing
  81 holes in message numbering.
  82 .SH FILES
  83 .nf
  84 .ta \w'$HOME/\*.mh\(ruprofile    'u
  85 $HOME/\*.mh\(ruprofile  The user profile
  86 /bin/ls To fast-list the folders
  87 .fi
  88 .SH "PROFILE COMPONENTS"
  89 .nf
  90 .ta \w'Current-Folder:    'u
  91 Path:   To determine the user's MH directory
  92 Current-Folder: To find the default current folder
  93 .fi
  94 .SH DEFAULTS
  95 .nf
  96 `+folder' defaults to the current folder
  97 `msg' defaults to none
  98 `\-nofast'
  99 `\-noheader'
 100 `\-nototal'
 101 `\-nopack'
 102 .fi
 103 .SH CONTEXT
 104 If `+folder' and/or `msg' are given, they will become the
 105 current folder and/or message.