diplodocus.org Git - nmh/blob - docs/historical/mh-jun-1982/man/scan.1

   1 .TH SCAN 1 RAND
   2 .SH NAME
   3 scan \- produce a one-line-per-message scan listing
   4 .SH SYNOPSIS
   5 scan \%[+folder] \%[msgs] \%[\-f\&f] \%[\-header] \%[\-help]
   6 \%[\-nof\&f] \%[\-noheader] \%[\-time] \%[\-notime] \%[\-numdate] \%[\-nonumdate]
   7 .SH DESCRIPTION
   8 \fIScan\fR produces a one-line-per-message listing of the specified
   9 messages.
  10 Each \fIscan\fR line contains the message number (name),
  11 the date, the ``From'' field, the \*(lqSubject'' field, and, if room
  12 allows, some of the body of the message.
  13 For example:
  14
  15 .nf
  16 .ta .5i 1.2i 2.6i
  17  #      Date      From  Subject\ \ \ \ \[\*(<<Body]
  18 15+     7/\05   dcrocker        nned  <<Last week I asked some of
  19 16\ \-  7/\05   dcrocker        message id format  <<I recommend
  20 18      7/\06   Obrien  Re: Exit status from mkdir
  21 19      7/\07   Obrien  "scan" listing format in MH
  22 20   7/\07   phyl \    \   \  Short  <<message >>
  23 .re
  24 .fi
  25
  26 The `+' on message 15 indicates that it is the current message.
  27 The `\-' on message 16 indicates that it has been
  28 replied to, as indicated by a ``Replied:'' component produced by
  29 an `\-annotate' switch to the \fIrepl\fR command.
  30
  31 If there is sufficient room left on the \fIscan\fR line after the
  32 subject, the line will be filled with text from the body,
  33 preceded by <<, and terminated by >> if the body is sufficiently short.
  34 \fIScan\fR actually reads each of the specified
  35 messages and parses them to extract the desired fields.
  36 During parsing, appropriate error messages will be produced if
  37 there are format errors in any of the messages.
  38
  39 The `\-header' switch produces a header line prior to the \fIscan\fR
  40 listing, and the `\-f\&f' switch will cause a form feed to be
  41 output at the end of the \fIscan\fR listing.
  42 .PP
  43 Example:
  44
  45 The command:  (scan -ff -header; show all -pr -f) | print
  46
  47 produces a scan listing of the current folder, followed by a form feed,
  48 followed by a formatted listing of all messages in the folder, one per
  49 page.  Omitting "-pr -f" will cause the messages to be concatenated,
  50 separated by a one-line header and two blank lines.
  51
  52 If the `\-time' switch is selected, the time of the message is shown
  53 after the date.
  54 If the `\-numdate' switch is selected,
  55 the date (and time if `\-time' is selected) of the message
  56 is shown as one long number made up of year, month, day, hour, minute.
  57 This is useful for sorting messages in a folder.
  58 .PP
  59 Example:
  60
  61 162+ 8202192032 Dave-Yost         mh distrib  <<is almost done.
  62
  63 .SH FILES
  64 .ta 2.4i
  65 $HOME/\*.mh\(ruprofile  The user profile
  66 .SH PROFILE COMPONENTS
  67 Path:   To determine the user's MH directory
  68 .br
  69 Current-Folder: To find the default current folder
  70 .SH SEE ALSO
  71 inc(1), show(1)
  72 .SH DEFAULTS
  73 .br
  74 `+folder' defaults to current
  75 .br
  76 `msgs' defaults to all
  77 .br
  78 `\-nof\&f'
  79 .br
  80 `\-noheader'
  81 .br
  82 `\-notime'
  83 .br
  84 `\-nonumdate'
  85 .SH CONTEXT
  86 If a folder is given, it will become current.
  87 The current
  88 message is unaffected.
  89 .SH BUGS
  90 The `\-numdate' option ignores timezones.