pick: add -nosequence command line switch
[mmh] / man / pick.man
1 .TH PICK %manext1% "November 6, 2012" "%nmhversion%"
2 .\"
3 .\" %nmhwarning%
4 .\"
5 .SH NAME
6 pick \- search for messages by content
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B pick
11 .RI [ +folder ]
12 .RI [ msgs ]
13 .RB [ \-and
14 \&...]
15 .RB [ \-or
16 \&...]
17 .RB [ \-not
18 \&...]
19 .RB [ \-lbrace
20 \&...
21 .BR \-rbrace ]
22 .RB [ \-\|\-component
23 .IR pattern ]
24 .RB [ \-cc
25 .IR pattern ]
26 .RB [ \-date
27 .IR pattern ]
28 .RB [ \-from
29 .IR pattern ]
30 .RB [ \-search
31 .IR pattern ]
32 .RB [ \-subject
33 .IR pattern ]
34 .RB [ \-to
35 .IR pattern ]
36 .RB [ \-after
37 .IR date ]
38 .RB [ \-before
39 .IR date ]
40 .RB [ \-datefield
41 .IR field ]
42 .RB [ \-sequence
43 .I name
44 \&...]
45 .RB [ \-nosequence ]
46 .RB [ \-public " | " \-nopublic ]
47 .RB [ \-zero " | " \-nozero ]
48 .RB [ \-list " | " \-nolist ] 
49 .RB [ \-version ]
50 .RB [ \-help ]
51 .PP
52 typical usage:
53 .PP
54 .RS 5
55 .nf
56 scan\0`pick\0\-from\0jones`
57 pick\0\-to\0holloway\0\-sequence\0select
58 show\0`pick\0\-before\0friday`
59 .fi
60 .RE
61 .ad
62 .SH DESCRIPTION
63 .B Pick
64 searches within a folder for messages with the specified
65 contents, and then identifies those messages.  Two types of search
66 primitives are available: pattern matching and date constraint
67 operations.
68 .PP
69 A modified
70 .IR grep (1)
71 is used to perform the matching, so the
72 full regular expression (see
73 .IR ed (1))
74 facility is available
75 within
76 .IR pattern .
77 With
78 .BR \-search ,
79 .I pattern
80 is used directly, and with the others, the grep pattern constructed is:
81 .PP
82 .RS 5
83 `component[ \\t]*:\&.*pattern'
84 .RE
85 .PP
86 This means that the pattern specified for a
87 .B \-search
88 will be found
89 everywhere in the message, including the header and the body, while
90 the other pattern matching requests are limited to the single specified
91 component.  The expression
92 .PP
93 .RS 5
94 `\-\|\-component\ pattern'
95 .RE
96 .PP
97 is a shorthand for specifying
98 .PP
99 .RS 5
100 `\-search \*(lqcomponent[ \\t]*:\&.*pattern\*(rq\ '
101 .RE
102 .PP
103 It is used to pick a component which is not one of \*(lqTo:\*(rq,
104 \*(lqcc:\*(rq, \*(lqDate:\*(rq, \*(lqFrom:\*(rq, or \*(lqSubject:\*(rq.
105 An example is
106 .RB \*(lq "pick\0\-\|\-reply\-to\0pooh" \*(rq.
107 .PP
108 Pattern matching is performed on a per\-line basis.  Within the header
109 of the message, each component is treated as one long line, but in the
110 body, each line is separate.  Lower\-case letters in the search pattern
111 will match either lower or upper case in the message, while upper case
112 will match only upper case.
113 .PP
114 Note that since the
115 .B \-date
116 switch is a pattern matching operation (as
117 described above), to find messages sent on a certain date the pattern
118 string must match the text of the \*(lqDate:\*(rq field of the message.
119 .PP
120 Independent of any pattern matching operations requested, the switches
121 .B \-after
122 .I date
123 or
124 .B \-before
125 .I date
126 may also be used to introduce date/time
127 constraints on all of the messages.  By default, the \*(lqDate:\*(rq
128 field is consulted, but if another date yielding field (such as
129 \*(lqBB\-Posted:\*(rq or \*(lqDelivery\-Date:\*(rq) should be used, the
130 .B \-datefield
131 .I field
132 switch may be used.
133 .PP
134 With
135 .B \-before
136 and
137 .BR \-after ,
138 .B pick
139 will actually parse the date
140 fields in each of the messages specified in `msgs' and compare them
141 to the date/time specified.  If
142 .B \-after
143 is given, then only those
144 messages whose \*(lqDate:\*(rq field value is chronologically after the
145 date specified will be considered.  The
146 .B \-before
147 switch specifies the
148 complimentary action.
149 .PP
150 Both the
151 .B \-after
152 and
153 .B \-before
154 switches take legal 822\-style date
155 specifications as arguments.
156 .B Pick
157 will default certain missing
158 fields so that the entire date need not be specified.  These fields
159 are (in order of defaulting): timezone, time and timezone, date, date
160 and timezone.  All defaults are taken from the current date, time,
161 and timezone.
162 .PP
163 In addition to 822\-style dates,
164 .B pick
165 will also recognize any of
166 the days of the week (\*(lqsunday\*(rq, \*(lqmonday\*(rq, and so on),
167 and the special dates \*(lqtoday\*(rq, \*(lqyesterday\*(rq (24 hours
168 ago), and \*(lqtomorrow\*(rq (24 hours from now).  All days of the
169 week are judged to refer to a day in the past (e.g., telling \fIpick\fR
170 \*(lqsaturday\*(rq on a \*(lqtuesday\*(rq means \*(lqlast\ saturday\*(rq
171 not \*(lqthis\ saturday\*(rq).
172 .PP
173 Finally, in addition to these special specifications,
174 .B pick
175 will
176 also honor a specification of the form \*(lq\-dd\*(rq, which means
177 \*(lqdd days ago\*(rq.
178 .PP
179 .B Pick
180 supports complex boolean operations on the searching primitives
181 with the
182 .BR \-and ,
183 .BR \-or ,
184 .BR \-not ,
185 and
186 .B \-lbrace
187 .B \&...
188 .B \-rbrace
189 switches.
190 For example,
191 .PP
192 .RS 5
193 .nf
194 pick\0\-after\0yesterday\0\-and
195      \-lbrace\0\-from\0freida\0\-or\0\-from\0fear\0\-rbrace
196 .fi
197 .RE
198 .PP
199 identifies messages recently sent by \*(lqfrieda\*(rq or \*(lqfear\*(rq.
200 .PP
201 The matching primitives take precedence over the
202 .B \-not
203 switch, which in turn takes precedence over
204 .B \-and
205 which in turn takes precedence
206 over
207 .BR \-or .
208 To override the default precedence, the
209 .B \-lbrace
210 and
211 .B \-rbrace
212 switches are provided, which act just like opening and closing
213 parentheses in logical expressions.
214 .PP
215 If no search criteria are given, all the messages specified on the
216 command line are selected (this defaults to \*(lqall\*(rq).
217 .PP
218 Once the search has been performed, if the
219 .B \-list
220 switch is given, the
221 message numbers of the selected messages are written to the standard
222 output separated by newlines.  This is
223 .B extremely
224 useful for
225 quickly generating arguments for other
226 .B nmh
227 programs by using the
228 \*(lqbackquoting\*(rq syntax of the shell.  For example, the command
229 .PP
230 .RS 5
231 scan\0`pick\0+todo\0\-after\0\*(lq31 Mar 83 0123 PST\*(rq`
232 .RE
233 .PP
234 says to
235 .B scan
236 those messages in the indicated folder which meet the
237 appropriate criterion.  Note that since
238 .BR pick 's
239 context changes
240 are written out prior to
241 .BR scan 's
242 invocation, you need not give
243 the folder argument to
244 .B scan
245 as well.
246 .PP
247 The
248 .B \-sequence
249 .I name
250 switch may be given once for each sequence the user wishes to define.
251 For each sequence named, that sequence will be defined to mean exactly
252 those messages selected by
253 .BR pick .
254 For example,
255 .PP
256 .RS 5
257 pick\0\-from\0frated\0\-seq\0fred
258 .RE
259 .PP
260 defines a new message sequence for the current folder called
261 \*(lqfred\*(rq which contains exactly those messages that were selected.
262 .PP
263 The
264 .B \-nosequence
265 switch will disable all previously named sequences, allowing
266 those established by a profile component to be overridden.
267 .PP
268 By default,
269 .B pick
270 will zero a sequence before adding it.  This
271 action can be disabled with the
272 .B \-nozero
273 switch, which means that the
274 messages selected by
275 .B pick
276 will be added to the sequence, if it
277 already exists, and any messages already a part of that sequence will
278 remain so.
279 .PP
280 The
281 .B \-public
282 and
283 .B \-nopublic
284 switches are used by
285 .B pick
286 in the
287 same way
288 .B mark
289 uses them.
290 .SH FILES
291 .fc ^ ~
292 .nf
293 .ta \w'%etcdir%/ExtraBigFileName  'u
294 ^$HOME/\&.mh\(ruprofile~^The user profile
295 .fi
296 .SH "PROFILE COMPONENTS"
297 .fc ^ ~
298 .nf
299 .ta 2.4i
300 .ta \w'ExtraBigProfileName  'u
301 ^Path:~^To determine the user's nmh directory
302 ^Current\-Folder:~^To find the default current folder
303 .fi
304 .SH "SEE ALSO"
305 .IR mark (1)
306 .SH DEFAULTS
307 .nf
308 .RB ` +folder "' defaults to the current folder"
309 .RB ` msgs "' defaults to all"
310 .RB ` "\-datefield date" '
311 .RB ` \-zero '
312 .RB ` \-list "' is the default if no `\-sequence', `\-nolist' otherwise"
313 .fi
314 .SH CONTEXT
315 If a folder is given, it will become the current folder.
316 .SH HISTORY
317 In previous versions of
318 .BR MH ,
319 the
320 .B pick
321 command would
322 .BR show ,
323 .BR scan ,
324 or
325 .B refile
326 the selected messages.  This was rather
327 \*(lqinverted logic\*(rq from the UNIX point of view, so
328 .B pick
329 was changed to define sequences and output those sequences.  Hence,
330 .B pick
331 can be used to generate the arguments for all other
332 .B MH
333 commands, instead of giving
334 .B pick
335 endless switches for invoking those commands
336 itself.
337 .PP
338 Also, previous versions of
339 .B pick
340 balked if you didn't specify
341 a search string or a date/time constraint.  The current version does
342 not, and merely matches the messages you specify.  This lets you type
343 something like:
344 .PP
345 .RS 5
346 show\0`pick\0last:20\0\-seq\0fear`
347 .RE
348 .PP
349 instead of typing
350 .PP
351 .RS 5
352 .nf
353 mark\0\-add\0\-nozero\0\-seq\0fear\0last:20
354 show\0fear
355 .fi
356 .RE
357 .PP
358 Finally, timezones used to be ignored when comparing dates: they aren't
359 any more.
360 .SH "HELPFUL HINTS"
361 Use
362 .RB \*(lq "pick sequence \-list" \*(rq
363 to enumerate the messages in a sequence
364 (such as for use by a shell script).
365 .SH BUGS
366 Any occurrence of
367 .B \-datefield
368 must occur prior to the
369 .B \-after
370 or
371 .B \-before
372 switch it applies to.
373 .PP
374 If
375 .B pick
376 is used in a backquoted operation, such as
377 .PP
378 .RS 5
379 scan\0`pick\0\-from\0jones`
380 .RE
381 .PP
382 and
383 .B pick
384 selects no messages (e.g., no messages are from
385 \*(lqjones\*(rq), then the shell will still run the outer command (e.g.,
386 .BR scan ).
387 Since no messages were matched,
388 .B pick
389 produced
390 no output, and the argument given to the outer command as a result of
391 backquoting
392 .B pick
393 is empty.  In the case of
394 .B nmh
395 programs,
396 the outer command now acts as if the default `msg' or `msgs' should be
397 used (e.g., \*(lqall\*(rq in the case of
398 .BR scan ).
399 To prevent this
400 unexpected behavior, if
401 .B \-list
402 was given, and if its standard output is not a tty, then
403 .B pick
404 outputs the illegal message number \*(lq0\*(rq
405 when it fails.  This lets the outer command fail gracefully as well.
406 .PP
407 The pattern syntax \*(lq[l-r]\*(rq is not supported; each letter to be
408 matched must be included within the square brackets.