![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to scan.rf CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [CSRG BSD Unix] / 43BSDReno / contrib / mh / conf / doc|
Return to scan.rf CVS log | Up to [CSRG BSD Unix] / 43BSDReno / contrib / mh / conf / doc |
1.1 root 1: .\" @(MHWARNING)
2: .TH SCAN 1 "April 22, 1986" MH [mh.6]
3: .UC 6
4: .SH NAME
5: scan \- produce a one line per message scan listing
6: .SH SYNOPSIS
7: .in +.5i
8: .ti -.5i
9: scan
10: \%[+folder] \%[msgs]
11: \%[\-clear] \%[\-noclear]
12: \%[\-form\ formatfile]
13: \%[\-format\ string]
14: \%[\-header] \%[\-noheader]
15: \%[\-width\ columns]
16: \%[\-help]
17: .in -.5i
18: .SH DESCRIPTION
19: \fIScan\fR produces a one\-line\-per\-message listing of the specified
20: messages.
21: Each \fIscan\fR line contains the message number (name),
22: the date, the \*(lqFrom:\*(rq field, the \*(lqSubject\*(rq field, and, if room
23: allows, some of the body of the message.
24: For example:
25:
26: .nf
27: .in +.5i
28: .ta \w'15+- 'u +\w'7/\05 'u +\w'Dcrocker 'u
29: 15+ 7/\05 Dcrocker nned\0\0\*(<<Last week I asked some of
30: 16\0- 7/\05 dcrocker message id format\0\0\*(<<I recommend
31: 18 7/\06 Obrien Re: Exit status from mkdir
32: 19 7/\07 Obrien \*(lqscan\*(rq listing format in MH
33: .re
34: .in -.5i
35: .fi
36:
37: The `+' on message 15 indicates that it is the current message.
38: The `\-' on message 16 indicates that it has been
39: replied to, as indicated by a \*(lqReplied:\*(rq component produced by
40: an `\-annotate' switch to the \fIrepl\fR command.
41:
42: If there is sufficient room left on the \fIscan\fR line after the
43: subject, the line will be filled with text from the body,
44: preceded by <<, and terminated by >> if the body is sufficiently short.
45: \fIScan\fR actually reads each of the specified
46: messages and parses them to extract the desired fields.
47: During parsing, appropriate error messages will be produced if
48: there are format errors in any of the messages.
49:
50: The `\-header' switch produces a header line prior to the \fIscan\fR
51: listing.
52: Currently,
53: the name of the folder and the current date and time are output
54: (see the \fBHISTORY\fR section for more information).
55:
56: If the `\-clear' switch is used and \fIscan's\fR output is directed to a
57: terminal,
58: then \fIscan\fR will consult the \fB$TERM\fR and \fB$TERMCAP\fR
59: envariables to determine your
60: terminal type in order to find out how to clear the screen prior to exiting.
61: If the `\-clear' switch is used and \fIscan's\fR output is not directed to
62: a terminal (e.g., a pipe or a file),
63: then \fIscan\fR will send a formfeed prior to exiting.
64:
65: For example, the command:
66:
67: .ti +.5i
68: (scan \-clear \-header; show all \-show pr \-f) | lpr
69:
70: produces a scan listing of the current folder, followed by a formfeed,
71: followed by a formatted listing of all messages in the folder, one per
72: page. Omitting `\-show\ pr\ \-f' will cause the messages to be concatenated,
73: separated by a one\-line header and two blank lines.
74:
75: If \fIscan\fR encounters a message without a \*(lqDate:\*(rq field,
76: rather than leaving that portion of the scan listing blank,
77: the date is filled\-in with the last write date of the message,
78: and post\-fixed with a `*'.
79: This is particularly handy for scanning a \fIdraft folder\fR,
80: as message drafts usually aren't allowed to have dates in them.
81:
82: To override the output format used by \fIscan\fR,
83: the `\-format\ string' or `\-format\ file' switches are used.
84: This permits individual fields of the scan listing to be extracted with ease.
85: The string is simply a format string and the file is simply a format file.
86: See \fImh\-format\fR\0(5) for the details.
87:
88: In addition to the standard escapes,
89: \fIscan\fR also recognizes the following additional escape:
90: .nf
91: .ta \w'escape 'u
92: \fIescape\fR \fIsubstitution\fR
93: body the (compressed) first part of the body
94: .re
95: .fi
96:
97: On hosts where \fIMH\fR was configured with the BERK option,
98: \fIscan\fR has two other switches: `\-reverse', and `\-noreverse'.
99: These make \fIscan\fR list the messages in reverse order.
100: In addition,
101: \fIscan\fR will update the \fIMH\fR context prior to starting the listing,
102: so interrupting a long \fIscan\fR listing preserves the new context.
103: \fIMH\fR purists hate both of these ideas.
104: .Fi
105: ^$HOME/\&.mh\(ruprofile~^The user profile
106: .Pr
107: ^Path:~^To determine the user's MH directory
108: .Ps
109: ^Alternate\-Mailboxes:~^To determine the user's mailboxes
110: .Ps
111: ^Current\-Folder:~^To find the default current folder
112: .Sa
113: inc(1), pick(1), show(1), mh\-format(5)
114: .De
115: `+folder' defaults to the folder current
116: .Ds
117: `msgs' defaults to all
118: .Ds
119: `\-format' defaulted as described above
120: .Ds
121: `\-noheader'
122: .Ds
123: `\-width' defaulted to the width of the terminal
124: .Co
125: If a folder is given, it will become the current folder.
126: .Hi
127: Prior to using the format string mechanism,
128: `\-header' used to generate a heading saying what each column in the listing
129: was.
130: Format strings prevent this from happening.
131: .Bu
132: The argument to the `\-format' switch must be interpreted as a single token
133: by the shell that invokes \fIscan\fR.
134: Therefore,
135: one must usually place the argument to this switch inside double\-quotes.
136: .En
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.