1
<HTML><HEAD><TITLE>Pine Technical Notes: Configuration and Preferences</TITLE></HEAD><BODY>
2
<H1>Configuration and Preferences</H1>
4
<H2><A NAME="pine-conf">Pine Configuration</A></H2>
6
There is very little in <EM>Pine</EM> which <STRONG>requires</STRONG> compile-time
7
configuration. In most cases, the compiled-in preferences will suit users
8
and administrators just fine. When running <EM>Pine</EM> on a UNIX system, the
9
default built-in configuration can be changed by setting variables in the
10
system configuration files, <CODE>/usr/local/lib/pine.conf</CODE>
11
or <CODE>/usr/local/lib/pine.conf.fixed</CODE>.
12
(Actually, these files are whatever the definitions for
13
<CODE>SYSTEM_PINERC</CODE> and <CODE>SYSTEM_PINERC_FIXED</CODE>
14
in pine/osdep/os-xxx.h are set to.)
15
The location of the pine.conf file can be changed with the -P command line
18
and <EM>PC-Pine</EM> also use personal (user-based) configuration files.
19
On UNIX machines, the personal configuration file is the
20
file <CODE>~/.pinerc</CODE>.
21
For <EM>PC-Pine</EM> systems, the personal configuration file is in
22
<CODE>$PINERC</CODE> or <CODE><PineRC registry value></CODE> or
23
<CODE>${HOME}\PINE\PINERC</CODE> or
24
<CODE><PINE.EXE </CODE>dir<CODE>>\PINERC</CODE>.
25
Or the personal configuration file can be specified with the -p command
28
After the personal configuration, <EM>Pine</EM> may optionally use
29
a personal exceptions configuration file which is specified with the
30
command line option "-x exceptions_config".
31
"Exceptions_config" may be either a local file or a remote
33
For Unix <EM>Pine</EM>, if you don't have a "-x" command line option,
34
<EM>Pine</EM> will look for the file "<CODE>.pinercex</CODE>"
35
in the same local directory that the regular config file is located in.
36
If the regular config file is remote then Unix <EM>Pine</EM> looks in the home
37
directory for "<CODE>.pinercex</CODE>".
39
For <EM>PC-Pine</EM>, if you don't have a "-x" command line option,
40
<EM>PC-Pine</EM> will use the value of the
41
environment variable <CODE>$PINERCEX</CODE>.
42
If that is not set, <EM>PC-Pine</EM> will look for
43
the local file "<CODE>PINERCEX</CODE>"
44
in the same local directory that the regular config file is located in.
45
If the regular config file is remote then <EM>PC-Pine</EM> looks in the
46
local directory specfied by the "-aux local_directory" command
47
line argument, or the directory <CODE>${HOME}\PINE</CODE>, or
48
in <CODE><PINE.EXE </CODE>directory<CODE>></CODE>.
51
The syntax of a non-list configuration variable is this:
54
<variable> = <value><BR>
57
If the value is absent then the variable is unset. To set a variable to
58
the empty value the syntax is "". This is equivalent to an absent value
59
except that it overrides any system-wide value that may be set. Quotes
60
may be used around any value. All values are strings and end at the end
61
of the line or the closing quote. Leading and trailing space is ignored
62
unless it is included in the quotes. There is one variable,
63
<EM>use-only-domain-name</EM>, for which the only
64
appropriate values are <EM>yes</EM> and <EM>no</EM>. That's because it is
65
a variable from the early days of <EM>Pine</EM> before features existed.
69
second type of variable, lists. A list is a comma-separated list of
70
values. The syntax for a list is:
73
<variable> = <value> [, <value> , ... ]<BR>
76
A list can be continued on subsequent lines by beginning the line with
77
white-space. Both the per-user and global configuration files may contain
78
comments which are lines beginning with a <CODE>#.</CODE> <P>
80
For UNIX <EM>Pine</EM>, there are five ways in which each variable can be set.
81
In decreasing order of precedence they are:
85
<LI> the system-wide <EM>fixed</EM> configuration file
87
<LI> a command line argument
89
<LI> the personal exceptions file
91
<LI> the personal configuration file
93
<LI> the system-wide configuration file.
97
If the variable is not set in any of those places, there is a default
98
setting in the source code.
100
So, system-wide fixed settings always take precedence over command line
101
flags, which take precedence over per-user exception settings, which take precedence over per-user settings, which take precedence
102
over system-wide configuration settings.
103
<EM>PC-Pine</EM> has the same list, except that it
104
does not use a system-wide <EM>fixed</EM> configuration file.
105
This can be modified slightly by using inheritance, which is covered below.
108
You may get a sample/fresh copy of the system configuration file by
109
running <EM>Pine -conf.</EM> The result will be printed on the standard
110
output with short comments describing each variable. (The online help in
111
the Setup screens provides longer comments.) If you need to fix some
112
of the configuration variables, you would use the same template for the
113
fixed configuration file as for the regular system-wide configuration
114
file. (If it isn't clear, the purpose of the fixed configuration file is
115
to allow system administrators to restrict the configurability of <EM>Pine</EM>.
116
It is by no means a bullet-proof method.) <EM>Pine</EM> will automatically create
117
the personal configuration file the first time it is run, so there is no
118
need to generate a sample. <EM>Pine</EM> reads and writes the personal
119
configuration file occasionally during normal operation. Users will not
120
normally look at their personal configuration file, but will use the
121
Setup screens from within <EM>Pine</EM> to set the values in this file. If a
122
user does add additional comments to the personal configuration file they
126
References to environment variables may be included in the <EM>Pine</EM>
127
configuration files. The format is <CODE>$variable</CODE> or
128
<CODE>${variable}.</CODE> The character <CODE>~</CODE> will be expanded to the
129
<CODE>$HOME</CODE> environment variable.
130
For a more complete explanation of how environment variables work, see
132
<A HREF="config-notes.html#env-variables">Using Environment Variables</A>.<P>
134
When environment variables are used for <EM>Pine</EM> settings which take lists,
135
you must have an environment variable set for each member of the list.
136
That is, <EM>Pine</EM> won't properly recognize an environment variable which is
137
set equal to a comma-delimited list. It is OK to reference unset
138
environment variables in the <EM>Pine</EM> configuration file, which
139
will expand to nothing. <P>
141
<H3>Remote and Local Configuration</H3>
143
Beginning with <EM>Pine</EM> 4.30 there are two types of storage
144
for configuration information.
145
<EM>Local</EM> configuration files are used by default.
146
These are just regular files on the UNIX system or on the PC.
147
This is the only kind of configuration storage <EM>Pine</EM> used prior
149
<EM>Remote</EM> configuration folders are stored on an IMAP server.
150
The advantage of using a remote configuration is that the same information
151
may be accessed from multiple platforms.
152
For example, if you use one computer at work and another at home, the same
153
configuration could be used from both places.
154
A configuration change from one place would be seen in both places.
155
Technical information about remote configuration is in
156
<A HREF="low-level.html#remote-config"><EM>Remote Configuration</EM></A>.
158
<H3>Generic and Exceptional Configuration</H3>
160
If you use <EM>Pine</EM> from more than one platform it may be convenient
161
to split your configuration information into two pieces, a generic piece
162
and exceptions which apply to a particular platform.
163
For example, suppose you use <EM>Pine</EM> from home and from work.
164
Most of your configuration settings are probably the
165
same in both locations, so those settings belong in the generic settings
167
However, you may use a different SMTP server and INBOX
168
from home than you do from work.
169
The "smtp-server" and "inbox-path" variables could be
170
part of your exceptional configuration so that they could be different in the
173
Beginning with <EM>Pine</EM> 4.30 you can use the command line option
174
"-x config"
175
to split your configuration into generic and exceptional pieces.
176
Config may be either local or remote.
178
For most people, splitting the configuration information into two pieces is
179
only going to be useful if the generic information is accessed remotely.
180
If you already have a local pinerc file with settings you like you may find
181
that the command Setup/RemoteConfigSetup will be useful in helping you
182
convert to a remote configuration.
183
The command line flag
184
<A HREF="cmd-line.html#copy_pinerc">copy_pinerc</A>
187
<H3>Configuration Inheritance</H3>
189
Configuration inheritance is a power user feature.
190
It is confusing and not completely supported by the configuration
193
For configuration variables which are lists, like "smtp-server" or
194
"incoming-folders",
195
the inheritance mechanism makes it possible to <EM>combine</EM>
196
the values of options from different configuration locations instead
197
of <EM>replacing</EM> the value.
198
<A HREF="config-notes.html#config-inheritance">Configuration Inheritance</A>
199
has more information about how inheritance is used.
204
<H2><A NAME="gen-conf">General Configuration Variables</A></H2>
206
The following is a list of all <EM>Pine</EM> configuration variables, in
207
alphabetical order. Note that not all variables apply to all versions of
208
<EM>Pine</EM> and that some variables are only applicable in a system configuration
209
file and some are only applicable in a personal configuration file.
210
These are configuration <EM>variables</EM>.
211
<A HREF="#features-conf">Configuration <EM>Features</EM></A>
212
are in a separate section.
217
<DT> <A NAME="addrbook-sort-rule"><EM>addrbook-sort-rule</EM></A>
219
<DD> This variable sets up the default address book sorting. Currently,
220
<EM>Pine</EM> will accept the values <EM>dont-sort</EM>,
221
<EM>fullname-with-lists-last</EM>, <EM>fullname</EM>,
222
<EM>nickname-with-lists-last</EM>, and <EM>nickname</EM>. The default is
223
to sort by fullname with lists last. <P>
225
<DT> <A NAME="pers-abook"><EM>address-book</EM></A>
227
<DD> A list of personal address books.
228
Each entry in the list is an
229
optional nickname followed by a pathname or file name relative to the home
231
The nickname is separated from the rest of the line with whitespace.
232
Instead of a local pathname or file name, a remote folder name can be given.
233
This causes the address book to
234
be a <A HREF="low-level.html#addrbook"><EM>Remote address book</EM></A>.
235
Remote folder syntax is discussed in
236
<A HREF="config-notes.html#remote-folders">Syntax for Remote Folders</A>.
237
This list of address books will be combined with the
238
<A HREF="#glob-abook"><EM>global-address-book</EM></A>
239
list to arrive at the complete set of address books. <P>
241
<DT> <A NAME="abook-formats"><EM>addressbook-formats</EM></A>
243
<DD> This option specifies the format that address books are displayed in.
244
By default, address books are displayed with the nicknames in the first
245
column, the fullnames in the second column, and addresses in the third
246
column. The system figures out reasonable defaults for the widths of the
247
columns. An address book may be given a different format by listing
248
special tokens in the order you want them to display. The possible tokens
249
are NICKNAME, FULLNAME, ADDRESS, FCC, and COMMENT. More details are included
250
in the online help for this variable. <P>
252
<DT> <A NAME="alt-addresses"><EM>alt-addresses</EM></A>
254
<DD> This option provides a place for you to list alternate email
255
addresses you may have. If set, the option affects the behavior of the
256
<EM>Reply</EM> command and the <EM>+</EM> symbol in the "Folder Index", which
257
denotes that a message has been addressed specifically to you. <P>
259
In the default INDEX display
260
the personal name (or email address) of
261
the person listed in the message's "From:" header
262
field is usually displayed except when that address is yours or one of your
264
In that case you will usually see the name of
265
the first person specified in the
266
message's "To:" header field
267
with the prefix "To: " prepended. <P>
269
With respect to <EM>Reply</EM>, the <EM>Reply to All</EM> option will
270
exclude addresses listed here. <P>
272
<DT> <A NAME="bugs-add"><EM>bugs-additional-data</EM></A>
274
<DD> System-wide configuration files only. Program/Script used by
275
<EM>Report Bug</EM> command. Output from the program/script is
276
captured and attached to the bug report. <P>
278
<DT> <A NAME="bugs"><EM>bugs-fullname</EM></A>,
279
<EM>bugs-address</EM>, <EM>local-fullname</EM>, <EM>local-address</EM>,
280
<EM>suggest-fullname</EM>, and <EM>suggest-address</EM>
282
<DD> System-wide configuration files only. These are used by the bug
283
report commands which can be accessed from some of the Help screens.
286
<DT> <A NAME="char-set"><EM>character-set</EM></A>
288
<DD> This sets the character set used by the terminal. Currently
289
appropriate values are <EM>US-ASCII</EM>,
290
<EM>ISO-8859-1</EM> through <EM>ISO-8859-9</EM> and
291
<EM>ISO-2022-JP</EM>. See the section on
292
<A HREF="low-level.html#char-set">International Character Sets</EM></A> for more
293
details. The default is <EM>US-ASCII</EM>. <P>
295
<DT> <A NAME="color-style"><EM>color-style</EM></A>
297
<DD> UNIX <EM>Pine</EM> only (color is automatically on with <EM>PC-Pine</EM>).
298
If the terminal or terminal emulator you are using is capable of displaying
299
colors, this variable controls whether or not
300
color will be used in <EM>Pine</EM>.
301
If you turn color on and things are set up correctly,
302
you should see color appear on the screen immmediately.
303
Modern terminal emulators are usually capable of displaying colors.
305
This variable may be set to any of the following values:
314
<DD>In order to decide if your terminal is capable of color,
315
<EM>Pine</EM> looks in
316
the terminal capabilities database, TERMINFO or TERMCAP, depending on
317
how <EM>Pine</EM> was compiled.
318
This is a good option to choose if you switch between a color and a non-color
319
terminal with the same <EM>Pine</EM> configuration.
320
<EM>Pine</EM> will know to use color on the color terminal because
322
in the termcap entry, and <EM>Pine</EM> will know to use black and white on the
324
<A HREF="config-notes.html#color-config-notes">Color Details</A>
325
has more information about configuring a termcap entry for color.
326
This is usually something a system administrator does.
329
<DT>force-ansi-8color</DT>
330
<DD>Because setting up a termcap entry is confusing and because the
331
terminal capabilities database is often not correctly configured for color,
332
this choice and the next may be easier for you to use.
333
If your terminal emulator responds to ANSI color escape sequences, which
334
many do, this option will
335
cause <EM>Pine</EM> to believe your terminal will respond
336
to the escape sequences which produce eight different foreground and background
338
The escape sequences used to set the foreground colors are
340
<P><CENTER>ESC [ 3 <color_number> m</CENTER><P>
342
where the color_number is an ASCII digit between 0 and 7.
343
The numbers 0 through 7 should correspond to the colors black, red, green,
344
yellow, blue, magenta, cyan, and white.
345
Some terminal emulators use a pre-ANSI scheme which swaps
346
the colors blue and red and the colors yellow and cyan.
347
This will cause the default colors to be different, but other than that
348
things should work fine.
349
The escape sequences used to set the background colors are the same
350
as for the foreground colors except a "4" replaces the "3".
352
Note: With the Tera Term terminal emulator this setting works well.
353
You should also have the Tera Term "Full color" option turned OFF.
354
You may find the "Full color" option in Tera Term's "Setup"
355
menu, in the "Window" submenu.
358
<DT>force-ansi-16color</DT>
359
<DD>Many terminal emulators know about the same eight colors above
361
This option attempts to use all 16 colors.
362
The same escape sequences as for the eight-color terminal are used
363
for the first eight colors.
364
The escape sequences used to set foreground colors 8-15 are the same as
365
for 0-7 except the "3" is replaced with a "9".
366
The background color sequences for colors 8-15 are the same as for 0-7
367
except the "4" is replaced with "10".
368
You can tell if the 16 colors are working by turning on this option
369
and then going into one of the color configuration screens, for example,
370
the configuration screen for Normal Color.
371
If you see 16 different colors to select from, it's working.
376
The normal default is "no-color".
378
Once you've turned on color you may set the
379
colors of many objects on the screen individually.
380
The <A HREF="#color-config">Color Configuration</A> section has more
381
information, or you may just try it by
382
running the "Setup" command and typing "K"
383
for Kolor to enter the color configuration screen (Kolor instead of Color
384
because C means Config).
385
Most categories of color which <EM>Pine</EM> supports are configurable there.
386
<A HREF="#index-color-config">Index line color</A> is configured separately.
388
Beginning with <EM>Pine</EM> 4.41, the default names of some colors were changed
389
in order to have better interoperability between <EM>PC-Pine</EM> and Unix
390
<EM>Pine</EM> with both eight and 16-color terminals.
391
Both <EM>PC-Pine</EM> and 8-color Unix <EM>Pine</EM> will interpret the
392
colors named color008, color009, ..., color015 as black, red, ..., white.
393
When changing a configuration color they will put the colors black, color009,
394
color010, ..., color015 into the config file.
395
That is, the colors red, green, ..., white will only appear in the config
396
file if put there manually or if they were already there from an older
397
version of <EM>Pine</EM>.
398
The reason for this is because with 16-color xterm the colors red, green, ...,
399
white are actually two-thirds intensity colors, and the colors color009,
400
color010, ..., color015 (in pine terminology) are full intensity colors
401
which better match the default eight of <EM>PC-Pine</EM> or 8-color
402
Unix terminal emulators.
403
The idea is that you can use the eight colors of an 8-color terminal on
404
a 16-color terminal and with <EM>PC-Pine</EM>.
405
Those eight colors will be about the same in all three situations.
407
In pre-4.41 <EM>PC-Pine</EM> the three default grays offered were called
408
color008, color009, and color010.
409
Since this conflicts with three of the colors on 16-color terminals these
410
three colors have been renamed colorlgr, colormgr, and colordgr.
411
<EM>PC-Pine</EM> will attempt to automatically change those color names
412
the first time you run a version higher than 4.40.
413
If that fails for some reason, you will see your old light grays displayed as
414
black, your old medium grays displayed as red,
415
and your old dark grays displayed as green.
416
You may fix these from within the <EM>PC-Pine</EM> color config screens.
417
If you then go back to running a pre-4.41 version of <EM>PC-Pine</EM> the
418
colors with the new names (colorlgr...) will show up as Normally colored
422
<DT> <A NAME="composer-wrap-column"><EM>composer-wrap-column</EM></A>
424
<DD> This option specifies an aspect of <EM>Pine</EM>'s Composer. This gives the
425
maximum width that auto-wrapped lines will have. It's also the maximum
426
width of lines justified using the ^J Justify command. The normal default
427
is <EM>74</EM>. The largest allowed setting is normally <EM>80</EM> in order to
428
prevent very long lines from being sent in outgoing mail. When the mail
429
is actually sent, trailing spaces will be stripped off of each line.
432
<DT> <A NAME="current-indexline-style"><EM>current-indexline-style</EM></A>
434
<DD> <A HREF="#cur-il-style"><EM>current-indexline-style</EM></A>.
437
<DT> <A NAME="cust-hdr"><EM>customized-hdrs</EM></A>
439
<DD> You may add your own custom headers to outgoing messages.
440
Each header you specify here must include the header tag
441
(Reply-To:, Approved:, etc.)
442
and may optionally include a value for that header.
443
If you want to see these custom headers each time you compose a message,
444
you must add them to your
445
<A HREF="#def-comp"><EM>default-composer-hdrs</EM></A> list,
446
otherwise they become part
447
of the rich header set which you only see when you press the rich header
449
(If you are looking for a way to change which headers are <EM>displayed</EM>
450
when you view a message, take a look at the
451
<A HREF="#viewer-hdrs"><EM>viewer-hdrs</EM></A>
453
Here's an example which shows how you might set your From address
455
<CENTER><SAMP>From: Full Name <user@example.com></SAMP></CENTER>
457
and another showing how you might set a Reply-To address
459
<CENTER><SAMP>Reply-To: user@example.com</SAMP></CENTER>
461
You may also set non-standard header values here.
462
For example, you could add
464
<CENTER><SAMP>Organization: My Organization Name</SAMP></CENTER>
468
<CENTER><SAMP>X-Favorite-Colors: Purple and Gold</SAMP></CENTER>
470
If you include a value after the colon then that header will be included
471
in your outgoing messages unless you delete it before sending.
472
If a header in the Customized-Headers list has only a tag but no value, then
473
it will not be included in outgoing messages unless you edit a value
477
<CENTER><SAMP>Reply-To:</SAMP></CENTER>
479
is in the list, then the Reply-To header will be available for editing
480
but won't be included unless a value is added while in the composer.
482
It's actually a little more complicated than that.
483
The values of headers that you set with the Customized-Headers option are
485
If the message you are about to compose already has a value for a header,
486
that value is used instead of a value from your Customized-Headers.
487
For example, if you are Replying to a message the Subject field
488
will already be filled in.
489
In that case, if the Customized-Headers list contains a Subject line, the
490
custom subject will <EM>NOT</EM> be used.
491
The subject derived from the subject of the message you are Replying
492
to will be used instead.
494
It is also possible to make header setting even more complicated and more
496
<A HREF="#role-config"><EM>Roles</EM></A>,
497
but if all you want to do is set a default value for a header, you don't
498
need to think about Roles.
500
If you change your From address you may also find it useful to add the
501
changed From address to the
502
<A HREF="#alt-addresses"><EM>alt-addresses</EM></A>
503
configuration option.
505
Limitation: Because commas are used to separate the list of
506
Customized-Headers, it is not possible to have the value of a
507
header contain a comma.
508
Nor is there currently an "escape" mechanism provided
512
<DT> <A NAME="dead-letter-files"><EM>dead-letter-files</EM></A>
514
<DD> This option affects <EM>Pine</EM>'s behavior when you cancel a message being
515
composed. <EM>Pine</EM>'s usual behavior is to write the canceled message to
517
"dead.letter" in your home directory, or
518
"DEADLETR" when using <EM>PC-Pine</EM>,
519
overwriting any previous message.
521
If you set this option to a value higher than one, then that many copies
522
of dead letter files will be saved.
523
For example, if you set this option to "3" then you may have
525
"DEADLETR",
526
"DEADLETR2", and
527
"DEADLETR3"; or
528
"dead.letter",
529
"dead.letter2", and
530
"dead.letter3".
531
In this example, the most recently cancelled message will be in
532
"dead.letter",
533
and the third most recently cancelled message will be in
534
"dead.letter3".
535
The fourth most recently cancelled message will no longer be saved.
538
If you set this option to zero, then NO record of canceled messages is
542
<A HREF="#quell-dead-letter-on-cancel">Quell-Dead-Letter-On-Cancel</A>
543
is set, that overrides whatever you set for this option.
544
If this option had existed at the time, then the Quell feature would not
545
have been added, but it is still there for backwards compatibility.
546
So, in order for this option to have the desired effect, make sure the
547
Quell feature is turned off.
550
<DT> <A NAME="def-comp"><EM>default-composer-hdrs</EM></A>
552
<DD> You can control which headers you want visible when composing outgoing
553
email using this option.
554
You can specify any of the regular set, any
556
or any <A HREF="#cust-hdr"><EM>Customized-Hdrs</EM></A>
557
which you have already defined.
558
If you use this setting at all, you must specify all the
559
headers you want to see, you can't just add to the regular header set.
560
The default set is To:, Cc:, Attchmnt:, and Subject:.
563
Note that the "Newsgroups:" header will be abbreviated in the Composer
564
display, but should be spelled out in full here.
567
<DT> <A NAME="def-fcc"><EM>default-fcc</EM></A>
569
<DD> The name of the folder to which all outgoing mail goes is set here.
570
The compiled-in default is <EM>sent-mail</EM> (UNIX) or <EM>sentmail</EM>
571
(PC). It can be set to "" (two double quotes with nothing between them)
572
to turn off saving copies of outgoing mail. If <EM>default-fcc</EM> is a
573
relative file name, then it is relative to your default collection for
574
saves (see <A HREF="#fold-coll"><EM>folder-collections</EM></A>). <P>
576
<DT> <A NAME="def-save"><EM>default-saved-msg-folder</EM></A>
578
<DD> This option determines the default folder name for <EM>Saves</EM>...
579
If this is not a path name, it will be in the default collection for saves.
580
Any valid folder specification, local or IMAP, is allowed. This default
581
folder only applies when the
582
<A HREF="#saved-msg-name"><EM>saved-msg-name-rule</EM></A>
584
Unix <EM>Pine</EM> default is normally
585
<EM>saved-messages</EM> in the default folder collection.
586
<EM>PC-Pine</EM> default is <EM>SAVEMAIL</EM>
587
(normally stored as <EM>SAVEMAIL.MTX</EM>). <P>
589
<DT> <A NAME="disable-setlocale-collate"><EM>disable-setlocale-collate</EM></A>
591
<DD> This is a hard to understand feature that should only be used in rare cases.
592
Normally, the C function call
594
<CENTER><SAMP>setlocale(LC_COLLATE, "")</SAMP></CENTER>
596
is used by <EM>Pine</EM>.
597
If you want to try turning it off,
598
setting this feature will turn it off.
599
This part of the locale has to do with the sort order
600
of characters in your locale.
602
<A HREF="#enable-setlocale-ctype"><EM>enable-setlocale-ctype</EM></A>.
605
<DT> <A NAME="disable-these-drivers"><EM>disable-these-drivers</EM></A>
607
<DD> This variable is a list of mail drivers which will be disabled.
608
The candidates for disabling are listed below.
609
There may be more in the future if you compile <EM>Pine</EM> with
610
a newer version of the c-client library.
627
The <EM>mbox</EM> driver enables the following behavior: if there is a
628
file called <CODE>mbox</CODE>
629
in your home directory, and if that file is either empty or in Unix mailbox
630
format, then every time you open <EM>INBOX</EM> the <EM>mbox</EM> driver
631
will automatically transfer mail from the system mail spool directory into the
632
<CODE>mbox</CODE> file and
633
delete it from the spool directory. If you disable the <EM>mbox</EM> driver,
634
this will not happen.
637
It is not recommended to disable the driver which supports the system default
638
mailbox format. On most non-SCO systems, that driver is the
639
<EM>unix</EM> driver.
640
On most SCO systems, it is the <EM>mmdf</EM> driver.
641
The system default driver may be
642
configured to something else on your system; check with your system manager
643
for additional information.
646
It is most likely not very useful for you to disable any of the drivers other
647
than possibly <EM>mbox</EM>.
648
You could disable some of the others if you know for
649
certain that you don't need them but the performance gain in doing so
653
<DT> <A NAME="disable-these-auths"><EM>disable-these-authenticators</EM></A>
655
<DD> This variable is a list of SASL (Simple Authentication and Security
656
Layer) authenticators which will be disabled.
657
SASL is a mechanism for
658
authenticating to IMAP, POP3, SMTP, and other network servers.
661
<EM>Pine</EM> matches its list of supported authenticators with the server to
662
determine the most secure authenticator that is supported by both.
663
If no matching authenticators are found, <EM>Pine</EM> will revert to plaintext
664
login (or, in the case of SMTP, will be unable to authenticate at all).
667
The candidates for disabling are listed below.
668
There may be more if you compile <EM>Pine</EM> with additional authenticators
669
and/or a newer version of the c-client library.
680
Normally, you will not disable any authenticators.
681
There are two exceptions:
685
<LI> You use a broken server that advertises an authenticator,
686
but does not actually implement it.
687
<LI> You have a Kerberos-capable version of <EM>Pine</EM> and the server is
688
also Kerberos-capable, but you can not obtain Kerberos
689
credentials on the server machine, thus you desire to disable
690
GSSAPI (which in turn disables <EM>Pine</EM>'s Kerberos support).
694
It is never necessary to disable authenticators, since <EM>Pine</EM> will try
695
other authenticators before giving up.
696
However, disabling the relevant authenticator avoids annoying error messages.
699
<DT> <A NAME="display-filters"><EM>display-filters</EM></A>
701
<DD> This option defines a list of text-filtering commands (programs or
702
scripts) that may be used to filter text portions of received messages
703
prior to their use (e.g., presentation in the "Message Text" display
704
screen). For security reasons, the full path name of the filter command
707
Display filters do not work with <EM>PC-Pine</EM>.
710
The command is executed and the message is piped into its standard input.
711
The standard output of the command is read back by <EM>Pine</EM>. The
712
<EM>_TMPFILE_</EM> token (see below) overrides this default behavior.
715
The filter's use is based on the configured <EM>trigger</EM> string. The
716
format of a filter definition is:
719
<CENTER><trigger> <command> <arguments></CENTER>
722
You can specify as many filters as you wish, separating them with a comma.
723
Each filter can have only one trigger and command. Thus, two trigger
724
strings which invoke the same command require separate filter
728
The <EM>trigger</EM> is simply text that, if found in the message,
729
will invoke the associated command. If the trigger contains any space
730
characters, it must be placed within quotes. Likewise, should you
731
wish a filter to be invoked unconditionally, define the trigger as the
732
null string, "" (two consecutive double-quote characters). If the
733
trigger string is found anywhere in the text of the message the filter
734
is invoked. Placing the trigger text within the tokens defined below
735
changes where within the text the trigger must be before considering
739
Trigger Modifying Tokens:
741
<DT><EM>_CHARSET(<VAR>string</VAR>)_</EM>
742
<DD>This token tells <EM>Pine</EM> to invoke the supplied command
743
if the text is in a character set matching <VAR>string</VAR>
744
(e.g., ISO-8859-2 or ISO-2022-JP).
746
<DT><EM>_LEADING(<VAR>string</VAR>)_</EM>
747
<DD>This token tells <EM>Pine</EM> to invoke the supplied command
748
if the enclosed <VAR>string</VAR> is found to be the first
750
<BR>NOTE: Quotes are necessary if <VAR>string</VAR> contains
753
<DT><EM>_BEGINNING(<VAR>string</VAR>)_</EM>
754
<DD>This token tells <EM>Pine</EM> to invoke the supplied command
755
if the enclosed <VAR>string</VAR> is found at the beginning
756
of any line in the text.
757
<BR>NOTE: Quotes are necessary if <VAR>string</VAR> contains
762
The "command" and "arguments" portion is simply
763
the command line to be invoked if the trigger string is found. Below
764
are tokens that <EM>Pine</EM> will recognize and replace with special values
765
when the command is actually invoked.
768
Command Modifying Tokens:
771
<DT><EM>_TMPFILE_</EM>
772
<DD>When the command is executed, this token is
773
replaced with the path and name of the temporary
774
file containing the text to be filtered. <EM>Pine</EM>
775
expects the filter to replace this data with the
778
NOTE: Use of this token implies that the text to
779
be filtered is not piped into standard input of the
780
executed command and its standard output is ignored.
781
<EM>Pine</EM> restores the tty modes before invoking the
782
filter in case the filter interacts with the user
783
via its own standard input and output.
785
<DT><EM>_RESULTFILE_</EM>
786
<DD>When the command is executed, this token is
787
replaced with the path and name of a temporary
788
file intended to contain a status message from the
789
filter. <EM>Pine</EM> displays this in the message status
792
<DT><EM>_DATAFILE_</EM>
793
<DD>When the command is executed, this token is
794
replaced with the path and name of a temporary
795
file that <EM>Pine</EM> creates once per session and deletes
796
upon exit. The file is intended to be used by the
797
filter to store state information between instances
800
<DT><EM>_PREPENDKEY_</EM>
801
<DD>When the command is executed, this token indicates that a random
802
number will be passed down the input stream before the message text.
803
This number could be used as a session key.
804
It does not appear as a command-line argument.
805
It is sent in this way to improve security.
806
The number is unique to the current <EM>Pine</EM> session
807
and is only generated once per session.
812
<A HREF="#disable-terminal-reset-for-display-filters"><EM>disable-terminal-reset-for-display-filters</EM></A> is related.
814
Performance caveat/considerations:
816
Testing for the trigger and invoking the filter doesn't come for free.
817
There is overhead associated with searching for the trigger string, testing
818
for the filter's existence and actually piping the text through the filter.
819
The impact can be reduced if the Trigger Modifying Tokens above are
824
If Header Colors are being used, the sequences of bytes which indicate
825
color changes will be contained in the text which is passed to the
827
If this causes problems you'll need to turn off Header Colors.
828
The thirteen bytes which indicate a color change are
829
the character \377 followed by
830
\010 for a foreground color or \011 for a background color.
831
Then comes eleven characters of RGB data which looks something like
832
255, 0,255, depending on the particular color, of course.
835
<DT> <A NAME="download-command"><EM>download-command</EM></A>
837
<DD> This option affects the behavior of the <EM>Export</EM> command.
838
It specifies a Unix program name, and any necessary command line arguments,
839
that <EM>Pine</EM> can use to transfer the exported message to your
840
personal computer's disk.
843
<DT> <A NAME="download-command-prefix"><EM>download-command-prefix</EM></A>
845
<DD> This option is used in conjunction with the <EM>download-command</EM>
847
It defines text to be written to the terminal emulator (via standard
848
output) immediately prior to starting the download command. This is
849
useful for integrated serial line file transfer agents that permit command
850
passing (e.g., Kermit's APC method). <P>
852
<DT> <A NAME="editor"><EM>editor</EM></A>
854
<DD> UNIX <EM>Pine</EM> only. Sets the name of the alternate editor for composing
855
mail (message text only, not headers). It will be invoked with the "^_"
856
command or it will be invoked automatically if the
857
<A HREF="#enable-alt-imp"><EM>enable-alternate-editor-implicitly</EM></A>
860
<DT> <A NAME="empty-header-message"><EM>empty-header-message</EM></A>
862
<DD> When sending, if all of the To, Cc, and Newsgroups fields are empty,
863
<EM>Pine</EM> will put a special address in the To line. The default value is
864
"undisclosed-recipients: ;". The reason for this is to avoid
865
embarrassment caused by some Internet mail transfer software that
866
interprets a "missing" To: header as an error and replaces it with an
867
Apparently-to: header that may contain the addresses you entered on the
868
Bcc: line, defeating the purpose of the Bcc. You may change the part
869
of this message that comes before the ": ;" by setting the
870
<EM>empty-header-message</EM> variable to something else.
873
<DT> <A NAME="fcc-name-rule"><EM>fcc-name-rule</EM></A>
875
<DD> Determines default folder name for fcc when composing. Currently,
876
<EM>Pine</EM> will accept the values <EM>default-fcc</EM>, <EM>by-recipient</EM>,
877
or <EM>last-fcc-used</EM>. If set to <EM>default-fcc</EM>, then <EM>Pine</EM> will
878
use the value defined in the <A HREF="#def-fcc"><EM>default-fcc</EM></A>
879
variable (which itself
880
has a default) for the Fcc header field. If set to <EM>by-recipient</EM>,
881
then <EM>Pine</EM> will use the name of the recipient as a folder name for the fcc.
882
The relevant recipient is the first address in the To field. If set to
883
"last-fcc-used", then <EM>Pine</EM> will offer to Fcc to whatever folder
885
In all cases, the field can still be edited after it is
886
initially assigned. If the fcc field in the address book is set for the
887
first To address, that value over-rides any value derived from this rule.
890
<DT> <A NAME="feat-list"><EM>feature-list</EM></A>
892
<DD> This is a list of the many features (options) which may be turned on
893
or off. There is a separate section titled
894
<A HREF="#features-conf">Configuration Features</A> which explains
895
each of the features. There is some additional explanation about the
896
<EM>feature-list</EM> variable itself
897
in <A HREF="config-notes.html#feature-list"><EM>Feature List Variable</EM></A>.
900
<DT> <A NAME="file-directory"><EM>file-directory</EM></A>
902
<DD> <EM>PC-Pine</EM> only.
903
This value affects the Composer's "^J Attach" command,
904
the Attachment Index Screen's "S Save" command, and the
905
Message Index's "E Export" command.
908
Normally, when a filename is supplied that lacks a leading "path"
909
component, <EM>Pine</EM> assumes the file exists in the user's home directory.
910
Under Windows operating systems, this definition isn't always clear. This
911
feature allows you to explictly set where <EM>Pine</EM> should look for files
912
without a leading path.
915
NOTE: this feature's value is ignored if either
916
<A HREF="#use-current-dir"><EM>use-current-dir</EM></A> feature
917
is set or the PINERC has a value for the
918
<A HREF="#operating-dir"><EM>operating-dir</EM></A> variable.
921
<DT> <A NAME="fold-coll"><EM>folder-collections</EM></A>
923
<DD> This is a list of one or more collections where saved mail is stored.
924
See the sections describing
925
<A HREF="config-notes.html#collections">folder collections and collection syntax</A> for more information.
926
The first collection in this list is the default
927
collection for <EM>Save</EM>s,
928
including <A HREF="#def-fcc"><EM>default-fcc</EM>'s</A>.
931
<DT> <A NAME="folder-ext"><EM>folder-extension</EM></A>
933
<DD> <EM>PC-Pine</EM> only. File extension used for local folder names. This
934
is <CODE>.MTX</CODE> by default.
937
<DT> <A NAME="reopen-rule"><EM>folder-reopen-rule</EM></A>
939
<DD> <EM>Pine</EM> normally checks for new mail in the currently open folder
940
and in the INBOX every few <A HREF="#mail-check"><EM>minutes</EM></A>.
943
There are some situations where automatic new-mail checking does not work.
944
For example, if a mail folder is opened using the POP protocol or a newsgroup
945
is being read using the NNTP protocol, then new-mail checking is disabled.
948
It may be possible to check for new mail in these cases by reopening the
950
<EM>Pine</EM> does not do this for you automatically, but you may do the commands
951
manually to cause this to happen.
952
You reopen by going back to the folder list screen from the message
953
index screen with the "<" command,
954
and then going back into the message index screen with
955
the ">" command.
956
(Actually, any method you would normally use to open a folder will work the
957
same as the "<" followed by ">" method.
958
For example, the GoTo Folder command will work, or you may use L to go to the
959
Folder List screen and Carriage Return to reopen the folder.)
962
There are some cases where <EM>Pine</EM> knows that reopening the folder should
963
be useful as a way to discover new mail.
964
At the time of this writing, connections made using the POP protocol,
965
news reading using the NNTP protocol, local news reading, and local
966
ReadOnly folders which are in the traditional UNIX or the MMDF format all
967
fall into this category.
968
There are other cases where it <EM>may</EM> be a way to discover new mail, but <EM>Pine</EM>
969
has no way of knowing, so it might also just be an exercise in futility.
970
All remote, ReadOnly folders other than those listed just above fall into this
972
The setting of this option together with the type of folder
973
controls how <EM>Pine</EM> will react to the apparent attempt to reopen a folder.
976
If you don't reopen, then you will just be back in
977
the message index with no change.
978
You left the index and came back, but the folder remained "open"
980
However, if you do reopen the folder, the folder is closed and then reopened.
981
In this case, the current state of the open folder is lost.
982
The New status, Important and Answered flags,
983
selected state, Zoom state, collapsed or expanded state of threads,
984
current message number,
985
and any other temporary state is all lost when the reopen happens.
986
For POP folders (but not NNTP newsgroups) the Deleted flags are also lost.
989
In the possibilities listed below, the text says "POP/NNTP" in
991
That really implies the case where <EM>Pine</EM> knows it is a good way to discover
992
new mail, which is more than just POP and NNTP, but POP and NNTP are
993
the cases of most interest.
994
This option probably has more possible values than it deserves. They are:
998
<DT>Always reopen</DT>
999
<DD><EM>Pine</EM> will not ask whether you want to reopen but will just do the reopen
1000
whenever you type a command that implies a reopen, regardless of the
1002
In other words, it is assumed you would always answer Yes if asked
1006
<DT>Yes for POP/NNTP, Ask about other remote [Yes]</DT>
1007
<DD><EM>Pine</EM> will assume a Yes answer if the access method is POP or NNTP, but
1008
will ask you whether to reopen other remote folders,
1009
with a default answer of Yes.
1012
<DT>Yes for POP/NNTP, Ask about other remote [No]</DT>
1013
<DD><EM>Pine</EM> will assume a Yes answer if the access method is POP or NNTP, but
1014
will ask you whether to reopen other remote folders,
1015
with a default answer of No.
1018
<DT>Yes for POP/NNTP, No for other remote</DT>
1019
<DD><EM>Pine</EM> will assume a Yes answer if the access method is POP or NNTP, and
1020
will assume a No answer for all other remote folders.
1023
<DT>Always ask [Yes]</DT>
1024
<DD><EM>Pine</EM> will not differentiate based on access method.
1025
It will always ask for all remote folders, with a default answer of Yes.
1028
<DT>Always ask [No]</DT>
1029
<DD><EM>Pine</EM> will not differentiate based on access method.
1030
It will always ask for all remote folders, with a default answer of No.
1033
<DT>Ask about POP/NNTP [Yes], No for other remote</DT>
1034
<DD><EM>Pine</EM> will ask if the access method is POP or NNTP, with a default answer
1036
It will never attempt to reopen other remote folders.
1039
<DT>Ask about POP/NNTP [No], No for other remote</DT>
1040
<DD>This is the default.
1041
<EM>Pine</EM> will ask if the access method is POP or NNTP, with a default answer
1043
It will never attempt to reopen other remote folders.
1046
<DT>Never reopen</DT>
1047
<DD><EM>Pine</EM> will never attempt to reopen already open folders.
1052
Remember, wherever it says POP or NNTP above it really means POP or NNTP or
1053
any of the other situations where it is likely that reopening is a good way
1054
to discover new mail.
1057
There is an alternative that may be of useful in some situations.
1058
Instead of manually checking for new mail you can set up a
1059
<A HREF="config-notes.html#maildrop">Mail Drop</A>
1060
and automatically check for new mail.
1063
<DT> <A NAME="folder-sort-rule"><EM>folder-sort-rule</EM></A>
1065
<DD> This option controls the order in which folder list entries will be
1066
presented in the FOLDER LIST screen. Choose one of the following:
1069
<DT> <EM>Alphabetical</EM>
1071
<DD> sort by alphabetical name independent of type
1073
<DT> <EM>Alpha-with-dirs-last</EM>
1075
<DD> sort by alphabetical name grouping directory entries
1076
to the end of the list
1078
<DT> <EM>Alpha-with-dirs-first</EM>
1080
<DD> sort by alphabetical name grouping directory entries
1081
to the start of the list
1084
The normal default is <EM>Alphabetical</EM>.
1087
<DT> <A NAME="font-name"><EM>font-name</EM></A>
1089
<DD> Winsock version of <EM>PC-Pine</EM> only. <P>
1091
<DT> <A NAME="font-size"><EM>font-size</EM></A>
1093
<DD> Winsock version of <EM>PC-Pine</EM> only. <P>
1095
<DT> <A NAME="font-style"><EM>font-style</EM></A>
1097
<DD> Winsock version of <EM>PC-Pine</EM> only. <P>
1099
<DT> <A NAME="forced-abook"><EM>forced-abook-entry</EM></A>
1101
<DD> System-wide <EM>Pine</EM> configuration files only.
1102
Force these address book
1103
entries into all writable personal address books.
1104
This is a list variable. Each item in the list has the form:
1107
Nickname | Fullname | Address <BR>
1110
with optional whitespace in all the obvious places.
1113
<DT> <A NAME="form-letter-folder"><EM>form-letter-folder</EM></A>
1115
<DD> A Form Letter Folder is a mail folder that is intended to
1116
contain messages that you have composed and that are intended to be
1117
sent in their original form repeatedly.
1120
Setting this variable will alter <EM>Pine</EM>'s usual behavior when you
1121
execute the Compose command. Normally, <EM>Pine</EM> offers a chance to
1122
continue a postponed or interrupted message should one or the other
1123
exist. When this variable is set to a folder name that exists, <EM>Pine</EM>
1124
will also offer the chance to select a message from the folder to
1125
insert into the composer, much like when continuing a postponed message.
1126
The difference, however, is that <EM>Pine</EM> will not automatically delete
1127
the selected message from the Form Letter Folder.
1129
Setting this variable will also affect <EM>Pine</EM>'s behavior when you
1130
Postpone a message from the composer. Normally, <EM>Pine</EM> simply stashes
1131
the message away in your
1132
<A HREF="#postponed-folder"><EM>Postponed-Folder</EM></A>.
1133
Regardless of the specified folder's existence, <EM>Pine</EM> will ask which
1134
folder you intend the message to be stored in. Choose the
1135
"F" option to store the message in your Form Letter Folder.
1136
This is the most common way to add a message to the folder.
1139
Another method of adding messages to the folder is via the <EM>Pine</EM>
1140
composer's <SAMP>Fcc:</SAMP> field. If you are sending a message that
1141
you expect to send in the same form again, you can enter the Form
1142
Letter Folder's name in this field. <EM>Pine</EM>, as usual, will copy the
1143
message as it's sent. Note, when you later select this message from
1144
your Form Letter Folder, it will have the same recipients as the original
1148
To delete a message from the Form Letter Folder, you can either select
1149
the folder from a suitable FOLDER LIST screen, or use the Delete
1150
command in the MESSAGE INDEX offered when selecting from the folder as
1151
part of the Compose command. You can delete a Form Letter Folder just
1152
as any other folder from a suitable FOLDER LIST screen.
1155
You may find that the <A HREF="#role-config"><EM>Roles</EM></A>
1156
facility introduced in <EM>Pine</EM> 4.10 can be used
1157
to replace the Form Letter Folder.
1161
<DT> <A NAME="glob-abook"><EM>global-address-book</EM></A>
1163
<DD> A list of shared address books. Each entry in the list is an
1164
optional nickname followed by a pathname or file name relative to the home
1166
A SPACE character separates the nickname from the rest of the line.
1167
Instead of a local pathname or file name, a remote folder name can be given.
1168
This causes the address book to
1169
be a <A HREF="low-level.html#addrbook"><EM>Remote address book</EM></A>.
1170
Remote folder syntax is discussed in
1171
<A HREF="config-notes.html#remote-folders">Syntax for Remote Folders</A>.
1172
This list will be added to the
1173
<A HREF="#pers-abook"><EM>address-book</EM></A> list to
1174
arrive at the complete set of address books. Global address books are
1175
defined to be ReadOnly. <P>
1177
<DT> <A NAME="goto-default-rule"><EM>goto-default-rule</EM></A>
1179
<DD> This value affects <EM>Pine</EM>'s behavior when using
1180
the <EM>Goto</EM> command.
1181
There are five possible values for this option:
1186
<DT> <EM>folder-in-first-collection</EM>
1188
<DD> <EM>Pine</EM> will offer the most recently visited folder in the default
1189
collection found in the "Collection List" screen as the default.
1192
<DT> <EM>inbox-or-folder-in-first-collection</EM>
1194
<DD> If the current folder is <EM>INBOX</EM>,
1195
<EM>Pine</EM> will offer the most recently visited folder in the
1196
default collection found in the "Collection List" screen.
1197
If the current folder is other than <EM>INBOX</EM>,
1198
<EM>INBOX</EM> is offered as the default.
1201
<DT> <EM>inbox-or-folder-in-recent-collection</EM>
1203
<DD> This is <EM>Pine</EM>'s default behavior.
1204
If the current folder is <EM>INBOX</EM>,
1205
<EM>Pine</EM> will offer the last open
1206
folder as the default.
1207
If the current folder is other than <EM>INBOX</EM>,
1208
<EM>INBOX</EM> is offered as the default.
1211
<DT> <EM>first-collection-with-inbox-default</EM>
1213
<DD> Instead of offering the most recently visited folder in the default
1214
collection, the default collection is offered but with <EM>INBOX</EM> as
1216
If you type in a folder name it will be in the default collection.
1217
If you simply accept the default, however, your <EM>INBOX</EM> will be opened.
1220
<DT> <EM>most-recent-folder</EM>
1222
<DD> The last accepted value simply causes the most recently opened
1223
folder to be offered as the default regardless of the currently opened
1229
NOTE: The default while a newsgroup is open remains the same; the last
1232
<DT> <A NAME="image-viewer"><EM>image-viewer</EM></A>
1234
<DD> This variable names the program to call for displaying parts of a
1235
MIME message that are of type IMAGE. If your system supports the
1236
<EM>mailcap</EM> system, you don't need to set this variable. <P>
1238
<DT> <A NAME="inbox-path"><EM>inbox-path</EM></A>
1240
<DD> This specifies the name of the folder to use for the <EM>INBOX</EM>.
1241
By default this is unset and the system's default is used.
1242
The most common reason for
1243
setting this is to open an IMAP mailbox for the <EM>INBOX</EM>. For example,
1244
<EM>{imap5.u.example.edu}inbox</EM> will open the user's standard
1245
<EM>INBOX</EM> on the mail server, <EM>imap5</EM>. <P>
1247
<DT> <A NAME="incoming-archive-folders"><EM>incoming-archive-folders</EM></A>
1249
<DD> This is like <A HREF="#read-msg-fold"><EM>read-message-folder</EM></A>,
1250
only more general. This is a list
1251
of folder pairs, with the first separated from the second in the pair by a
1252
space. The first folder in a pair is the folder you want to archive, and
1253
the second folder is the folder that read messages from the first should
1254
be moved to. Depending on how you define the
1255
<A HREF="#auto-read-msg"><EM>auto-move-read-msgs</EM></A>
1256
feature, you may or may not be asked when you leave
1257
the first folder if you want read messages to be moved to the second
1258
folder. In either case, moving the messages means they will be deleted
1259
from the first folder. <P>
1261
If these are not path names, they will be in the default collection for
1262
<EM>Save</EM>s. Any valid folder specification, local or remote (via IMAP), is
1263
allowed. There is no default. <P>
1265
<DT> <A NAME="inc-fold"><EM>incoming-folders</EM></A>
1267
<DD> This is a list of one or more folders other than <EM>INBOX</EM> that
1268
may receive new messages. This list is slightly special in that it is
1269
always expanded in the folder lister. In the future, it may become more
1270
special. For example, it would be nice
1271
if <EM>Pine</EM> would monitor the folders
1272
in this list for new mail. <P>
1274
<DT> <A NAME="incoming-startup-rule"><EM>incoming-startup-rule</EM></A>
1276
<DD> This rule affects <EM>Pine</EM>'s behavior when opening
1277
the <EM>INBOX</EM> or
1278
another folder from the "INCOMING MESSAGE FOLDERS".
1279
This rule tells <EM>Pine</EM>
1280
which message to make the current message when an incoming folder is opened.
1281
There are seven possible values for this option:
1286
<DT> <EM>first-unseen</EM>
1288
<DD> The current message will be the first unseen message which has not been
1289
marked deleted, or the last message if all of the messages have been seen.
1290
This is the default setting.
1293
<DT> <EM>first-recent</EM>
1295
<DD> This is similar to <EM>first-unseen</EM>. Instead of first unseen
1296
it is the first recent message. A message is considered to be recent if it
1297
arrived since the last time the folder was open (by any mail client, not just
1298
the current one). So this option causes the
1299
current message to be set to the first undeleted-recent message, or the
1300
last message if none is both undeleted and recent.
1303
<DT> <EM>first-important</EM>
1305
<DD> This will result in the current message being set to the first
1306
message marked Important (but not Deleted).
1307
If no messages are marked Important, then it will be the last message.
1310
<DT> <EM>first-important-or-unseen</EM>
1312
<DD> This selects the minimum of the first unseen and the first important
1316
<DT> <EM>first-important-or-recent</EM>
1318
<DD> This selects the first of the first recent and the first important
1324
<DD> Set the current message to the first undeleted message unless all
1325
are deleted. In that case set it to the last message.
1330
<DD> Set the current message to the last undeleted message unless all
1331
are deleted. In that case set it to the last message.
1337
<DT> <A NAME="index-answered-background-color"><EM>index-answered-background-color</EM></A>
1338
<DT> <A NAME="index-answered-foreground-color"><EM>index-answered-foreground-color</EM></A>
1339
<DT> <A NAME="index-deleted-background-color"><EM>index-deleted-background-color</EM></A>
1340
<DT> <A NAME="index-deleted-foreground-color"><EM>index-deleted-foreground-color</EM></A>
1341
<DT> <A NAME="index-important-background-color"><EM>index-important-background-color</EM></A>
1342
<DT> <A NAME="index-important-foreground-color"><EM>index-important-foreground-color</EM></A>
1343
<DT> <A NAME="index-new-background-color"><EM>index-new-background-color</EM></A>
1344
<DT> <A NAME="index-new-foreground-color"><EM>index-new-foreground-color</EM></A>
1345
<DT> <A NAME="index-recent-background-color"><EM>index-recent-background-color</EM></A>
1346
<DT> <A NAME="index-recent-foreground-color"><EM>index-recent-foreground-color</EM></A>
1347
<DT> <A NAME="index-to-me-background-color"><EM>index-to-me-background-color</EM></A>
1348
<DT> <A NAME="index-to-me-foreground-color"><EM>index-to-me-foreground-color</EM></A>
1349
<DT> <A NAME="index-unseen-background-color"><EM>index-unseen-background-color</EM></A>
1350
<DT> <A NAME="index-unseen-foreground-color"><EM>index-unseen-foreground-color</EM></A>
1352
<DD> <A HREF="#index-colors"><EM>Index Colors</EM></A>.
1355
<DT> <A NAME="index-format"><EM>index-format</EM></A>
1357
<DD> This option is used to customize the content of lines in the
1358
MESSAGE INDEX screen. Each line is intended
1359
to convey some amount of immediately relevant information about each
1360
message in the current folder.
1363
<EM>Pine</EM> provides a pre-defined set of informational fields with
1364
reasonable column widths automatically computed. You can, however,
1365
replace this default set by listing special tokens in the order you
1366
want them displayed.
1369
The list of available tokens is
1370
<A HREF="#index-tokens"><EM>here</EM></A>.
1373
Spaces are used to separate listed tokens. Additionally, you can
1374
specify how much of the screen's width the taken's associated data
1375
should occupy on the index line by appending the token with a pair of
1376
parentheses enclosing either a number or percentage. For example,
1377
"SUBJECT(13)" means to allocate 13 characters of space to the subject
1378
column, and "SUBJECT(20%)" means to
1379
allocate 20% of the available space
1380
to the subjects column, while plain "SUBJECT" means the system will
1381
attempt to figure out a reasonable amount of space.
1384
There is always one space between every pair of columns, so if you use fixed
1385
column widths (like 13) you should remember to take that into account.
1386
Several of the fields are virtually fixed-width, so it doesn't make
1387
much sense to specify the width for them. The fields STATUS,
1388
FULLSTATUS, IMAPSTATUS, MSGNO, the DATE fields, SIZE,
1389
and DESCRIPSIZE all fall into that category.
1390
You <EM>may</EM> specify widths for those if you wish, but
1391
you're probably better off letting the system pick those widths. <P>
1394
The default is equivalent to:
1397
<CENTER><SAMP>index-format=STATUS MSGNO DATE FROMORTO(33%) SIZE SUBJECT(67%)</SAMP></CENTER>
1400
This means that the four fields without percentages will be allocated
1401
first, and then 33% and 67% of the <EM>remaining</EM> space will go to
1402
the from and subject fields. If one of those two fields is specified
1403
as a percentage and the other is left for the system to choose, then
1404
the percentage is taken as an absolute percentage of the screen, not
1405
of the space remaining after allocating the first four columns. It
1406
doesn't usually make sense to do it that way. If you leave off all
1407
the widths, then the subject and from fields (if both are present) are
1408
allocated space in a 2 to 1 ratio, which is almost exactly the same as
1412
What you are most likely to do with this configuration option is to
1413
specify which fields appear at all, which order they appear in, and the
1414
percentage of screen that is used for the from and subject fields if you
1415
don't like the 2 to 1 default.
1419
<DT> <A NAME="initial-keystroke-list"><EM>initial-keystroke-list</EM></A>
1421
<DD> This is a comma-separated list of keystrokes which <EM>Pine</EM> executes on
1422
startup. Items in the list are usually just characters, but there are
1423
some special values. <EM>SPACE,</EM> <EM>TAB,</EM> and <EM>CR</EM> mean a
1424
space character, tab character, and a carriage return, respectively.
1425
<EM>F1</EM> through <EM>F12</EM> stand for the twelve function keys.
1426
<EM>UP, DOWN, LEFT, </EM>and<EM> RIGHT </EM>stand for the arrow keys.
1427
Control characters are represented with <EM>^<char></EM>. A
1428
restriction is that you can't mix function keys and character keys in this
1429
list even though you can, in some cases, mix them when running <EM>Pine</EM>. A
1430
user can always use only <EM>character</EM> keys in the startup list even
1431
if he or she is using <EM>function</EM> keys normally, or vice versa. If
1432
an element in this list is a string surrounded by double quotes (")
1433
then it will be expanded into the individual characters in the string,
1434
excluding the double quotes. <P>
1436
<DT> <A NAME="kblock-count"><EM>kblock-passwd-count</EM></A>
1438
<DD> System-wide <EM>Pine</EM> configuration files only. Number of times a user
1439
will have to enter a password when they run the keyboard lock command in
1442
<DT> <A NAME="keylabel-background-color"><EM>keylabel-background-color</EM></A>
1443
<DT> <A NAME="keylabel-foreground-color"><EM>keylabel-foreground-color</EM></A>
1445
<DD> <A HREF="#keylabel-color"><EM>KeyLabel Color</EM></A>.
1448
<DT> <A NAME="keyname-background-color"><EM>keyname-background-color</EM></A>
1449
<DT> <A NAME="keyname-foreground-color"><EM>keyname-foreground-color</EM></A>
1451
<DD> <A HREF="#keyname-color"><EM>KeyName Color</EM></A>.
1454
<DT> <A NAME="keywords"><EM>keywords</EM></A>
1456
<DD> You may define your own set of keywords and optionally set them on a
1457
message by message basis.
1458
These are similar to the "Important" flag which the user
1459
may set using the Flag command.
1460
The difference is that the Important flag is always present for each folder.
1461
User-defined keywords are chosen by the user.
1462
You may set up the list of possible keywords here.
1463
Then you use the Flag command
1464
to set or clear the keywords in each message.
1467
Keywords may be used when Selecting messages (Select Keyword).
1468
You will need to enable the
1469
<A HREF="#enable-aggregate-command-set">enable-aggregate-command-set</A>
1470
option to use Select.
1471
Keywords may also be used in the Patterns of Rules (Filters, Indexcolors, etc).
1472
Filter rules may be used to set keywords automatically.
1473
Keywords may be displayed as part of the Subject of a message by using
1474
the SUBJKEY or SUBJKEYINIT tokens in the
1475
<A HREF="#index-format">Index-Format</A> option.
1476
The <A HREF="#keyword-surrounding-chars"><EM>Keyword-Surrounding-Chars</EM></A>
1477
option may be used to modify the display of keywords using
1478
SUBJKEY and SUBJKEYINIT slightly.
1479
Keywords may also be displayed in a column of their own in the MESSAGE INDEX
1480
screen by using the KEY or KEYINIT tokens.
1481
It is also possible to color keywords in the index using the
1483
(<A HREF="#keyword-colors">Keyword Colors</A>).
1484
Keywords are not supported by all mail servers.
1486
You may give keywords nicknames if you wish.
1487
If the keyword definition you type in contains a SPACE character, then the
1488
actual value of the keyword is everything after the last SPACE and the
1489
nickname for that keyword is everything before the last SPACE.
1490
For example, suppose you are trying to interoperate with another email program
1491
which uses a particular keyword with an unpleasant name.
1492
Maybe it uses a keyword called
1494
<CENTER><SAMP>VendorName.SoftwareName.08</SAMP></CENTER>
1496
but for you that keyword means that the message is work-related.
1497
You could define a keyword to have the value
1499
<CENTER><SAMP>Work VendorName.SoftwareName.08</SAMP></CENTER>
1501
and then you would use the name "Work" when dealing with
1502
that keyword in <EM>Pine</EM>.
1503
If you defined it as
1505
<CENTER><SAMP>My Work VendorName.SoftwareName.08</SAMP></CENTER>
1507
the nickname would be everything before the last SPACE, that is the nickname
1508
would be "My Work".
1510
Some commonly used keywords begin with dollar signs.
1511
This presents a slight complication, because the dollar sign is normally used
1513
<A HREF="config-notes.html#env-variables">environment variable expansion</A>
1514
in the <EM>Pine</EM> configuration.
1515
In order to specify a keyword which begins with a dollar sign you must
1516
precede the dollar sign with a second dollar sign to escape its special
1518
For example, if you want to include the keyword
1520
<CENTER><SAMP>$Label1</SAMP></CENTER>
1522
as one of your possible keywords, you must enter the text
1524
<CENTER><SAMP>$$Label1</SAMP></CENTER>
1529
<DT> <A NAME="keyword-surrounding-chars"><EM>keyword-surrounding-chars</EM></A>
1531
<DD> This option controls a minor aspect of <EM>Pine</EM>'s MESSAGE INDEX and MESSAGE
1533
If you have modified the
1534
<A HREF="#index-format"><EM>Index-Format</EM></A> option
1535
so that either the "SUBJKEY" or "SUBJKEYINIT" tokens
1536
are used to display keywords or their initials along with the Subject; then
1537
this option may be used to modify the resulting display slightly.
1538
By default, the keywords or initials displayed for these tokens will be
1539
surrounded with curly braces ({ and }) and a trailing space.
1540
For example, if keywords "Work" and "Now" are set for
1541
a message, the "SUBJKEY" token will normally look like
1543
<CENTER><SAMP>{Work Now} actual subject</SAMP></CENTER>
1545
and the SUBJKEYINIT token would look like
1547
<CENTER><SAMP>{WN} actual subject</SAMP></CENTER>
1549
The default character before the keywords is the left brace ({) and the
1550
default after the keywords is the right brace followed by a space (} ).
1552
This option allows you to change that.
1553
You should set it to two values separated by a space.
1554
The values may be quoted if they include space characters.
1555
So, for example, the default value could be specified explicitly by setting this
1558
<CENTER><SAMP>Keyword-Surrounding-chars="{" "} "</SAMP></CENTER>
1560
The first part wouldn't need to be quoted (but it doesn't hurt).
1561
The second part does need the quotes because it includes a space character.
1562
If you wanted to change the braces to brackets you could use
1564
<CENTER><SAMP>Keyword-Surrounding-chars="[" "] "</SAMP></CENTER>
1566
Inside the quotes you can use backslash quote to mean quote, so
1568
<CENTER><SAMP>Keyword-Surrounding-chars="\"" "\" "</SAMP></CENTER>
1572
<CENTER><SAMP>"Work Now" actual subject</SAMP></CENTER>
1574
It is also possible to color keywords in the index using the
1576
(<A HREF="#keyword-colors">Keyword Colors</A>).
1578
It is not possible to change the fact that a space character is used to
1579
separate the keywords if more than one keyword is set for a message.
1580
It is also not possible to change the fact that there are no separators
1581
between the keyword initials if more than one keyword is set.
1584
<DT> <A NAME="last-time"><EM>last-time-prune-questioned</EM></A>
1586
<DD> Personal configuration file only. This variable records the month
1587
the user was last asked if his or her <EM>sent-mail</EM> folders should
1589
The format is <EM>yy.mm</EM>.
1590
This is automatically updated by <EM>Pine</EM> when
1591
the the pruning is done or declined.
1592
If a user wanted to make <EM>Pine</EM> stop
1593
asking this question he or she could set this time to something
1595
This may not be set in the system-wide configuration files.
1596
Note: The <EM>yy</EM> year is actually the number of years since 1900, so it
1597
will be equal to 101 in the year 2001.
1600
<DT> <A NAME="last-version-used"><EM>last-version-used</EM></A>
1602
<DD> Personal configuration file only.
1603
This is set automatically by <EM>Pine</EM>.
1604
It is used to keep track of the last version of <EM>Pine</EM> that
1605
was run by the user.
1606
Whenever the version number increases, a new version message is printed out.
1607
This may not be set in the system-wide configuration files.
1610
<DT> <A NAME="ldap-servers"><EM>ldap-servers</EM></A>
1612
<DD> This is only available if <EM>Pine</EM> was linked with an LDAP library
1613
when it was compiled. This variable is normally managed by <EM>Pine</EM> though
1614
it can be set in the system-wide configuration files as well as the personal
1615
configuration. It is a list variable. Each item in the
1616
list contains quite a bit of extra information besides just the server name.
1617
To put this into a system-wide config file the easiest thing to do is to
1618
configure a personal <EM>Pine</EM> for the LDAP server then copy the
1620
into the system-wide config file. Each item in the list looks like:
1624
server_name[:port] <SPACE> "quoted stuff" </CODE><BR>
1627
The <CODE>server_name</CODE> is just a hostname and it is followed by
1628
an optional colon and port number. The default <CODE>port</CODE> is 389.
1629
Following the server name is a single SPACE character followed by
1630
a bunch of characters inside double quotes. The part inside the quotes is
1631
a set of <EM>tag</EM> = <EM>value</EM> pairs.
1632
Each tag is preceded by a slash (/) and followed
1633
by an equal sign. The value for that tag is the text up to the next slash.
1634
An example of some <CODE>quoted stuff</CODE> is:
1638
"/base=o=University of Washington, c=US/impl=0/.../nick=My Server"
1642
This would set the search base for this server to
1643
<CODE>o=University of Washington, c=US</CODE>, set the implicit bit to zero,
1644
and set the nickname for the server to <CODE>My Server</CODE>.
1645
All of the tags correspond directly to items in the Setup/Directory screen
1646
so experiment with that if you want to see what the possible tags and values
1650
<DT> <A NAME="literal-signature"><EM>literal-signature</EM></A>
1652
<DD> With this option your actual signature, as opposed to
1653
the name of a file containing your signature,
1654
is stored in the <EM>Pine</EM> configuration file.
1655
If this is defined it takes precedence over the <EM>signature-file</EM> option.
1658
This is simply a different way to store the signature data.
1659
The signature is stored inside your <EM>Pine</EM> configuration file
1660
instead of in a separate signature file.
1661
Tokens contained in the signature work the same way they do with the regular
1662
<A HREF="#sig-file">signature-file</A>.
1665
The Setup/Signature command in <EM>Pine</EM>'s Main Menu will edit
1666
the <EM>literal-signature</EM> by default. However, if no
1667
<EM>literal-signature</EM> is defined and the file named in the
1668
<EM>signature-file</EM> option exists, then the latter will be used
1669
instead. Compose (Reply, Forward, ...) will default to using the
1670
<EM>literal-signature</EM> if defined, otherwise it will use the contents
1671
of the file named in <EM>signature-file</EM>.
1674
The <EM>Pine</EM> composer is used to edit the literal-signature.
1675
The result of that edit is first converted to a C-style string before it
1676
is stored in the configuration file.
1677
In particular, the two character sequence \n (backslash followed by
1678
the character "n") will be used to signify a
1679
line-break in the signature.
1680
You don't have to enter the \n, but it will be visible in the
1681
SETUP CONFIGURATION window after you are done editing the signature.
1684
<DT> <A NAME="mail-check"><EM>mail-check-interval</EM></A>
1686
<DD> This option specifies, in seconds,
1687
how often <EM>Pine</EM> will check for new mail.
1688
If set to zero, new-mail checking is disabled.
1689
(You can always manually force a new-mail check by typing ^L (Ctrl-L), which is also
1690
the command to refresh the screen, or by typing the Next command when the
1691
current message is the last message of the folder.)
1692
There is a minimum value for this option, normally 15 seconds.
1693
The default value is normally 150 seconds.
1694
The higher you set this option, the easier it is on the server.
1696
There are some situations where automatic new-mail checking does not work.
1697
See the discussion about new-mail checking in <A HREF="#reopen-rule"><EM>folder-reopen-rule</EM></A>.
1699
The new-mail checking will not happen exactly at the frequency that you specify.
1700
For example, <EM>Pine</EM> may elect to defer a non-INBOX mail check if you
1702
Or, it may check more frequently than you have specified if that is
1703
thought to be necessary to keep the server from closing the connection
1704
to the folder due to inactivity.
1705
If <EM>Pine</EM> checks for new mail as a side effect of another command, it will reset
1706
the timer, so that new-mail checking may seem to happen irregularly instead of
1707
every X seconds like clockwork.
1709
If you are anxious to know about new mail as soon as possible, set the check
1710
interval low, and you'll know about the new mail by approximately
1711
that amount of time after it arrives.
1712
If you aren't so worried about knowing right away, set this option to a
1714
That will save the server some processing time and may save you some of
1715
the time you spend waiting for new-mail checks to happen if you are
1716
dealing with a slow server or slow network connection.
1718
If you suspect that new-mail checking is causing slow downs for you,
1719
you may want to look into the options
1720
<A HREF="#quell-mailchecks-composing-except"><EM>Quell-Mailchecks-Composing-Except-Inbox</EM></A>,
1721
<A HREF="#quell-mailchecks-composing-inbox"><EM>Quell-Mailchecks-Composing-Inbox</EM></A> and
1722
<A HREF="#mail-check-noncurr"><EM>Mail-Check-Interval-Noncurrent</EM></A>,
1723
which refine when mail checking is done.
1725
If the mailbox being check uses a <A HREF="config-notes.html#maildrop">Mail Drop</A> then
1726
there is a minimum time
1727
(<A HREF="#maildrop-check-minimum"><EM>maildrop-check-minimum</EM></A>)
1728
between new-mail checks.
1729
Because of this minimum you may notice that new mail does not
1730
appear promptly when you expect it.
1731
The reason for this is to protect the server from over-zealous opening and
1732
closing of the Mail Drop folder, since that is a costly operation.
1734
A side effect of disabling mail checking is that there will be situations
1735
in which the user's IMAP connection will be broken due to inactivity timers
1736
on the server. Another side effect is that the
1737
<A HREF="#user-input"><EM>user-input-timeout</EM></A>
1741
<DT> <A NAME="mail-check-noncurr"><EM>mail-check-interval-noncurrent</EM></A>
1743
<DD> This option is closely related to the
1744
<A HREF="#mail-check"><EM>Mail-Check-Interval</EM></A>
1745
option, as well as the
1746
<A HREF="#quell-mailchecks-composing-except"><EM>Quell-Mailchecks-Composing-Except-Inbox</EM></A> and
1747
<A HREF="#quell-mailchecks-composing-inbox"><EM>Quell-Mailchecks-Composing-Inbox</EM></A> options.
1748
If the "Mail-Check-Interval" option is set to zero, then automatic
1749
new-mail checking is disabled and this option will have no effect.
1751
Normally this option is set to zero, which means that the value used will be
1752
the same as the value for the "Mail-Check-Interval".
1753
If you set this option to a value different from zero
1754
(usually larger than the value for "Mail-Check-Interval")
1755
then that is the check interval that will be used
1756
for folders which are not the currently open folder or the INBOX.
1757
You may not even have any folders that are noncurrent and not the INBOX.
1758
If you do, it is likely that they are due to
1759
<A HREF="#stay-open-folders">Stay-Open-Folders</A>
1760
you have configured.
1761
This option also affects the rate of mail checking done on cached
1762
connections to folders you previously had open but are no longer actively
1764
You aren't expected to understand that last sentence, but if you are interested
1766
<A HREF="#max-remote-connections">Max-Remote-Connections</A>,
1767
and the related options.
1770
<DT> <A NAME="mail-directory"><EM>mail-directory</EM></A>
1772
<DD> This variable was more important in previous versions of <EM>Pine</EM>. Now
1773
it is used only as the default for storing personal folders (and only if
1774
there are no <A HREF="#fold-coll"><EM>folder-collections</EM></A> defined).
1775
The default value is
1776
<EM>~/mail</EM> on UNIX and <EM>${HOME}\MAIL</EM> on a PC. <P>
1778
<DT> <A NAME="mailcap-search-path"><EM>mailcap-search-path</EM></A>
1780
<DD> This variable is used to replace <EM>Pine</EM>'s default
1781
mailcap file search path.
1782
It takes one or more file names (full paths must be specified) in
1783
which to look for mail capability data. <P>
1785
<DT> <A NAME="maildrop-check-minimum"><EM>maildrop-check-minimum</EM></A>
1787
<DD> New-mail checking for a
1788
<A HREF="config-notes.html#maildrop">Mail Drop</A>
1789
is a little different from new
1790
mail checking for a regular folder.
1791
One of the differences is that the connection to the Mail Drop is not
1792
kept open and so the cost of checking
1793
(delay for you and additional load for the server) may be significant.
1794
Because of this additional cost we set a minimum time that
1795
must pass between checks.
1796
This minimum only applies to the automatic checking done by <EM>Pine</EM>.
1797
If you force a check by typing ^L (Ctrl-L) or by typing the Next command when you are
1798
at the end of a folder index, then the check is done right away.
1800
This option specifies, in seconds, the <EM>minimum</EM> time between Mail Drop
1802
You may want to set this minimum high in order to avoid experiencing some
1803
of the delays associated with the checks.
1804
Note that the time between checks is still controlled by the regular
1805
<A HREF="#mail-check"><EM>Mail-Check-Interval</EM></A> option.
1806
When <EM>Pine</EM> is about to do an automatic check for new mail (because
1807
the Mail-Check-Interval has expired) then if the time since the last
1809
of any open Mail Drops has been greater than the MailDrop-Check-Minimum,
1810
the Mail Drop is checked for new mail as well.
1811
Therefore, it is only useful to set this option to a value that is higher
1812
than the Mail-Check-Interval.
1814
If this option is set to zero, automatic Mail Drop new-mail
1815
checking is disabled.
1816
There is a minimum value, normally 60 seconds.
1817
The default value is normally 60 seconds as well.
1818
This applies to the INBOX and to the currently open folder if that is
1819
different from the INBOX.
1822
<DT> <A NAME="max-remote-connections"><EM>max-remote-connections</EM></A>
1824
<DD> This option affects low-level behavior of Pine.
1825
The default value for this option is <EM>2</EM>.
1826
If your INBOX is accessed using the IMAP protocol
1827
from an IMAP server, that connection is kept open throughout the
1828
duration of your <EM>Pine</EM> session, independent of the value of this option.
1829
The same is true of any
1830
<A HREF="#stay-open-folders">Stay-Open-Folders</A>
1832
This option controls <EM>Pine</EM>'s behavior when connecting to remote IMAP folders
1833
other than your INBOX or your Stay-Open-Folders.
1834
It specifies the maximum number of remote IMAP connections (other than
1835
those mentioned above) that <EM>Pine</EM> will use for accessing the rest of your
1837
If you set this option to zero, you will turn off most remote connection
1839
It's difficult to understand exactly what this option does, and it is usually
1840
fine to leave it set to its default value.
1841
It is probably more likely that you will be interested in setting the
1842
<A HREF="#stay-open-folders">Stay-Open-Folders</A> option
1843
instead of changing the value of this option.
1844
A slightly longer explanation of what is going on with this option
1845
is given in the next paragraphs.
1848
There are some time costs involved in opening and closing remote IMAP
1849
folders, the main costs being the time you have to wait for the connection
1850
to the server and the time for the folder to open.
1851
Opening a folder may involve not only the time the server takes to do its
1852
processing but time that <EM>Pine</EM> uses to do filtering.
1853
These times can vary widely.
1854
They depend on how loaded the server is, how large
1855
the folder being opened is, and how you set up filtering, among other things.
1856
Once <EM>Pine</EM> has opened a connection to a particular folder, it will attempt
1857
to keep that connection open in case you use it again.
1858
In order to do this,
1859
<EM>Pine</EM> will attempt to use the Max-Remote-Connections (the value of
1860
this option) IMAP connections you have alloted for this purpose.
1862
For example, suppose the value of this option is set to "2".
1863
If your INBOX is accessed on a remote server using the IMAP protocol, that
1864
doesn't count as one of the remote connections but it is always kept open.
1865
If you then open another IMAP folder, that would be your first
1866
remote connection counted as one of the Max-Remote-Connections connections.
1867
If you open a third folder the second will be left open, in case you
1869
You won't be able to tell it has been left open.
1870
It will appear to be closed when you leave the folder but the connection
1871
will remain in the background.
1872
Now suppose you go back to the second folder (the first folder after the
1874
A connection to that folder is still open so you won't have to wait
1875
for the startup time to open it.
1876
Meanwhile, the connection to the third folder will be left behind.
1877
Now, if you open a fourth folder, you will bump into the
1878
Max-Remote-Connections limit, because this will be the third folder other
1879
than INBOX and you have the option set to "2".
1880
The connection that is being used for
1881
the third folder will be re-used for this new fourth folder.
1882
If you go back to the third folder after this, it is no longer already
1883
connected when you get there.
1884
You'll still save some time since <EM>Pine</EM> will re-use the connection to the
1885
fourth folder and you have already logged in on that connection,
1886
but the folder will have to be re-opened from scratch.
1888
If a folder is large and the startup cost is dominated by the time it takes
1889
to open that folder or to run filters on it, then it will pay to make the
1890
value of this option large enough to keep it open.
1891
On the other hand, if you only revisit a handful of folders or if
1892
the folders are small, then it might
1893
make more sense to keep this number small so that the reconnect
1894
time (the time to start up a new connection and authenticate)
1895
is eliminated instead.
1897
You may also need to consider the impact on the server.
1898
On the surface, a larger number here may cause a larger impact on the
1899
server, since you will have more connections open to the server.
1900
On the other hand, not only will <EM>you</EM> be avoiding the startup costs
1901
associated with reopening a folder, but the <EM>server</EM> will be
1902
avoiding those costs as well.
1904
When twenty five minutes pass without any active use of an IMAP connection
1905
being saved for possible re-use, that connection will be shut down,
1908
<DT> <A NAME="mimetype-search-path"><EM>mimetype-search-path</EM></A>
1910
<DD> This variable is used to replace <EM>Pine</EM>'s default mime.types file
1911
search path. It takes one or more file names (full paths must be
1912
specified) in which to look for file-name-extension to MIME type mapping
1913
data. See the Config Notes for details on <EM>Pine</EM>'s usage of the <A
1914
HREF="config-notes.html#mime.types">MIME.Types File</A>. <P>
1916
<DT> <A NAME="new-version-threshold"><EM>new-version-threshold</EM></A>
1918
<DD> When a new version of <EM>Pine</EM> is run for the first time it offers a
1919
special explanatory screen to the user upon startup. This option
1920
helps control when and if that special screen appears for users that
1921
have previously run <EM>Pine</EM>. It takes as its value a <EM>Pine</EM> version
1922
number. <EM>Pine</EM> versions less than the specified value will supress this
1923
special screen while versions equal to or greater than that specified
1924
will behave normally. <P>
1926
<DT> <A NAME="newmail-fifo-path"><EM>newmail-fifo-path</EM></A>
1928
<DD> This option is only available in UNIX <EM>Pine</EM>.
1929
However, there is a very similar feature built in to <EM>PC-Pine</EM>.
1930
In <EM>PC-Pine</EM>'s Config menu at the top of the screen
1931
is an option called "New Mail Window".
1933
You may have <EM>Pine</EM> create a FIFO special file (also called a named pipe, see mkfifo(3) and fifo(4)) where
1934
it will send a one-line message each time a new message is received in
1935
the current folder, the INBOX, or any open
1936
<A HREF="#stay-open-folders">Stay-Open-Folders</A>.
1937
To protect against two different <EM>Pine</EM>s both writing to the same FIFO, <EM>Pine</EM>
1938
will only create the FIFO and write to it if it doesn't already exist.
1940
A possible way to use this option would be to have a separate window
1941
on your screen running the command
1943
<CENTER><SAMP>cat filename</SAMP></CENTER>
1945
where "filename" is the name of the file given for this option.
1946
Because the file won't exist until after you start <EM>Pine</EM>, you must <EM>first</EM>
1947
start <EM>Pine</EM> and <EM>then</EM> run the "cat" command.
1948
You may be tempted to use "tail -f filename" to view the new
1950
However, the common implementations of the tail command will not do what you
1953
The width of the messages produced for the FIFO may be altered with the
1954
<A HREF="#newmail-window-width">NewMail-Window-Width</A> option.
1956
On some systems, fifos may only be created in a local filesystem.
1957
In other words, they may not be in NFS filesystems.
1958
This requirement is not universal.
1959
If the system you are using supports it, it should work.
1960
(It is often the case that your home directory is in an NFS filesystem.
1961
If that is the case, you might try using a file in the "/tmp"
1962
filesystem, which is usually a local filesytem.)
1963
Even when it is possible to use an NFS-mounted filesystem as a place to name
1964
the fifo (for example, your home directory), it will still be the case that
1965
the reader (probably the "cat" command) and the
1966
writer (<EM>Pine</EM>) of the fifo must be running on the same system. <P>
1968
<DT> <A NAME="newmail-window-width"><EM>newmail-window-width</EM></A>
1970
<DD> UNIX <EM>Pine</EM> only.
1972
This option is only useful if you have turned on the
1973
<A HREF="#newmail-fifo-path">NewMail-FIFO-Path</A> option.
1974
That option causes new mail messages to be sent to a fifo file.
1975
Those messages will be 80 characters wide by default.
1976
You can change the width of the messages by changing this option.
1977
For example, if you are reading those messages in another window you might
1978
want to set this width to the width of that other window. <P>
1979
For UNIX <EM>Pine</EM>, this option is only useful if you have turned on the
1980
<A HREF="#newmail-fifo-path">NewMail-FIFO-Path</A> option.
1981
That option causes new mail messages to be sent to a fifo file.
1982
Those messages will be 80 characters wide by default.
1983
You can change the width of those messages by changing this option.
1984
For example, if you are reading those messages in another window you might
1985
want to set this width to the width of that other window.
1987
If you are using <EM>PC-Pine</EM>, it has an option in the Config menu to turn
1988
on the "New Mail Window".
1989
The present option also controls the width of that window.
1991
<DT> <A NAME="news-active"><EM>news-active-file-path</EM></A>
1993
<DD> This option tells <EM>Pine</EM> where to look for the "active file" for
1994
newsgroups when accessing news locally, rather than via NNTP. The default
1995
path is usually <CODE>/usr/lib/news/active</CODE>. <P>
1997
<DT> <A NAME="news-coll"><EM>news-collections</EM></A>
1999
<DD> This is a list of collections where news folders are located. See
2000
the section describing <A HREF="config-notes.html#collections">collections</A>
2001
for more information. <P>
2003
<DT> <A NAME="news-spool"><EM>news-spool-directory</EM></A>
2005
<DD> This option tells <EM>Pine</EM> where to look for the "news spool" for
2006
newsgroups when accessing news locally, rather than via NNTP. The default
2007
path is usually <CODE>/usr/spool/news</CODE>. <P>
2009
<DT> <A NAME="newsrc-path"><EM>newsrc-path</EM></A>
2011
<DD> This option overrides the default name <EM>Pine</EM> uses for your "newsrc"
2012
news status and subscription file. If set, <EM>Pine</EM> will take this value as
2013
the full pathname for the desired newsrc file. <P>
2015
<DT> <A NAME="nntp-range"><EM>nntp-range</EM></A>
2017
<DD> This option applies only to newsgroups accessed using the NNTP protocol.
2018
It does not, for example,
2019
apply to newsgroups accessed using an IMAP-to-NNTP proxy.
2021
When you open a connection to a News server using the NNTP protocol, you
2022
normally have access to all of the articles in each newsgroup.
2023
If a server keeps a large backlog of messages it may speed performance
2024
some to restrict attention to only the newer messages in a group.
2025
This option allows you to set how many article numbers should be checked
2026
when opening a newsgroup.
2027
You can think of "nntp-range" as specifying the maximum number
2028
of messages you ever want to see.
2029
For example, if you only ever wanted to look at the last 500 messages in each
2030
newsgroup you could set this option to 500.
2031
In actuality, it isn't quite that.
2032
Instead, for performance reasons, it specifies the range of article
2033
numbers to be checked, beginning
2034
with the highest numbered article and going backwards from there.
2035
If there are messages that have been canceled or deleted
2036
their article numbers are still counted as part of the range.
2038
So, more precisely, setting the "nntp-range" will cause article
2040
<P><CENTER>last_article_number - nntp-range + 1 through last_article_number</CENTER>
2042
to be considered when reading a newsgroup.
2043
The number of messages that show up in your index will be less than or equal
2044
to the value of "nntp-range".
2046
The purpose of this option is simply to speed up access when reading news.
2047
The speedup comes because <EM>Pine</EM> can ignore all but the last nntp-range article
2048
numbers, and can avoid downloading any information about the ignored articles.
2049
There is a cost you pay for this speedup.
2050
That cost is that there is no way for you to see those ignored articles.
2051
The articles that come before the range you specify are invisible to you and
2052
to <EM>Pine</EM>, as if they did not exist at all.
2053
There is no way to see those messages using, for example, an unexclude command
2054
or something similar.
2055
The only way to see those articles is to set this option high enough (or
2056
set it to zero) and then to reopen the newsgroup.
2059
If this option is set to 0 (which is also the default),
2060
then the range is unlimited.
2061
This option applies globally to all NNTP servers and to all newsgroups
2063
There is no way to set different values for different newsgroups or servers.
2066
<DT> <A NAME="nntp-server"><EM>nntp-server</EM></A>
2068
<DD> One or more NNTP servers (host name or IP address) which <EM>Pine</EM> will
2069
use for reading and posting news.
2070
If you read and post news to and from a single
2071
NNTP server, you can get away with only setting the <EM>nntp-server</EM>
2072
variable and leaving the <EM>news-collections</EM> variable unset.
2074
When you define an NNTP server, <EM>Pine</EM> implicitly defines a
2075
news collection for you, assuming that server as the news server
2076
and assuming that you will use the NNTP protocol and a local newsrc
2077
configuration file for reading news.
2078
See also <A HREF="#configuring-news">Configuring News</A>.
2080
Your NNTP server may offer NNTP "AUTHINFO SASL"
2081
or "AUTHINFO USER" authentication.
2082
It may even require it.
2083
If your NNTP server does offer such authentication you may specify a user name
2084
parameter to cause <EM>Pine</EM> to attempt to authenticate.
2085
The same is true for the server name in a folder collection which uses NNTP.
2086
This parameter requires an associated value,
2087
the username identifier with which to establish the server connection.
2088
An example might be:
2091
<CENTER><SAMP>nntpserver.example.com/user=katie</SAMP></CENTER>
2094
If authentication is offered by the server, this will cause <EM>Pine</EM> to
2096
If authentication is not offered by the server, this will cause <EM>Pine</EM>
2097
to fail with an error similar to:
2100
<CENTER><SAMP>Error: NNTP authentication not available</SAMP></CENTER>
2102
For more details about the server name possibilities see
2103
<A HREF="config-notes.html#server-name-syntax">Server Name Syntax</A>.
2106
<DT> <A NAME="norm-back"><EM>normal-background-color</EM></A>
2107
<DT> <A NAME="normal-foreground-color"><EM>normal-foreground-color</EM></A>
2109
<DD> <A HREF="#normal-color"><EM>Normal Color</EM></A>.
2112
<DT> <A NAME="operating-dir"><EM>operating-dir</EM></A>
2114
<DD> System-wide <EM>Pine</EM> configuration files only.
2115
This names the root of the
2116
tree to which the user is restricted when reading and writing folders and
2117
files. It is usually used in the <EM>fixed</EM> configuration file. <P>
2119
<DT> <A NAME="patterns-filters2"><EM>patterns-filters2</EM></A>
2121
<DD> Matching patterns and their corresponding actions are stored in
2123
These patterns are used with
2124
<A HREF="#filter-config"><EM>Filtering</EM></A>.
2125
This variable is normally maintained through the Setup/Rules/Filters
2126
configuration screen.
2127
It is a list variable.
2128
Each member of the list is a single pattern/action pair, or it can be
2129
a file which contains zero or more lines of pattern/action pairs.
2130
The only way to create a filters file is to use the InsertFile command in
2131
the Setup/Rules/Filters screen with a filename which doesn't yet exist.
2132
Then use the Shuffle command to move existing filter patterns into the file.
2133
This isn't very convenient but it isn't thought that many users will
2134
need this functionality.
2135
The purpose of filter files is for sharing filters.
2138
<DT> <A NAME="patterns-indexcolors"><EM>patterns-indexcolors</EM></A>
2140
<DD> Matching patterns and their corresponding actions are stored in
2142
These patterns are used for
2143
<A HREF="#index-color-config"><EM>Index Line Colors</EM></A>.
2144
This variable is normally maintained through the Setup/Rules/Indexcolor
2145
configuration screen.
2146
It is a list variable.
2147
Each member of the list is a single pattern/action pair, or it can be
2148
a file which contains zero or more lines of pattern/action pairs.
2149
The only way to create a indexcolor file is to use the InsertFile command in
2150
the Setup/Rules/Indexcolor screen with a filename which doesn't yet exist.
2151
Then use the Shuffle command to move existing patterns into the file.
2152
This isn't very convenient but it isn't thought that many users will
2153
need this functionality.
2154
The purpose of indexcolor files is for sharing indexcolors.
2157
<DT> <A NAME="patterns-other"><EM>patterns-other</EM></A>
2159
<DD> Matching patterns and their corresponding actions are stored in
2161
These patterns are used with
2162
<A HREF="#other-config"><EM>Miscellaneous Rules</EM></A> configuration.
2163
This variable is normally maintained through the Setup/Rules/Other
2164
configuration screen.
2165
It is a list variable.
2166
Each member of the list is a single pattern/action pair, or it can be
2167
a file which contains zero or more lines of pattern/action pairs.
2168
The only way to create a rules file is to use the InsertFile command in
2169
the Setup/Rules/Other screen with a filename which doesn't yet exist. Then use
2170
the Shuffle command to move existing rules into the file.
2171
This isn't very convenient but it isn't thought that many users will
2172
need this functionality.
2175
<DT> <A NAME="patterns-roles"><EM>patterns-roles</EM></A>
2177
<DD> Matching patterns and their corresponding actions are stored in
2179
These patterns are used with
2180
<A HREF="#role-config"><EM>Roles</EM></A>.
2181
This variable is normally maintained through the Setup/Rules/Roles
2182
configuration screen.
2183
It is a list variable.
2184
Each member of the list is a single pattern/action pair, or it can be
2185
a file which contains zero or more lines of pattern/action pairs.
2186
The only way to create a roles file is to use the InsertFile command in
2187
the Setup/Rules/Roles screen with a filename which doesn't yet exist. Then use
2188
the Shuffle command to move existing roles into the file.
2189
This isn't very convenient but it isn't thought that many users will
2190
need this functionality.
2191
The purpose of role files is for sharing roles.
2194
<DT> <A NAME="patterns-scores2"><EM>patterns-scores2</EM></A>
2196
<DD> Matching patterns and their corresponding actions are stored in
2198
These patterns are used with
2199
<A HREF="#scoring-config"><EM>Scoring</EM></A>.
2200
This variable is normally maintained through the Setup/Rules/SetScores
2201
configuration screen.
2202
It is a list variable.
2203
Each member of the list is a single pattern/action pair, or it can be
2204
a file which contains zero or more lines of pattern/action pairs.
2205
The only way to create a scores file is to use the InsertFile command in
2206
the Setup/Rules/SetScores screen with a filename which doesn't yet exist.
2207
Then use the Shuffle command to move existing scoring patterns into the file.
2208
This isn't very convenient but it isn't thought that many users will
2209
need this functionality.
2210
The purpose of scoring files is for sharing scoring rules.
2213
<DT> <A NAME="personal-name"><EM>personal-name</EM></A>
2215
<DD> Personal configuration file only.
2216
User's full personal name. On UNIX systems, the default is taken
2217
from the accounts data base (<CODE>/etc/passwd</CODE>).
2218
The easiest way to change the full From address is with the
2219
<A HREF="#cust-hdr"><EM>customized-hdrs</EM></A> variable.
2222
<DT> <A NAME="personal-print-category"><EM>personal-print-category</EM></A>
2224
<DD> Personal configuration file only.
2225
This is the category that the default print command belongs to. There
2226
are three categories. Category 1 is an attached printer which uses the ANSI
2227
escape sequence, category 2 is the standard system print command, and
2228
category 3 is the set of custom printer commands defined by the user.
2229
This just helps <EM>Pine</EM> figure out where to put the cursor when the user
2230
runs the <EM>Setup/Printer</EM> command. This is not used by <EM>PC-Pine</EM>.
2233
<DT> <A NAME="personal-print-command"><EM>personal-print-command</EM></A>
2235
<DD> Personal configuration file only.
2236
This corresponds to the third category in the printer menu, the
2237
personally selected print commands. This variable
2238
contains the list of custom commands that the user has entered in the
2239
<EM>Setup/Printer</EM> screen. This is not used by <EM>PC-Pine</EM>.
2242
<DT> <A NAME="postponed-folder"><EM>postponed-folder</EM></A>
2244
<DD> The folder where postponed messages are stored. The default is
2245
<EM>postponed-msgs</EM> (Unix) or <EM>POSTPOND</EM> (PC). <P>
2247
<DT> <A NAME="print-font-name"><EM>print-font-name</EM></A>
2249
<DD> Winsock version of <EM>PC-Pine</EM> only. <P>
2251
<DT> <A NAME="print-font-size"><EM>print-font-size</EM></A>
2253
<DD> Winsock version of <EM>PC-Pine</EM> only. <P>
2255
<DT> <A NAME="print-font-style"><EM>print-font-style</EM></A>
2257
<DD> Winsock version of <EM>PC-Pine</EM> only. <P>
2259
<DT> <A NAME="printer"><EM>printer</EM></A>
2261
<DD> Personal configuration file only.
2262
This is the current setting for a user's printer.
2263
This variable is set from <EM>Pine</EM>'s <EM>Setup/Printer</EM> screen.
2266
<DT> <A NAME="prompt-background-color"><EM>prompt-background-color</EM></A>
2267
<DT> <A NAME="prompt-foreground-color"><EM>prompt-foreground-color</EM></A>
2269
<DD> <A HREF="#prompt-color"><EM>Prompt Color</EM></A>.
2272
<DT> <A NAME="pruned-folders"><EM>pruned-folders</EM></A>
2274
<DD> This variable allows you to define a list of one or more folders that
2275
<EM>Pine</EM> will offer to prune for you in the same way it automatically offers
2276
to prune your "sent-mail" folder each month.
2277
Each folder in this list must be a folder in your default folder collection
2278
(the first folder collection if you have more than one), and it is just
2279
the relative name of the folder in the collection, not the fully-qualified name.
2280
It is similar to sent-mail.
2281
Instead of something like
2283
<CENTER><SAMP>pruned-folders={servername}mail/folder</SAMP></CENTER>
2285
the correct value to use would be
2287
<CENTER><SAMP>folder</SAMP></CENTER>
2289
There is an assumption here that your first collection is the folders in
2291
<CENTER><SAMP>{servername}mail</SAMP></CENTER>
2294
Once a month, for each folder listed, <EM>Pine</EM> will offer to move
2295
the contents of the folder to a new folder of the same name but with
2296
the previous month's date appended. <EM>Pine</EM> will then look for any such
2297
date-appended folder names created for a previous month, and offer each
2298
one it finds for deletion.
2301
If you decline the first offer, no mail is moved and no new folder is
2305
The new folders will be created
2306
in your default folder collection.
2309
<DT> <A NAME="pruning-rule"><EM>pruning-rule</EM></A>
2311
<DD> By default, <EM>Pine</EM> will ask at the beginning of each month whether or not
2312
you want to rename your sent-mail folder to a name like sent-mail-month-year.
2313
(See the feature <A HREF="#prune-uses-yyyy-mm">prune-uses-yyyy-mm</A> to
2314
change the format of the folder to sent-mail-yyyy-mm.)
2315
It will also ask whether you would like to delete old sent-mail folders.
2317
<A HREF="#read-msg-fold"><EM>read-message-folder</EM></A>
2319
<A HREF="#pruned-folders"><EM>pruned-folders</EM></A>
2320
<EM>Pine</EM> will also ask about pruning those folders.
2321
With this option you may provide an automatic answer to the rename questions
2322
and you may tell <EM>Pine</EM> to not ask about deleting old folders.<P>
2324
<DT> <A NAME="quote1-background-color"><EM>quote1-background-color</EM></A>
2325
<DT> <A NAME="quote1-foreground-color"><EM>quote1-foreground-color</EM></A>
2326
<DT> <A NAME="quote2-background-color"><EM>quote2-background-color</EM></A>
2327
<DT> <A NAME="quote2-foreground-color"><EM>quote2-foreground-color</EM></A>
2328
<DT> <A NAME="quote3-background-color"><EM>quote3-background-color</EM></A>
2329
<DT> <A NAME="quote3-foreground-color"><EM>quote3-foreground-color</EM></A>
2331
<DD> <A HREF="#quote-colors"><EM>Quote Colors</EM></A>.
2334
<DT> <A NAME="quote-suppression-threshold"><EM>quote-suppression-threshold</EM></A>
2336
<DD> This option should be used with care.
2337
It will cause some of the quoted text to be eliminated from the
2338
display when viewing a message in the MESSAGE TEXT screen.
2339
For example, if you set the Quote-Suppression-Threshold to the
2340
value "5",
2341
this will cause quoted text that is longer than five lines to be truncated.
2342
Quoted text of five or fewer consecutive lines will be displayed in its entirety.
2343
Quoted text of more than six lines will have the first five lines displayed
2344
followed by a line that looks something like
2346
<CENTER><SAMP>[ 12 lines of quoted text hidden from view ]</SAMP></CENTER>
2348
As a special case, if exactly one line of quoted text would be hidden, the
2349
entire quote will be shown instead.
2350
So for the above example, quoted text which is exactly six lines long will
2351
will be shown in its entirety.
2352
(In other words, instead of hiding a single line and adding a line
2353
that announces that one line was hidden, the line is just shown.)
2355
If the sender of a message has carefully chosen the quotes that he or she
2356
includes, hiding those quotes may change the meaning of the message.
2357
For that reason, <EM>Pine</EM> requires that when you want to set the value of this
2358
variable to something less than four lines, you actually have to set it
2359
to the negative of that number.
2360
So if you want to set this option to "3", you actually have to
2361
set it to "-3".
2362
The only purpose of this is to get you to think about whether or not you
2363
really want to do this!
2364
If you want to delete all quoted text you set the value of this option
2365
to the special value "-10".
2367
The legal values for this option are
2371
<TD> 0 </TD>
2372
<TD> Default, don't hide anything </TD>
2375
<TD> -1,-2,-3 </TD>
2376
<TD> Suppress quote lines past 1, 2, or 3 lines </TD>
2379
<TD> 4,5,6,... </TD>
2380
<TD> Suppress if more than that many lines </TD>
2383
<TD> -10 </TD>
2384
<TD> Suppress all quoted lines </TD>
2388
If you set this option to a non-default value you may sometimes wish to
2389
view the quoted text that is not shown.
2390
When this is the case, the HdrMode (Header Mode) command may be used to
2391
show the hidden text.
2392
Typing the "H" command once will show the hidden text.
2393
Typing a second "H" will also turn on Full Header mode.
2394
The presence or absence of the HdrMode command is determined by the
2395
<A HREF="#enable-full-header-cmd">"Enable-Full-Header-Cmd"</A>
2396
Feature-List option in your <EM>Pine</EM> configuration, so you will want to
2397
be sure to turn that on if you use quote suppression.
2399
For the purposes of this option, a quote is a line that begins with the
2400
character ">".
2402
Quotes are only suppressed when displaying a message on the screen.
2403
The entire quote will be left intact when printing or forwarding or something
2407
<DT> <A NAME="read-msg-fold"><EM>read-message-folder</EM></A>
2409
<DD> If set, mail in the <EM>INBOX</EM> that has been read but not deleted
2410
is moved here, or rather, the user is asked whether or not he or she wants
2411
to move it here upon quitting <EM>Pine</EM>. <P>
2413
<DT> <A NAME="remote-abook-history"><EM>remote-abook-history</EM></A>
2415
<DD> Sets how many extra copies of
2416
<A HREF="low-level.html#addrbook">remote address book</A>
2417
data will be kept in each remote address book folder.
2418
The default is three.
2419
These extra copies are simply old versions of the data. Each time a change
2420
is made a new copy of the address book data is appended to the folder. Old
2421
copies are trimmed, if possible, when <EM>Pine</EM> exits.
2422
An old copy can be put back into use by
2423
deleting and expunging newer versions of the data from the folder.
2424
Don't delete the first message from the folder. It is a special header
2425
message for the remote address book and it must be there.
2426
This is to prevent regular folders from being used as remote address book
2427
folders and having their data destroyed.
2430
<DT> <A NAME="remote-abook-metafile"><EM>remote-abook-metafile</EM></A>
2432
<DD> Personal configuration file only.
2433
This is usually set by <EM>Pine</EM> and is the name of a file
2434
that contains data about
2435
<A HREF="low-level.html#addrbook">remote address books</A> and
2436
<A HREF="low-level.html#remote-config">remote configuration files</A>.
2439
<DT> <A NAME="remote-abook-validity"><EM>remote-abook-validity</EM></A>
2441
<DD> Sets the minimum number of minutes that a
2442
remote address book will be considered up to date.
2443
Whenever an entry contained in a remote address book is used,
2444
if more than this many minutes have
2445
passed since the last check the remote server will be queried to see if the
2446
address book has changed.
2447
If it has changed, the local copy is updated.
2448
The default value is five minutes.
2449
The special value of -1 means never check.
2450
The special value of zero means only check when the address book is first
2453
No matter what the value, the validity check is always done when the
2454
address book is about to be changed by the user.
2455
The check can be initiated manually by typing <EM>^L</EM> (Ctrl-L)
2456
while in the address book maintenance screen for the remote address book.
2459
<DT> <A NAME="quote-replace-string"><EM>quote-replace-string</EM></A>
2461
<DD> This option specifies what string to use as a quote when <b>viewing</b> a
2462
message. The standard way of quoting messages when replying is the string
2463
"> " (quote space).
2464
With this variable set, viewing a message will
2465
replace occurrences of "> " with the replacement string.
2466
This setting works best when
2467
<A HREF="#reply-ind-string">Reply-Indent-String</A>
2468
or the equivalent setting in your correspondents' mail programs
2469
is set to the default "> ", but it will also work fine with the
2470
Reply-Indent-String set to ">".
2472
By default, this setting will only work on messages that are flowed, which is
2473
the default way of sending messages for many mail clients including versions
2474
of Pine after 4.60. Enable the feature
2475
<A HREF="#quote-replace-nonflowed">Quote-Replace-Nonflowed</A>
2476
to also have quote-replacement performed on non-flowed messages.
2478
Setting this option will replace ">" and
2479
"> " with the new setting. This string may include trailing
2480
spaces. To preserve those spaces enclose the full string in double quotes.
2482
No padding to separate the text of the message from the quote string is
2483
added. This means that if you do not add trailing spaces to the value of
2484
this variable, text will be displayed right next to the quote string,
2485
which may be undesirable. This can be avoided by adding a new string
2486
separated by a space from your selection of quote string replacement. This
2487
last string will be used for padding. For example, setting this variable to
2488
">" " " has the effect of setting
2489
">" as the quote-replace-string, with the text padded by
2490
a space from the last quote string to make it more readable.
2492
One possible setting for this variable could be
2493
" " (four spaces wrapped in quotes), which
2494
would have the effect of indenting each level of quoting four spaces and
2495
removing the ">"'s. Different levels of quoting could be made
2496
more discernible by setting colors for quoted text.
2498
Replying to or forwarding the viewed message will preserve the original
2499
formatting of the message, so quote-replacement will not be performed on
2500
messages that are being composed.
2503
<DT> <A NAME="reply-ind-str"><EM>reply-indent-string</EM></A>
2505
<DD> This variable specifies an aspect of <EM>Pine</EM>'s <EM>Reply</EM>
2507
When a message is replied to and the text of the message is included, the
2508
included text usually has the string "> " prepended
2509
to each line indicating it is quoted text.
2512
This option specifies a different value for that string.
2513
If you wish to use a string which begins or ends with a space,
2514
enclose the string in double quotes.
2517
Besides simple text, the prepended string can be based
2518
on the message being replied to.
2519
The following tokens are substituted for the message's corresponding value:
2523
<DD>This token gets replaced with the message sender's "username".
2524
At most six characters are used.
2528
<DD>This token gets replaced with the nickname of the message sender's
2529
address as found in your addressbook.
2530
If no addressbook entry is found,
2531
Pine replaces the characters "_NICK_" with nothing.
2532
At most six characters are used.
2536
<DD>This token gets replaced with the initials of the sender of the message.
2542
<A HREF="#enable-reply-indent-string-editing"><EM>enable-reply-indent-string-editing</EM></A>
2543
feature is enabled, you are given the opportunity to edit the string, whether
2544
it is the default or one automatically generated using the above tokens.
2547
<DT> <A NAME="reply-leadin"><EM>reply-leadin</EM></A>
2549
<DD> This variable specifies an aspect of <EM>Pine</EM>'s <EM>Reply</EM>
2551
When a message is replied to and the text of the message is included,
2552
that text has an introductory line preceding it.
2553
The normal default if you don't set this variable looks something like:
2555
<CENTER><SAMP>On Sat, 24 Oct 1998, Fred Flintstone wrote:</SAMP></CENTER>
2557
where the day of the week is only included if it is available in the
2559
You may replace this default with text of your own.
2560
The text may contain tokens which are replaced with text
2561
which depends on the message you are replying to.
2562
For example, the default is equivalent to:
2564
<CENTER><SAMP>On _DAYDATE_, _FROM_ wrote:</SAMP></CENTER>
2566
The list of available tokens is
2567
<A HREF="#index-tokens"><EM>here</EM></A>.
2569
For the adventurous, there is a way to conditionally include text based
2570
on whether or not a token would result in specific replacement text.
2571
For example, you could include some text based on whether or not
2572
the _NEWS_ token would result in any newsgroups if it was used.
2573
It's explained in detail
2574
<A HREF="#reply-token-conditionals"><EM>here</EM></A>.
2578
If your <EM>Reply-Leadin</EM> turns out to be longer
2579
than 80 characters when replying to a particular message, it is shortened.
2581
In the very unlikely event that you want to include a literal token
2582
in the introduction line you must precede it with a backslash character.
2585
<CENTER><SAMP>\_DAYDATE_ = _DAYDATE_</SAMP></CENTER>
2587
would produce something like
2589
<CENTER><SAMP>_DAYDATE_ = Sat, 24 Oct 1998</SAMP></CENTER>
2591
It is not possible to have a literal backslash followed by an expanded token.
2594
<DT> <A NAME="reverse-background-color"><EM>reverse-background-color</EM></A>
2595
<DT> <A NAME="reverse-foreground-color"><EM>reverse-foreground-color</EM></A>
2597
<DD> <A HREF="#reverse-color"><EM>Reverse Color</EM></A>.
2600
<DT> <A NAME="rsh-command"><EM>rsh-command</EM></A>
2602
<DD> Sets the format of the command used to
2603
open a UNIX remote shell connection. The default is
2604
"%s %s -l %s exec /etc/r%sd". All four "%s" entries MUST exist in the
2605
provided command. The first is for the command's pathname, the second is
2606
for the host to connnect to, the third is for the user to connect as, and
2607
the fourth is for the connection method (typically <CODE>imap</CODE>).
2610
<DT> <A NAME="rsh-open-timeout"><EM>rsh-open-timeout</EM></A>
2612
<DD> Sets the time in seconds that <EM>Pine</EM> will
2613
attempt to open a UNIX remote shell connection.
2614
The default is 15, the minimum non-zero value is 5,
2615
and the maximum is unlimited. If this is set to zero rsh connections
2616
will be completely disabled.
2619
<DT> <A NAME="rsh-path"><EM>rsh-path</EM></A>
2621
<DD> Sets the name of the command used to open a UNIX remote shell
2622
connection. The default is typically <CODE>/usr/ucb/rsh</CODE>.
2625
<DT> <A NAME="saved-msg-name"><EM>saved-msg-name-rule</EM></A>
2627
<DD> Determines default folder name when <EM>Sav</EM>ing.
2628
If set to <EM>default-folder</EM> (which is the default setting),
2629
then <EM>Pine</EM> will offer the folder "saved-messages" (UNIX) or "SAVEMAIL"
2630
(PC) for <EM>Sav</EM>ing messages. The default folder offered in this way
2631
may be changed by using the configuration variable
2632
<A HREF="#def-save"><EM>default-saved-msg-folder</EM></A>.
2635
If this rule is set to <EM>last-folder-used</EM>, <EM>Pine</EM> offers to
2636
<EM>Save</EM> to the folder you last successfully <EM>Saved</EM> a message
2638
The first time you <EM>Save</EM> a message in a session,
2639
<EM>Pine</EM> offers to <EM>Save</EM> the message to the default folder.
2642
Choosing any of the <EM>by-</EM> options causes <EM>Pine</EM> to attempt
2643
to get the chosen option's value for the message being <EM>Saved</EM> (or
2644
for the first message being Saved if using an aggregate Save).
2645
For example, if <EM>by-from</EM> is chosen, <EM>Pine</EM> attempts to
2646
get the value of who the message
2647
came from (i.e. the from address). <EM>Pine</EM> then attempts to
2648
<EM>Save</EM> the message to a folder matching that value.
2649
If <EM>by-from</EM> is chosen and no value is
2650
obtained, <EM>Pine</EM> uses <EM>by-sender</EM>.
2651
The opposite is also true.
2652
If <EM>by-recipient</EM> was chosen and the message was posted to a newsgroup,
2653
<EM>Pine</EM> will use the newsgroup name.
2654
If <EM>by-replyto</EM> is chosen and no value is
2655
obtained, <EM>Pine</EM> uses <EM>by-from</EM>.
2658
If any of the "by-realname" options are chosen, <EM>Pine</EM> will attempt
2659
to use the personal name part of the address instead of the mailbox part.
2660
If any of the "by-nick" options are chosen, the
2661
address is looked up in your address book and if found, the
2662
nickname for that entry is used.
2663
Only simple address book entries are checked, not distribution lists.
2664
Similarly, if any of the
2665
"by-fcc" options are chosen, the fcc from the corresponding
2666
address book entry is used.
2667
If by-realname, or the by-nick or by-fcc lookups result in no value,
2668
then if the chosen option ends with the "then-from",
2669
"then-sender", "then-replyto",
2670
or "then-recip" suffix, <EM>Pine</EM>
2671
reverts to the same behavior as "by-from",
2672
"by-sender", "by-replyto", or "by-recip"
2673
depending on which option was specified.
2674
If the chosen option doesn't end with one of
2675
the "then-" suffixes, then <EM>Pine</EM> reverts to the default
2676
folder when no match is found in the address book.
2679
Here is an example to make some of the options clearer.
2680
If the message is From
2682
<CENTER><SAMP>Fred Flintstone <flint@bedrock.org></SAMP></CENTER>
2684
and this rule is set to "by-from", then the default folder offered
2685
in the save dialog would be "flint".
2687
If this rule is set to "by-realname-of-from" then the default would
2688
be "Fred Flintstone".
2690
If this rule is set to "by-nick-of-from" then <EM>Pine</EM> will search
2691
for the address "flint@bedrock.org" in your address book.
2692
If an entry is found and it has a nickname associated with it, that nickname
2693
will be offered as the default folder.
2694
If not, the default saved message folder will be offered as the default.
2696
If this rule is set to "by-fcc-of-from" then <EM>Pine</EM> will search
2697
for the address "flint@bedrock.org" in your address book.
2698
If an entry is found and it has an Fcc associated with it, that Fcc
2699
will be offered as the default folder.
2700
If not, the default saved message folder will be offered as the default.
2702
If this rule is set to "by-nick-of-from-then-from" then <EM>Pine</EM> will search
2703
for the address "flint@bedrock.org" in your address book.
2704
If an entry is found and it has a nickname associated with it, that nickname
2705
will be offered as the default folder.
2706
If it is not found (or has no nickname) then the default offered will be
2707
the same as it would be for the "by-from" rule.
2708
That is, it would be "flint"
2711
<DT> <A NAME="scroll-margin"><EM>scroll-margin</EM></A>
2713
<DD> This option controls when <EM>Pine</EM>'s line-by-line scrolling occurs.
2714
Typically, when a selected item is at the top or bottom screen edge
2715
and the UP or DOWN (and Ctrl-P or Ctrl-N) keys are pressed, the
2716
displayed items are scrolled down or up by a single line.
2719
This option allows you to tell <EM>Pine</EM> the number of lines from the top and
2720
bottom screen edge that line-by-line scrolling should occur. For example,
2721
setting this value to one (1) will cause <EM>Pine</EM> to scroll the display
2722
when you move to select an item on the display's top or
2723
bottom edge (instead of moving when you move off the edge of the screen).
2726
By default, this variable is zero (0), indicating that scrolling happens
2727
when you move up or down to select an item immediately off the display's
2731
<DT> <A NAME="selectable-item-background-color"><EM>selectable-item-background-color</EM></A>
2732
<DT> <A NAME="selectable-item-foreground-color"><EM>selectable-item-foreground-color</EM></A>
2734
<DD> <A HREF="#selectable-item-color"><EM>Selectable-item Color</EM></A>.
2737
<DT> <A NAME="sending-filters"><EM>sending-filters</EM></A>
2739
<DD> This option defines a list of text-filtering commands (programs and
2740
scripts) that may be selectively invoked to process a message just before
2741
it is sent. If set, the Composer's <EM>^X Send</EM> command will allow you to
2742
select which filter (or none) to apply to the message before it is sent.
2743
For security reasons, the full path of the filter program must be
2746
Sending filters do not work with <EM>PC-Pine</EM> and sending filters are
2747
not used if the feature
2748
<A HREF="#send-without-confirm">send-without-confirm</A> is set.
2750
Command Modifying Tokens:
2753
<DT><EM>_RECIPIENTS_</EM>
2754
<DD>When the command is executed, this token is replaced
2755
with the space delimited list of recipients of the
2758
<DT><EM>_TMPFILE_</EM>
2760
When the command is executed, this token is
2761
replaced with the path and name of the temporary
2762
file containing the text to be filtered. <EM>Pine</EM>
2763
expects the filter to replace this data with the
2766
NOTE: Use of this token implies that the text to
2767
be filtered is not piped into standard input of the
2768
executed command and its standard output is ignored.
2769
<EM>Pine</EM> restores the tty modes before invoking the
2770
filter in case the filter interacts with the user
2771
via its own standard input and output.
2773
<DT><EM>_RESULTFILE_</EM>
2774
<DD>When the command is executed, this token is
2775
replaced with the path and name of a temporary
2776
file intended to contain a status message from the
2777
filter. <EM>Pine</EM> displays this in the message status
2780
<DT><EM>_DATAFILE_</EM>
2781
<DD>When the command is executed, this token is replaced
2782
in the command line with the path and name of a
2783
temporary file that <EM>Pine</EM> creates once per session
2784
and deletes upon exit. The file is intended to be
2785
used by the filter to store state information between
2786
instances of the filter.
2788
<DT><EM>_PREPENDKEY_</EM>
2789
<DD>When the command is executed, this token indicates
2790
that a random number will be passed down the input
2791
stream before the message text. It is not included as a command-line argument.
2792
This number could be used as a session key. It is sent in this way
2793
to improve security. The number is unique to the
2794
current <EM>Pine</EM> session and is only generated once per
2797
<DT><EM>_INCLUDEALLHDRS_</EM>
2798
<DD>When the command is executed, this token indicates
2799
that the headers of the message will be passed down the input stream
2800
before the message text.
2801
It is not included as a command-line argument.
2802
The filter should, of course, remove the headers before returning control
2805
<DT><EM>_MIMETYPE_</EM>
2806
<DD>When the command is executed, this token is replaced in the
2807
command name with a temporary file name used to accept any new MIME
2808
Content-Type information necessitated by the output of the filter.
2809
Upon the filter's exit, if the file contains new MIME type
2810
information, <EM>Pine</EM> verifies its format and replaces the outgoing
2811
message's MIME type information with that contained in the file. This
2812
is basically a cheap way of sending something other than Text/Plain.
2816
<DT> <A NAME="sendmail-path"><EM>sendmail-path</EM></A>
2818
<DD> This names the path to an
2819
alternative program, and any necessary arguments, to be used in posting
2820
mail messages. See the section on <A
2821
HREF="background.html#SMTP">SMTP and Sendmail</A> for more details.
2824
<DT> <A NAME="sig-file"><EM>signature-file</EM></A></A>
2826
<DD> This is the name of a file which will be automatically inserted into
2828
It typically contains information such as your
2829
name, email address and organizational affiliation.
2830
<EM>Pine</EM> adds the
2831
signature into the message as soon as you enter the composer so you
2832
can choose to remove it or edit it on a message by message basis.
2833
Signature file placement in message replies is controlled by the
2834
<A HREF="#sig-at-bot">signature-at-bottom</A>
2835
setting in the feature list.
2839
<CODE>~/.signature</CODE> on UNIX and <PINERC
2840
directory><CODE>\PINE.SIG</CODE> on a PC. <P>
2842
To create or edit your signature file choose Setup from the Main Menu
2843
and then select S for Signature (Main/Setup/Signature).
2845
into the Signature Editor where you can enter a <EM>few</EM> lines of
2846
text containing your identity and affiliation.
2849
If the filename is followed by a vertical bar (|) then instead
2850
of reading the contents of the file the file is assumed to be a
2851
program which will produce the text to be used on its standard output.
2852
The program can't have any arguments and doesn't receive any input from <EM>Pine</EM>,
2853
but the rest of the processing works as if the contents came from a file.
2856
Instead of storing the data in a local file, the
2857
signature data may be stored remotely in an IMAP folder.
2858
In order to do this,
2859
you must use a remote name for the file.
2860
A remote signature-file name might look like:
2862
<CENTER><SAMP>{myimaphost.myschool.k12.wa.us}mail/signature</SAMP></CENTER>
2864
or, if you have an SSL-capable version of <EM>Pine</EM>, you might try
2866
<CENTER><SAMP>{myimaphost.myschool.k12.wa.us/user=loginname/ssl}mail/signature</SAMP></CENTER>
2869
The syntax used here is the same as the syntax used for remote configuration
2870
files from the command line.
2871
Note that you may not access an existing signature file remotely,
2872
you have to create a new <EM>folder</EM> which contains the signature data.
2873
If the name you use here for the signature file is a remote name, then when
2874
you edit the file from the Setup/Signature command the data will be stored
2875
remotely in the folder.
2876
You aren't required to do anything special to create the folder, it
2877
gets created automatically if you use a remote name.
2880
Besides regular text, the signature file may also contain
2881
(or a signature program may produce) tokens which
2882
are replaced with text which usually depends on the message you are replying
2884
For example, if the signature file contains the token
2886
<CENTER><SAMP>_DATE_</SAMP></CENTER>
2888
anywhere in the text, then that token is replaced by the date
2889
the message you are replying to or forwarding was sent.
2892
<CENTER><SAMP>_CURDATE_</SAMP></CENTER>
2894
that is replaced with the current date.
2895
The first is an example of a token which depends on the message you
2896
are replying to (or forwarding) and the second is an example which
2897
doesn't depend on anything other than the current date.
2898
You have to be a little careful with this facility since tokens which
2899
depend on the message you are replying to or forwarding will be replaced
2900
by nothing in the case where you are composing a new message from scratch.
2901
The use of <A HREF="#role-config"><EM>roles</EM></A> may help you
2903
It allows you to use different signature files in different cases.
2906
The list of tokens available for use in the signature file is
2907
<A HREF="#index-tokens"><EM>here</EM></A>.
2910
Instead of, or along with the use of <EM>roles</EM> to give you
2911
different signature files in different situations, there is also
2912
a way to conditionally include text based
2913
on whether or not a token would result in specific replacement text.
2914
For example, you could include some text based on whether or not
2915
the _NEWS_ token would result in any newsgroups if it was used.
2916
This is explained in detail
2917
<A HREF="#reply-token-conditionals"><EM>here</EM></A>.
2918
This isn't for the faint of heart.
2920
In the very unlikely event that you want to include a literal token
2921
in the signature you must precede it with a backslash character.
2924
<CENTER><SAMP>\_DAYDATE_ = _DAYDATE_</SAMP></CENTER>
2926
would produce something like
2928
<CENTER><SAMP>_DAYDATE_ = Sat, 24 Oct 1998</SAMP></CENTER>
2930
It is not possible to have a literal backslash followed by an expanded token.
2933
<DT> <A NAME="signature-background-color"><EM>signature-background-color</EM></A>
2934
<DT> <A NAME="signature-foreground-color"><EM>signature-foreground-color</EM></A>
2936
<DD> <A HREF="#signature-color"><EM>Signature Color</EM></A>.
2939
<DT> <A NAME="smtp-server"><EM>smtp-server</EM></A>
2941
<DD> One or more SMTP servers (host name or IP address) which <EM>Pine</EM> will
2942
use for outgoing mail. If not set, <EM>Pine</EM> passes outgoing email to the
2943
<EM>sendmail</EM> program on the local machine. <EM>PC-Pine</EM> users must have
2944
this variable set in order to send mail as they have no <EM>sendmail</EM>
2947
Your SMTP server may offer SMTP AUTH authentication.
2948
It may even require it.
2949
If your SMTP server offers SMTP AUTH authentication you may specify a
2950
"user" name parameter to cause Pine to attempt to authenticate.
2951
This parameter requires an associated value,
2952
the username identifier with which to establish the server
2954
An example might be:
2957
<CENTER><SAMP>smtpserver.example.com/user=katie</SAMP></CENTER>
2960
If AUTH authentication is offered by the server, this will cause <EM>Pine</EM> to
2962
If AUTH authentication is not offered by the server, this will cause <EM>Pine</EM>
2963
to fail sending with an error similar to:
2966
<CENTER><SAMP>Error: SMTP authentication not available</SAMP></CENTER>
2969
Another type of authentication that is used by some ISPs is called
2970
"POP before SMTP" or "IMAP before SMTP",
2971
which means that you have to authenticate
2972
yourself to the POP or IMAP server by opening a mailbox before you
2974
To do this, you usually only have to open your INBOX.
2976
You may tell <EM>Pine</EM> to use the
2977
<A HREF="http://www.ietf.org/rfc/rfc2476.txt">Message Submission</A>
2978
port (587) instead of the SMTP port (25) by including the "submit"
2981
At this time "/submit" is simply equivalent to specifying
2982
port 587, though it may imply more than that at some point in the future.
2983
Some ISPs are blocking port 25 in order to reduce the amount of spam
2984
being sent to their users.
2985
You may find that the submit option allows you to get around such a block.
2988
<CENTER><SAMP>smtpserver.example.com/submit</SAMP></CENTER>
2991
To specify any non-standard port number on the SMTP server you may follow
2992
the hostname with a colon followed by the portnumber.
2995
<CENTER><SAMP>smtpserver.example.com:12345</SAMP></CENTER>
2998
Normally, when a connection is made to the Smtp-Server <EM>Pine</EM> will attempt
2999
to negotiate a secure (encrypted) session using Transport Layer Security (TLS).
3000
If that fails then a non-encrypted connection will be attempted instead.
3001
You may specify that a TLS connection is required if you wish.
3002
If you append "/tls" to the name then the connection will fail
3003
instead of falling back to a non-secure connection.
3006
<CENTER><SAMP>smtpserver.example.com/tls</SAMP></CENTER>
3010
<A HREF="config-notes.html#smtp-server">SMTP Servers</A>
3012
<A HREF="config-notes.html#server-name-syntax">Server Name Syntax</A>
3013
section for some more details.
3016
<DT> <A NAME="sort-key"><EM>sort-key</EM></A>
3018
<DD> This variable sets up the default Message Index sorting.
3020
sort by arrival order (the order the messages arrived in the folder).
3021
It has the same functionality as the
3022
<EM>-sort</EM> command line argument and the <EM>$</EM> command in the
3023
"Folder Index". If a <EM>sort-key</EM> is set, then all folders open during
3024
the session will have that as the default sort order. <P>
3026
<DT> <A NAME="speller"><EM>speller</EM></A>
3028
<DD> This option affects the behavior of the <EM>^T</EM> (spell check)
3029
command in the Composer.
3030
It specifies the program invoked by <EM>^T</EM> in the Composer.
3031
By default, <EM>Pine</EM> uses the system's "spell" command.
3032
<EM>Pine</EM> will use the
3033
command defined by this option (if any) instead.
3034
When invoking the spell-checking program,
3035
<EM>Pine</EM> appends a tempfile name (where the message is passed)
3036
to the command line.
3037
<EM>Pine</EM> expects the speller to correct the
3038
spelling in that file. When you exit from the speller
3039
program <EM>Pine</EM> will read the
3040
tmpfile back into the composer.
3042
For Unix <EM>Pine</EM> the program <EM>ispell</EM> works well as an
3043
alternate spell checker.
3044
If your Unix system has <EM>ispell</EM> it is probably reasonable to make
3045
it the default speller by configuring it as the default in the
3046
system configuration file, <CODE>/usr/local/lib/pine.conf</CODE>.
3049
If this option is not set, then the system's <EM>spell</EM> command is used.
3050
The spell command does not work the same as the alternate speller.
3051
It produces a list of misspelled words on its standard output, instead,
3052
and doesn't take a tempfile as an argument.
3053
Don't set this speller option to the standard Unix spell command.
3054
That won't work. If you want to use the standard Unix spell command,
3055
set the speller option to nothing.
3057
<DT> <A NAME="ssh-command"><EM>ssh-command</EM></A>
3059
<DD> Sets the format of the command used to
3060
open a UNIX secure shell connection. The default is
3061
"%s %s -l %s exec /etc/r%sd". All four "%s" entries MUST exist in the
3062
provided command. The first is for the command's pathname, the second is
3063
for the host to connnect to, the third is for the user to connect as, and
3064
the fourth is for the connection method (typically <CODE>imap</CODE>).
3067
<DT> <A NAME="ssh-open-timeout"><EM>ssh-open-timeout</EM></A>
3069
<DD> Sets the time in seconds that <EM>Pine</EM> will
3070
attempt to open a UNIX secure shell connection.
3071
The default is 15, the minimum non-zero value is 5,
3072
and the maximum is unlimited. If this is set to zero ssh connections
3073
will be completely disabled.
3076
<DT> <A NAME="ssh-path"><EM>ssh-path</EM></A>
3078
<DD> Sets the name of the command used to open a UNIX secure shell
3079
connection. The default is typically <CODE>/usr/bin/ssh</CODE>.
3082
<DT> <A NAME="standard-printer"><EM>standard-printer</EM></A>
3084
<DD> System-wide configuration file only. Specifies a list of commands
3085
for category 2 of the <EM>Setup/Printer</EM> screen, the standard print command
3086
section. This is not used by <EM>PC-Pine</EM>.
3089
<DT> <A NAME="status-background-color"><EM>status-background-color</EM></A>
3090
<DT> <A NAME="status-foreground-color"><EM>status-foreground-color</EM></A>
3092
<DD> <A HREF="#status-color"><EM>Status Color</EM></A>.
3095
<DT> <A NAME="status-message-delay"><EM>status-message-delay</EM></A>
3097
<DD> This option has evolved over time, causing the possible values to be
3099
Read carefully before you set this option.
3100
First we explain what the option does, then there is a longer discussion
3103
If this is set to zero, the default value, it has <EM>no</EM> effect.
3104
Positive and negative values serve two similar, but different purposes.
3106
If it is set to a positive number, it causes the cursor to move to the
3107
status line whenever a status message is printed and pause there for this
3109
It will probably only be useful if the
3110
<A HREF="#show-cursor"><EM>show-cursor</EM></A>
3113
Setting this option to a postive number can only be used to
3114
<EM>increase</EM> the status message delay.
3115
This may be useful for Braille displays, or other non-traditional displays.
3117
If it is set to a negative number the interpretation is a bit complicated.
3118
Negative numbers are used to <EM>decrease</EM> the amount of delay <EM>Pine</EM> uses to
3119
allow you to read important status messages.
3120
Of course, this may cause you to miss some important messages.
3121
If you see a message flash by but miss what it says you can use the
3122
Journal command from the Main menu to read it.
3123
If you set this option to a negative value, the delay will be
3124
no more than one second less than the absolute value
3125
of the value you set.
3126
So if you set it to -1, the delay will be no more than zero seconds, no
3128
If you set it to -2, the delay will be no more than 1 second.
3129
And so on, -3 is 2 seconds, -4 is 3 seconds, ...
3130
If the delay that <EM>Pine</EM> would have used by default is less than this delay,
3131
then the smaller delay set by <EM>Pine</EM> will be used.
3132
Setting this option to a negative value can only reduce the amount of
3133
delay, never increase it.
3135
Here is a more detailed explanation.
3136
Status messages are the messages which show up spontaneously in the
3137
status message line, the third line from the bottom of the screen.
3138
By default, <EM>Pine</EM> assigns each status message it produces a minimum
3140
Some status messages have a minimum display time of zero.
3141
You can see an example of such a message by paging up in this help text
3142
until you reach the top of the screen.
3143
If you try to page past the top you will see the message
3145
<CENTER><SAMP>[Already at start of help text]</SAMP></CENTER>
3148
If there is another more important use of the status message line this message
3149
might be replaced quickly, or it even might not be shown at all.
3150
However, if there is no reason to get rid of the message, it might stay
3151
there for several seconds while you read the help.
3152
An example where it is replaced immediately happens when you page up in
3153
the help text past the top of the screen, but then type the "WhereIs"
3154
command right after paging up.
3155
The message will disappear immediately without causing a delay (unless you
3156
have set this option to a positive value) to allow you to type input for
3157
the "WhereIs" command.
3158
Since it isn't a very important message, <EM>Pine</EM> has set its minimum display
3159
time to zero seconds.
3161
Other messages have minimum display times of three or more seconds.
3162
These are usually error messages that <EM>Pine</EM> thinks you ought to see.
3163
For example, it might be a message about a failed Save or a failed folder open.
3164
It is often the case that this minimum display time won't delay you in
3165
any way because the status message line is not needed for another reason.
3166
However, there are times when <EM>Pine</EM> has to delay what it is doing in
3167
order to display a status message for the minimum display time.
3168
This happens when a message is being displayed and <EM>Pine</EM> wants to ask
3169
for input from the keyboard.
3170
For example, when you Save a message you use the status message line.
3171
You get a prompt there asking for the name of the folder to save to.
3172
If there is a status message being displayed that has not
3173
yet displayed for its minimum
3174
time <EM>Pine</EM> will display that status message surrounded with the characters
3175
> and < to show you that it is delaying.
3176
That might happen, for example, if you tried to save to a folder that
3177
caused an error, then followed that immediately with another Save command.
3178
You might find yourself waiting for a status message like
3180
<CENTER><SAMP>[>Can't get write access to mailbox, access is readonly<]</SAMP></CENTER>
3182
to finish displaying for three seconds.
3183
If that is something you find happening to you frequently, you may use
3184
negative values of this option to decrease or eliminate that delay, at
3185
the risk of missing the message.
3188
<DT> <A NAME="stay-open-folders"><EM>stay-open-folders</EM></A>
3190
<DD> This option affects low-level behavior of <EM>Pine</EM>.
3191
There is no default value for this option.
3192
It is related to the options
3193
<A HREF="#preopen-stayopen-folders">Preopen-Stayopen-Folders</A>,
3194
<A HREF="#max-remote-connections">Max-Remote-Connections</A>,
3195
and <A HREF="#offer-expunge-on-stayopen-folders">Offer-Expunge-On-Stayopen-Folders</A>.
3198
Note: changes made to this list take effect the next time you open a
3202
This is a list of folders that will be permanently kept open once they
3204
The names in this list may be either the nickname of an Incoming folder
3205
or the full technical specification of a folder.
3206
The folders in this list need not be remote IMAP folders, they could usefully
3207
be local folders, as well.
3208
If a folder in the list is a newsgroup or is not accessed either locally
3209
or via IMAP, then the entry will be ignored.
3210
For example, folders accessed via NNTP or POP3 will not be kept open, since
3211
the way that new mail is found with those protocols involves closing and
3212
reopening the connection.
3214
Once a Stay Open folder has been opened, new-mail checking will continue
3215
to happen on that folder for the rest of the <EM>Pine</EM> session.
3216
Your INBOX is always implicitly included in this Stay-Open list and doesn't
3217
need to be added explicitly.
3219
Another difference that you may notice between a Stay Open folder and a
3220
non-Stay Open folder is which message is selected as the current message
3221
when you enter the folder index.
3222
Normally, the starting position for an incoming folder (which most Stay Open
3223
folders will likely be) is controlled by the
3224
<A HREF="#incoming-startup-rule"><EM>Incoming-Startup-Rule</EM></A>.
3225
However, if a folder is a Stay Open folder, when you re-enter the folder
3226
after the first time the current message will be the same as it was when
3227
you left the folder.
3228
An exception is made if you use the TAB command to get to the folder.
3229
In that case, the message number will be incremented by one from what it
3230
was when you left the folder.
3232
The above special behavior is thought to be useful.
3233
However, it is special and different from what you might at first expect.
3235
<A HREF="#use-reg-start-rule"><EM>Use-Regular-Startup-Rule-for-Stayopen-Folders</EM></A>
3236
may be used to turn off this special treatment.
3238
If the message that was current when you left the folder no longer exists,
3239
then the regular startup rule will be used instead.
3242
<DT> <A NAME="tcp-open-timeout"><EM>tcp-open-timeout</EM></A>
3244
<DD> Sets the time in seconds that <EM>Pine</EM> will
3245
attempt to open a network connection. The default is 30, the minimum is 5,
3246
and the maximum is system defined (typically 75). If a connection has not
3247
completed within this many seconds <EM>Pine</EM> will give up and consider it a
3251
<DT> <A NAME="tcp-query-timeout"><EM>tcp-query-timeout</EM></A>
3253
<DD> When <EM>Pine</EM> times out a network read or write it will normally just display
3254
a message saying "Still waiting".
3255
However, if enough time has elapsed since it started waiting it will offer
3256
to let you break the connection.
3257
That amount of time is set by this option, which defaults to 60 seconds,
3258
has a minimum of 5 seconds, and a maximum of 1000 seconds.
3261
<DT> <A NAME="tcp-read-warning-timeout"><EM>tcp-read-warning-timeout</EM></A>
3263
<DD> Sets the time in seconds that <EM>Pine</EM> will
3264
wait for a network read before warning you that things are moving slowly
3265
and possibly giving you the option to break the connection.
3266
The default is 15 seconds. The minimum is 5 seconds and the maximumn is
3270
<DT> <A NAME="threading-display-style"><EM>threading-display-style</EM></A>
3272
<DD> When a folder is sorted by Threads or OrderedSubject,
3273
this option will affect the MESSAGE INDEX display.
3274
By default, <EM>Pine</EM> will display the MESSAGE INDEX in the
3275
"show-thread-structure" style if a folder is sorted
3276
by Threads or OrderedSubject.
3277
The possible values are:
3281
<DT><EM>none</EM></DT>
3282
<DD>Regular index display.
3283
The same index line as would be displayed without threading is used.
3284
The only difference will be in the order of the messages.
3287
<DT><EM>show-thread-structure</EM></DT>
3288
<DD>Threaded Subjects will be indented and vertical bars and horizontal
3289
lines will be added to make it easier to see the relationships among
3290
the messages in a thread (a conversation).
3293
<DT><EM>mutt-like</EM></DT>
3294
<DD>This is the same as the option above except that the Subject
3295
is suppressed (is blank) if it matches the previous Subject in the thread.
3296
The name comes from the email client <A HREF="http://www.mutt.org/">Mutt</A>.
3297
Here is an example of what a mutt-like index might look like.
3298
In this example, the first column represents the message number, the
3299
<A HREF="#threading-index-style"><EM>threading-index-style</EM></A>
3300
is set to "regular-index-with-expanded-threads", and the
3301
<A HREF="#threading-lastreply-character"><EM>Threading-Lastreply-Character</EM></A>
3302
is set to a backslash:
3305
2 . Subject original message in thread
3307
4 . |-> another reply to 2
3308
5 . | \-> reply to 4
3309
6 . | \-> reply to 5
3310
7 | \-> reply to 6
3311
8 |-> another reply to 2
3312
9 . |->New subject another reply to 2 but with a New subject
3314
11 | \-> another reply to 9
3315
12 | \-> reply to 11
3316
13 \-> final reply to 2
3321
<DT><EM>indent-subject-1</EM></DT>
3322
<DD>Threaded Subjects will be indented one space per level of the conversation.
3323
The bars and lines that show up in the show-thread-structure display will
3324
not be there with this style.
3327
<DT><EM>indent-subject-2</EM></DT>
3328
<DD>Same as above but indent two spaces per level instead of one space.
3331
<DT><EM>indent-from-1</EM></DT>
3332
<DD>Similar to indent-subject-1, except that instead of indenting the
3333
Subject field one space the From field of a thread will be indented one
3334
space per level of the conversation.
3337
<DT><EM>indent-from-2</EM></DT>
3338
<DD>Same as above but indent two spaces per level instead of one space.
3341
<DT><EM>show-structure-in-from</EM></DT>
3342
<DD>The structure of the thread is illustrated with indenting, vertical bars,
3343
and horizontal lines just like with the show-thread-structure option, but
3344
the From field is used to show the relationships instead of the Subject field.
3350
<DT> <A NAME="threading-expanded-character"><EM>threading-expanded-character</EM></A>
3352
<DD> The Threading-Expanded-Character option has a small effect on the MESSAGE
3353
INDEX display when using a
3354
<A HREF="#threading-display-style"><EM>threading-display-style</EM></A>
3355
other than <EM>none</EM>.
3356
The value of this option is a single character.
3357
This character is used to indicate that part of a thread has been expanded
3358
and could be collapsed if desired with
3359
the "/" Collapse/Expand command.
3360
By default, the value of this option is a dot (.).
3362
If this option is set to the Empty Value, then the column (and the following
3363
blank column) will be deleted from the display.
3365
This option is closely related to the
3366
<A HREF="#threading-indicator-character"><EM>threading-indicator-character</EM></A>
3368
Another similar option which affects the thread display is the
3369
<A HREF="#threading-lastreply-character"><EM>threading-lastreply-character</EM></A> option.
3371
<DT> <A NAME="threading-index-style"><EM>threading-index-style</EM></A>
3373
<DD> When a folder is sorted by Threads or OrderedSubject,
3374
this option will affect the INDEX displays.
3375
The possible values are:
3379
<DT><EM>regular-index-with-expanded-threads</EM></DT>
3380
<DD>This is the default display.
3381
If the configuration option
3382
<A HREF="#threading-display-style"><EM>threading-display-style</EM></A>
3383
is set to something other than "none", then this setting
3384
will cause <EM>Pine</EM> to start off with a MESSAGE INDEX with all of
3385
the threads expanded.
3386
That is, each message will have a line in the MESSAGE INDEX display.
3387
The Collapse/Expand command (/) may be used to manually collapse or
3388
expand a thread or subthread (see also <A HREF="#slash-collapses-entire-thread"><EM>slash-collapses-entire-thread</EM></A>).
3390
This setting affects the display when the folder is first threaded.
3391
The collapsed state may also be re-initialized by re-sorting the folder manually
3392
using the SortIndex command ($).
3393
After re-sorting the threads will once again all be expanded, even if you
3394
have previously collapsed some of them.
3396
If "threading-display-style" is set to "none", then
3397
the display will be the regular default Pine MESSAGE INDEX, but sorted
3398
in a different order.
3401
<DT><EM>regular-index-with-collapsed-threads</EM></DT>
3402
<DD>If the configuration option
3403
<A HREF="#threading-display-style"><EM>threading-display-style</EM></A>
3404
is set to something other than "none", then this setting
3405
will cause <EM>Pine</EM> to start out with all of the threads collapsed instead of
3406
starting out with all of the threads expanded.
3407
The Collapse/Expand command (/) may be used to manually collapse or
3408
expand a thread or subthread (see also <A HREF="#slash-collapses-entire-thread"><EM>slash-collapses-entire-thread</EM></A>).
3410
This setting affects the display when the folder is first threaded.
3411
The collapsed state may also be re-initialized by re-sorting the folder manually
3412
using the SortIndex command ($).
3413
After re-sorting the threads will once again all be collapsed, even if you
3414
have previously expanded some of them.
3417
<DT><EM>separate-index-screen-always</EM></DT>
3418
<DD>With this setting and the next, you will see an index of threads
3420
index of messages, provided you have sorted by Threads or OrderedSubject.
3422
The THREAD INDEX contains a '*' in the first column if any message in the thread
3423
is marked Important.
3424
If not, it contains a '+' if any message in the thread is to you.
3425
The second column is blank. The third column contains a 'D' if all of the
3426
messages in the thread are deleted.
3427
Otherwise, it contains an 'N' if any of the messages in the thread are New.
3429
When you view a particular thread from the THREAD INDEX you will be
3430
in the MESSAGE INDEX display
3431
but the index will only contain messages from the thread you are viewing.
3434
<DT><EM>separate-index-screen-except-for-single-messages</EM></DT>
3435
<DD>This is very similar to the option above.
3436
When you are in the THREAD INDEX, one of the available commands
3437
is "ViewThd".
3438
With the setting "separate-index-screen-always" (the option above)
3439
when you view a particular thread you will be in the
3440
MESSAGE INDEX display and the index will only contain messages from
3441
the thread you are viewing.
3442
If the thread you are viewing consists of a single message, the MESSAGE INDEX
3443
will be an index with only one message in it.
3444
If you use this "separate-index-screen-except-for-single-messages"
3445
setting instead, then that index which contains a single message
3446
will be skipped and you will go directly from the THREAD INDEX into the
3447
MESSAGE VIEW screen.
3454
<DT> <A NAME="threading-indicator-character"><EM>threading-indicator-character</EM></A>
3456
<DD> The Threading-Indicator-Character option has a small effect on the MESSAGE
3457
INDEX display when using a
3458
<A HREF="#threading-display-style"><EM>threading-display-style</EM></A>
3459
other than <EM>none</EM> and sorting by Threads or OrderedSubject.
3460
The value of this option is a single character.
3461
This character is used to indicate that part of a thread (a conversation) is
3462
hidden beneath a message.
3463
The message could be expanded
3464
if desired with the "/" Collapse/Expand command.
3465
By default, the value of this option is the greater than sign (>).
3467
If this option is set to the Empty Value, then the column (and the following
3468
blank column) will be deleted from the display.
3471
This option is closely related to the
3472
<A HREF="#threading-expanded-character"><EM>threading-expanded-character</EM></A>
3474
Another similar option which affects the thread display is the
3475
<A HREF="#threading-lastreply-character"><EM>threading-lastreply-character</EM></A> option.
3478
<DT> <A NAME="threading-lastreply-character"><EM>threading-lastreply-character</EM></A>
3480
<DD>The Threading-Lastreply-Character option has a small effect on the MESSAGE
3481
INDEX display when using a
3482
<A HREF="#threading-display-style"><EM>threading-display-style</EM></A>
3483
of <EM>show-thread-structure</EM>, <EM>mutt-like</EM>, or
3484
<EM>show-structure-in-from</EM>; and sorting by Threads or OrderedSubject.
3485
The value of this option is a single character.
3486
This character is used instead of the vertical line character when there are
3487
no more replies directly to the parent of the current message.
3488
It can be used to "round-off" the bottom of the vertical line
3489
by setting it to a character such as a backslash (\) or
3490
a backquote (`).
3491
By default, the value of this option is the vertical bar character (|).
3492
This option may not be set to the Empty Value.
3493
In that case, the default will be used instead.
3497
<DT> <A NAME="tcp-write-warning-timeout"><EM>tcp-write-warning-timeout</EM></A>
3499
<DD> Sets the time in seconds that <EM>Pine</EM> will
3500
wait for a network write before warning you that things are moving slowly
3501
and possibly giving you the option to break the connection.
3502
The default is 0 which means it is unset. If set to a non-zero value, the
3503
minimum is 5 and the maximum is 1000.
3505
<DT> <A NAME="title-background-color"><EM>title-background-color</EM></A>
3506
<DT> <A NAME="title-foreground-color"><EM>title-foreground-color</EM></A>
3508
<DD> <A HREF="#title-color"><EM>Title Color</EM></A>.
3511
<DT> <A NAME="titlebar-color-style"><EM>titlebar-color-style</EM></A>
3513
<DD> <A HREF="#titlebar-style"><EM>titlebar-color-style</EM></A>.
3516
<DT> <A NAME="upload-command"><EM>upload-command</EM></A>
3518
<DD> This option affects the behavior of the Composer's <EM>^R</EM> (Read File)
3519
and <EM>^J</EM> (Attach File, in the header) commands. It
3520
specifies a Unix program name, and any necessary command line arguments,
3521
that <EM>Pine</EM> can use to transfer files from your personal computer into
3522
messages that you are composing. <P>
3524
<DT> <A NAME="upload-command-prefix"><EM>upload-command-prefix</EM></A>
3526
<DD> This option is used in
3527
conjunction with the <EM>upload-command</EM> option.
3528
It defines text to be written to the terminal emulator (via standard
3529
output) immediately prior to starting the upload command. This is useful for
3530
integrated serial line file transfer agents that permit command passing
3531
(e.g., Kermit's APC method). <P>
3533
<DT> <A NAME="url-viewers"><EM>url-viewers</EM></A>
3535
<DD> List of programs to use to open Internet URLs.
3536
This value affects <EM>Pine</EM>'s handling of URLs that are found in the text of
3537
messages you read. Normally, only URLs <EM>Pine</EM> can handle directly are
3538
automatically offered for selection in the "Message Text" screen. When
3539
one or more comma delimited Web browsers capable of deciphering URLs on
3540
their command line are added here, <EM>Pine</EM> will choose the first available
3541
browser to display URLs it doesn't recognize.
3544
Additionally, to support various connection methods and browsers, each
3545
entry in this list can begin with the special token
3546
<CODE>_TEST(test-string)_</CODE>.
3547
The <CODE>test-string</CODE> is a shell command that <EM>Pine</EM>
3548
will run and which must exit with a status of zero for <EM>Pine</EM> to consider
3549
that browser for use (the other criteria is that the browser must exist
3550
as a full path or a path relative to your home directory).
3557
url-viewers=_TEST("test -n '${DISPLAY}'")_ /usr/local/bin/netscape,
3558
/usr/local/bin/lynx,
3559
C:\BIN\NETSCAPE.BAT </CODE><BR>
3562
This example shows that for the first browser in the list to be used the
3563
environment variable <CODE>DISPLAY</CODE> must be defined.
3564
If it is, then the file <CODE>/usr/local/bin/netscape</CODE> must exist.
3565
If either condition is not met, then the file
3566
<CODE>/usr/local/bin/lynx</CODE> must exist.
3567
If it doesn't, then the final path and file must
3568
exist. Note that the last entry is a DOS/Windows path. This is one way
3569
to support <EM>Pine</EM> running on more than one architecture with the same
3573
<DT> <A NAME="use-only"><EM>use-only-domain-name</EM></A>
3575
<DD> Can be set to <EM>yes</EM> or <EM>no.</EM> Anything but
3576
<EM>yes</EM> means <EM>no.</EM> If set to <EM>yes</EM> the first label in
3577
the host name will be lopped off to get the domain name and the domain
3578
name will be used for outgoing mail and such. That is, if the host name
3579
is <EM>carson.u.example.edu</EM> and this variable is set to <EM>yes,</EM>
3580
then <EM>u.example.edu</EM> will be used on outgoing mail. Only
3581
meaningful if <A HREF="#user-domain"><EM>user-domain</EM></A> is NOT set. <P>
3583
<DT> <A NAME="user-domain"><EM>user-domain</EM></A>
3585
<DD> Sets the domain or host name for the user, overriding the system host
3586
or domain name. See the <A HREF="config-notes.html#domain"><EM>domain name section</EM></A>.
3587
The easiest way to change the full From address is with the
3588
<A HREF="#cust-hdr"><EM>customized-hdrs</EM></A> variable.
3591
<DT> <A NAME="user-id"><EM>user-id</EM></A>
3593
<DD> <EM>PC-Pine</EM> only and personal configuration file only.
3594
Sets the username that is placed on all outgoing
3595
messages. The username is the part of the address that comes before the "@".
3596
The easiest way to change the full From address is with the
3597
<A HREF="#cust-hdr"><EM>customized-hdrs</EM></A> variable.
3600
<DT> <A NAME="user-input"><EM>user-input-timeout</EM></A>
3602
<DD> If this is set to an integer greater than zero, then this is the number
3603
of <EM>hours</EM> to wait for user input before <EM>Pine</EM> times out.
3605
in the midst of composing a message or is waiting for user response to
3606
a question, then it will not timeout.
3607
However, if <EM>Pine</EM> is sitting idle waiting for
3608
the user to tell it what to do next and the user does not give any
3609
input for this many hours, <EM>Pine</EM> will exit.
3610
No expunging or moving of read
3611
messages will take place.
3612
It will exit similarly to the way it would exit
3613
if it received a hangup signal.
3614
This may be useful for cleaning up unused <EM>Pine</EM> sessions which have been
3615
forgotten by their owners.
3616
The <EM>Pine</EM> developers envision system administrators
3617
setting this to a value of several hours (24?) so that it won't surprise
3618
a user who didn't want to be disconnected.
3621
<DT> <A NAME="viewer-hdr-colors"><EM>viewer-hdr-colors</EM></A>
3623
<DD> This variable holds the optional Header Colors and patterns which
3624
have been defined by the user. This is usually modified by using
3625
the <A HREF="#header-colors"><EM>Header Colors</EM></A> section
3626
of the Setup Color screen.
3629
<DT> <A NAME="viewer-hdrs"><EM>viewer-hdrs</EM></A>
3631
<DD> You may change the default list of headers that are viewed by listing
3632
the headers you want to view here. If the headers in your <EM>viewer-hdrs</EM>
3633
list are present in the message, then they will be shown. The order of
3634
the headers you list will also be honored. If the special
3635
value <EM>all-except</EM>
3636
is included as the first header in the <EM>viewer-hdrs</EM> list, then all
3637
headers in the message except those in the list will be shown. The values
3638
are all case insensitive.<P>
3640
<DT> <A NAME="viewer-margin-left"><EM>viewer-margin-left</EM></A>
3642
<DD> This variable controls the left-hand vertical margin's width in
3643
<EM>Pine</EM>'s Message Viewing screen.
3644
Its value is the number of space characters preceding each displayed line.
3645
For consistency with
3646
<A HREF="#viewer-margin-right">Viewer-Margin-Right</A>,
3647
you may specify the column number to start in
3648
(column numbering begins with number 1)
3649
instead of the width of the margin by appending a lower case letter
3650
"c" to the number.
3651
For example, a value of "2c" means to start the text in column two,
3652
which is entirely equivalent to a value of "1", which means to
3653
leave a margin of 1 space.
3655
The default is a left margin of 0 (zero).
3656
Misconfigurations (for example, negative values or values with starting
3657
left columns greater than the ending right column)
3658
are silently ignored.
3659
If the number of columns for text between the Viewer-Margin-Left and
3660
the Viewer-Margin-Right is fewer than 8, then margins of zero will be used
3664
<DT> <A NAME="viewer-margin-right"><EM>viewer-margin-right</EM></A>
3666
<DD> This variable controls the right-hand vertical margin's width in
3667
<EM>Pine</EM>'s Message Viewing screen.
3668
Its value is the number of space characters following each displayed line.
3669
You may specify the column number to end the text in
3670
(column numbering begins with number 1)
3671
instead of the width of the margin by appending a lower case letter
3672
"c" to the number.
3673
For example, a value of "76c" means to end the text in column 76.
3674
If the screen is 80 characters wide, this is equivalent to a value
3675
of "4", which means to leave a margin of 4 spaces.
3676
However, if you use different size screens at different times, then these
3677
two values are not equivalent.
3679
The default right margin is 4.
3680
Misconfigurations (for example, negative values or values with starting
3681
left columns greater than the ending right column)
3682
are silently ignored.
3683
If the number of columns for text between the
3684
<A HREF="#viewer-margin-left">Viewer-Margin-Left</A> and
3685
the Viewer-Margin-Right is fewer than 8, then margins of zero will be used
3689
<DT> <A NAME="overlap"><EM>viewer-overlap</EM></A>
3691
<DD> This option specifies an aspect of <EM>Pine</EM>'s Message Viewing screen.
3692
When the space bar is used to page forward in a message, the number of
3693
lines specified by the <EM>viewer-overlap</EM> variable
3694
will be repeated from the
3695
bottom of the screen. That is, if this was set to two lines, then the
3696
bottom two lines of the screen would be repeated on the top of the next
3697
screen. The normal default value is "2". <P>
3699
<DT> <A NAME="window-position"><EM>window-position</EM></A>
3701
<DD> Winsock version of <EM>PC-Pine</EM> only. Window position in the format:
3702
CxR+X+Yn Where C and R are the window size in characters and X and Y are
3703
the screen position of the top left corner of the window. <P>
3709
<H2><A NAME="features-conf">Configuration Features</A></H2>
3711
There are several features (options) which may be turned off or on.
3712
The configuration variable
3713
<A HREF="#feat-list"><EM>feature-list</EM></A> is a list of all the
3714
features that are turned on or off.
3715
If the name of a feature is in
3716
the list it will be turned on.
3717
If the name of a feature with the characters
3718
<CODE>no-</CODE> prepended is in the list, it will turn the feature off.
3719
This is useful for overriding system-wide defaults.
3720
This is because, unlike all the other configuration variables,
3721
the <EM>feature-list</EM> is additive.
3722
That is, first the system-wide <EM>feature-list</EM> is read
3723
and then the user's <EM>feature-list</EM> is read. This makes it possible
3724
for the system manager to turn some of the features on by default while
3725
still allowing the user to cancel that default.
3726
For example, if the system manager has
3727
turned on the <EM>allow-talk</EM> feature by default then a user may turn
3728
it back off by including the feature <EM>no-allow-talk</EM> in his or her
3729
personal configuration file. Of course, these details are usually handled
3730
by <EM>Pine</EM> when the user turns an option on or off from inside the
3731
<EM>Setup/Config</EM> screen.
3734
System managers should take some care when turning on features by default.
3735
Some of the documentation assumes that all of the features are off by
3736
default, so it could be confusing for a user if some are on by default instead.
3739
Here is an alphabetical list of possible features.
3743
<DT> <A NAME="allow-from"><EM>allow-changing-from</EM></A>
3745
<DD> Prior to <EM>Pine</EM> 4.00 there was a <EM>compile</EM>-time option called
3746
ALLOW_CHANGING_FROM. That has been replaced by a <EM>runtime</EM> feature.
3747
If this feature is turned on then the From line can be changed just like
3748
all the other header fields that can be changed. See the configuration
3749
variables <A HREF="#cust-hdr"><EM>customized-hdrs</EM></A>
3750
and <A HREF="#def-comp"><EM>default-composer-hdrs</EM></A>
3751
for more information on editing headers.
3753
Beginning with <EM>Pine</EM> 4.30 the default value for this feature has
3754
been changed from OFF to ON, so that editing of From headers is now allowed
3758
<DT> <A NAME="allow-talk"><EM>allow-talk</EM></A>
3760
<DD> Unix <EM>Pine</EM> only. By default, permission for
3761
others to <EM>talk</EM> to your terminal is turned
3762
off when you are running <EM>Pine</EM>. When this feature is set, permission is
3766
Note: The <EM>talk</EM> program has nothing to do with <EM>Pine</EM> or email. The
3767
<EM>talk</EM> daemon on your system will
3768
attempt to print a message on your screen
3769
when someone else is trying to contact you. If you wish to see these
3770
messages while you are running <EM>Pine</EM>, you should enable this feature.
3773
If you do enable this feature and see a <EM>talk</EM> message, you must
3774
suspend or quit <EM>Pine</EM> before you can respond.
3777
<DT> <A NAME="alternate-compose-menu"><EM>alternate-compose-menu</EM></A>
3779
<DD>This feature controls the menu that is displayed when Compose is selected.
3780
If set, a list of options will be presented, with each option representing
3781
the type of composition that could be used. This feature is most useful for
3782
users who want to avoid being prompted with each option separately, or who
3783
want to avoid the checking of remote postponed or form letter folders.
3784
The possible types of composition are:
3787
New, for starting a new composition. Note that if New is selected and roles
3788
are set, roles are checked for matches and applied according to the setting
3789
of the matching role.
3792
Interrupted, for continuing an interrupted composition. This option is only
3793
offered if an interrupted message folder is detected.
3796
Postponed, for continuing postponed compositions. This option is offered
3797
if a postponed-folder is set in the config <EM>REGARDLESS OF</EM> whether or not
3798
the postponed folder actually exists. This option is especially handy
3799
for avoiding having to check for the existence of a remote postponed folder.
3802
Form, for using form letters. This option is offered if the form-letter-folder
3803
is set in the config, and is not checked for existence for reasons similar
3804
to those explained by the postponed option.
3807
setRole, for selecting a role to apply to a composition.
3811
<DT> <A NAME="alternate-role-menu"><EM>alternate-role-menu</EM></A>
3813
<DD> Normally the Role Command allows you to choose
3814
a role and compose a new message using that role.
3815
When this feature is set, the role command will first ask whether you want to
3816
Compose a new message, Forward the current message, Reply to the
3817
current message, or Bounce the current message.
3818
If you are not in the MESSAGE INDEX and are not viewing a message,
3819
then there is no current message and the question will be skipped.
3820
After you have chosen to Compose, Forward, Reply or Bounce you will
3821
then choose the role to be used.
3823
When Bouncing the "Set From" address is used for the
3824
Resent-From header, the "Set Fcc" value is used for the Fcc
3825
provided that the option
3826
<A HREF="#fcc-on-bounce">"Fcc-On-Bounce"</A> is turned on,
3827
and the "Use SMTP Server" value is used for the SMTP server, if
3829
Other actions of the role are ignored when Bouncing.
3833
<DT> <A NAME="assume-slow-link"><EM>assume-slow-link</EM></A>
3835
<DD> This feature affects <EM>Pine</EM>'s display routines. If set, the normal
3836
inverse-video cursor (used to highlight the current item in a list) will be
3837
replaced by an <EM>arrow</EM> cursor and other screen update optimizations for
3838
low-speed links (e.g. 2400 bps dialup connections) will be activated.
3839
One of the optimizations is that colored index lines (set up with Indexcolor
3840
Rules) will not be colored.
3841
This might be useful if <I>you</I> know you have a slow speed link but for some
3842
reason <EM>Pine</EM> doesn't know.
3845
<DT> <A NAME="auto-read-msg"><EM>auto-move-read-msgs</EM></A>
3847
<DD> This feature controls an aspect
3848
of <EM>Pine</EM>'s behavior upon quitting. If set,
3849
and the <A HREF="#read-msg-fold"><EM>read-message-folder</EM></A>
3850
variable is also set, then <EM>Pine</EM> will
3851
automatically transfer all read messages from the <EM>INBOX</EM> to
3852
the designated folder and mark
3853
them as deleted in the <EM>INBOX</EM>. Messages in the <EM>INBOX</EM> marked
3854
with an <EM>N</EM> (meaning New, or unseen) are not affected.
3857
<DT> <A NAME="auto-open-next-unread"><EM>auto-open-next-unread</EM></A>
3859
<DD> This feature controls the behavior of the TAB key when traversing folders
3860
in the optional <A HREF="#inc-fold"><EM>incoming-folders</EM></A>
3861
collection or in optional <A HREF="#news-coll"><EM>news-collections</EM></A>.
3864
When the TAB (Next New) key is pressed, and there are no more unseen
3865
messages in the current (incoming message or news) folder, <EM>Pine</EM> will
3866
search the list of folders in the current collection for one containing
3867
New or Recent (new since the last time the folder was opened) messages.
3868
This behavior may be modified slightly with the
3869
<A HREF="#tab-uses-unseen-for-next-folder">Tab-Uses-Unseen-For-Next-Folder</A>
3870
feature which causes <EM>Pine</EM> to look for Unseen messages instead of Recent
3872
By default, when such a folder is found,
3873
<EM>Pine</EM> will ask whether you wish to
3875
If this feature is set, <EM>Pine</EM> will automatically open the
3876
folder without prompting.
3879
<DT> <A NAME="auto-unzoom-after-apply"><EM>auto-unzoom-after-apply</EM></A>
3882
you are currently looking at a Zoomed Index view of selected messages,
3883
the <EM>Apply</EM> command will do the operation you specify, but then will
3884
implicitly do an <EM>UnZoom</EM>, so that you will automatically be back in
3885
the normal Index view after the <EM>Apply</EM>.
3888
<DT> <A NAME="auto-zoom-after-select"><EM>auto-zoom-after-select</EM></A>
3890
<DD> If set, the <EM>; select</EM> command will automatically
3891
perform a <EM>Zoom</EM> after the <EM>select</EM> is complete.
3894
<DT> <A NAME="check-newmail-when-quitting"><EM>check-newmail-when-quitting</EM></A>
3896
<DD> If set, <EM>Pine</EM> will check for new mail after you give the
3898
If new mail has arrived since the previous check, you will be notified
3899
and given the choice of quitting or not quitting.
3902
<DT> <A NAME="combined-addrbook-display"><EM>combined-addrbook-display</EM></A>
3904
<DD> This feature affects the address book display screens.
3905
Normally, expanding an address book from the ADDRESS BOOK LIST screen
3906
will cause the remaining address books and directory servers to disappear
3907
from the screen, leaving only the entries of the expanded address book.
3908
If this feature is set, then the other address books will remain on the screen,
3909
so that all of the address books can be present at once.
3912
The way that commands work won't be changed.
3913
For example, the Select All command will select all of the entries in the
3914
current address book, not all of the entries in all of the address books.
3915
The WhereIs command will change a little.
3916
It will search through all of the text on the screen plus all of the entries
3917
from expanded address books.
3920
When this feature is set, the setting of the feature
3921
<A HREF="#expanded-view-of-addressbooks"><EM>expanded-view-of-addressbooks</EM></A>
3925
<DT> <A NAME="combined-folder-display"><EM>combined-folder-display</EM></A>
3927
<DD> This feature affects the folder list display screens.
3928
Normally, each folder list is viewed within its collection only. This
3929
command allows folder lists to be viewed within a single screen that
3930
combines the contents of all collections.
3933
The way that commands work won't be changed.
3934
For example, the Select All command will select all of the folders in the
3935
current collection, not all of the entries in all of the collections.
3936
The WhereIs command will change a little.
3937
It will search through all of the folders in the current collection as well
3938
as all the folder in any other expanded collection.
3941
When this feature is set, the setting of the feature
3942
<A HREF="#expanded-view-of-folders"><EM>expanded-view-of-folders</EM></A>
3946
<DT> <A NAME="combined-subdirectory-display"><EM>combined-subdirectory-display</EM></A>
3948
<DD> This feature affects the Folder List screen when
3950
<A HREF="#combined-folder-display"><EM>combined-folder-display</EM></A>
3951
feature is enabled. Normally, selecting a directory from the Folder
3952
List takes you into a new screen displaying only the contents of
3956
Enabling this feature will cause the contents of the selected
3958
displayed within the boundaries of the
3959
<A HREF="background.html#collections"><EM>Collection</EM></A>
3960
it is a part of. All previously displayed collections will remain
3964
The way that commands work won't be changed.
3965
For example, the Select All command will select all of the folders in the
3966
directory, as opposed to all of the entries in all of the collections.
3967
The WhereIs command will change a little.
3968
It will search through all of the folders in the current collection as well
3969
as all the folder in any other expanded collection.
3973
<DT> <A NAME="compose-cancel-confirm-uses-yes"><EM>compose-cancel-confirm-uses-yes</EM></A>
3975
<DD> This feature affects what happens when you type ^C to cancel a composition.
3976
By default, if you attempt to cancel a composition by typing ^C, you will be
3977
asked to confirm the cancellation by typing a "C"
3978
for <EM>C</EM>onfirm.
3979
It logically ought to be a "Y" for <EM>Y</EM>es, but that is
3980
risky because the "^C Y" needed to cancel a message
3981
is close (on the keyboard) to the "^X Y" needed to send a message.
3983
If this feature is set the confirmation asked for
3984
will be a "<EM>Y</EM>es"
3985
instead of a "<EM>C</EM>onfirm" response.
3988
<DT> <A NAME="compose-cut-from-cursor"><EM>compose-cut-from-cursor</EM></A>
3990
<DD> If set, the <EM>^K</EM> command in the composer will cut from the
3991
current cursor position to the end of the line,
3992
rather than cutting the entire line.
3995
<DT> <A NAME="compose-maps-delete-key-to-ctrl-d"><EM>compose-maps-delete-key-to-ctrl-d</EM></A>
3997
<DD> If set, Delete will be equivalent to ^D, and delete
3998
the current character. Normally <EM>Pine</EM> defines the Delete key
3999
to be equivalent to ^H, which deletes the <EM>previous</EM>
4003
<DT> <A NAME="compose-rejects-unqualified-addrs"><EM>compose-rejects-unqualified-addrs</EM></A>
4005
<DD> If set, unqualified names entered as addresses will be treated as errors
4006
unless they match an addressbook nickname or are looked up successfully
4007
on an LDAP server. <EM>Pine</EM> will not attempt to turn
4008
them into complete addresses by adding your local domain (which <EM>Pine</EM> normally
4012
A complete (fully-qualified) address is one containing a username
4013
followed by an <EM>@</EM> symbol, followed by a host or domain name (e.g.
4014
<EM>jsmith@example.com</EM>). An unqualified name is one without the
4016
and host or domain name (e.g. <EM>jsmith</EM>).
4019
<DT> <A NAME="compose-send-offers-first-filter"><EM>compose-send-offers-first-filter</EM></A>
4021
<DD> If you have <A HREF="#sending-filters"><EM>sending-filters</EM></A>
4022
configured, setting this feature will cause the first filter in the
4023
<EM>sending-filters</EM> list to be offered as the default
4024
instead of <EM>unfiltered</EM>, the usual default.
4027
<DT> <A NAME="compose-sets-newsgroup-without-confirm"><EM>compose-sets-newsgroup-without-confirm</EM></A>
4029
<DD> If you enter the
4030
composer while reading a newsgroup, you will normally be prompted to
4031
determine whether you intend the new message to be posted to the current
4032
newsgroup or not. If this feature is set, <EM>Pine</EM> will not prompt you
4033
in this situation, and will assume that you do indeed wish to post
4034
to the newsgroup you are reading.
4037
<DT> <A NAME="confirm-role-even-for-default"><EM>confirm-role-even-for-default</EM></A>
4039
<DD> If you have roles, when you Reply to or Forward a message, or Compose
4040
a new message, <EM>Pine</EM>
4041
will search through your roles for one which matches.
4042
Normally, if no matches are found you will be placed into the composer
4043
with no opportunity to select a role.
4044
If this feature is set, then you will be asked to confirm that you don't
4046
This will give you the opportunity to select a role (with the ^T command).
4047
If you confirm no role with a Return, you will be placed in
4048
the composer with no role.
4049
You may also confirm with either an "N" or a "Y".
4050
These behave the same as if you pressed the Return.
4051
(The "N" and "Y" answers are available because they
4052
match what you might type if there was a role match.)
4054
If you are using the alternate form of the Compose command called
4055
"Role", then all of your roles will be available to you,
4056
independent of the value of this feauture and of the values set for all of
4057
Reply Use, Forward Use, and Compose Use.
4060
<DT> <A NAME="continue-tab-without-confirm"><EM>continue-tab-without-confirm</EM></A>
4062
<DD> Normally, when you use the TAB NextNew
4063
command and there is a problem checking a folder, you are asked
4064
whether you want to continue with the search in the following folder or not.
4065
This gives you a chance to stop the NextNew processing.
4067
If this feature is set you will not be asked.
4068
It will be assumed that you want to continue.
4071
<DT> <A NAME="delete-skips-deleted"><EM>delete-skips-deleted</EM></A>
4074
feature will cause the <EM>Delete</EM> command to
4075
advance past other messages that
4076
are marked deleted. In other words, pressing <EM>D</EM> will both mark the
4077
current message deleted and advance to the next message that is not marked
4081
<DT> <A NAME="disable-2022-jp-conversions"><EM>disable-2022-jp-conversions</EM></A>
4083
<DD> By default, UNIX <EM>Pine</EM> will convert Japanese characters encoded as
4084
ISO-2022-JP data into EUC-JP and <EM>PC-Pine</EM>
4085
will convert the ISO-2022-JP data into Shift-JIS before displaying it.
4086
Conversely, when sending mail, UNIX <EM>Pine</EM> will convert EUC-JP into ISO-2022-JP
4087
and <EM>PC-Pine</EM> will convert Shift-JIS into ISO-2022-JP.
4088
If this feature is set, those conversions are turned off.
4090
Most of <EM>Pine</EM> is not set up to handle multi-byte characters or variable width characters.
4091
From time to time, your display will be garbled because <EM>Pine</EM>'s word wrapping
4092
code, which is not aware of the possibility that characters may be
4093
multi-byte, may wrap a line in the middle of a character.
4094
<EM>Pico</EM> is also not able to edit Japanese data well so you may need to use an
4095
<A HREF="#enable-alt-ed"><EM>alternate editor</EM></A>
4096
when composing or replying to mail.
4099
<DT> <A NAME="disable-busy-alarm"><EM>disable-busy-alarm</EM></A>
4101
<DD> If set, the spinning bar that sometimes appears in the status line will not
4102
appear when <EM>Pine</EM> is busy. This might be useful if it is suspected that
4103
the alarm(2) system calls that <EM>Pine</EM> uses to implement the busy spinner
4104
are suspected of causing a problem.
4107
<DT> <A NAME="disable-charset-conversions"><EM>disable-charset-conversions</EM></A>
4109
<DD> By default, if your
4110
<A HREF="#char-set">Character-Set</A>
4111
configuration option
4112
is different from the character set
4113
of the message you are viewing, then <EM>Pine</EM> will
4114
attempt to convert the characters in the message
4115
to the character set you have set
4117
<A HREF="#char-set">Character-Set</A>
4118
configuration option before
4119
sending them to your display.
4120
The currently supported conversions are between 8-bit character sets (e.g.
4121
between WINDOWS-1251 and KOI8-R), and from UTF-8 to any other character
4124
If this feature is set, the conversions are turned off.
4126
Conversion is only possible if the character being converted is present in
4127
both character sets.
4128
Many pairs of character sets have no characters in common.
4129
In that case, <EM>Pine</EM> will not attempt any conversion.
4130
If there are some characters in common then <EM>Pine</EM> will attempt to convert
4131
those and will display the unknown characters as question marks.
4133
The conversion of Japanese character sets from one encoding to another
4134
is controlled separately by the
4135
<A HREF="#disable-2022-jp-conversions"><EM>Disable-2022-JP-Conversions</EM></A>
4139
<DT> <A NAME="disable-config-cmd"><EM>disable-config-cmd</EM></A>
4141
<DD> If set, the configuration
4142
screen <EM>Setup/Config</EM> will not be available at all.
4145
<DT> <A NAME="disable-kblock"><EM>disable-keyboard-lock-cmd</EM></A>
4147
<DD> In the Main <EM>Pine</EM> menu there is a Keyboard locking
4148
command (<EM>KBLock</EM>). If this feature is set, that command won't be
4149
available to the user.
4152
<DT> <A NAME="disable-keymenu"><EM>disable-keymenu</EM></A>
4154
<DD> If set, the command key menu that normally appears on the
4155
bottom two lines of the screen will not usually be there. Asking for
4156
help with <EM>^G</EM> or <EM>?</EM> will cause the key menu to
4157
appear instead of causing the help message to come up. If you want to
4158
actually see the help text,
4159
another <EM>^G</EM> or <EM>?</EM> will show it to you.
4160
After the key menu has popped
4161
up with the help key it will remain there for an <EM>O Other</EM> command but
4162
will disappear if any other command is typed.
4165
<DT> <A NAME="disable-password-caching"><EM>disable-password-caching</EM></A>
4167
<DD> Normally, loginname/password combinations are cached in <EM>Pine</EM>
4168
so that the user does not have to enter the same password more than once
4170
A disadvantage to this approach is that the password must be stored in
4171
the memory image of the running <EM>Pine</EM> in order that it can be reused.
4172
In the event that <EM>Pine</EM> crashes and produces a core dump, and that core
4173
dump is readable by others, the loginname and password could possibly be read
4176
If this hidden feature is set, then the passwords will not be cached and
4177
the user will have to retype the password whenever <EM>Pine</EM> needs it.
4178
Even with this feature set there is still some chance that the core
4179
file will contain a password, so care should be taken to make the
4180
core files unreadable.
4182
NOTE: If PASSFILE caching is enabled, this does not disable it.
4183
That is a separate and independent feature.
4186
<DT> <A NAME="disable-password-cmd"><EM>disable-password-cmd</EM></A>
4188
<DD> If set the <EM>Newpassword</EM> command usually available under the
4189
<EM>Setup</EM> command will not be available.
4192
<DT> <A NAME="disable-pipes-in-sigs"><EM>disable-pipes-in-sigs</EM></A>
4194
<DD> If set it will be an error to append a vertical bar (|) to the name
4195
of a signature file.
4196
Appending a vertical bar normally causes the signature file to be executed
4197
to produce the signature.
4200
<DT> <A NAME="disable-pipes-in-templates"><EM>disable-pipes-in-templates</EM></A>
4202
<DD> If set it will be an error to append a vertical bar (|) to the name
4204
Appending a vertical bar normally causes the signature file to be executed
4205
to produce the signature.
4208
<DT> <A NAME="disable-roles-setup-cmd"><EM>disable-roles-setup-cmd</EM></A>
4210
<DD> If set the <EM>Roles</EM> command usually available under the
4211
<EM>Setup</EM> command will not be available.
4214
<DT> <A NAME="disable-roles-sig-edit"><EM>disable-roles-sig-edit</EM></A>
4216
<DD> If set the roles editor in the <EM>Setup/Roles</EM> command will not allow
4217
editing of signature files with the F subcommand.
4220
<DT> <A NAME="disable-roles-template-edit"><EM>disable-roles-template-edit</EM></A>
4222
<DD> If set the roles editor in the <EM>Setup/Roles</EM> command will not allow
4223
editing of template files with the F subcommand.
4226
<DT> <A NAME="disable-sender"><EM>disable-sender</EM></A>
4228
<DD> If set, <EM>Pine</EM> will not generate a "Sender:" or "X-X-Sender" header.
4229
This may be desirable on a system which is virtually hosting many domains,
4230
and the sysadmin has other methods available for tracking a message to
4234
<DT> <A NAME="disable-shared-namespaces"><EM>disable-shared-namespaces</EM></A>
4236
<DD> If this hidden feature is set
4237
the automatic search for namespaces "ftp",
4238
"imapshared", and "imappublic" by the underlying library
4240
The reason this feature exists is because there are some implementations
4241
of system password lookup routines which are very slow when presented with
4242
a long loginname which does not exist.
4243
This feature could be set to prevent the delay at startup time when the
4244
names above are searched for in the password file.
4247
<DT> <A NAME="disable-signature-edit-cmd"><EM>disable-signature-edit-cmd</EM></A>
4249
<DD> If set the <EM>Signature</EM> editing command usually available under the
4250
<EM>Setup</EM> command will not be available.
4253
<DT> <A NAME="disable-take-fullname"><EM>disable-take-fullname-in-addresses</EM></A>
4255
<DD> Normally, when TakeAddr is used to copy an address or addresses
4256
from a message into an address book entry, <EM>Pine</EM> will try to preserve
4257
the full name associated with each address in the list of addresses.
4258
The reason for this is so that if the entry is a list or later becomes a
4259
list, then information about the individual addresses in the list
4261
If you would rather just have the simple addresses in the list of addresses,
4262
set this feature. For example, with the default setting you might
4263
see something like this in the ADDRESS BOOK editor after you type TakeAddr
4267
Fullname : Bedrock Elders
4270
Addresses : Fred Flintstone <flint@bedrock.org>,
4271
Barney Rubble <rubble@bedrock.org>
4274
but with this feature set it would look like
4278
Fullname : Bedrock Elders
4281
Addresses : flint@bedrock.org,
4285
instead. Note the difference in the Addresses field.
4288
<DT> <A NAME="disable-take-last-comma-first"><EM>disable-take-last-comma-first</EM></A>
4290
<DD> Normally, when <EM>TakeAddr</EM> is used to copy an address
4291
from a message into an address book, <EM>Pine</EM> will attempt to rewrite the
4292
full name of the address in the form:
4304
It does this because many people find it useful to sort by Last name instead
4305
of First name. If this feature is set, then the <EM>TakeAddr</EM> command will
4306
not attempt to reverse the name in this manner.
4309
<DT> <A NAME="disable-terminal-reset-for-display-filters"><EM>disable-terminal-reset-for-display-filters</EM></A>
4311
<DD> UNIX Pine only.
4313
This feature affects <EM>Pine</EM>'s behavior when using
4314
<A HREF="#display-filters"><EM>Display-Filters</EM></A>.
4315
Normally, before the display filter is run, the terminal mode is reset
4316
to what it was before you started <EM>Pine</EM>.
4317
This may be necessary if the filter requires the use of the terminal.
4318
For example, it may need to interact with you.
4319
If you set this feature, then the terminal mode will not be reset.
4320
One thing that turning on this feature should fix is the coloring of
4321
quoted text in the message view, which
4322
breaks because the terminal reset resets the color state of the terminal
4323
(<A HREF="#color-config">Color Configuration</A>).
4326
<DT> <A NAME="downgrade-multipart-to-text"><EM>downgrade-multipart-to-text</EM></A>
4328
<DD> This feature affects <EM>Pine</EM>'s behavior when sending mail. Internet
4329
standards require <EM>Pine</EM> to translate all non-ASCII characters in
4330
messages that it sends using MIME encoding. This encoding can be
4331
ostensibly broken for recipients if any agent between <EM>Pine</EM> and the
4332
recipient, such as an email list expander, appends text to the
4333
message, such as list information or advertising. When sending such
4334
messages <EM>Pine</EM> attempts to protect such encoding by placing extra
4335
MIME boundaries around the message text.
4337
These extra boundaries are invisible to recipients that
4338
use MIME-aware email programs (the vast majority). However, if
4339
you correspond with users of email programs that are not MIME-aware,
4340
or do not handle the extra boundaries gracefully, you can
4341
use this feature to prevent <EM>Pine</EM> from including the extra
4342
MIME information. Of course, it will increase the likelihood
4343
that non-ASCII text you send may appear corrupt to the recipient.
4346
<DT> <A NAME="enable-8bit-esmtp-negotiation"><EM>enable-8bit-esmtp-negotiation</EM></A>
4348
<DD> This feature affects <EM>Pine</EM>'s behavior when sending mail. Internet standards
4349
require that all electronic mail messages traversing the global Internet
4350
consist of 7bit ASCII characters unless a pair of cooperating mail
4351
transfer agents explicitly agree to allow 8bit messages. In general,
4352
then, exchanging messages in non-ASCII characters requires MIME encoding.
4355
However, there are now Internet standards that allow for unencoded 8bit
4356
exchange of messages between cooperating systems. Setting this feature
4357
tells <EM>Pine</EM> to try to negotiate unencoded 8bit transmission during the
4358
sending process. Should the negotiation fail, <EM>Pine</EM> will fall back to its
4359
ordinary encoding rules.
4362
Note, this feature relies on your system's mail transport agent or
4363
configured <A HREF="#smtp-server"><EM>smtp-server</EM></A>
4364
having the negotiation mechanism introduced in
4365
"Extended SMTP" (ESMTP) and the specific extension called <EM>8BITMIME</EM>.
4368
<DT> <A NAME="enable-8bit-nntp-posting"><EM>enable-8bit-nntp-posting</EM></A>
4370
<DD> The Internet standard for exchanging USENET news messages (RFC-1036)
4371
specifies that USENET messages should conform to Internet mail standards
4372
and contain only 7bit characters, but much of the news transport software
4373
in use today is capable of successfully sending messages containing 8bit
4374
characters. Hence, many people believe that it is appropriate to send 8bit
4375
news messages without any MIME encoding.
4378
Moreover, there is no Internet standard for explicitly negotiating 8bit
4379
transfer, as there is for Internet email. Therefore, <EM>Pine</EM> provides the
4380
option of posting unencoded 8bit news messages, though not as the default.
4381
Setting this feature will turn OFF <EM>Pine</EM>'s MIME encoding of newsgroup
4382
postings that contain 8bit characters.
4385
Note, articles may cross a path or pass through news transport software
4386
that is unsafe or even hostile to 8bit characters. At best this will only
4387
cause the posting to become garbled. The safest way to transmit 8bit
4388
characters is to leave <EM>Pine</EM>'s MIME encoding turned on, but recipients
4389
who lack MIME-aware tools are often annoyed when they receive MIME-encoded
4393
<DT> <A NAME="enable-aggregate-command-set"><EM>enable-aggregate-command-set</EM></A>
4395
<DD> Setting this feature enables the commands and subcommands that relate to
4396
performing operations on more than one message at a time.
4397
We call these "aggregate operations".
4398
In particular, the <EM>; Select</EM>, <EM>A Apply</EM>, and
4399
<EM>Z Zoom</EM> commands are enabled by this feature.
4400
<EM>Select</EM> is used to <EM>tag</EM> one
4401
or more messages meeting the specified criteria. <EM>Apply</EM> can then be used
4402
to apply any message command to all of the selected/tagged messages.
4403
Further, the <EM>Zoom</EM> command allows you to toggle the "Folder Index" view
4404
between just those Selected and all messages in the folder.
4407
This feature also enables the <EM>^X</EM> subcommand in
4408
the "Folder Index" <EM>WhereIs</EM>
4409
command which causes
4410
all messages matching the <EM>WhereIs</EM> argument to become
4414
You may also use aggregate operations in the address book screens where
4415
you are operating on address book entries instead of on messages.
4418
<DT> <A NAME="enable-alt-ed"><EM>enable-alternate-editor-cmd</EM></A>
4420
<DD> If this feature is set, and the <A HREF="#editor"><EM>editor</EM></A>
4421
variable is not set, entering
4422
the <EM>^_</EM> (Control-underscore) key while
4423
composing a message will prompt you
4424
for the name of the editor you would like to use.
4427
If the environment variable <CODE>$EDITOR</CODE> is set,
4428
this value will be offered as a default.
4430
If the <EM>editor</EM> variable is set, the <EM>^_</EM> key will activate
4431
the specified editor without prompting, in which case it is not necessary to
4432
set the <EM>enable-alternate-editor-cmd</EM> feature.
4433
This feature is not available in <EM>PC-Pine</EM>.
4436
<DT> <A NAME="enable-alt-imp"><EM>enable-alternate-editor-implicitly</EM></A>
4438
<DD> If this feature and the <A HREF="#editor"><EM>editor</EM></A>
4439
variable are both set, <EM>Pine</EM> will
4440
automatically activate the specified editor when the cursor is moved from
4441
the header of the message being composed into the message text. For
4442
replies, the alternate editor will be activated immediately. If this
4443
feature is set but the <EM>editor</EM> variable is not set,
4444
then <EM>Pine</EM> will
4445
automatically ask for the name of an alternate editor when the cursor
4446
is moved out of the headers, or if a reply is being done.
4447
This feature is not available in <EM>PC-Pine</EM>.
4450
<DT> <A NAME="enable-arrow-navigation"><EM>enable-arrow-navigation</EM></A>
4452
<DD> This feature controls the behavior of the left and right arrow keys.
4453
If set, the left and right arrow keys will operate like the usual
4454
navigation keys <EM><</EM> and <EM>></EM>.
4457
If you set this feature, and do not like the changed behavior of the up/down
4458
arrow keys when navigating through the FOLDER LIST screen --
4459
<B>first</B> from column to column, if more than one folder is
4461
and <B>then</B> from row to row -- you may either also wish to set the feature
4462
<A HREF="#enable-arrow-navigation-relaxed"><EM>enable-arrow-navigation-relaxed</EM></A>,
4463
<A HREF="#single-column-folder-list"><EM>single-column-folder-list</EM></A>,
4464
or use the ^P/^N (instead of up/down arrow) keys to move up/down the list of
4465
folders in each column.
4468
<DT> <A NAME="enable-arrow-navigation-relaxed"><EM>enable-arrow-navigation-relaxed</EM></A>
4470
<DD> This feature controls the behavior of the left and right arrow keys
4471
in the FOLDER LIST screen when the
4472
<A HREF="#enable-arrow-navigation"><EM>enable-arrow-navigation</EM></A>
4476
Normally, when the "enable-arrow-navigation" feature is set,
4478
right arrow keys in the Folder List screen strictly track the commands
4479
bound to the <EM><</EM> and <EM>></EM> keys,
4480
and the up and down arrow keys move the
4481
highlite bar to the previous and next folder or directory name.
4484
When enabled, this feature returns the left, right, up and down arrow
4485
key's functionality in the FOLDER LIST screen to what it was before
4486
enabling "enable-arrow-navigation".
4487
In other words, left and right arrows
4488
move the highlight bar to the left or right, and the up and down arrows
4492
<DT> <A NAME="enable-background-sending"><EM>enable-background-sending</EM></A>
4495
feature enables a subcommand in the composer's <EM>Send?</EM> confirmation
4496
prompt. The subcommand allows you to tell <EM>Pine</EM> to handle the actual
4497
posting in the background. While this feature usually allows posting
4498
to appear to happen very fast, it has no affect on the actual delivery
4499
time it takes a message to arrive at its destination.
4502
This feature isn't supported on all systems. All DOS and Windows,
4503
as well as several Unix ports, do not recognize this feature.
4504
It is not possible to use background sending if the feature
4505
<A HREF="#send-without-confirm">send-without-confirm</A> is set.
4508
Error handling is significantly different when this feature is
4509
enabled. Any message posting failure results in the message
4510
being appended to your <EM>Interrupted</EM> mail folder. When you
4511
type the <EM>Compose</EM> command, <EM>Pine</EM> will notice this folder and
4512
offer to extract any messages contained. Upon continuing a
4513
failed message, <EM>Pine</EM> will display the nature of the failure
4514
in the status message line.
4517
Under extreme conditions, it is possible for message data to
4518
get lost. Do not enable this feature if you typically run close
4519
to any sort of disk-space limits or quotas.
4522
<DT> <A NAME="enable-bounce-cmd"><EM>enable-bounce-cmd</EM></A>
4524
<DD> Setting this feature enables the <EM>B Bounce</EM> command,
4526
for an address and <EM>remail</EM> the message to the new recipient.
4528
is used to re-direct messages that you have received in error, or need to
4529
be redirected for some other reason (e.g. list moderation). The final
4530
recipient will see a header indicating that you have Resent the msg, but
4531
the message's From: header will show the original author of the message,
4532
and replies to it will go back to that author, and not to you.
4535
<DT> <A NAME="enable-cruise-mode"><EM>enable-cruise-mode</EM></A>
4537
<DD> This feature affects <EM>Pine</EM>'s behavior when you hit the "Space Bar" at
4538
the end of a displayed message. Typically, <EM>Pine</EM> complains that the end
4539
of the text has already been reached. Setting this feature causes such
4540
keystrokes to be interpreted as if the <EM>Tab</EM> key had been hit, thus
4541
taking you to the next <EM>interesting</EM> message, or scanning ahead to the
4542
next incoming folder with <EM>interesting</EM> messages.
4545
<DT> <A NAME="enable-cruise-mode-delete"><EM>enable-cruise-mode-delete</EM></A>
4547
<DD> This feature modifies the behavior of <EM>Pine</EM>'s <EM>enable-cruise-mode</EM>
4548
feature. Setting this feature causes <EM>Pine</EM> to implicitly delete read
4549
messages when it moves on to display the next <EM>interesting</EM> message.
4552
NOTE: Beware when enabling this feature <B>and</B> the
4553
<A HREF="#expunge-wo-confirm"><EM>expunge-without-confirm</EM></A> feature.
4556
<DT> <A NAME="enable-delivery-status-notification"><EM>enable-delivery-status-notification</EM></A>
4559
feature enables a subcommand in the composer's "Send?" confirmation
4560
prompt. The subcommand allows you to tell <EM>Pine</EM> to request the type of
4561
Delivery Status Notification (DSN) which you would like. Most users will
4562
be happy with the default, and need not enable this feature. See the online
4563
help for more details.
4565
It is not possible to use delivery status notifications if the feature
4566
<A HREF="#send-without-confirm">send-without-confirm</A> is set.
4569
Note that this is not a method to request <EM>READ</EM> receipts, which tells
4570
the sender when the receiver has read the message. In this case we're talking
4571
about notification of delivery to the mailbox, not notification that the
4572
message has been seen.
4575
<DT> <A NAME="enable-dot-files"><EM>enable-dot-files</EM></A>
4577
<DD> If set, files beginning with dot (".") will be
4578
visible in the file browser. For example, you'll be able to select them
4579
when using the browser to add an attachment to a message.
4582
<DT> <A NAME="enable-dot-folders"><EM>enable-dot-folders</EM></A>
4584
<DD> If set, folders beginning with dot (".") may be added
4588
<DT> <A NAME="enable-exit-via-lessthan-command"><EM>enable-exit-via-lessthan-command</EM></A>
4590
<DD> If set, then on screens where there is an <EM>Exit</EM> command
4591
but no <EM><</EM> command, the <EM><</EM> key will perform
4592
the same function as the <EM>Exit</EM> command.
4595
<DT> <A NAME="enable-fast-recent-test"><EM>enable-fast-recent-test</EM></A>
4597
<DD> This feature controls the behavior of the TAB key when traversing folders
4599
<A HREF="#enable-incoming-folders">Incoming-Folders</A>
4600
collection or in optional News-Collections.
4605
key is pressed, the default behavior is to
4606
explicitly examine the status of the folder for the number of recent
4607
messages (messages delivered since the last time it was viewed).
4608
Depending on the size and number of messages in the folder, this test
4609
can be time consuming.
4612
Enabling this feature will cause <EM>Pine</EM> to only test for the existence of
4613
any recent messages rather than to obtain the count. This is much faster
4614
in many cases. The downside is that you're not given the number of recent
4615
messages when prompted to view the next folder.
4617
<A HREF="#tab-uses-unseen-for-next-folder">Tab-Uses-Unseen-For-Next-Folder</A>
4618
is turned on, then the present feature will have no effect.
4621
<DT> <A NAME="enable-flag-cmd"><EM>enable-flag-cmd</EM></A>
4623
<DD> Setting this feature enables the <EM>* Flag</EM> command,
4625
manipulate the status flags associated with a message.
4626
By default, <EM>Flag</EM>
4627
will set the <EM>Important</EM> flag, which results in an asterisk being
4628
displayed in column one of the "Folder Index" for such messages.
4631
<DT> <A NAME="enable-flag-screen-implicitly"><EM>enable-flag-screen-implicitly</EM></A>
4633
<DD> This feature modifies the behavior of the <EM>* Flag</EM> command
4634
(provided it too is enabled).
4635
By default, when the <EM>* Flag</EM> command is selected,
4636
<EM>Pine</EM> offers a prompt to set one of several flags and also offers the
4637
option of entering the detailed flag manipulation screen via the <EM>^T</EM>
4638
key. Enabling this feature causes <EM>Pine</EM> to immediately enter the detailed
4639
flag screen rather than first offer the simple prompt.
4641
<A HREF="#enable-flag-screen-keyword-shortcut">Enable-Flag-Screen-Keyword-Shortcut</A> option offers a slightly different way of setting keywords.
4644
<DT> <A NAME="enable-flag-screen-keyword-shortcut"><EM>enable-flag-screen-keyword-shortcut</EM></A>
4646
<DD> This feature modifies the behavior of the
4647
Flag command (provided it too is
4648
<A HREF="#enable-flag-cmd">enabled</A>).
4649
By default, when the "* Flag" command is selected,
4650
<EM>Pine</EM> offers a prompt to set one of several flags and also offers the
4651
option of entering the detailed flag manipulation screen via the "^T"
4654
<A HREF="#keywords">keywords</A>
4655
defined, then enabling this feature adds a shortcut way to set or unset
4657
You use "*" followed by the first letter of a keyword (or the nickname of
4658
a keyword if you've given it a nickname) and that will set the keyword.
4660
An example is easier to understand than the explanation.
4661
The flag command can always be used to set the system flags.
4662
For example, to set the Answered flag you would type
4664
<CENTER><SAMP>* A</SAMP></CENTER>
4666
Now suppose you have defined a keyword "Work" using the Keywords
4667
option in the Config screen.
4668
By default, to set a keyword like "Work" you would usually
4669
have to go to the Flag Details screen using
4670
the "^T To Flag Details" command.
4671
Instead, if you have enabled this feature, you may type
4673
<CENTER><SAMP>* W</SAMP></CENTER>
4675
to set the Work flag, or
4677
<CENTER><SAMP>* ! W</SAMP></CENTER>
4680
Just like for the other flag setting commands, the case of the letter does
4681
not matter, so "w" or "W" both set the "Work"
4684
Notice that you can only use this trick for one keyword that begins
4686
If you happen to have a "Work" keyword and another keyword that is
4687
"WIFI" the "* W" command will set the first one in
4688
your list of keywords.
4689
Also, there are five letters which are reserved for system
4690
flags and the NOT command.
4691
If you type "* A" it will always set the Answered flag, not
4692
your "Aardvark" keyword.
4693
In order to set the "Aardvark" keyword you'll still have to use
4694
the Flag Details screen.
4696
Because enabling the
4697
<A HREF="#enable-flag-screen-implicitly">Enable-Flag-Screen-Implicitly</A>
4698
option causes <EM>Pine</EM> to skip directly to the Flag Details screen when the
4699
Flag command is used,
4700
setting it will cause this feature to have no effect at all.
4703
<DT> <A NAME="enable-full-header-cmd"><EM>enable-full-header-cmd</EM></A>
4705
<DD> This feature enables the <EM>H Full Headers</EM> command which
4707
the display of all headers in the message and the normal edited view of
4708
headers. The <EM>Full Header</EM> command also controls
4709
which headers are included
4710
for <EM>Export</EM>, <EM>Pipe</EM>, <EM>Print</EM>, <EM>Forward</EM>,
4711
and <EM>Reply</EM> functions. (For <EM>Reply</EM>, the
4712
<EM>Full Header</EM> mode will respect
4713
the <EM>include-headers-in-reply</EM> feature setting.)
4715
If Full Header mode has been turned on and you Forward a message, you will
4716
be asked if you'd like to forward the message as an attachment, as opposed
4717
to including the text of the message in the body of your new message.
4719
If you have also turned on the
4720
<A HREF="#quote-suppression-threshold">"Quote Suppression"</A>
4721
option then the Full Headers command actually rotates through three states
4722
instead of just two.
4723
The first is the normal view with long quotes suppressed.
4724
The second is the normal view but with the long quotes included.
4725
The last enables the display of all headers in the message.
4726
When using Export, Pipe, Print, Forward, or Reply the quotes are
4727
never suppressed, so the first two states are identical.
4729
Normally, the Header Mode will reset
4730
to the default behavior when moving to a new message.
4731
The mode can be made to persist from message to message by setting the feature
4732
<A HREF="#quell-full-header-auto-reset">Quell-Full-Header-Auto-Reset</A>.
4735
<DT> <A NAME="enable-full-header-and-text"><EM>enable-full-header-and-text</EM></A>
4738
<P>This feature affects how the <EM>H Full Headers</EM> command displays
4739
message text. If set, the raw message text will be displayed. This
4740
especially affects MIME formatted email, where the entire MIME format
4741
will be displayed. This feature similarly affects how messages are
4742
included for the <EM>Export</EM>, <EM>Pipe</EM>, <EM>Print</EM>, <EM>Forward</EM>,
4743
and <EM>Reply</EM> functions.
4745
<DT> <A NAME="enable-goto-in-file-browser"><EM>enable-goto-in-file-browser</EM></A>
4747
<DD> Setting this causes <EM>Pine</EM> to offer the <EM>G Goto</EM> command in
4748
the file browser. This command allows you to explicitly set the
4749
displayed directory. <EM>Pine</EM>'s default behavior requires you to visit
4750
each related directory when moving between two distant directories.
4753
<DT> <A NAME="enable-incoming-folders"><EM>enable-incoming-folders</EM></A>
4755
<DD> If set, this feature defines a pseudo-folder collection called
4756
<EM>INCOMING MESSAGE FOLDERS</EM>.
4757
Initially, the only folder included in this collection
4758
will be your <EM>INBOX</EM>, which will no longer show up in your default
4759
saved-message folder collection.
4762
<DT> <A NAME="enable-jump-shortcut"><EM>enable-jump-shortcut</EM></A>
4764
<DD> Setting this feature will allow you to enter a number (followed by RETURN)
4765
and jump to that message number, when in the "Folder Index" or "Message Text"
4766
screens. In other words, it obviates the need for typing the <EM>J</EM> for the
4767
<EM>Jump</EM> command.
4770
<DT> <A NAME="enable-lame-list-mode"><EM>enable-lame-list-mode</EM></A>
4772
<DD> This feature modifies the method Pine uses to ask your IMAP
4773
server for folder names to display in the the FOLDER LIST screen.
4774
It is intended to compensate for a small set of IMAP servers that
4775
are programmed to ignore a part of the request, and thus respond
4776
to <EM>Pine</EM>'s query with nonsensical results.
4779
If you find that <EM>Pine</EM> is erroneously displaying blank folder lists,
4780
try enabling this feature.
4783
NOTE: Enabling this feature has consequences for the Goto and Save
4784
commands. Many servers allow access to folders outside the area
4785
reserved for your personal folders via some reserved character,
4786
typically '#' (sharp), '~' (tilde) or '/' (slash). This mechanism
4787
allows, at the Goto and Save prompts, quick access to folders
4788
outside your personal folder collection without requiring a specific
4789
collection definition. This behavior will generally not be available
4790
when this feature is enabled.
4793
<DT> <A NAME="enable-mail-check-cue"><EM>enable-mail-check-cue</EM></A>
4795
<DD> If set, this will cause an asterisk to appear in the upper
4796
left-hand corner of the screen whenever <EM>Pine</EM> checks for new mail, and two
4797
asterisks whenever <EM>Pine</EM> saves (checkpoints) the state of the current
4801
<DT> <A NAME="enable-mailcap-param-substitution"><EM>enable-mailcap-param-substitution</EM></A>
4803
<DD> If set, this will allow mailcap named parameter substitution to occur
4805
By default, this is turned off to prevent security problems which may occur
4806
with some incorrect mailcap configurations.
4807
For more information, RFC1524 and look for "named parameters" in the
4811
<DT> <A NAME="enable-mouse-in-xterm"><EM>enable-mouse-in-xterm</EM></A>
4813
<DD> This feature controls whether or not an X terminal mouse can be used with
4814
<EM>Pine</EM>. If set, and the <CODE>$DISPLAY</CODE> variable indicates that an
4815
X terminal is being used, the left mouse button on the mouse can be
4816
used to select text or commands.
4819
Note: if this feature is set, the behavior of X terminal cut-and-paste is
4820
also modified. It is necessary to hold the shift key down while clicking
4821
left or middle mouse buttons for the normal xterm cut/paste operations.
4824
<DT> <A NAME="enable-msg-view-addresses"><EM>enable-msg-view-addresses</EM></A>
4826
<DD> This feature modifies the behavior of <EM>Pine</EM>'s "Message Text" screen.
4827
Setting this feature causes <EM>Pine</EM> to select possible email addresses
4828
from the displayed text and display them in boldface for selection.
4831
The first available email address is displayed in inverse. This is the
4833
Pressing <EM>RETURN</EM> will cause <EM>Pine</EM> to enter the message
4834
composition screen with the To field filled in with the selected address.
4837
Use the up and down arrow keys to change which of the addresses
4838
displayed in boldface is the current selection.
4841
<DT> <A NAME="enable-msg-view-attachments"><EM>enable-msg-view-attachments</EM></A>
4843
<DD> This feature modifies the behavior of <EM>Pine</EM>'s "Message Text" screen.
4844
Setting this feature causes <EM>Pine</EM> to present attachments in boldface.
4845
The first available attachment is displayed in inverse. This is the
4846
"selected" attachment. Pressing <EM>RETURN</EM> will cause <EM>Pine</EM> to display
4847
the selected attachment. Use the up and down arrow keys to change which of the
4848
attachments displayed in boldface is the current selection.
4851
Speaking of arrow keys, the Up and Down Arrows will select the next
4852
and previous attachments if one is available on the screen for selection.
4853
Otherwise, they will simply adjust the viewed text one line up or down.
4856
Similarly, when selectable items are present in a message, the Ctrl-F
4857
key can be used to select the next item in the message independent
4858
of which portion of the viewed message is currently displayed. The
4859
Ctrl-B key can be used to select the previous item in the same way.
4862
<DT> <A NAME="enable-msg-view-forced-arrows"><EM>enable-msg-view-forced-arrows</EM></A>
4864
<DD> This feature modifies Up and Down arrow key behavior in <EM>Pine</EM>'s
4865
"Message Text" screen when selectable Attachments, URL's, or
4866
web-hostnames are presented. <EM>Pine</EM>'s usual behavior is to move to
4867
the next or previous selectable item if currently displayed or
4868
simply to adjust the screen view by one line if the next selectable line
4872
Setting this feature causes the Up and Down arrow keys to behave as
4873
if no selectable items were present in the message.
4876
Note, the <EM>Ctrl-F</EM> (next selectable item) and
4877
<EM>Ctrl-B</EM> (previous selectable item) functionality is unchanged.
4880
<DT> <A NAME="enable-msg-view-urls"><EM>enable-msg-view-urls</EM></A>
4882
<DD> This feature modifies the behavior of <EM>Pine</EM>'s "Message Text" screen.
4883
Setting this feature causes <EM>Pine</EM> to select possible URL's from the
4884
displayed text and display them in boldface for selection.
4887
The first available URL is displayed in inverse. This is the
4888
"selected" URL. Pressing <EM>RETURN</EM> will cause <EM>Pine</EM> to display
4889
the selected URL via either built-in means as with <CODE>mailto:</CODE>,
4890
<CODE>imap:</CODE>, <CODE>news:</CODE>, and <CODE>nntp:</CODE>,
4891
or via an external application as defined
4892
by the <A HREF="#url-viewers"><EM>url-viewers</EM></A> variable.
4895
Use the up and down arrow keys to change which of the URLs displayed in boldface
4896
is the current selection.
4899
<DT> <A NAME="enable-msg-view-web-hostnames"><EM>enable-msg-view-web-hostnames</EM></A>
4901
<DD> This feature modifies the behavior of <EM>Pine</EM>'s "Message Text" screen.
4902
Setting this feature causes <EM>Pine</EM> to select possible web hostnames
4903
from the displayed text and display them in boldface for selection.
4906
The first available hostname is displayed in inverse. This is the
4907
"selected" hostname. Pressing <EM>RETURN</EM> will cause <EM>Pine</EM> to display
4908
the selected hostname via an external application as defined
4909
by the <A HREF="#url-viewers"><EM>url-viewers</EM></A> variable.
4912
Use the up and down arrow keys to change which of the hostnames displayed in
4913
boldface is the current selection.
4916
<DT> <A NAME="enable-multiple-newsrcs"><EM>enable-multiple-newsrcs</EM></A>
4918
<DD> This feature makes it so Pine can use multiple newsrcs based on
4919
the news server being connected to, which allows for separate lists
4920
of subscribed-to newsgroups. When this feature is not set, there is only
4921
one list of newsgroups.
4923
Under this feature, the name of a newsrc is based on the news server.
4924
For example, if your <a href="#newsrc-path">newsrc-path</a>
4925
is set to ".newsrc", and the news server you are connecting to is
4926
news.example.com, then the newsrc to be used is .newsrc-news.example.com.
4927
Setting this feature for the first time will allow for the option of using
4928
your old newsrc the next time you read news.
4930
If this feature is set, then the feature
4931
<A HREF="#mult-newsrc-hostnames-as-typed">Mult-Newsrc-Hostnames-As-Typed</A>
4932
also may affect the name of the newsrc file that is used.
4936
<DT> <A NAME="enable-newmail-in-xterm-icon"><EM>enable-newmail-in-xterm-icon</EM></A>
4938
<DD> This feature controls whether or not <EM>Pine</EM> will attempt to announce new
4939
mail arrival when it is running in an X terminal window and that window
4941
If set, and the <CODE>$DISPLAY</CODE> variable indicates that an X
4942
terminal is being used, <EM>Pine</EM> will send appropriate escape sequences to
4943
the X terminal to modify the label on <EM>Pine</EM>'s icon to indicate that new
4944
mail has arrived. <EM>Pine</EM> will also modify the <EM>Pine</EM> window's title to
4946
See also <A HREF="#enable-newmail-short-text-in-icon">Enable-Newmail-Short-Text-in-Icon</A>.
4949
<DT> <A NAME="enable-newmail-short-text-in-icon"><EM>enable-newmail-short-text-in-icon</EM></A>
4951
<DD> This feature controls the text to be displayed in an icon in the event
4952
of a new message arrival. Normally, the message will
4953
be the one that is displayed on the screen. This feature shortens the
4954
message to a count of the number of new messages in brackets. This may be
4955
more useful for those who use the window's title bar in the task bar as a
4956
new mail indicator. This feature is only useful if the
4957
<A HREF="#enable-newmail-in-xterm-icon">Enable-Newmail-in-Xterm-Icon</A>
4958
is also set. Like the Enable-Newmail-in-Xterm-Icon
4959
feature, this feature is only relevant when run in an xterm environment.
4962
<DT> <A NAME="enable-partial-match-lists"><EM>enable-partial-match-lists</EM></A>
4964
<DD> This feature affects the subcommands available when <EM>Sav</EM>ing
4965
or Opening a new folder. If set, the subcommand <EM>^X ListMatches</EM> will be
4966
available. This command allows you to type in a substring of the folder
4967
you are looking for and when you type <EM>^X</EM> it will display all folders
4968
which contain that substring in their names.
4971
<DT> <A NAME="enable-print-via-y-command"><EM>enable-print-via-y-command</EM></A>
4973
<DD> By default, <EM>Pine</EM>'s print command is available by pressing the <EM>%</EM>
4974
key. In recent versions prior to 4.00, the print command was accessed by
4975
pressing the <EM>Y</EM> key.
4978
Enabling this feature will cause <EM>Pine</EM> to recognize both the old
4979
command, <EM>Y</EM>, and the new <EM>%</EM> method for invoking
4980
printing. Note, key menu labels are not changed as a result of
4981
enabling this feature.
4984
<DT> <A NAME="enable-reply-indent-string-editing"><EM>enable-reply-indent-string-editing</EM></A>
4986
<DD> This feature affects the Reply command's "Include original message
4987
in Reply?" prompt. When enabled, it causes the
4988
"Edit Indent String" sub-command to appear which allows
4989
you to edit the string <EM>Pine</EM> would otherwise use to denote included
4990
text from the message being replied to.<P>
4992
Thus, you can change <EM>Pine</EM>'s default message quote character (usually
4993
an angle bracket) on a per message basis. So you could change your quoted message to
4994
look, for example, like this:<p>
4996
<pre>On Tues, 26 Jan 1999, John Q. Smith wrote:
4998
John: I just wanted to say hello and to congratulate you
4999
John: on a job well done!</pre><p>
5001
The configuration option
5002
<A HREF="#reply-ind-str">"reply-indent-string"</A>
5003
may be used to change what appears as the default string to be edited.
5005
NOTE: Edited reply-indent-strings only apply to the message
5006
currently being replied to.
5009
<DT> <A NAME="enable-rules-under-take"><EM>enable-rules-under-take</EM></A>
5011
<DD> Normally, the Take command takes addresses from a message and helps you
5012
put them into your Address Book.
5013
If you use Rules for Indexcolors, Roles, Filtering, or Scoring;
5014
you may find it useful
5015
to be able to Take information from a message's headers and put it into
5017
When this feature is set, you will be given an extra prompt which gives
5018
you the choice to Take into the Address Book or Take into a rule.
5021
<DT> <A NAME="enable-search-and-replace"><EM>enable-search-and-replace</EM></A>
5023
<DD> If set <EM>Pine</EM>'s composer offers the <EM>R Replace</EM> command
5024
option inside the <EM>W WhereIs</EM> command.
5027
<DT> <A NAME="enable-setlocale-ctype"><EM>enable-setlocale-ctype</EM></A>
5029
<DD> This is a hard to understand feature that should only be used in rare cases.
5030
Normally, the C function call
5032
<CENTER><SAMP>setlocale(LC_CTYPE, "")</SAMP></CENTER>
5034
is not used by <EM>Pine</EM> because it causes problems in some cases.
5035
If you want to try turning it on, and it is available in your operating system,
5036
setting this feature will turn it on.
5037
This part of the locale has to do with identifying space characters and
5038
alphanumeric characters in your locale.
5039
A related feature is
5040
<A HREF="#disable-setlocale-collate"><EM>disable-setlocale-collate</EM></A>.
5043
<DT> <A NAME="enable-sigdashes"><EM>enable-sigdashes</EM></A>
5045
<DD> If set and a <EM>signature-file</EM> exists, the line consisting of
5046
the three characters "<CODE>-- </CODE>" (dash dash space) is included
5047
before the signature.
5048
This only happens if the signature doesn't already contain such a line.
5050
In addition, when you Reply or Followup to a message containing one of
5051
these special lines and choose to include its text, <EM>Pine</EM> will observe
5052
the convention of not including text beyond the special line in your
5056
<DT> <A NAME="enable-suspend"><EM>enable-suspend</EM></A>
5058
<DD> Setting this feature will allow you to type <EM>^Z</EM>
5059
and temporarily suspend <EM>Pine</EM>. Not available on <EM>PC-Pine</EM>.
5062
<DT> <A NAME="enable-tab-completion"><EM>enable-tab-completion</EM></A>
5064
<DD> This feature enables the <EM>TAB</EM> key when
5065
at a prompt for a filename. In this
5066
case, <EM>TAB</EM> will cause the
5067
partial name already entered to be automatically
5068
completed, provided the partial name is unambiguous.
5071
<DT> <A NAME="enable-take-export"><EM>enable-take-export</EM></A>
5073
<DD> Normally, the Take command takes addresses from a message and helps you
5074
put them into your Address Book.
5075
When this feature is set, you will be given an extra prompt which gives you
5076
the choice to Take addresses into a file instead of your Address
5078
Only the user@domain_name part of the address is put in the file.
5081
<DT> <A NAME="enable-tray-icon"><EM>enable-tray-icon</EM></A>
5083
<DD> <EM>PC-Pine</EM> only. This option restores a behavior of
5084
previous versions of PC-Pine. These
5085
versions, when started, installed a PC-Pine icon in the notification
5086
tray of Window's Taskbar. The primary use of this icon was to indicate
5087
new mail arrival by turning red (while the Taskbar icon remained green).
5088
Additionally, the icon now changes to yellow to signify that a mail folder
5089
has been closed unexpectedly.
5091
Rather than add another icon to the Taskbar, this version of PC-Pine will
5092
color its Taskbar entry's icon red (as well as the icon in the Window
5093
Title). This feature is only provided for backwards compatibility.
5096
<DT> <A NAME="enable-unix-pipe-cmd"><EM>enable-unix-pipe-cmd</EM></A>
5098
<DD> This feature enables the <EM>| Pipe</EM> command
5099
that sends the current message
5100
to the specified Unix command for external processing. Not available on
5104
<DT> <A NAME="enable-verbose-smtp-posting"><EM>enable-verbose-smtp-posting</EM></A>
5106
<DD> This feature controls an aspect of <EM>Pine</EM>'s message sending. When enabled,
5107
<EM>Pine</EM> will send a <CODE>VERB</CODE> (i.e., VERBose) command
5108
early in the posting process
5109
intended to cause the server SMTP to provide a more detailed account of
5110
the transaction. This feature is typically only useful to system
5111
administrators and other support personel as an aid in troublshooting
5114
Note, this feature relies on a specific capability of the system's mail
5115
transport agent or configured <A HREF="#smtp-server"><EM>smtp-server</EM></A>.
5118
<DT> <A NAME="expanded-view-of-addressbooks"><EM>expanded-view-of-addressbooks</EM></A>
5120
<DD> If multiple address books (either personal or global) are defined, and you
5121
wish to have them all expanded implicitly upon entering the ADDRESS BOOK
5122
screen, then set this feature. This feature will have no effect unless the
5124
<A HREF="#combined-addrbook-display"><EM>combined-addrbook-display</EM></A>
5128
<DT> <A NAME="expanded-view-of-distribution-lists"><EM>expanded-view-of-distribution-lists</EM></A>
5130
<DD> If this feature is set, then distribution lists in the address book
5131
screen will always be expanded automatically.
5134
<DT> <A NAME="expanded-view-of-folders"><EM>expanded-view-of-folders</EM></A>
5136
<DD> If multiple folder collections are defined, and you
5137
wish to have them all expanded implicitly upon entering the FOLDER LIST
5138
screen, then set this feature. This feature will have no effect unless the
5140
<A HREF="#combined-folder-display"><EM>combined-folder-display</EM></A>
5144
<DT> <A NAME="expose-hidden-config"><EM>expose-hidden-config</EM></A>
5146
<DD> The purpose of this feature is to allow you to change configuration
5147
features and variables which are normally hidden.
5148
This is particularly useful if you are using a remote configuration file,
5149
where it is difficult to edit the file manually, but it may also be used
5150
on a local pinerc configuration file.
5152
If set, most configuration variables and features which are normally
5153
hidden from view will show up in the Setup/Configuration screen.
5154
They will be at the bottom of the configuration screen.
5155
You can find them by searching for the word "hidden".
5158
Note that this is an advanced feature which should be used with care.
5159
The reason that this part of the configuration is normally hidden is because
5160
there is a significant potential for causing problems if you change these
5162
If something breaks after a change try changing it back to see if that is
5163
what is causing the problem.
5164
There are also some variables which are normally hidden because they are
5165
manipulated through <EM>Pine</EM> in other ways.
5166
For example, the "address-book" variable is normally set using
5167
the Setup/AddressBooks screen, so there is little reason to edit it directly.
5168
The "incoming-folders" variable is normally changed by using
5169
the Add, Delete, and Rename commands in the FOLDER LIST screen,
5170
and the "last-time-prune-questioned" variable is normally used
5171
internally by <EM>Pine</EM> and not set directly by the user.
5174
<DT> <A NAME="expunge-only-manually"><EM>expunge-only-manually</EM></A>
5176
<DD> Normally, when you close a folder which contains deleted messages you are
5177
asked if you want to expunge those messages from the folder permanently.
5178
If this feature is set, you won't be asked and the deleted messages will
5179
remain in the folder.
5180
If you choose to set this feature you will have to expunge the
5181
messages manually using the eXpunge command, which you can use while
5182
in the MESSAGE INDEX screen.
5183
If you do not expunge deleted messages the size of your
5184
folder will continue to increase until you are out of disk space.
5187
<DT> <A NAME="expunge-wo-confirm"><EM>expunge-without-confirm</EM></A>
5189
<DD> If set, you will not be prompted to confirm your intent before
5190
the expunge takes place. Actually, you will still be prompted for confirmation
5191
if the folder is not the <EM>INBOX</EM> folder or another folder in the
5192
Incoming Folders collection. See the <EM>expunge-without-confirm-everywhere</EM>
5193
feature which follows.
5196
<DT> <A NAME="expunge-without-confirm-everywhere"><EM>expunge-without-confirm-everywhere</EM></A>
5198
<DD> The regular <EM>expunge-without-confirm</EM> feature actually only
5199
works for the <EM>INBOX</EM> folder and for other folders in the "Incoming
5200
Folders" collection. If this feature is set then you also won't be prompted
5201
to confirm expunges for all other folders.
5204
<DT> <A NAME="fcc-on-bounce"><EM>fcc-on-bounce</EM></A>
5206
<DD> If set, normal Fcc (File Carbon Copy) processing will be
5207
done for bounced messages,
5208
just as if you had composed a message to the address you are
5209
bouncing to. If not set, no Fcc of the message will be saved.
5212
<DT> <A NAME="fcc-only-without-confirm"><EM>fcc-only-without-confirm</EM></A>
5214
<DD> This features controls an aspect of Pine's composer.
5215
The only time this feature will be used is if you attempt to send mail
5216
which has no recipients but does have an Fcc.
5217
Normally, Pine will ask if you really mean to copy the message only to
5219
That is, it asks if you really meant to have no recipients.
5220
If this feature is set, you
5221
will <B>not</B> be prompted to confirm your intent to make only a copy
5222
of a message with no recipients.
5224
This feature is closely related to
5225
<A HREF="#warn-if-blank-to-and-cc-and-newsgroups"><EM>warn-if-blank-to-and-cc-and-newsgroups</EM></A>.
5226
The difference between this feature and that feature is that this feature
5227
considers a Bcc to be a recipient while that feature will ask for confirmation
5228
even if there is a Bcc when there is no To, Cc, or Newsgroup.
5229
The default values also differ. This feature defaults to asking the question
5230
and you have to turn it off.
5231
The warn-if-blank-to-and-cc-and-newsgroups feature defaults to not asking
5232
unless you turn it on.
5235
<DT> <A NAME="fcc-without-attachments"><EM>fcc-without-attachments</EM></A>
5237
<DD> This features controls the way FCC's (File Carbon Copies) are
5238
made of the messages you send.
5241
Normally, <EM>Pine</EM> saves an exact copy of your message as it was sent.
5242
When this feature is enabled, the "body" of the message
5243
you send (the text you type in the composer) is preserved in the
5244
copy as before, however all attachments are replaced with text
5245
explaining what had been sent rather than the attachments themselves.
5248
This feature also affects <EM>Pine</EM>'s "Send ?" confirmation prompt
5249
in that a new "^F Fcc Attchmnts" option becomes available which
5250
allows you to interactively set whether or not attachments are saved
5254
<DT> <A NAME="force-arrow-cursor"><EM>force-arrow-cursor</EM></A>
5256
<DD> This feature affects <EM>Pine</EM>'s MESSAGE INDEX display routine.
5257
If set, the normal inverse-video cursor will be
5258
replaced by a simple "arrow" cursor, which normally occupies the
5259
second column of the index display.
5261
This is the same index cursor you get if you turn on
5262
<A HREF="#assume-slow-link">Assume-Slow-Link</A>, but the index
5263
line coloring will still be present if this feature is turned on and
5264
Assume-Slow-Link is off.
5266
An alternative version of the Arrow cursor is available by including the
5269
<A HREF="#index-format"><EM>Index-Format</EM></A> option.
5271
It ought to be the case that this feature also affects the ATTACHMENT INDEX,
5272
but that is not implemented.
5275
<DT> <A NAME="hide-nntp-path"><EM>hide-nntp-path</EM></A>
5277
<DD> Normally the Path header that <EM>Pine</EM> generates when posting to a newsgroup
5278
contains the name of the computer from which the message is being sent and
5280
Some believe that this information is used by spammers.
5281
If this feature is set, that information will be replaced with the text
5283
<CENTER><SAMP>not-for-mail</SAMP></CENTER>
5287
It should be noted that many servers being connected to will still reveal
5288
the information that this feature attempts to protect.
5290
<DT> <A NAME="include-attachments-in-reply"><EM>include-attachments-in-reply</EM></A>
5292
<DD> If set, any MIME
5293
attachments that were part of the original message will automatically be
5294
included in a <EM>Reply</EM>.
5297
<DT> <A NAME="include-header-in-reply"><EM>include-header-in-reply</EM></A>
5300
message being replied to is included in the <EM>Reply</EM>,
5301
then headers from that
5302
message will also be part of the reply.
5305
<DT> <A NAME="include-text-in-reply"><EM>include-text-in-reply</EM></A>
5307
<DD> Normally, <EM>Pine</EM> will ask whether you
5308
wish to include the original message in your <EM>Reply</EM>.
5309
If this feature is set and the feature
5310
<A HREF="#enable-reply-indent-string-editing"><EM>enable-reply-indent-string-editing</EM></A>
5311
is <EM>not</EM> set, then the original message will be included in the reply
5312
automatically, without prompting.
5315
<DT> <A NAME="ldap-result-to-addrbook-add"><EM>ldap-result-to-addrbook-add</EM></A>
5317
<DD> This is only available if <EM>Pine</EM> was linked with an LDAP library
5318
when it was compiled.
5319
If both the per-directory-server option
5320
<A HREF="#use-implicitly-from-composer"><EM>use-implicitly-from-composer</EM></A>
5321
and this feature are set,
5322
then when an implicit directory lookup is done from the
5323
composer you will automatically be prompted to add the result of the
5324
directory lookup to your address book.
5327
<DT> <A NAME="maildrops-preserve-state"><EM>maildrops-preserve-state</EM></A>
5330
This feature affects the way
5331
<A HREF="config-notes.html#maildrop">Mail Drops</A> work.
5332
Normally, when mail is moved from a Mail Drop folder to a destination
5333
folder, the state changes that have taken place since the mail was originally
5335
Any Seen/New, Answered, Important/Flagged state that has changed will be
5337
All of the mail will be considered unSeen, unAnswered, and unImportant after
5340
If this feature is set, then the state changes will not be lost.
5342
In any case, messages which are already marked Deleted when the
5343
mail is to be copied from the Mail Drop will be ignored.
5346
<DT> <A NAME="mark-fcc-seen"><EM>mark-fcc-seen</EM></A>
5348
<DD> This features controls the way FCCs (File Carbon Copies) are
5349
made of the messages you send.
5350
Normally, when <EM>Pine</EM> saves a copy of a message you sent as an Fcc, that
5351
copy will be marked as Unseen.
5352
When you look at the folder it was saved in the message will appear to
5353
be a New message until you read it.
5354
When this feature is enabled, the message will be marked as having
5358
<DT> <A NAME="mark-for-cc"><EM>mark-for-cc</EM></A>
5360
<DD> This feature affects Pine's MESSAGE INDEX display.
5361
By default, a '+' is displayed in the first column if the
5362
message is addressed directly to you.
5363
When this feature is set and the message is not addressed to you, then a
5364
'-' character is displayed if the message is instead Cc'd directly
5368
<DT> <A NAME="mult-newsrc-hostnames-as-typed"><EM>mult-newsrc-hostnames-as-typed</EM></A>
5370
<DD> This feature will be of little use to most users.
5371
It has no effect unless the feature
5372
<A HREF="#enable-multiple-newsrcs">Enable-Multiple-Newsrcs</A>
5375
When the Enable-Multiple-Newsrcs feature is set
5376
then the setting of this feature may have an effect on the names of the
5378
Normally, the name of the news server will be canonicalized before it is
5379
used in the newsrc file name.
5380
For example, if you type the news server name
5383
<CENTER><SAMP>servername</SAMP></CENTER>
5386
it is likely that the canonical name will be something like
5389
<CENTER><SAMP>servername.example.com</SAMP></CENTER>
5392
Or it may be the case that
5395
<CENTER><SAMP>servername.example.com</SAMP></CENTER>
5398
is really an alias (a DNS CNAME) for
5401
<CENTER><SAMP>othername.example.com</SAMP></CENTER>
5404
If this feature is not set, then the canonicalized names will be used.
5405
If this feature is set, then the name you typed in (or put in your
5406
configuration) will be used.
5409
<DT> <A NAME="news-approximates-new-status"><EM>news-approximates-new-status</EM></A>
5411
<DD> This feature causes certain messages to be marked as <EM>New</EM> in the
5412
"Folder Index" of newsgroups.
5415
When opening a newsgroup, <EM>Pine</EM> will consult
5416
your <EM>newsrc</EM> file and
5417
determine the last message you have previously disposed of via the <EM>D</EM>
5418
key. If this feature is set, any subsequent messages will be shown in the
5419
Index with an <EM>N</EM>, and the first of these messages will be highlighted.
5420
Although this is only an approximation of true <EM>New</EM> or <EM>Unseen</EM>
5421
status, it provides a useful cue to distinguish more-or-less recent
5422
messages from those you have seen previously, but are not yet ready to
5426
Background: your <EM>newsrc</EM> file (used to store message status information
5427
for newsgroups) is only capable of storing a single flag, and <EM>Pine</EM> uses
5428
this to record whether or not you are "done with" a message, as
5429
indicated by marking the message as <EM>Deleted</EM>. Unfortunately, this
5430
means that <EM>Pine</EM> has no way to record exactly which messages you have
5431
previously seen, so it normally does not show the <EM>N</EM> status flag for
5432
any messages in a newsgroup. This feature enables a starting
5433
<I>approximation</I> of seen/unseen status that may be useful.
5436
<DT> <A NAME="news-deletes-across-groups"><EM>news-deletes-across-groups</EM></A>
5438
<DD> This feature controls what <EM>Pine</EM> does when you delete a
5439
message in a newsgroup that appears in more than one newsgroup.
5440
Such a message is sometimes termed a "crossposting"
5441
in that it was posted across several newsgroups.
5444
<EM>Pine</EM>'s default behavior when you delete such a message is to remove
5445
only the copy in the current newsgroup from view when you use the
5446
"Exclude" command or the next time you visit the newsgroup.
5449
Enabling this feature causes <EM>Pine</EM> to remove every occurrence of the
5450
message from all newsgroups it appears in and to which you are
5454
NOTE: As currently implemented, enabling this feature may increase the
5455
time it takes the Expunge command and newsgroup closing to complete.
5458
<DT> <A NAME="news-offers-catchup-on-close"><EM>news-offers-catchup-on-close</EM></A>
5460
<DD> This feature controls what <EM>Pine</EM> does as it closes a newsgroup.
5461
When set, <EM>Pine</EM> will offer to delete all messages from the newsgroup
5462
as you are quitting <EM>Pine</EM> or opening a new folder.
5465
This feature is useful if you typically read all the interesting messages
5466
in a newsgroup each time you open it. This feature saves you from
5467
having to delete each message in a newsgroup as you read it or from
5468
selecting all the messages and doing an
5469
aggregate delete before you move on to the next folder or newsgroup.
5472
<DT> <A NAME="news-post-without-validation"><EM>news-post-without-validation</EM></A>
5474
<DD> This feature controls whether the NNTP server is queried as newsgroups
5475
are entered for posting. Validation over slow links (e.g. dialup using
5476
SLIP or PPP) can cause delays. Set this feature to eliminate such delays.
5479
<DT> <A NAME="news-read-in-newsrc-order"><EM>news-read-in-newsrc-order</EM></A>
5481
<DD> This feature controls the order that newsgroups will be presented. If
5482
set, they will be presented in the same order as they occur in
5483
your <EM>newsrc</EM> file.
5484
If not set, the newsgroups
5485
will be presented in alphabetical order.
5488
<DT> <A NAME="next-thread-without-confirm"><EM>next-thread-without-confirm</EM></A>
5490
<DD> This feature controls an aspect of <EM>Pine</EM>'s Next and Prev commands in
5491
the case where you are using one of the
5492
"separate-index-screen" styles for the configuration option
5493
<A HREF="#threading-index-style"><EM>threading-index-style</EM></A>
5494
and currently have the folder sorted by a Threaded or OrderedSubject sort.
5495
When you are Viewing a particular thread you have a
5496
MESSAGE INDEX of only the messages in that thread.
5497
If you press the Next command with the last message in the thread highlighted
5498
you will normally be asked if you want to "View next thread?",
5499
assuming there is a next thread to view.
5500
If this feature is set it will be assumed that you always want to view the
5501
next thread and you won't be asked to confirm that.
5502
Similarly, if the first message of the thread is highlighted and you
5503
press the Prev command, this feature will prevent the question
5504
"View previous thread".
5506
This feature only has an effect in the MESSAGE INDEX screen.
5507
If you then view a particular message from that screen and press the
5508
Next command, you will be sent to the next thread without being asked,
5509
independent of the setting of this feature.
5512
<DT> <A NAME="offer-expunge-on-inbox"><EM>offer-expunge-on-inbox</EM></A>
5514
<DD> The INBOX is normally treated differently from regular folders in several
5516
One of the differences is that the normal "close" sequence of
5517
events is deferred until <EM>Pine</EM> is exited, instead of happening when you
5518
leave the INBOX to view another folder.
5519
The "close" sequence normally includes the Expunging
5521
(either automatically or after a prompt, controlled by the features
5522
<A HREF="#expunge-wo-confirm">Expunge-Without-Confirm</A>,
5523
<A HREF="#expunge-without-confirm-everywhere">Expunge-Without-Confirm-Everywhere</A>, and
5524
<A HREF="#expunge-only-manually">Expunge-Only-Manually</A>), and the
5526
<A HREF="#read-msg-fold">Read-Message-Folder</A>.
5529
If this feature is set the "close" sequence handling will take
5530
place every time you leave the INBOX.
5531
The INBOX will still be kept open, but the offer to Expunge and the archiving
5532
to the Read-Message-Folder
5533
will take place each time you leave the INBOX instead of only once at the
5537
<DT> <A NAME="offer-expunge-on-stayopen-folders"><EM>offer-expunge-on-stayopen-folders</EM></A>
5539
<DD> This feature is related to the option
5540
<A HREF="#stay-open-folders">Stay-Open-Folders</A>.
5541
Stay Open folders are treated differently from regular folders in several
5543
One of the differences is that the normal "close" sequence of
5544
events is deferred until <EM>Pine</EM> is exited, instead of happening when you
5545
leave the folder to view another folder.
5546
The "close" sequence normally includes the Expunging
5548
(either automatically or after a prompt, controlled by the features
5549
<A HREF="#expunge-wo-confirm">Expunge-Without-Confirm</A>,
5550
<A HREF="#expunge-without-confirm-everywhere">Expunge-Without-Confirm-Everywhere</A>, and
5551
<A HREF="#expunge-only-manually">Expunge-Only-Manually</A>), and the
5553
<A HREF="#incoming-archive-folders">Incoming-Archive-Folders</A>.
5556
If this feature is set the "close" sequence handling will take
5557
place when you leave the Stay Open folder.
5558
The folder will still be kept open, but the offer to Expunge and the archiving
5559
will take place each time you leave the folder instead of only once at the
5561
This feature does not affect the INBOX, which will still only be processed
5562
when you exit <EM>Pine</EM>.
5565
<DT> <A NAME="pass-c1-control-characters-as-is"><EM>pass-c1-control-characters-as-is</EM></A>
5567
<DD> UNIX <EM>Pine</EM> only.
5568
If the feature <A HREF="#pass-control-characters-as-is">pass-control-characters-as-is</A>
5569
is set, then this feature has no effect.
5570
However, if you wish to filter out regular control characters but pass the
5571
so-called C1 control characters (0x80 <= char < 0xA0) through unchanged, then
5572
you may leave <A HREF="#pass-control-characters-as-is">pass-control-characters-as-is</A>
5573
unset and set this feature.
5574
This feature is not available in PC-Pine where control characters
5575
are never suppressed.
5578
<DT> <A NAME="pass-control-characters-as-is"><EM>pass-control-characters-as-is</EM></A>
5580
<DD> UNIX <EM>Pine</EM> only (this feature is automatically on with <EM>PC-Pine</EM>).
5581
If set, all characters in a message will be sent to the
5582
screen. Normally, control characters are automatically suppressed in
5583
order to avoid inadvertently changing terminal setup parameters.
5584
Control characters are usually displayed as two character sequences like
5585
<P><CENTER><SAMP> ^C </SAMP></CENTER><P>
5587
<P><CENTER><SAMP> ^[ </SAMP></CENTER><P>
5589
<P><CENTER><SAMP> ^? </SAMP></CENTER><P>
5591
<P><CENTER><SAMP> ~E </SAMP></CENTER><P>
5592
for the character with value 133 (0x85).
5593
(The DEL character is displayed as ^?, regular control characters are displayed
5594
as the character ^ followed by the character obtained by adding the
5595
five low-order bits of the character to 0x40, and the C1
5596
control characters 0x80 - 0x9F are displayed as the character ~ followed by the
5597
character obtained by adding the
5598
five low-order bits of the character to 0x40.)
5599
Sometimes, in cases where changing a single control character into a
5600
two-character sequence would confuse Pine's display routines,
5601
a question mark is substituted for the control character.
5603
If you wish to filter out regular control characters but pass the
5604
so-called C1 control characters (0x80 <= char < 0xA0) through unchanged, then
5605
you may leave this feature unset and set the feature <A HREF="#pass-c1-control-characters-as-is">pass-c1-control-characters-as-is</A> instead.
5606
This feature is not available in PC-Pine where control characters
5607
are never suppressed.
5610
<DT> <A NAME="predict-nntp-server"><EM>predict-nntp-server</EM></A>
5612
<DD> This feature allows Pine to assume that the open NNTP server at the
5613
time of composition is the NNTP server to which the message should be
5614
posted. This is especially recommended when there are multiple News
5615
collections. If this feature is not set, Pine will try to post to the first server in
5616
the <a href="#nntp-server">nntp-server</a> variable. Setting
5617
this feature also negates the need to add News collection servers to
5618
the nntp-server variable.
5620
This feature can be especially handy when used in conjunction with
5621
<a href="#enable-multiple-newsrcs">enable-multiple-newsrcs</a>.
5624
<DT> <A NAME="prefer-plain-text"><EM>prefer-plain-text</EM></A>
5626
<DD> A message being viewed may contain alternate versions of the same content.
5627
Those alternate versions are ordered by the sending software such that the
5628
first alternative is the least preferred and the last alternative is the
5629
most preferred. Pine will normally display the most-preferred version that
5630
it knows how to display. This is most often encountered where the two
5631
alternate versions are a plain text version and an HTML version, with the
5632
HTML version listed last as the most preferred.
5635
If this option is set, then any plain text version will be preferred to
5639
<DT> <A NAME="preopen-stayopen-folders"><EM>preopen-stayopen-folders</EM></A>
5641
<DD> This feature is related to the option
5642
<A HREF="#stay-open-folders">Stay-Open-Folders</A>.
5643
Normally, Stay Open folders are only opened on demand, when the user
5645
From then on they are kept open for the duration of the session.
5646
However, if this feature is set, then the Stay Open folders will all be
5647
opened at startup, at the same time that the INBOX is opened.
5650
<DT> <A NAME="preserve-start-stop-characters"><EM>preserve-start-stop-characters</EM></A>
5652
<DD> This feature controls how special control key characters, typically
5653
<EM>^S</EM> and <EM>^Q</EM>, are interpreted when input to <EM>Pine</EM>.
5655
are known as the "start" and "stop" characters and are sometimes used in
5656
communications paths to control data flow between devices that operate at
5660
By default, <EM>Pine</EM> turns the system's handling of these special characters
5661
off except during printing. However, if you see <EM>Pine</EM> reporting input errors
5665
[ Command "^Q" not defined for this screen. ] <BR>
5668
and, at the same time, see your display become garbled, then it is likely
5669
that setting this option will solve the problem. Be aware, though, that
5670
enabling this feature will also cause <EM>Pine</EM> to ostensibly "hang"
5671
whenever the <EM>Ctrl-S</EM> key combination is entered as the system is now
5672
interpreting such input as a "stop output" command. To "start
5673
output" again, simply type <EM>Ctrl-Q</EM>.
5676
<DT> <A NAME="print-formfeed-between-messages"><EM>print-formfeed-between-messages</EM></A>
5678
<DD> Setting this feature causes a formfeed to be printed between messages when
5679
printing multiple messages with the <EM>Apply Print</EM> command.
5682
<DT> <A NAME="print-includes-from-line"><EM>print-includes-from-line</EM></A>
5684
<DD> If this feature is set, then the Unix mail style From line is included
5685
at the start of each message that is printed. This line looks something
5686
like the following, with the address replaced by the address from the
5687
From line of the message being printed:
5690
From user@domain.somewhere.com Mon May 13 14:11:06 1996 <BR>
5694
<DT> <A NAME="print-index-enabled"><EM>print-index-enabled</EM></A>
5696
<DD> This feature controls the behavior of the <EM>Print</EM> command
5698
"Folder Index" screen.
5699
If set, the <EM>Print</EM> command will give you a prompt
5700
asking if you wish to print the message index, or the currently highlighted
5701
message. If not set, the message will be printed.
5704
<DT> <A NAME="print-offers-custom-cmd-prompt"><EM>print-offers-custom-cmd-prompt</EM></A>
5706
<DD> When this feature is set, the <EM>Print</EM> command
5707
will have an additional
5708
subcommand called <EM>C CustomPrint</EM>.
5709
If selected, you will have
5710
the opportunity to enter any system print command, instead of being
5711
restricted to using those that have been previously configured in the
5712
<EM>Setup/Printer</EM> screen.
5715
<DT> <A NAME="prune-uses-yyyy-mm"><EM>prune-uses-yyyy-mm</EM></A>
5717
<DD> By default, <EM>Pine</EM> asks monthly whether or not you would like to rename
5718
some folders to a new name containing the date.
5719
It also asks whether or not you would like to delete some old folders.
5720
See the <A HREF="#pruning-rule">pruning-rule</A> option for an
5724
By default, the name used when renaming a folder looks like
5726
<CENTER><SAMP><foldername>-<month>-<year></SAMP></CENTER>
5728
For example, the first time you run <EM>Pine</EM> in May of 2004,
5729
the folder "sent-mail" might be renamed to
5731
<CENTER><SAMP>sent-mail-apr-2004</SAMP></CENTER>
5733
If this feature is set, the name used will be of the form
5735
<CENTER><SAMP><foldername>-<yyyy>-<mm></SAMP></CENTER>
5737
where "yyyy" is the year and "mm" is the two-digit
5738
month (01, 02, ..., 12).
5739
For the April, 2004 example above, it would instead be
5741
<CENTER><SAMP>sent-mail-2004-04</SAMP></CENTER>
5743
because April is the 4th month of the year.
5744
A reason you might want to set this feature is so that the folders
5745
will sort in chronological order.
5748
<DT> <A NAME="quell-attachment-extra-prompt"><EM>quell-attachment-extra-prompt</EM></A>
5749
<DD> By default, when you attempt to view an attachment externally
5750
from the "Attachment View" screen, you are asked if you
5751
really want to view the selected attachment.
5754
If this feature is set, you will <B>not</B> be prompted to confirm
5755
your selection. Prior to <EM>Pine</EM> 4.50, the default behavior was to not
5756
prompt. This feature was added for those wanting to preserve that
5759
<DT> <A NAME="quell-berkeley-format-timezone"><EM>quell-berkeley-format-timezone</EM></A>
5761
<DD> POSIX mandates a timezone in UNIX mailbox format folder delimiters
5762
(the line which begins with From <SPACE>).
5763
Some versions of Berkeley mail have trouble with this, and don't recognize
5764
the line as a message delimiter.
5765
If this feature is set, the timezone will be left off the delimiter line.
5768
<DT> <A NAME="quell-charset-warning"><EM>quell-charset-warning</EM></A>
5770
<DD> By default, if your
5771
<A HREF="#char-set">Character-Set</A>
5772
is different from the character set
5773
of the message you are viewing, then <EM>Pine</EM> will
5774
add a warning to the start of the displayed text.
5775
If this option is set, then that editorial message will be suppressed.
5777
Setting this feature also suppresses the comment about the character set
5779
For example, when viewing a message you might see
5781
<CENTER><SAMP>From: "[ISO-8859-2] Name" <address></SAMP></CENTER>
5783
in the From header if your Character-Set is something other than ISO-8859-2.
5784
If you set this feature, the comment about the character set will
5788
<DT> <A NAME="quell-content-id"><EM>quell-content-id</EM></A>
5790
<DD> This feature changes the behavior of <EM>Pine</EM> when sending messages.
5791
It is intended to work around a bug in Microsoft's Outlook XP mail user
5793
As of this writing, Microsoft has acknowledged the bug but
5794
has not added it to the Knowledge Base.
5795
We have been told that there will be a post-SP1 hotfix for Outlook XP.
5796
This particular bug has bug fix number OfficeQFE:4781.
5797
The nature of the bug is that messages with attachments which
5798
contain a Content-ID header (which standard <EM>Pine</EM> attachments do)
5799
do not show the attachment indicator (a paperclip) when viewed with
5801
So the user has no indication that the message contains an attachment.
5804
If this feature is set then <EM>Pine</EM> will remove most Content-ID headers
5805
before sending a message.
5806
If an attachment is of type MESSAGE, then the existing Content-ID headers
5807
inside the message will be left intact.
5808
This would only happen with <EM>Pine</EM> if a message was forwarded as an attachment
5809
or if a message with a message attached was forwarded.
5810
Similarly if an attachment of type MULTIPART/ALTERNATIVE is forwarded,
5811
the Content-ID headers of the alternative parts will not be removed.
5814
Because the Content-ID header is a standard part of MIME it is possible
5815
that setting this feature will break something.
5816
For example, if an attachment has a Content-ID header which is necessary
5817
for the correct functioning of that attachment, it is possible that <EM>Pine</EM>
5818
may remove that header when the attachment is forwarded.
5819
However, it seems fairly safe at this time.
5822
<DT> <A NAME="quell-dead-letter-on-cancel"><EM>quell-dead-letter-on-cancel</EM></A>
5824
<DD> This feature affects <EM>Pine</EM>'s behavior when you cancel a message being
5825
composed. <EM>Pine</EM>'s usual behavior is to write the canceled message to
5826
a file named <CODE>dead.letter</CODE> in your home directory (under UNIX;
5827
<CODE>DEADLETR</CODE> under WINDOWS/DOS) overwriting any previous message.
5828
Under some conditions (some routine), this can introduce a noticeable delay.
5831
Setting this feature will cause <EM>Pine</EM> NOT to write canceled compositions
5832
into the file called <CODE>dead.letter</CODE>.
5834
This feature affects the newer option
5835
<A HREF="#dead-letter-files">Dead-Letter-Files</A>, which specifies the
5836
number of dead letter files to keep around.
5837
If this feature is set, then the Dead-Letter-Files option has no effect.
5840
<DT> <A NAME="quell-empty-directories"><EM>quell-empty-directories</EM></A>
5842
<DD> This feature causes <EM>Pine</EM> to remove from the display any directories
5843
that do not contain at least one file or directory. This can be useful
5844
to prevent overly cluttered folder lists when a collection is stored on
5845
a server that treats all names as both a folder and a directory.
5848
Note, enabling this feature can cause surprising behavior! For example,
5849
you can still use Add to create a directory, but unless you immediately
5850
enter that directory and create a folder, that newly created directory
5851
may not be displayed next time you enter the folder list.
5855
<DT> <A NAME="quell-extra-post-prompt"><EM>quell-extra-post-prompt</EM></A>
5857
<DD> This feature causes <EM>Pine</EM> to skip the extra question about
5858
posting a message which may go to thousands of readers when you
5859
are about to post to a newsgroup.
5863
<DT> <A NAME="quell-filtering-done-message"><EM>quell-filtering-done-message</EM></A>
5865
<DD> This feature causes <EM>Pine</EM> to suppress the "filtering done" message.
5869
<DT> <A NAME="quell-filtering-messages"><EM>quell-filtering-messages</EM></A>
5871
<DD> This feature causes <EM>Pine</EM> to suppress the messages about
5872
moving filtered messages and setting flags in messages, due to Filter Rules.
5876
<DT> <A NAME="quell-flowed-text"><EM>quell-flowed-text</EM></A>
5878
<DD> Beginning with version 4.60, <EM>Pine</EM> generates flowed text where possible.
5879
The method for generating flowed text is defined by
5880
<A HREF="http://www.ietf.org/rfc/rfc3676.txt">RFC 3676</A>,
5881
the benefit of doing so is
5882
to send message text that can properly be viewed both on normal width displays
5883
and on displays with smaller or larger than normal screen widths.
5884
With flowed text, a space at the end of a line tells the receiving mail
5885
client that the following line belongs to the same paragraph.
5886
Quoted text will also be affected, with only the innermost
5887
level of ">" quoting being followed by a space.
5888
However, if you have changed the
5889
<A HREF="#reply-ind-str">"Reply-Indent-String"</A>
5890
so that it is not equal to the default value of "> ", then
5891
quoted text will not be flowed.
5892
For this reason, we recommend that you leave your
5893
"Reply-Indent-String" set to the default.
5895
This feature turns off the generation of flowed text, as it might be
5896
desired to more tightly control how a message is displayed on the receiving end.
5898
If this feature is <EM>not</EM> set, you can control on a message by message
5899
basis whether or not flowed text is generated.
5900
You do this by typing ^V at the Send confirmation prompt that you get
5901
after typing ^X to send a message.
5902
^V is a toggle which turns flowing off and back on if typed again.
5903
If for some reason flowing cannot be done on a particular message, then the
5904
^V command will not be available.
5905
This would be the case, for example, if this feature was set, or if your
5906
"Reply-Indent-String" was set to a non-default value.
5908
<A HREF="#send-without-confirm">Send-Without-Confirm</A> is set,
5909
then the opportunity to control on a message by message basis
5910
whether or not flowed text is generated is lost.
5912
When this feature is not set and you have typed ^V to turn off flowing,
5913
the Send confirmation prompt will change to look like
5915
<CENTER><SAMP>Send message (not flowed)?</SAMP></CENTER>
5917
<A HREF="#strip-whitespace-before-send">Strip-Whitespace-Before-Send</A> will
5918
also turn off the sending of flowed text messages, but it differs in that
5919
it also trims all trailing white space from a message before sending it.
5921
If alternate editors are used extensively, be aware that a message will still
5922
be sent flowed if this feature is unset. In most cases this will be fine,
5923
but if the editor has a "flowed text" mode, it would be best to
5927
<DT> <A NAME="quell-folder-internal-msg"><EM>quell-folder-internal-msg</EM></A>
5929
<DD> This feature determines whether or not <EM>Pine</EM> will create
5930
"pseudo messages" in folders that are in standard Unix or
5934
<EM>Pine</EM> will normally create these
5935
pseudo messages when they are not already
5936
present in a standard Unix or MMDF folder.
5937
Their purpose is to record
5938
certain mailbox state data needed for correct IMAP and POP server operation,
5939
and also for <EM>Pine</EM> to be able to mark messages as Answered when
5940
the Reply has been postponed.
5943
Sites which do not use IMAP/POP for remote mail access, and which need to
5944
support mail tools that are adversely affected by the presence of the
5945
pseudo-messages (e.g. some mail notification tools) may enable this
5946
feature to tell <EM>Pine</EM> not to create them.
5947
Note that <EM>Pine</EM>'s "Answered" flag
5948
capability will be adversely affected if this is done.
5951
Note too that, even if this feature is enabled, <EM>Pine</EM> will not remove
5952
pseudo-messages when it encounters them (e.g. those created by UW's imapd
5954
This feature has no effect on folders that are not in
5955
standard Unix or MMDF format, as pseudo-messages are not needed in the
5956
other formats to record mailbox state information.
5959
<DT> <A NAME="quell-full-header-auto-reset"><EM>quell-full-header-auto-reset</EM></A>
5961
<DD> The HdrMode Command
5962
normally resets to the default state when switching to a new message.
5963
For example, if you've used the "H" command to turn on Full
5964
Headers for a message you are viewing, and then you type the Next command
5965
to look at the next message, the full headers will no longer be shown.
5966
Setting this feature disables that reset.
5967
Instead, the Header Mode remains the same from message to message.
5970
The presence or absence of the HdrMode command is determined by the
5971
<A HREF="#enable-full-header-cmd">"Enable-Full-Header-Cmd"</A>
5972
Feature-List option.
5975
<DT> <A NAME="quell-imap-envelope-update"><EM>quell-imap-envelope-update</EM></A>
5977
<DD> In the MESSAGE INDEX screen, if the open folder is being accessed
5978
using IMAP, <EM>Pine</EM> normally tries to paint the index lines on the screen
5979
as soon as the information arrives from the IMAP server.
5980
This means that the index information makes it onto the screen more quickly
5981
than it otherwise would.
5982
This sometimes results in behavior that bothers some users.
5983
For example, when paging to a new page of the index, it may be possible for
5984
the lines to be painted on the screen in a random order, rather than from
5988
Setting this feature causes <EM>Pine</EM> to wait for all of the information
5989
to be gathered before it paints the index screen.
5990
Once it collects all of the information, the screen will be painted quickly
5994
<DT> <A NAME="quell-lock-failure-warnings"><EM>quell-lock-failure-warnings</EM></A>
5996
<DD> This feature affects <EM>Pine</EM>'s behavior when it encounters a problem
5997
acquiring a mail folder lock. Typically, a secondary file associated
5998
with the mail folder being opened is created as part of the locking
5999
process. On some systems, such file creation has been administratively
6000
precluded by the system configuration.
6003
<EM>Pine</EM> issues a warning when such failures occur, which can become bothersome
6004
if the system is configured to disallow such actions. Setting this
6005
feature causes <EM>Pine</EM> to remain silent when this part of lock creation fails.
6008
WARNING: systems that have been configured in a way that precludes locking
6009
introduce some risk of mail folder corruption when more than one program
6010
attempts to modify the mail folder. This is most likely to occur to one's
6011
<EM>INBOX</EM> or other "Incoming Message Folder".
6014
<DT> <A NAME="quell-mailchecks-composing-except"><EM>Quell-Mailchecks-Composing-Except-Inbox</EM></A>
6016
<DD> This option is closely related to the
6017
<A HREF="#mail-check"><EM>Mail-Check-Interval</EM></A>
6019
<A HREF="#mail-check-noncurr"><EM>Mail-Check-Interval-Noncurrent</EM></A> option, and
6020
<A HREF="#quell-mailchecks-composing-inbox"><EM>Quell-Mailchecks-Composing-Inbox</EM></A>.
6022
If this option is set, then the normal new-mail checking which happens
6023
while you are composing will not happen for folders other than your
6024
INBOX (which depends on the setting
6025
of "Quell-Mailchecks-Composing-Inbox").
6027
You might want to set this option if you are experiencing delays while
6028
composing which you think might be related to the speed of the new-mail
6031
Even with this option turned on, an occasional new-mail check may be done
6032
in order to keep the server from killing the connection to the folder.
6033
For example, IMAP servers may remove a connection to a folder if there
6034
has been no activity on the connection for 30 minutes or more.
6035
Instead of letting that happen, <EM>Pine</EM> will check for new mail before the
6036
30 minutes is up even though you have turned on this feature to quell
6039
Besides new-mail checks, checkpoint operations on the folders
6040
will also be quelled when you set this option.
6041
The purpose of checkpointing is to write the changes to a folder out to
6042
disk periodically in order to avoid losing those changes when system or
6043
software problems occur.
6044
New-mail checking and checkpointing while you are not composing are not
6045
affected by this option.
6048
<DT> <A NAME="quell-mailchecks-composing-inbox"><EM>Quell-Mailchecks-Composing-Inbox</EM></A>
6050
<DD> This option is closely related to the
6051
<A HREF="#mail-check"><EM>Mail-Check-Interval</EM></A>
6053
<A HREF="#mail-check-noncurr"><EM>Mail-Check-Interval-Noncurrent</EM></A> option, and
6054
<A HREF="#quell-mailchecks-composing-except"><EM>Quell-Mailchecks-Composing-Except-Inbox</EM></A>.
6056
If this option is set, then the normal new-mail checking which happens
6057
while you are composing will not happen for your INBOX.
6058
Checking of other folders is controlled in a similar way with the
6059
"Quell-Mailchecks-Composing-Except-Inbox" option.
6061
You might want to set this option if you are experiencing delays while
6062
composing which you think might be related to the speed of the new-mail
6065
Even with this option turned on, an occasional new-mail check may be done
6066
in order to keep the server from killing the connection to the folder.
6067
For example, IMAP servers may remove a connection to a folder if there
6068
has been no activity on the connection for 30 minutes or more.
6069
Instead of letting that happen, <EM>Pine</EM> will check for new mail before the
6070
30 minutes is up even though you have turned on this feature to quell
6073
Besides new-mail checks, checkpoint operations on the INBOX
6074
will also be quelled when you set this option.
6075
The purpose of checkpointing is to write the changes to a folder out to
6076
disk periodically in order to avoid losing those changes when system or
6077
software problems occur.
6078
New-mail checking and checkpointing while you are not composing are not
6079
affected by this option.
6082
<DT> <A NAME="quell-maildomain-warning"><EM>quell-maildomain-warning</EM></A>
6084
<DD> When your configuration is set up so that your domain name contains no dots,
6085
it is usually a configuration error.
6086
By default, <EM>Pine</EM> will warn you about this when you start it up.
6087
You will see a warning message that looks like
6089
<CENTER><SAMP>Incomplete maildomain "<domain>".</SAMP></CENTER>
6092
If this feature is set, the warning is turned off.
6095
<DT> <A NAME="quell-news-envelope-update"><EM>quell-news-envelope-update</EM></A>
6097
<DD> In the MESSAGE INDEX screen, if the open folder is being accessed
6098
using NNTP (News), <EM>Pine</EM> normally tries to paint the index lines on the screen
6099
as soon as the information arrives from the NNTP server.
6100
This means that the index information makes it onto the screen more quickly
6101
than it otherwise would.
6102
This sometimes results in behavior that bothers some users.
6103
For example, when paging to a new page of the index, it may be possible for
6104
the lines to be painted on the screen in a random order, rather than from
6108
Setting this feature causes <EM>Pine</EM> to wait for all of the information
6109
to be gathered before it paints the index screen.
6110
Once it collects all of the information, the screen will be painted quickly
6114
<DT> <A NAME="quell-partial-fetching"><EM>quell-partial-fetching</EM></A>
6116
<DD> Partial fetching is a feature of the IMAP protocol.
6117
By default, <EM>Pine</EM>
6118
will use partial fetching when copying the contents of a message or attachment
6119
from the IMAP server to <EM>Pine</EM>.
6120
This means that the fetch will be done in many
6121
small chunks instead of one big chunk. The main benefit of this approach is
6122
that the fetch becomes interruptible. That is, the user can type <EM>^C</EM>
6123
to stop the fetch early. In some cases partial fetching may cause a performance
6124
problem so that the fetching of data takes significantly longer when partial
6125
fetching is used. Turning on this feature will turn off partial fetching.
6128
<DT> <A NAME="quell-personal-name-prompt"><EM>quell-personal-name-prompt</EM></A>
6130
<DD> <EM>PC-Pine</EM only. This feature quells the prompting for a
6131
<A HREF="#personal-name">personal-name</A>. This prompt normally happens
6132
before composing a message, and only happens when there is no personal name
6136
<DT> <A NAME="quell-user-id-prompt"><EM>quell-user-id-prompt</EM></A>
6138
<DD> <EM>PC-Pine</EM only. This feature quells the prompting for a
6139
<A HREF="#user-id">user-id</A>
6140
if the information can be obtained from the login name used
6141
to open the INBOX. Normally, this prompt happens before composing
6142
a message, and only happens when there is no user-id already set
6143
in the configuration.
6145
With this feature set, composing a message is only possible after
6146
establishing a connection to the INBOX.
6149
<DT> <A NAME="quell-ssl-largeblocks"><EM>quell-ssl-largeblocks</EM></A>
6151
<DD> This feature (<EM>PC-Pine</EM> only) changes the behavior of fetching messages
6152
and attachments so that the message data is fetched in chunks no larger
6154
This works around a bug in Microsoft's SSL/TLS support.
6155
Some versions of Microsoft SSL are not able to read full-sized (16K)
6157
Some servers will send such packets and this will
6158
cause <EM>PC-Pine</EM> to crash with the error
6161
<CENTER><SAMP>incomplete SecBuffer exceeds maximum buffer size</SAMP></CENTER>
6164
Microsoft is aware of the problem and has developed a hotfix for it, but as of
6165
this writing the hotfix has not yet been added to the Knowledge Base.
6168
<DT> <A NAME="quell-status-message-beeping"><EM>quell-status-message-beeping</EM></A>
6170
<DD> If set status messages will never emit a beep.
6173
<DT> <A NAME="quell-timezone-comment-when-sending"><EM>quell-timezone-comment-when-sending</EM></A>
6175
<DD> Normally, when <EM>Pine</EM> generates a Date header for outgoing mail,
6176
it will try to include the symbolic timezone at the end of the
6177
header inside parentheses.
6178
The symbolic timezone is often three characters long, but on
6179
some operating systems, it may be longer.
6180
Apparently there are some SMTP servers in the world which will reject an
6181
incoming message if it has a Date header longer than about 80 characters.
6182
If this feature is set, the symbolic timezone normally generated by
6183
<EM>Pine</EM> will not be included.
6184
You probably don't need to worry about this feature unless you run into
6185
the problem described above.
6188
<DT> <A NAME="quell-user-lookup-in-passwd-file"><EM>quell-user-lookup-in-passwd-file</EM></A>
6190
<DD> This feature controls an aspect of
6191
<EM>Pine</EM>'s Composer, and if needed, will usually be set by the
6192
system manager in <EM>Pine</EM>'s system-wide configuration file.
6193
Specifically, if this feature is set, <EM>Pine</EM> will not attempt to look
6194
in the system password file to find a Full Name for the entered address.
6197
Normally, names you enter into address fields (e.g. To: or Cc:) are
6198
checked against your address book(s) to see if they match an address book
6200
Failing that, (in Unix <EM>Pine</EM>) the name is then checked against
6201
the Unix password file. If the entered name matches a username in the
6202
system password file, <EM>Pine</EM> extracts the corresponding Full Name information
6203
for that individual, and adds that to the address being entered.
6206
However, password file matching can have surprising (incorrect) results if
6207
other users of the system do not receive mail at the domain you are using.
6208
That is, if either the <A HREF="#user-domain"><EM>user-domain</EM></A>
6209
or <A HREF="#use-only"><EM>use-only-domain-name</EM></A> option
6210
is set such that the administrative domain of other users on the system
6211
isn't accurately reflected, <EM>Pine</EM> should be told that a password
6212
file match is coincidental,
6213
and Full Name info will be incorrect.
6215
personal name from the password file could get falsely paired with the
6216
entered name as it is turned into an address in the configured domain.
6219
If you are seeing this behavior, enabling this feature will prevent Unix
6220
<EM>Pine</EM> from looking up names in the password file to find the Full Name
6221
for incomplete addresses you enter.
6224
<DT> <A NAME="quit-without-confirm"><EM>quit-without-confirm</EM></A>
6226
<DD> This feature controls whether or not <EM>Pine</EM> will ask for confirmation when a
6227
<EM>Quit</EM> command is received.
6230
<DT> <A NAME="quote-replace-nonflowed"><EM>quote-replace-nonflowed</EM></A>
6232
<DD> This feature, which is only active when
6233
<A HREF="#quote-replace-string">Quote-Replace-String</A> is
6235
enables quote-replacement on non-flowed messages. It is off
6236
by default because a non-flowed message is more dependent on its format,
6237
and thus quote-replacement may cause less-than-pleasing results.
6238
Setting this feature will cause quote-replacement similar to that of flowed
6239
messages, but with the added possibility of long lines being wrapped
6240
into new lines if the Quote-Replacement-String is longer than the string
6241
it is replacing, which is "> ".
6245
<DT> <A NAME="reply-always-uses-reply-to"><EM>reply-always-uses-reply-to</EM></A>
6247
<DD> If set, <EM>Pine</EM>
6248
will not prompt when a message being replied to contains a <EM>Reply-To:</EM>
6249
header value, but will simply use its value (as opposed to using the
6250
<EM>From:</EM> field's value).
6253
<DT> <A NAME="quell-berkeley-format-timezone"><EM>quell-berkeley-format-timezone</EM></A>
6256
Versions of <EM>Pine</EM> prior to 4.20 would write Berkeley format
6257
message delimiters with a trailing timezone offset. On rare occurances
6258
this can cause an incompatibility with other mail access utilities.
6259
Enabling this hidden feature will cause <EM>Pine</EM> to refrain from writing
6260
this timezone to the "From " delimiter.
6264
<DT> <A NAME="return-to-inbox-without-confirm"><EM>return-to-inbox-without-confirm</EM></A>
6267
Normally, when you use the TAB
6268
command and there are no more folders or newsgroups to visit, you are asked
6269
if you want to return to the INBOX.
6270
If this feature is set you will not be asked.
6271
It will be assumed that you do want to return to the INBOX.
6275
<DT> <A NAME="save-aggregates-copy-sequence"><EM>save-aggregates-copy-sequence</EM></A>
6277
<DD> This feature will optimize an aggregate copy operation, if
6278
possible, by issuing a single IMAP <EM>COPY</EM> command with a
6279
list of the messages to be copied.
6280
This may save network traffic when the source and destination
6281
folders are on the same IMAP server.
6282
<EM>However, many IMAP servers (including the UW IMAP server) do
6283
not preserve the order of messages when this optimization is applied.</EM>
6284
If this feature is not enabled, or if
6285
the folders are on different IMAP servers, or the folders are local and in
6286
different formats, <EM>Pine</EM> will copy each message individually.
6289
<DT> <A NAME="save-partial-wo-confirm"><EM>save-partial-msg-without-confirm</EM></A>
6291
<DD> This feature controls an aspect of <EM>Pine</EM>'s Save command.
6292
By default, when you Save a message that has some deleted parts, you will
6293
be asked to confirm that you want to Save with a prompt that looks like:
6295
<CENTER><SAMP>Saved copy will NOT include entire message! Continue?</SAMP></CENTER>
6297
If this feature is set, you will not be asked.
6300
<DT> <A NAME="save-will-advance"><EM>save-will-advance</EM></A>
6302
<DD> If set, <EM>Save</EM> will
6303
(in addition to copying the current message to the designated folder) also
6304
advance to the next message.
6307
<DT> <A NAME="save-will-not-delete"><EM>save-will-not-delete</EM></A>
6309
<DD> If set, <EM>Save</EM> will
6310
not mark the message Deleted (its default behavior) after it has been
6311
copied to the designated folder.
6314
<DT> <A NAME="save-will-quote"><EM>save-will-quote-leading-froms</EM></A>
6316
<DD> This feature controls an aspect of the <EM>Save</EM> command
6318
outgoing messages are saved to an FCC folder). If set, <EM>Pine</EM> will add
6319
a leading <CODE>></CODE> character in front of message
6320
lines beginning with "From" when they are
6321
saved to another folder, including lines syntactically
6322
distinguishable from the type of message separator line commonly used on
6326
The default behavior is that a <CODE>></CODE> will be prepended only to lines
6327
beginning with "From " that might otherwise be confused with a message
6328
separator line on Unix systems. If <EM>Pine</EM> is the only mail program you use,
6329
this default is reasonable. If another program you use has trouble
6330
displaying a message with an unquoted From saved by <EM>Pine</EM>, you should
6331
enable this feature. This feature only applies to the common Unix mailbox
6332
format that uses message separator lines beginning with "From ". If
6333
<EM>Pine</EM> has been configured to use a different mailbox format (possibly
6334
incompatible with other mail programs), then this issue does not arise,
6335
and the feature is irrelevant.
6338
<DT> <A NAME="scramble-message-id"><EM>scramble-message-id</EM></A>
6340
<DD> Normally the Message-ID header that <EM>Pine</EM> generates when sending a message
6341
contains the name of the computer from which the message is being sent.
6342
Some believe that this hostname could be used by spammers or could
6343
be used by others for nefarious purposes.
6344
If this feature is set, that name will be transformed with a simple
6345
Rot13 transformation.
6346
The result will still have the correct syntax for a Message-ID but the
6347
part of the MessageID that is often a domain name will not be an actual
6348
domain name because the letters will be scrambled.
6350
It is possible (but unlikely?) that some spam detection
6351
software will use that as a reason to reject the mail as spam.
6352
It has also been reported that some spam detection software uses the
6353
fact that there are no dots after the "@" as a reason to reject
6355
If your <EM>PC-Pine</EM> Message-ID is using a name without a dot that is because
6356
that is what Windows thinks is your "Full computer name".
6357
The method used to set this varies from one type of Windows to another but
6358
check under Settings -> Control Panel -> System and
6359
look for Network Identification or Computer Name or something similar.
6360
How to set it is beyond the scope of <EM>Pine</EM>.
6363
<DT> <A NAME="select-without-confirm"><EM>select-without-confirm</EM></A>
6365
<DD> This feature controls an aspect of
6366
<EM>Pine</EM>'s <EM>Save</EM>, <EM>Export</EM>, and <EM>Goto</EM> commands.
6367
These commands all take text input to specify the name of the folder or
6368
file to be used, but allow you to press <EM>^T</EM> for a
6369
list of possible names.
6370
If set, the selected name will be used immediately, without further
6371
opportunity to confirm or edit the name.
6374
<DT> <A NAME="send-without-confirm"><EM>send-without-confirm</EM></A>
6376
<DD> By default, when you send or post a message you will be asked to confirm
6377
with a question that looks something like:
6380
<CENTER><SAMP>Send message?</SAMP></CENTER>
6383
If this feature is set, you
6384
will <B>not</B> be prompted to confirm your intent to send
6385
and your message will be sent.
6387
If this feature is set it disables some possibilities and renders some
6388
other features meaningless.
6389
You will not be able to use
6390
<A HREF="#sending-filters">Sending Filters</A>,
6391
Verbose sending mode,
6392
<A HREF="#enable-background-sending">Background Sending</A>,
6393
<A HREF="#enable-delivery-status-notification">Delivery Status Notifications</A>,
6394
or ^V to turn off the generation of flowed text for this message.
6395
These options are normally available as suboptions in the Send prompt, but
6396
with no Send prompt the options are gone.
6399
A somewhat related feature is
6400
<A HREF="#quell-extra-post-prompt">quell-extra-post-prompt</A>.
6401
which may be used to eliminate the extra confirmation
6402
question when posting to a newsgroup.
6405
<DT> <A NAME="separate-folder-and-directory-display"><EM>separate-folder-and-directory-display</EM></A>
6407
<DD> This feature affects folder collections wherein a folder
6408
and directory can have the same name. By default, <EM>Pine</EM> displays them
6409
only once, denoting that it is both a folder and directory by appending
6410
the folder name with the hierarchy character enclosed
6414
Enabling this feature will cause <EM>Pine</EM> to display such names
6415
separately marking the name representing a directory with a trailing
6416
hierarchy delimiter (typically the slash, "/", character).
6419
The feature also alters the command set slightly. By default, the
6420
right-arrow descends into the directory, while hitting the Return key will
6421
cause the folder by that name to be opened.
6424
With this feature set, the Return key will open the highlighted folder, or
6425
enter the highlighted directory.
6428
<DT> <A NAME="show-cursor"><EM>show-cursor</EM></A>
6430
<DD> If set, the system
6431
cursor will move to convenient locations in the displays. For example,
6432
to the beginning of the status field of the highlighted index line, or
6433
to the highlighted word after a successful <EM>WhereIs</EM> command.
6434
It is intended to draw your attention to the <EM>interesting</EM>
6438
<DT> <A NAME="show-plain-text-internally"><EM>show-plain-text-internally</EM></A>
6440
<DD> This feature modifies the method Pine uses to display Text/Plain
6441
MIME attachments from the Attachment Index screen. Normally, the
6442
"View" command searches for any externally defined (usually
6443
via the Mailcap file) viewer,
6444
and displays the selected text within that viewer.
6447
Enabling this feature causes Pine to ignore any external viewer
6448
settings and always display text with Pine's internal viewer.
6452
<DT> <A NAME="show-selected-in-boldface"><EM>show-selected-in-boldface</EM></A>
6454
<DD> This feature controls an aspect of <EM>Pine</EM>'s aggregate operation commands;
6455
in particular, the <EM>Select</EM> and <EM>WhereIs</EM> commands.
6456
<EM>Select</EM> and <EM>WhereIs</EM> (with
6457
the <EM>^X</EM> subcommand) will search the current folder
6458
for messages meeting a
6459
specified criteria, and <EM>tag</EM> the resulting
6460
messages with an <EM>X</EM> in the
6461
first column of the applicable lines in the "Folder Index". If this feature
6462
is set, instead of using the <EM>X</EM> to denote a selected message,
6463
<EM>Pine</EM> will attempt to display those index lines in boldface.
6464
Whether this is preferable to the <EM>X</EM> will depend on personal
6465
taste and the type of terminal being used.
6468
<DT> <A NAME="show-sort"><EM>show-sort</EM></A>
6470
<DD> If this feature is set and there is sufficient space on the screen,
6471
a short indication of the current sort order will be
6472
added in the titlebar (the top line on the screen), before the name
6474
For example, with the default Arrival sort in effect,
6475
the display would have the characters
6477
<P><CENTER>[A]</CENTER><P>
6479
added between the title of the screen and the folder name.
6480
The letters are the same as the letters you may type to manually
6481
sort a folder with the SortIndex command ($).
6482
The letters in the table below are the ones that may show
6483
up in the titlebar line.
6486
<TR> <TD> A </TD> <TD> <EM>A</EM>rrival </TD> </TR>
6487
<TR> <TD> S </TD> <TD> <EM>S</EM>ubject </TD> </TR>
6488
<TR> <TD> F </TD> <TD> <EM>F</EM>rom </TD> </TR>
6489
<TR> <TD> T </TD> <TD> <EM>T</EM>o </TD> </TR>
6490
<TR> <TD> C </TD> <TD> <EM>C</EM>c </TD> </TR>
6491
<TR> <TD> D </TD> <TD> <EM>D</EM>ate </TD> </TR>
6492
<TR> <TD> Z </TD> <TD> si<EM>Z</EM>e </TD> </TR>
6493
<TR> <TD> O </TD> <TD> <EM>O</EM>rderedsubject </TD> </TR>
6494
<TR> <TD> E </TD> <TD> scor<EM>E</EM> </TD> </TR>
6495
<TR> <TD> H </TD> <TD> t<EM>H</EM>read </TD> </TR>
6498
If the sort order is Reversed, the letter above will be preceded by the letter
6499
"R", for example
6501
<P><CENTER>[RS]</CENTER><P>
6503
means that a Reverse Subject sort is in effect.
6504
For the case where the sort is in Reverse Arrival order, the "A" is
6505
left out, and just an "R" is shown.
6507
<P><CENTER>[R]</CENTER>
6510
<DT> <A NAME="sig-at-bot"><EM>signature-at-bottom</EM></A>
6512
<DD> If this feature
6513
is set, and a message being <EM>Repl</EM>ied to is being included in
6515
contents of the signature file (if any) will be inserted after the included
6517
This feature does not affect the results of a <EM>Forward</EM> command.
6520
<DT> <A NAME="single-column-folder-list"><EM>single-column-folder-list</EM></A>
6522
<DD> If set, the "Folder List" screen will list one folder per line
6523
instead of several per line.
6526
<DT> <A NAME="slash-collapses-entire-thread"><EM>slash-collapses-entire-thread</EM></A>
6528
<DD> Normally, the Collapse/Expand Thread command Collapses or Expands the subthread which
6529
starts at the currently highlighted message, if any.
6530
If this feature is set, then the slash command Collapses or Expands the
6531
<EM>entire</EM> current thread instead of just the subthread.
6534
<DT> <A NAME="sort-default-fcc-alpha"><EM>sort-default-fcc-alpha</EM></A>
6536
<DD> This feature controls an aspect of <EM>Pine</EM>'s FOLDER LIST screen.
6537
If set, the default FCC folder will be sorted alphabetically with the other
6538
folders instead of appearing right after the INBOX.
6541
<DT> <A NAME="sort-default-save-alpha"><EM>sort-default-save-alpha</EM></A>
6543
<DD> This feature controls an aspect of <EM>Pine</EM>'s FOLDER LIST screen.
6544
If set, the default save folder will be sorted alphabetically with the other
6545
folders instead of appearing right after the INBOX (and default FCC folder).
6548
<DT> <A NAME="spell-check-before-sending"><EM>spell-check-before-sending</EM></A>
6550
<DD> When this feature is set, every composed message will be spell-checked before
6555
<DT> <A NAME="store-window-position-in-config"><EM>store-window-position-in-config</EM></A>
6557
<DD> Normally, <EM>PC-Pine</EM> will store its window size and position in the
6559
This is convenient if you want to use the same remote
6560
configuration from more than one PC.
6561
If you use multiple configuration files to start <EM>PC-Pine</EM>, you may want
6562
to store the window size and position in the configuration file instead
6564
Setting this feature causes that to happen.
6568
<DT> <A NAME="strip-from-sigdashes-on-reply"><EM>strip-from-sigdashes-on-reply</EM></A>
6570
<DD> This feature doesn't do anything if the feature
6571
<A HREF="#enable-sigdashes"><EM>enable-sigdashes</EM></A> is turned on.
6572
However, if the <EM>enable-sigdashes</EM> feature is not turned on,
6573
then turning on this feature enables support for the convention
6574
of not including text beyond the sigdashes line when Replying or Following
6575
up to a message and including the text of that message.
6577
In other words, this is a way to turn on the signature stripping behavior
6578
without also turning on the dashes-adding behavior.
6581
<DT> <A NAME="strip-whitespace-before-send"><EM>strip-whitespace-before=send</EM></A>
6583
<DD> Starting with Pine 4.60, trailing whitespace is no longer stripped from
6584
a message before sending. Trailing whitespace should have no effect on an
6585
email message, and in flowed text can aid in delimiting paragraphs.
6586
However, the old behavior of stripping trailing whitespace was in place
6587
to better deal with older clients that couldn't handle certain types of
6588
text encodings. This feature restores the old behavior
6590
Trailing whitespace is of aid to flowed-text-formatted messages, which are
6591
generated by default but can be turned off via the
6592
<A HREF="#quell-flowed-text">quell-flowed-text</A> feature.
6593
strip-whitespace-before-send also has the effect of turning off sending
6597
<DT> <A NAME="tab-checks-recent"><EM>tab-checks-recent</EM></A>
6599
<DD> In a FOLDER LIST screen, the TAB key usually just changes which
6600
folder is highlighted.
6601
If this feature is set, then the TAB key will cause the number of
6602
recent messages and the total number of messages in the highlighted folder
6603
to be displayed instead.
6606
<DT> <A NAME="tab-uses-unseen-for-next-folder"><EM>tab-uses-unseen-for-next-folder</EM></A>
6608
<DD> This feature affects <EM>Pine</EM>'s behavior when using the TAB
6610
to move from one folder to the next.
6611
<EM>Pine</EM>'s usual behavior is to search for folders
6612
with <EM>Recent</EM> messages in them.
6613
Recent messages are messages which have arrived since the last time the
6617
Setting this feature causes <EM>Pine</EM> to search for <EM>Unseen</EM>
6618
messages instead of Recent messages.
6619
Unseen messages remain Unseen until you view them (or flag then as Seen with
6621
Setting this feature allows you to locate messages you have not read
6622
instead of only recently received messages.
6623
When this feature is set, the feature
6624
<A HREF="#enable-fast-recent-test">Enable-Fast-Recent-Test</A>
6625
will have no effect, so the checking may be slower.
6628
Another reason why you might want to use this feature is that <EM>Pine</EM> sometimes
6629
opens folders implicitly behind the scenes, and this clears the
6630
Recent status of all messages in the folder.
6631
One example where this happens is when Saving or filtering a
6632
message to another folder.
6633
If that message has some <A HREF="#keywords">keywords</A>
6634
set, then because of some shortcomings
6635
in the IMAP specification, the best way to ensure that those keywords are
6636
still set in the saved copy of the message is to open the folder and
6637
set the keywords explicitly.
6638
Because this clears the Recent status of all messages in that folder the
6639
folder will not be found by the NextNew command unless this feature is set.
6642
<DT> <A NAME="tab-visits-next-new-message-only"><EM>tab-visits-next-new-message-only</EM></A>
6644
<DD> This feature affects <EM>Pine</EM>'s behavior when using the <EM>TAB</EM>
6645
key to move from one message to the next.
6646
<EM>Pine</EM>'s usual behavior is to select the next
6647
<EM>Unread</EM> message or message flagged as <EM>Important</EM>.
6650
Setting this feature causes <EM>Pine</EM> to skip the
6651
messages flagged as <EM>Important</EM>,
6652
and select <EM>Unread</EM> messages exclusively.
6653
Tab behavior when there are no
6654
new messages left to select remains unchanged.
6657
<DT> <A NAME="termdef-takes-precedence"><EM>termdef-takes-precedence</EM></A>
6659
<DD> In some versions of <EM>Pine</EM> before 4.00 there was a compile-time macro
6660
called <EM>TERMCAP_WINS</EM> which could be set to cause the <EM>termcap</EM>
6661
or <EM>terminfo</EM> definitions to be used instead of the built in definitions.
6662
Beginning with 4.00 this hidden runtime feature can be turned
6663
on to accomplish the same thing.
6666
<DT> <A NAME="thread-index-shows-important-color"><EM>thread-index-shows-important-color</EM></A>
6668
<DD> This option affects only the THREAD INDEX screen.
6669
Whether or not you ever see a THREAD INDEX screen depends on the setting
6670
of the configuration option
6671
<A HREF="#threading-index-style"><EM>threading-index-style</EM></A>
6672
and on the sort order of the index.
6673
If a message within a thread is flagged as Important
6674
and this option is set, then
6675
the entire line in the THREAD INDEX will be colored the color of the
6676
Index-important Symbol, which can be set using the
6680
<DT> <A NAME="try-alternative-authentication-driver-first"><EM>try-alternative-authentication-driver-first</EM></A>
6682
<DD> This feature affects how <EM>Pine</EM> connects to IMAP servers.
6683
It's utility has largely been overtaken by events,
6684
but it may still be useful in some circumstances.
6685
If you only connect to modern IMAP servers that support
6686
"TLS" you can ignore this feature.
6692
By default, <EM>Pine</EM> will attempt to connect to an IMAP server on the
6693
normal IMAP service port (143), and if the server offers "Transport Layer
6694
Security" (TLS) and <EM>Pine</EM> has been compiled with encryption capability,
6695
then a secure (encrypted) session will be negotiated.
6698
With this feature enabled, before connecting on the normal IMAP port, <EM>Pine</EM>
6699
will first attempt to connect to an alternate IMAP service port (993) used
6700
specifically for encrypted IMAP sessions via the Secure Sockets Layer
6702
If the SSL attempt fails, <EM>Pine</EM> will then try the default
6703
behavior described in the previous paragraph.
6706
TLS negotiation on the normal port is preferred, and supersedes the use of
6707
SSL on port 993, but older servers may not provide TLS support.
6708
This feature may be convenient when accessing IMAP servers that do not support
6709
TLS, but do support SSL connections on port 993.
6710
However, it is important to understand that with this feature enabled,
6711
<EM>Pine</EM> will <EM>attempt</EM> to make a secure connection if that is possible,
6712
but it will proceed to make an insecure connection if that is the only
6713
option offered by the server, or if the <EM>Pine</EM> in question has been built
6714
without encryption capability.
6717
Note that this feature specifies a per-user (or system-wide) default
6718
behavior, but host/folder specification flags may be used to control the
6719
behavior of any specific connection.
6720
This feature interacts with some of
6721
the possible host/folder path specification flags as follows:
6724
The <SAMP>/tls</SAMP> host flag, for example,
6727
<CENTER><SAMP>{foo.example.com/tls}INBOX</SAMP></CENTER>
6729
will over-ride this feature for the specified host by bypassing the
6730
SSL connection attempt.
6731
Moreover, with <SAMP>/tls</SAMP> specified,
6732
the connection attempt will fail if the
6733
service on port 143 does not offer TLS support.
6736
The <SAMP>/ssl</SAMP> host flag, for example,
6739
<CENTER><SAMP>{foo.example.com/ssl}INBOX</SAMP></CENTER>
6741
will insist on an SSL connection for the specified host,
6742
and will fail if the SSL service on port 993 is not available.
6743
<EM>Pine</EM> will not subsequently retry a connection
6744
on port 143 if <SAMP>/ssl</SAMP> is specified.
6747
<DT> <A NAME="unselect-will-not-advance"><EM>unselect-will-not-advance</EM></A>
6749
<DD> Normally, when the Unselect current message command (:) is typed when the
6750
current message is selected, the message will be unselected and the next
6751
message will become the current message.
6752
If this feature is set, the cursor will not advance to the next message.
6753
Instead, the current message will remain the current message after
6757
<DT> <A NAME="use-current-dir"><EM>use-current-dir</EM></A>
6759
<DD> This feature controls an aspect of several commands. If set, your
6760
"current working directory" will be used instead of your home directory
6761
for all of the following operations:
6764
<LI> <EM>Export</EM> in the "Folder Index" and "Message Text" screens
6765
<LI> Attachment <EM>Save</EM> in the "Message Text" and "Attachment Text" screens
6766
<LI> <EM>^R</EM> file inclusion in the Composer
6767
<LI> <EM>^J</EM> file attachment in the Composer
6771
<DT> <A NAME="use-function-keys"><EM>use-function-keys</EM></A>
6773
<DD> This feature specifies that <EM>Pine</EM> will
6774
respond to function keys instead of
6775
the normal single-letter commands. In this mode, the key menus at the
6776
bottom of each screen will show function key designations instead of the
6777
normal mnemonic key.
6780
<DT> <A NAME="use-reg-start-rule"><EM>use-regular-startup-rule-for-stayopen-folders</EM></A>
6782
<DD> This feature affects which message is selected as the current message
6784
<A HREF="#stay-open-folders">Stay Open</A> folder.
6786
Normally, the starting position for an incoming folder (which most Stay Open
6787
folders will likely be) is controlled by the
6788
<A HREF="#incoming-startup-rule"><EM>Incoming-Startup-Rule</EM></A>.
6789
However, if a folder is a Stay Open folder, when you re-enter the folder
6790
after the first time the current message will be the same as it was when
6791
you left the folder.
6792
An exception is made if you use the TAB command to get to the folder.
6793
In that case, the message number will be incremented by one from what it
6794
was when you left the folder.
6796
The above special behavior is thought to be useful.
6797
However, it is special and different from what you might at first expect.
6798
If this feature is set, then Stay Open folders will not be treated specially
6799
as far as the startup rule is concerned.
6802
<DT> <A NAME="use-sender-not-x-sender"><EM>use-sender-not-x-sender</EM></A>
6804
<DD> Normally <EM>Pine</EM> on Unix adds a header line labeled <EM>X-X-Sender</EM>,
6805
if the sender is different from the <EM>From:</EM> line.
6808
The standard specifies that this header
6809
line should be labeled <EM>Sender</EM>, not <EM>X-X-Sender</EM>.
6810
Setting this feature causes
6811
<EM>Sender</EM> to be used instead of <EM>X-X-Sender</EM>. The standard also states
6812
that the data associated with this header field should not be used as a Reply address.
6813
Unfortunately, certain implementations of mail list management servers will use the
6814
Sender address for such purposes. These implementations often even recognize the
6815
<EM>X-Sender</EM> fields as being equivalent to the <EM>Sender</EM> field, and use it
6816
if present. This is why Pine defaults to <EM>X-X-Sender</EM>.
6818
Note, <EM>PC-Pine</EM> always adds
6819
either an <EM>X-X-Sender</EM> line if there is an open, remote mailbox, or an
6820
<EM>X-Warning: UNAuthenticated User</EM> otherwise
6824
<DT> <A NAME="use-subshell-for-suspend"><EM>use-subshell-for-suspend</EM></A>
6826
<DD> This feature affects <EM>Pine</EM>'s behavior when process suspension
6827
is enabled and then activated via the <EM>^Z</EM> key.
6828
<EM>Pine</EM> suspension allows one to
6829
temporarily interact with the operating system command "shell" without
6830
quitting <EM>Pine</EM>,
6831
and then subsequently resume the still-active <EM>Pine</EM> session.
6834
When the <EM>enable-suspend</EM> feature is set and subsequently the
6835
<EM>^Z</EM> key is pressed,
6836
<EM>Pine</EM> will normally suspend itself and return temporary
6837
control to <EM>Pine</EM>'s parent shell process.
6838
However, if this feature is set, <EM>Pine</EM> will instead create an
6839
inferior subshell process.
6840
This is useful when the parent process is not intended to be used
6842
Examples include invoking <EM>Pine</EM> via the <CODE>-e</CODE> argument
6843
of the Unix <EM>xterm</EM> program, or via a menu system.
6846
Note that one typically resumes a suspended <EM>Pine</EM> by entering the Unix
6847
<EM>fg</EM> command, but if this feature is set, it will be necessary to enter
6848
the <EM>exit</EM> command instead.
6851
<DT> <A NAME="vertical-folder-list"><EM>vertical-folder-list</EM></A>
6853
<DD> This feature controls an aspect of <EM>Pine</EM>'s FOLDER LIST screen. If set,
6854
the folders will be listed alphabetically down the columns rather
6855
than across the columns as is the default.
6859
<DT> <A NAME="warn-if-blank-subject"><EM>warn-if-blank-subject</EM></A>
6861
<DD> This feature affects <EM>Pine</EM>'s behavior when you send a message being
6863
If this option is set, <EM>Pine</EM> will check to see if the message about to be sent
6864
has a subject or not.
6865
If not, you will be asked if you want to send the message anyway.
6868
<DT> <A NAME="warn-if-blank-to-and-cc-and-newsgroups"><EM>warn-if-blank-to-and-cc-and-newsgroups</EM></A>
6870
<DD> This feature affects <EM>Pine</EM>'s behavior when you send a message being
6872
If this option is set, <EM>Pine</EM> will check to see if the message about to be sent
6873
has either a To address, a Cc address, or a Newsgroup.
6874
If none of these is set,
6875
you will be asked if you want to send the message anyway.
6877
This feature is closely related to
6878
<A HREF="#fcc-only-without-confirm"><EM>fcc-only-without-confirm</EM></A>.
6879
<EM>Pine</EM> will normally ask if you want to copy a message only to the Fcc.
6880
This feature also applies to cases where there is a Bcc but still no To, Cc,
6882
If the Fcc-Only-Without-Confirm feature is set and you are sending a
6883
message with only an Fcc, then you won't be asked about sending with
6884
a blank To and Cc and Newsgroups header even if this feature is set.
6885
Similarly, if you have already been asked if you want to send to the Fcc
6886
only and you have answered Yes, then you won't be asked again about sending with
6887
blank To, Cc, and Newsgroups headers even if this feature is set.
6894
<H2><A NAME="hidden-config">Hidden Config Variables and Features</A></H2>
6896
There are several configuration variables and features which are normally hidden
6897
from the user. That is, they don't appear on any of the configuration
6898
screens. Some of these are suppressed because they are intended to be used
6899
by system administrators, and in fact may only be set in system-wide
6900
configuration files. Others are available to users but are thought to be
6901
of such little value to most users that their presence on the Config
6902
screens would cause more confusion than help.
6903
You may set the feature <A HREF="#expose-hidden-config">expose-hidden-config</A>
6904
to cause most of these hidden variables and features to show up at the bottom
6905
of the Setup/Config screen.
6907
<H3>Hidden Variables Not Settable by Users</H3>
6909
These variables are settable only in system-wide configuration files.
6912
<LI> <A HREF="#bugs-add">bugs-additional-data</A>
6913
<LI> <A HREF="#bugs">bugs-address</A>
6914
<LI> <A HREF="#bugs">bugs-fullname</A>
6915
<LI> <A HREF="#forced-abook">forced-abook-entry</A>
6916
<LI> <A HREF="#kblock-count">kblock-passwd-count</A>
6917
<LI> <A HREF="#bugs">local-address</A>
6918
<LI> <A HREF="#bugs">local-fullname</A>
6919
<LI> <A HREF="#mail-directory">mail-directory</A>
6920
<LI> <A HREF="#standard-printer">standard-printer</A>
6921
<LI> <A HREF="#bugs">suggest-address</A>
6922
<LI> <A HREF="#bugs">suggest-fullname</A>
6925
<H3>Hidden Variables Which are Settable by Users</H3>
6927
These variables are not shown to users but are settable by means
6928
of hand editing the personal configuration file. This first group
6929
is usually maintained by <EM>Pine</EM> and there will usually
6930
be no reason to edit them by hand.
6933
<LI> <A HREF="#last-version-used">last-version-used</A>
6934
<LI> <A HREF="#patterns-filters2">patterns-filters2</A>
6935
<LI> <A HREF="#patterns-indexcolors">patterns-indexcolors</A>
6936
<LI> <A HREF="#patterns-roles">patterns-roles</A>
6937
<LI> <A HREF="#patterns-scores2">patterns-scores2</A>
6938
<LI> <A HREF="#remote-abook-metafile">remote-abook-metafile</A>
6942
This group is usually correct but may be changed by system managers or
6943
users in special cases.
6946
<LI> <A HREF="#disable-setlocale-collate">disable-setlocale-collate</A>
6947
<LI> <A HREF="#disable-these-auths">disable-these-authenticators</A>
6948
<LI> <A HREF="#disable-these-drivers">disable-these-drivers</A>
6949
<LI> <A HREF="#enable-setlocale-ctype">enable-setlocale-ctype</A>
6950
<LI> <A HREF="#last-time">last-time-prune-questioned</A>
6951
<LI> <A HREF="#new-version-threshold">new-version-threshold</A>
6952
<LI> <A HREF="#remote-abook-history">remote-abook-history</A>
6953
<LI> <A HREF="#remote-abook-validity">remote-abook-validity</A>
6954
<LI> <A HREF="#rsh-command">rsh-command</A>
6955
<LI> <A HREF="#rsh-open-timeout">rsh-open-timeout</A>
6956
<LI> <A HREF="#rsh-path">rsh-path</A>
6957
<LI> <A HREF="#save-aggregates-copy-sequence">save-aggregates-copy-sequence</A>
6958
<LI> <A HREF="#sendmail-path">sendmail-path</A>
6959
<LI> <A HREF="#ssh-command">ssh-command</A>
6960
<LI> <A HREF="#ssh-open-timeout">ssh-open-timeout</A>
6961
<LI> <A HREF="#ssh-path">ssh-path</A>
6962
<LI> <A HREF="#tcp-open-timeout">tcp-open-timeout</A>
6963
<LI> <A HREF="#tcp-query-timeout">tcp-query-timeout</A>
6964
<LI> <A HREF="#tcp-read-warning-timeout">tcp-read-warning-timeout</A>
6965
<LI> <A HREF="#tcp-write-warning-timeout">tcp-write-warning-timeout</A>
6966
<LI> <A HREF="#use-function-keys">use-function-keys</A>
6970
System managers are usually interested in setting these in the system-wide
6971
configuration files, though users may set them if they wish.
6974
<LI> <A HREF="#operating-dir">operating-dir</A>
6975
<LI> <A HREF="#user-input">user-input-timeout</A>
6979
<H3>Hidden Features Which are Settable by Users</H3>
6981
These are <EM>features</EM> (as opposed to variables) which users or system
6982
administrators may set. Some of them only make sense for administrators.
6983
To turn these on manually, the configuration file should be edited and the
6984
feature added to the <EM>feature-list</EM> variable.
6985
You may set the feature <A HREF="#expose-hidden-config">expose-hidden-config</A>
6986
to cause these hidden features to show up in the Setup/Config screen.
6987
They will be at the bottom of the screen.
6990
<LI> <A HREF="#allow-from">allow-changing-from</A>
6991
<LI> <A HREF="#disable-busy-alarm">disable-busy-alarm</A>
6992
<LI> <A HREF="#disable-config-cmd">disable-config-cmd</A>
6993
<LI> <A HREF="#disable-kblock">disable-keyboard-lock-cmd</A>
6994
<LI> <A HREF="#disable-password-caching">disable-password-caching</A>
6995
<LI> <A HREF="#disable-password-cmd">disable-password-cmd</A>
6996
<LI> <A HREF="#disable-pipes-in-sigs">disable-pipes-in-sigs</A>
6997
<LI> <A HREF="#disable-pipes-in-templates">disable-pipes-in-templates</A>
6998
<LI> <A HREF="#disable-roles-setup-cmd">disable-roles-setup-cmd</A>
6999
<LI> <A HREF="#disable-roles-sig-edit">disable-roles-sig-edit</A>
7000
<LI> <A HREF="#disable-roles-template-edit">disable-roles-template-edit</A>
7001
<LI> <A HREF="#disable-shared-namespaces">disable-shared-namespaces</A>
7002
<LI> <A HREF="#disable-signature-edit-cmd">disable-signature-edit-cmd</A>
7003
<LI> <A HREF="#enable-mailcap-param-substitution">enable-mailcap-param-substitution</A>
7004
<LI> <A HREF="#quell-berkeley-format-timezone">quell-berkeley-format-timezone</A>
7005
<LI> <A HREF="#quell-imap-envelope-update">quell-imap-envelope-update</A>
7006
<LI> <A HREF="#quell-news-envelope-update">quell-news-envelope-update</A>
7007
<LI> <A HREF="#quell-partial-fetching">quell-partial-fetching</A>
7008
<LI> <A HREF="#save-aggregates-copy-sequence">save-aggregates-copy-sequence</A>
7009
<LI> <A HREF="#termdef-takes-precedence">termdef-takes-precedence</A>
7013
<H2><A NAME="ret-var">Retired Variables and Features</A></H2>
7015
Variables and features that are no longer used by the current <EM>Pine</EM> version.
7016
When an obsolete variable is encountered, its value is applied to any new
7017
corresponding setting.
7018
The replaced values include:
7023
<DT> <EM>compose-mime</EM>
7025
<DT> <EM>elm-style-save</EM>
7027
<DD> Replaced by <EM>saved-msg-name-rule</EM>
7029
<DT> <EM>expanded-view-of-addressbooks</EM>
7031
<DD> This one was retired in 4.00 but made a comeback in 4.10.
7033
<A HREF="#expanded-view-of-addressbooks">active</A>
7036
<DT> <EM>expanded-view-of-folders</EM>
7038
<DD> This one was retired in 4.00 but made a comeback in 4.10.
7040
<A HREF="#expanded-view-of-folders">active</A>
7043
<DT> <EM>feature-level</EM>
7045
<DD> Replaced by <EM>feature-list.</EM>
7047
<DT> <EM>header-in-reply</EM>
7049
<DD> Replaced by <EM>include-header-in-reply</EM> in the
7050
<EM>feature-list.</EM>
7052
<DT> <EM>old-style-reply</EM>
7054
<DD> Replaced by <EM>signature-at-bottom</EM> in the
7055
<EM>feature-list.</EM>
7057
<DT> <EM>use-old-unix-format-write</EM>
7059
<DD> No replacement.
7061
<DT> <EM>patterns</EM>
7063
<DD> Replaced by four separate patterns variables:
7064
<EM>patterns-roles</EM>,
7065
<EM>patterns-filters</EM>,
7066
<EM>patterns-scores</EM>, and
7067
<EM>patterns-indexcolors</EM>.
7068
Since then, <EM>patterns-filters</EM> has also become obsolete and is replaced
7069
by <EM>patterns-filters2</EM>; <EM>patterns-scores</EM> is replaced by
7070
<EM>patterns-scores2</EM>.
7072
<DT> <EM>save-by-sender</EM>
7074
<DD> Replaced by <EM>saved-msg-name-rule.</EM>
7076
<DT> <EM>show-all-characters</EM>
7078
<DD> No replacement, it always works this way now.
7084
<H2><A NAME="index-tokens"></A>Tokens for Index and Replying</H2>
7086
This set of special tokens may be used in the
7087
<A HREF="#index-format"><EM>index-format</EM></A> option,
7088
in the <A HREF="#reply-leadin"><EM>reply-leadin</EM></A> option,
7090
in template files used in
7091
<A HREF="#role-config"><EM>roles</EM></A>,
7092
and in the folder name that is the target of a Filter Rule.
7093
Some of them aren't available in all situations.
7095
The tokens are used as they appear below for the <EM>Index-Format</EM>
7096
option, but they must be surrounded by underscores for the
7097
<EM>Reply-Leadin</EM> option, in signature and template files,
7098
and in the target of Filter Rules.
7101
<H3><EM>Tokens Available for all Cases (except Filter Rules)</EM></H3>
7106
This token represents the Subject the sender gave the message.
7111
This token represents the personal name (or email address if the name
7112
is unavailable) of the person specified in the message's "From:"
7118
This is similar to the "FROM" token, only it is always the
7119
email address, never the personal name.
7120
For example, "mailbox@domain".
7125
This is the same as the "ADDRESS" except that the
7126
domain part of the address is left off.
7127
For example, "mailbox".
7132
This token represents the personal name (or email address) of the person
7133
listed in the message's "Sender:" header field.
7138
This token represents the personal names (or email addresses if the names
7139
are unavailable) of the persons specified in the
7140
message's "To:" header field.
7145
This token represents the newsgroups from the
7146
message's "Newsgroups:" header field <EM>and</EM>
7147
the personal names (or email addresses if the names
7148
are unavailable) of the persons specified in the
7149
message's "To:" header field.
7154
Same as "NEWSANDTO" except in the opposite order.
7159
This token represents the newsgroups from the
7160
message's "Newsgroups:" header field.
7165
This token represents the personal names (or email addresses if the names
7166
are unavailable) of the persons specified in the
7167
message's "Cc:" header field.
7172
This token represents the personal names (or email addresses if the names
7173
are unavailable) of the persons specified in both the
7174
message's "To:" header field and
7175
the message's "Cc:" header field.
7178
<DT>NEWSANDRECIPS</DT>
7180
This token represents the newsgroups from the
7181
message's "Newsgroups:" header field <EM>and</EM>
7182
the personal names (or email addresses if the names
7183
are unavailable) of the persons specified in the
7184
message's "To:" and "Cc:" header fields.
7187
<DT>RECIPSANDNEWS</DT>
7189
Same as "NEWSANDRECIPS" except in the opposite order.
7194
This token represents the initials from the personal name
7195
of the person specified in the message's "From:"
7197
If there is no personal name, it is blank.
7202
This token represents the date on which the message was sent, according
7203
to the "Date" header field.
7204
It has the format MMM DD. For example, "Oct 23".
7209
This token represents the date on which the message was sent, according
7210
to the "Date" header field.
7211
It is "Today" if the message was sent today,
7212
"Yesterday" for yesterday,
7213
"Wednesday" if it was last Wednesday, and so on. If the
7214
message is from more than six months ago it includes the year, as well.
7215
There is no adjustment made for different time zones, so you'll get
7216
the day the message was sent according to the time zone the sender
7222
This token represents the most relevant elements of the date on which
7223
the message was sent (according to the "Date" header field),
7224
in a compact form. If the message was sent today, only the time is used
7225
(e.g. "9:22am", "10:07pm"); if it was sent during
7226
the past week, the day of the week and the hour are used
7227
(e.g. "Wed09am", "Thu10pm"); other dates are
7228
given as date, month, and year (e.g. "23Aug00",
7229
"9Apr98").
7230
There is no adjustment made for different time zones, so you'll get
7231
the day/time the message was sent according to the time zone the sender
7235
<DT>SMARTDATETIME</DT>
7237
This is a combination of SMARTDATE and SMARTTIME.
7238
It is SMARTDATE unless the SMARTDATE value is "Today", in which
7239
case it is SMARTTIME.
7244
This token represents the date on which the message was sent, according
7245
to the "Date" header field.
7246
It has the format YYYY-MM-DD. For example, "1998-10-23".
7249
<DT>SHORTDATEISO</DT>
7251
This token represents the date on which the message was sent, according
7252
to the "Date" header field.
7253
It has the format YY-MM-DD. For example, "98-10-23".
7258
This token represents the date on which the message was sent, according
7259
to the "Date" header field.
7260
It has the format MM/DD/YY. For example, "10/23/98".
7265
This token represents the date on which the message was sent, according
7266
to the "Date" header field.
7267
It has the format DD/MM/YY. For example, "23/10/98".
7272
This token represents the date on which the message was sent, according
7273
to the "Date" header field.
7274
It has the format DD.MM.YY. For example, "23.10.98".
7279
This token represents the date on which the message was sent, according
7280
to the "Date" header field.
7281
It has the format YY.MM.DD. For example, "98.10.23".
7286
This token represents the date on which the message was sent, according
7287
to the "Date" header field.
7288
It has the format MMM DD, YYYY. For example, "Oct 23, 1998".
7293
This token represents the date on which the message was sent, according
7294
to the "Date" header field.
7295
It looks like "Sat, 23 Oct 1998".
7300
This token represents the day of the month on which the message was sent,
7301
according to the "Date" header field.
7302
For example, "23" or "9".
7307
This token represents the day of the month on which the message was sent,
7308
according to the "Date" header field.
7309
For example, "23" or "09".
7310
It is always 2 digits.
7315
This token represents the ordinal number which is the day of
7316
the month on which the message was sent,
7317
according to the "Date" header field.
7318
For example, "23rd" or "9th".
7323
This token represents the day of the week on which the message was sent,
7324
according to the "Date" header field.
7325
For example, "Sunday" or "Wednesday".
7328
<DT>DAYOFWEEKABBREV</DT>
7330
This token represents the day of the week on which the message was sent,
7331
according to the "Date" header field.
7332
For example, "Sun" or "Wed".
7335
<DT>MONTHABBREV</DT>
7337
This token represents the month the message was sent, according
7338
to the "Date" header field.
7339
For example, "Oct".
7344
This token represents the month in which the message was sent, according
7345
to the "Date" header field.
7346
For example, "October".
7351
This token represents the month in which the message was sent, according
7352
to the "Date" header field.
7353
For example, "10" or "9".
7356
<DT>MONTH2DIGIT</DT>
7358
This token represents the month in which the message was sent, according
7359
to the "Date" header field.
7360
For example, "10" or "09".
7361
It is always 2 digits.
7366
This token represents the year the message was sent, according
7367
to the "Date" header field.
7368
For example, "1998" or "2001".
7373
This token represents the year the message was sent, according
7374
to the "Date" header field.
7375
For example, "98" or "01".
7376
It is always 2 digits.
7381
This token represents the time at which the message was sent, according
7382
to the "Date" header field.
7383
There is no adjustment made for different time zones, so you'll get
7384
the time the message was sent according to the time zone the sender
7386
It has the format HH:MM. For example, "17:28".
7391
This token represents the time at which the message was sent, according
7392
to the "Date" header field.
7393
This time is for a 12 hour clock.
7394
It has the format HH:MMpm.
7395
For example, "5:28pm" or "11:13am".
7400
This token represents the numeric timezone from
7401
the "Date" header field.
7402
It has the format [+-]HHMM. For example, "-0800".
7408
<H3><EM>Tokens Available Only for Index-Format</EM></H3>
7413
This token represents the message's current position in the folder which,
7414
of course, may change as the folder is sorted or new mail arrives.
7419
This token represents a three character wide field displaying various
7420
aspects of the message's state.
7421
The first character is either blank,
7422
a '*' for message marked Important, or a '+' indicating a message
7423
addressed directly to you (as opposed to your having received it via a
7424
mailing list, for example).
7426
<A HREF="#mark-for-cc"><EM>mark-for-cc</EM></A>
7427
is set, if the first character would have been
7428
blank then it will instead be a '-' if the message is cc'd to you.
7429
The second character is typically blank,
7430
though the arrow cursor may occupy it if either the
7431
<A HREF="#assume-slow-link"><EM>assume-slow-link</EM></A>
7433
<A HREF="#force-arrow-cursor"><EM>force-arrow-cursor</EM></A> feature
7434
is set (or you actually are on a slow link).
7435
The third character is either the letter 'D' if the
7436
message is deleted, 'A' if it is answered (but not deleted), or 'N' if
7437
it is new (but not deleted or answered), or blank if it is neither
7438
deleted, answered nor new.
7440
If you are using a threaded view of the index and this message is at the
7441
top of a collapsed portion of a thread,
7442
then this token refers to all of the messages in the collapsed portion of
7443
the thread instead of just the top message.
7444
The first character will be a '*' if <EM>any</EM> of the messages in the thread
7445
are marked Important, else a '+' if any of the messages are addressed
7446
to you, else a '-' if any of the messages are cc'd to you.
7447
The third character will be a 'D' if <EM>all</EM> of the messages
7448
in the collapsed thread are marked deleted, else it will be 'N' if any of
7449
the messages are undeleted and unseen, and it will be blank otherwise.
7454
This token represents a less abbreviated alternative
7455
to the "STATUS" token.
7456
It is six characters wide.
7457
The first character is '+', '-', or blank, the
7458
second blank, the third either '*' or blank, the fourth 'N' or blank,
7459
the fifth 'A' or blank, and the sixth character is either 'D' or
7462
If you are using a threaded view of the index and this message is at the
7463
top of a collapsed portion of a thread,
7464
then this token refers to all of the messages in the collapsed portion of
7465
the thread instead of just the top message.
7466
The first character is '+', '-', or blank depending on whether <EM>any</EM>
7467
of the messages in the collapsed thread are addressed to you or cc'd to you.
7468
The third character will be '*' if any of the messages are marked
7470
The fourth character will be 'N' if all of the messages in the thread
7471
are New, else 'n' if some of the messages in the thread are New, else blank.
7472
The fifth character will be 'A' or 'a' or blank, and the sixth character
7473
will be 'D' or 'd' or blank.
7478
This token represents an even less abbreviated alternative to the
7479
"STATUS" token.
7480
It differs from "FULLSTATUS" in only the fourth character which is
7481
an 'N' if the message is new to this folder since the last time
7482
it was opened <EM>and</EM> it has not been viewed, an 'R' (Recent) if the message
7483
is new to the folder and has been viewed, a 'U' (Unseen) if the message is not
7484
new to the folder since it was last opened <EM>but</EM> has not been
7485
viewed, or a blank if the message has been in the folder since it was
7486
last opened and has been viewed.
7488
If you are using a threaded view of the index and this message is at the
7489
top of a collapsed portion of a thread,
7490
then the fourth character will be
7491
'N' if all of the messages in the thread are unseen and recent;
7492
else 'n' if some of the messages in the thread are unseen and recent;
7493
else 'U' if all of the messages in the thread are unseen and not recent;
7494
else 'u' if some of the messages in the thread are unseen and not recent;
7495
else 'R' if all of the messages in the thread are seen and recent;
7496
else 'r' if some of the messages in the thread are seen and recent;
7502
This token represents the total size, in bytes, of the message.
7503
If a "K" (Kilobyte)
7504
follows the number, the size is approximately 1,000
7505
times that many bytes (rounded to the nearest 1,000).
7506
If an "M" (Megabyte) follows the number, the size is approximately
7507
1,000,000 times that many bytes.
7508
Commas are not used in this field.
7509
This field is seven characters wide, including the enclosing parentheses.
7510
Sizes are rounded when "K" or "M" is present.
7511
The progression of sizes used looks like:
7514
<CENTER><SAMP>0 1 ... 9999 10K ... 999K 1.0M ... 99.9M 100M ... 2000M</SAMP></CENTER>
7520
This token represents the total size, in bytes, of the message.
7521
If a "K" (Kilobyte)
7522
follows the number, the size is approximately 1,000
7523
times that many bytes (rounded to the nearest 1,000).
7524
If an "M" (Megabyte) follows the number, the size is approximately
7525
1,000,000 times that many bytes.
7526
Commas are used if the number shown is 1,000 or greater.
7527
The SIZECOMMA field is one character wider than the SIZE field.
7528
Sizes are rounded when "K" or "M" is present.
7529
The progression of sizes used looks like:
7532
<CENTER><SAMP>0 1 ... 99,999 100K ... 9,999K 10.0M ... 999.9M 1,000M ... 2,000M</SAMP></CENTER>
7538
This token represents the total size of the message, expressed in
7539
kilobytes or megabytes, as most appropriate.
7540
These are 1,024 byte kilobytes and 1,024 x 1,024 byte megabytes.
7541
The progression of sizes used looks like:
7544
<CENTER><SAMP>0K 1K ... 1023K 1.0M ... 99.9M 100M ... 2047M</SAMP></CENTER>
7550
This token represents the total size, in bytes, of the message.
7551
If a "K" (Kilobyte)
7552
follows the number, the size is approximately 1,000
7553
times that many bytes.
7554
If an "M" (Megabyte) follows the number, the size is approximately
7555
1,000,000 times that many bytes.
7556
If a "G" (Gigabyte) follows the number, the size is approximately
7557
1,000,000,000 times that many bytes.
7558
This field uses only five characters of screen width, including the enclosing
7560
The progression of sizes used looks like:
7563
<CENTER><SAMP>0 1 ... 999 1K ... 99K .1M ... .9M 1M ... 99M .1G ... .9G 1G 2G</SAMP></CENTER>
7567
<DT>DESCRIPSIZE</DT>
7569
This token is intended to represent a more useful description of the
7570
message than just its size, but it isn't very useful at this point.
7571
The plus sign in this view means there are attachments.
7572
Note that including this token in
7573
the "Index-Format" could slow down the
7574
display a little while <EM>Pine</EM> collects the necessary information.
7579
This token is the same as the SUBJECT token unless keywords are set for
7581
In that case, a list of keywords enclosed in braces will be prepended to
7582
the subject of the message.
7583
Having this set in the index-format will also cause the keywords to be
7584
prepended to the subject in the MESSAGE VIEW screen.
7585
If you have given a keyword a nickname
7586
(<A HREF="#keywords">Keywords</A>), that nickname is displayed
7587
instead of the actual keyword.
7588
The <A HREF="#keyword-surrounding-chars">Keyword-Surrounding-Chars</A>
7589
option may be used to modify this token slightly.
7590
It is also possible to color keywords in the index using the
7592
(<A HREF="#keyword-colors">Keyword Colors</A>).
7595
<DT>SUBJKEYINIT</DT>
7597
This token is the same as the SUBJKEY token except that instead of
7598
prepending a list of keywords to the subject, a list of first initials
7599
of keywords will be prepended instead.
7600
For example, if a message has the keywords <EM>Work</EM> and <EM>Now</EM>
7601
set (or Work and Now are the Pine nicknames of keywords which are set)
7602
then the SUBJKEY token would cause a result like
7604
<CENTER><SAMP>{Work Now} actual subject</SAMP></CENTER>
7606
whereas the SUBJKEYINIT token would give
7608
<CENTER><SAMP>{WN} actual subject</SAMP></CENTER>
7610
The <A HREF="#keyword-surrounding-chars"><EM>Keyword-Surrounding-Chars</EM></A>
7611
option may be used to modify this token slightly.
7612
It is also possible to color keywords in the index using the
7614
(<A HREF="#keyword-colors">Keyword Colors</A>).
7619
This is a space-delimited list of keywords that are set for the message.
7620
If you have given a keyword a nickname
7621
(<A HREF="#keywords">Keywords</A>), that nickname is displayed
7622
instead of the actual keyword.
7623
It is also possible to color keywords in the index using the
7625
(<A HREF="#keyword-colors">Keyword Colors</A>).
7630
This is a list of keyword initials that are set for the message.
7631
If you have given a keyword a nickname
7632
(<A HREF="#keywords">Keywords</A>), the initial of that nickname
7633
is displayed instead of the initial of the actual keyword.
7634
It is also possible to color keyword initials in the index using the
7636
(<A HREF="#keyword-colors">Keyword Colors</A>).
7641
This is a one column wide field which represents the number of attachments
7642
a message has. It will be blank if there are no attachments, a single
7643
digit for one to nine attachments, or an asterisk for more than nine.
7644
Note that including this token in
7645
the "Index-Format" could slow down the
7646
display a little while <EM>Pine</EM> collects the necessary information.
7651
This token represents <EM>either</EM> the personal name (or email address) of
7652
the person listed in the message's "From:" header
7653
field, <EM>or</EM>, if that address is yours or one of your
7654
<A HREF="#alt-addresses"><EM>alternate addresses</EM></A>,
7655
the first person specified in the
7656
message's "To:" header field
7657
with the prefix "To: " prepended.
7658
If the from address is yours and there is also no "To" address,
7659
<EM>Pine</EM> will use the address on the "Cc" line.
7660
If there is no address there, either, <EM>Pine</EM> will look for a newsgroup name
7661
from the "Newsgroups" header field and put
7662
that after the "To: " prefix.
7665
<DT>FROMORTONOTNEWS</DT>
7667
This is almost the same as <EM>FROMORTO</EM>.
7668
The difference is that newsgroups aren't considered.
7669
When a message is from you, doesn't have a To or Cc, and does have
7670
a Newsgroups header; this token will be your name instead of the name
7671
of the newsgroup (like it would be with FROMORTO).
7676
This gives an alternative way to display the current message in the
7677
MESSAGE INDEX screen.
7678
Usually the current message is indicated by the line being shown in
7680
Instead, if the ARROW token is included in your Index-Format,
7681
the current line will include an "arrow" that
7684
<CENTER><SAMP>-></SAMP></CENTER>
7686
in the ARROW token's field.
7687
For all of the non-current messages, the ARROW field will be filled
7689
If you use the fixed-field width feature the length of the "arrow"
7691
The arrow will be drawn as width-1 dashes followed by a greater than sign.
7692
For example, if you use ARROW(3) you will get
7694
<CENTER><SAMP>--></SAMP></CENTER>
7696
and ARROW(1) will give you just
7698
<CENTER><SAMP>></SAMP></CENTER>
7700
It is also possible to set the color of the ARROW field.
7701
By default (and for non-current messages) the arrow is colored the same
7702
as the index line it is part of.
7703
You may set it to be another color with the
7704
"Index Arrow Color" option available from
7705
the <A HREF="#color-config">Setup Kolor</A> screen.
7710
This gives the score
7712
This will be six columns wide to accomodate the widest possible score.
7713
You will probably want to use the index-format fixed-field width feature
7714
to limit the width of the field to the widest score that
7715
you use (e.g. SCORE(3) if your scores are always between 0 and 999).
7716
If you have not defined any score rules the scores will all be zero.
7717
If any of your score rules contain AllText or BodyText patterns
7718
then including SCORE in the index-format
7719
may slow down the display of the MESSAGE INDEX screen.
7724
<H3><EM>Tokens Available for all but Index-Format</EM></H3>
7729
This token represents the current newsgroup if there is one.
7730
For example, "comp.mail.pine".
7735
This token represents the message ID of the message.
7740
This token represents the current date.
7741
It has the format MMM DD. For example, "Oct 23".
7746
This token represents the current date.
7747
It has the format YYYY-MM-DD. For example, "1998-10-23".
7750
<DT>CURDATEISOS</DT>
7752
This token represents the current date.
7753
It has the format YY-MM-DD. For example, "98-10-23".
7758
This token represents the current time.
7759
It has the format HH:MM. For example, "17:28".
7764
This token represents the current time.
7765
This time is for a 12 hour clock.
7766
It has the format HH:MMpm.
7767
For example, "5:28pm" or "11:13am".
7772
This token represents the current day of the month.
7773
For example, "23" or "9".
7776
<DT>CURDAY2DIGIT</DT>
7778
This token represents the current day of the month.
7779
For example, "23" or "09".
7780
It is always 2 digits.
7783
<DT>CURDAYOFWEEK</DT>
7785
This token represents the current day of the week.
7786
For example, "Sunday" or "Wednesday".
7789
<DT>CURDAYOFWEEKABBREV</DT>
7791
This token represents the current day of the week.
7792
For example, "Sun" or "Wed".
7797
This token represents the current month.
7798
For example, "10" or "9".
7801
<DT>CURMONTH2DIGIT</DT>
7803
This token represents the current month.
7804
For example, "10" or "09".
7805
It is always 2 digits.
7808
<DT>CURMONTHLONG</DT>
7810
This token represents the current month.
7811
For example, "October".
7814
<DT>CURMONTHABBREV</DT>
7816
This token represents the current month.
7817
For example, "Oct".
7822
This token represents the current year.
7823
For example, "1998" or "2001".
7826
<DT>CURYEAR2DIGIT</DT>
7828
This token represents the current year.
7829
For example, "98" or "01".
7830
It is always 2 digits.
7835
This token represents last month.
7836
For example, if this is November (the 11th month),
7837
it is equal to "10" or if this is October (the 10th month),
7838
it is "9".
7839
It is possible that this and the other tokens beginning with LASTMONTH
7840
below could be useful when used with a Filtering Rule that
7841
has the "Beginning of Month" option set.
7844
<DT>LASTMONTH2DIGIT</DT>
7846
This token represents last month.
7847
For example, if this is November (the 11th month),
7848
it is equal to "10" or if this is October (the 10th month),
7849
it is "09".
7850
It is always 2 digits.
7853
<DT>LASTMONTHLONG</DT>
7855
This token represents last month.
7856
For example, if this is November the value is "October".
7859
<DT>LASTMONTHABBREV</DT>
7861
This token represents last month.
7862
For example, if this is November the value is "Oct".
7865
<DT>LASTMONTHYEAR</DT>
7867
This token represents what the year was a month ago.
7868
For example, if this is October, 1998, it is "1998".
7869
If this is January, 1998, it is "1997".
7872
<DT>LASTMONTHYEAR2DIGIT</DT>
7874
This token represents what the year was a month ago.
7875
For example, if this is October, 1998, it is "98".
7876
If this is January, 1998, it is "97".
7881
This token represents last year.
7882
For example, if this is 1998, it equals "1997".
7883
It is possible that this
7884
could be useful when used with a Filtering Rule that
7885
has the "Beginning of Year" option set.
7888
<DT>LASTYEAR2DIGIT</DT>
7890
This token represents last year.
7891
For example, if this is 1998, it equals "97".
7892
It is always 2 digits.
7897
This token represents the nickname of the
7898
role currently being used. If no role is being used,
7899
then no text will be printed for this token.
7900
This token does not work with Filter Rule folder names.
7905
<H3><EM>Token Available Only for Templates and Signatures</EM></H3>
7910
This token is different from the others.
7911
When it is replaced it is replaced with nothing, but it sets a <EM>Pine</EM>
7912
internal variable which tells the composer to start with the cursor
7913
positioned at the position where this token was.
7914
If both the template file and the signature file contain
7915
a "CURSORPOS" token, then the position in the template file
7917
If there is a template file and neither it nor the signature file contains
7918
a "CURSORPOS" token, then the cursor is positioned
7919
after the end of the contents of the
7920
template file when the composer starts up.
7924
<H2><A NAME="reply-token-conditionals"></A>Conditional Inclusion of Text for Reply-Leadin, Signatures, and Templates</H2>
7926
Conditional text inclusion may be used with
7927
the <A HREF="#reply-leadin"><EM>Reply-Leadin</EM></A> option,
7928
in signature files, and in template files used in
7930
It may <EM>not</EM> be used with the
7931
<EM>Index-Format</EM> option.
7934
There is a limited if-else capability for including text.
7935
The if-else condition is based
7936
on whether or not a given token would result in replacement text you
7938
The syntax of this conditional inclusion is
7940
<CENTER><SAMP>_token_(match_this, if_matched [ , if_not_matched ] )</SAMP></CENTER>
7942
The left parenthesis must follow the underscore immediately, with no
7944
It means the token is expanded and the results of that expansion are
7945
compared against the "match_this" argument.
7946
If there is an exact match, then the "if_matched" text is used
7947
as the replacement text.
7948
Otherwise, the "if_not_matched" text is used.
7949
One of the most useful values for the "match_this" argument is
7950
the empty string, "".
7951
In that case the expansion is compared against the empty string.
7953
Here's an example to make it clearer.
7954
This text could be included in one of your template files:
7956
<CENTER><SAMP>_NEWS_("", "I'm replying to email","I'm replying to news")</SAMP></CENTER>
7958
If that is included in a template file which you are using while replying
7959
to a message (because you chose to use the role it was part of),
7960
and that message has a newsgroup header and a newsgroup in that header,
7963
<CENTER><SAMP>I'm replying to news</SAMP></CENTER>
7965
will be included in the message you are about to compose.
7966
On the other hand, if the message you are replying to does not have
7967
a newsgroup, then the text
7969
<CENTER><SAMP>I'm replying to email</SAMP></CENTER>
7971
would be included instead.
7972
This would also work in signature files and in
7973
the "Reply-Leadin" option.
7974
If the "match_this", "if_matched",
7975
or "if_not_matched" arguments contain
7976
spaces, parentheses, or commas;
7977
they have to be quoted with double quotation marks (like in the example
7979
If you want to include a literal quote in the text you must escape the
7980
quote by preceding it with a backslash character.
7981
If you want to include a literal backslash character you must escape it
7982
by preceding it with another backslash.
7984
The comma followed by "if_not_matched" is optional.
7985
If there is no "if_not_matched"
7986
present then no text is included if the not_matched case is true.
7987
Here's another example:
7989
<CENTER><SAMP>_NEWS_("", "", "This msg was seen in group: _NEWS_.")</SAMP></CENTER>
7991
Here you can see that tokens may appear in the arguments.
7992
The same is true for tokens with the conditional parentheses.
7993
They may appear in arguments,
7994
though you do have to be careful to get the quoting and escaping of
7995
nested double quotes correct.
7996
If this was in the signature file being used and you were replying to a message
7997
sent to comp.mail.pine the resulting text would be:
7999
<CENTER><SAMP>This msg was seen in group: comp.mail.pine.</SAMP></CENTER>
8001
If you were replying to a message which wasn't sent to any newsgroup the
8002
resulting text would be a single blank line.
8003
The reason you'd get a blank line is because the end of the line is
8004
outside of the conditional, so is always included.
8005
If you wanted to get rid of that blank line you could do so by moving
8006
the end of line inside the conditional.
8007
In other words, it's ok to have multi-line
8008
"if_matched" or "if_not_matched" arguments.
8009
The text just continues until the next double quotation, even if it's not
8012
Here's one more (contrived) example illustrating a matching argument
8013
which is not the empty string.
8015
<CENTER><SAMP>_SMARTDATE_("Today", _SMARTDATE_, "On _DATE_") _FROM_ wrote:</SAMP></CENTER>
8017
If this was the value of your "Reply-Leadin" option and you
8019
a message which was sent today, then the value of the "Reply-Leadin"
8022
<CENTER><SAMP>Today Fred Flintstone wrote:</SAMP></CENTER>
8024
But if you were replying to a message sent on Oct. 27 (and that wasn't
8025
today) you would get
8027
<CENTER><SAMP>On Oct 27 Fred Flintstone wrote:</SAMP></CENTER>
8030
<H2><A NAME="per-server-ldap-config"></A>Per Server Directory Configuration</H2>
8032
This is only available if <EM>Pine</EM> was linked with an LDAP library
8033
when it was compiled.
8034
If that's the case, there will be a Directory option underneath the Setup
8035
command on the Main Menu.
8036
Each server that is defined there has several configuration variables
8037
which control the behavior when using it.
8041
<DT> <A NAME="ldap-server"><EM>ldap-server</EM></A>
8043
<DD> This is the name of the host where an LDAP server is running.
8045
To find out whether your organization has its own LDAP server,
8046
contact its computing support staff.
8049
<DT> <A NAME="search-base"><EM>search-base</EM></A>
8051
<DD> This is the search base to be used on this server.
8052
It functions as a filter
8053
by restricting your searches in the LDAP server database
8054
to the specified contents of the specified fields.
8055
Without it, searches submitted to this directory server may fail.
8056
It might be something like:
8059
O = <Your Organization Name>, C = US
8062
or it might be blank.
8063
(Some LDAP servers actually ignore anything specified here.)
8066
If in doubt what parameters you should specify here,
8067
contact the maintainers of the LDAP server.
8070
<DT> <A NAME="port"><EM>port</EM></A>
8072
<DD> This is the TCP port number to be used with this LDAP server.
8073
If you leave this blank port <CODE>389</CODE> will be used.
8076
<DT> <A NAME="ldap-nickname"><EM>nickname</EM></A>
8078
<DD> This is a nickname to be used in displays.
8079
If you don't supply a nickname the server name from
8080
"ldap-server" will be used instead.
8081
This option is strictly for your convenience.
8084
<DT> <A NAME="use-implicitly-from-composer"><EM>use-implicitly-from-composer</EM></A>
8086
<DD> Set this feature to have lookups done to this server implicitly from
8088
If an address doesn't look like a fully-qualified address, it will be looked
8089
up in your address books, and if it doesn't match a nickname there, then it
8090
will be looked up on the LDAP servers which have this feature set.
8091
Also see the LDAP feature
8092
<A HREF="#lookup-addrbook-contents"><EM>lookup-addrbook-contents</EM></A>
8093
and the Setup/Config feature
8094
<A HREF="#ldap-result-to-addrbook-add"><EM>ldap-result-to-addrbook-add</EM></A>.
8097
<DT> <A NAME="lookup-addrbook-contents"><EM>lookup-addrbook-contents</EM></A>
8099
<DD> Normally implicit LDAP lookups from the composer are done only for the
8100
strings you type in from the composer screen. In other words, you type in
8101
something in the To or CC field and press return, then the string is looked up.
8102
First that string is looked up in your address books. If a match is found
8103
there, then the results of that match are looked up again. If you place
8104
a string in your address book that you want to have looked up on the LDAP
8105
directory server, you need to turn on this feature. If you set this feature
8106
for a server, you almost always will also want to set the
8107
<A HREF="#use-implicitly-from-composer"><EM>use-implicitly-from-composer</EM></A>
8109
An example might serve to best illustrate this feature.
8111
If an LDAP lookup of "William Clinton" normally returns an
8113
address of pres@whitehouse.gov, then you might put an entry in your address
8114
book that looks like:
8117
bill "William Clinton"
8119
Now, when you type "bill" into an
8120
address field in the composer <EM>Pine</EM> will
8121
find the "bill" entry in your address book.
8122
It will replace "bill" with
8123
"William Clinton".
8124
It will then search for an entry with that nickname
8125
in your address book and not find one. If this feature
8126
is set, <EM>Pine</EM> will then attempt to lookup
8127
"William Clinton" on the LDAP server and find the entry with address
8128
pres@whitehouse.gov.
8130
A better way to accomplish the same thing is probably to use the feature
8131
<A HREF="#save-search-criteria-not-result"><EM>save-search-criteria-not-result</EM></A>.
8134
<DT> <A NAME="save-search-criteria-not-result"><EM>save-search-criteria-not-result</EM></A>
8136
<DD> Normally when you save the results of an LDAP directory lookup to your
8137
address book the <EM>results</EM> of the lookup are saved.
8138
If this feature is set
8139
and the entry being saved was found on this directory server, then the
8140
search <EM>criteria</EM> is saved instead of the <EM>results</EM> of the search.
8141
When this address book entry is used in the future, instead of copying
8142
the results from the address book the directory lookup will be done again.
8143
This could be useful if the copied result might become stale because the data on
8144
the directory server changes (for example, the entry's email address changes).
8145
You probably don't want to set this feature if the server is at all slow or
8148
The way this actually works is that instead of saving the email address
8149
in your address book, <EM>Pine</EM> saves enough
8150
information to look up the same directory entry again.
8151
In particular, it saves the server name and the
8152
distinguished name of the entry.
8153
It's possible that the server administrators
8154
might change the format of distinguished names on the server, or that the
8155
entry might be removed from the server. If <EM>Pine</EM> notices this, you will be warned
8156
and a backup copy of the email address will be used. You may want to create
8157
a new entry in this case, since you will get the annoying warning every
8158
time you use the old entry. You may do that by Saving the entry to a new
8159
nickname in the same address book. You will be asked whether or not you
8160
want to use the backup email address.
8162
A related feature in the Setup/Config screen is
8163
<A HREF="#ldap-result-to-addrbook-add"><EM>ldap-result-to-addrbook-add</EM></A>.
8166
<DT> <A NAME="disable-ad-hoc-space-substitution"><EM>disable-ad-hoc-space-substitution</EM></A>
8168
<DD> Spaces in your input are normally handled specially.
8169
Each space character is replaced
8174
in the search query (but not by "* <SPACE> *").
8175
The reason this is done is so the input string
8179
(which is converted to "Greg* Donald") will match
8180
the names "Greg Donald",
8181
"Gregory Donald", "Greg F. Donald", and
8182
"Gregory F Donald"; but it won't match "Greg McDonald".
8183
If the "Search-Rule" you were using was "begins-with",
8184
then it would also match the name "Greg Donaldson".
8186
Turning on this feature will disable this substitution.
8189
<DT> <A NAME="search-type"><EM>search-type</EM></A>
8191
<DD> This affects the way that LDAP searches are done.
8192
In particular, this tells the server where to look for the string to be matched.
8193
If set to "name" then the string that is being searched for will
8194
be compared with the string in the
8195
"Name" field on the server
8196
(technically, it is the "commonname" field on the server).
8197
"Surname" means we're looking for a
8198
match in the "Surname" field on the
8199
server (actually the "sn" field).
8200
"Givenname" really is "givenname"
8201
and "email" is the electronic mail address (this is actually the field
8202
called "mail" or "electronicmail" on the server).
8203
The other three types are combinations of
8204
the types listed so far. "Name-or-email"
8205
means the string should appear
8206
in either the "name" field OR the "email" field.
8207
Likewise, "surname-or-givenname"
8208
means "surname" OR "givenname"
8209
and "sur-or-given-or-name-or-email" means the obvious thing.
8211
This search <EM>type</EM> is combined with the
8212
search <A HREF="#search-rule"><EM>rule</EM></A>
8213
to form the actual search query.
8215
The usual default value for this
8216
option is "sur-or-given-or-name-or-email".
8217
This type of search may be slow on some servers.
8218
Try "name-or-email", which is often
8219
faster, or just "name" if the performance seems to be a problem.
8221
Some servers have been configured with different attribute names for
8223
In other words, instead of using the attribute name "mail"
8224
for the email address field, the server might be configured to use something
8225
else, for example, "rfc822mail" or "internetemailaddress".
8226
<EM>Pine</EM> can be configured to use these different attribute names by using
8227
the four per-server configuration options:
8229
<LI><A HREF="#email-attribute"><EM>email-attribute</EM></A>
8232
<LI><A HREF="#name-attribute"><EM>name-attribute</EM></A>
8235
<LI><A HREF="#surname-attribute"><EM>surname-attribute</EM></A>
8238
<LI><A HREF="#givenname-attribute"><EM>givenname-attribute</EM></A>
8242
<DT> <A NAME="search-rule"><EM>search-rule</EM></A>
8244
<DD> This affects the way that LDAP searches are done.
8245
If set to "equals" then
8246
only exact matches count.
8247
"Contains" means that the string you type in
8248
is a substring of what you are matching against.
8249
"Begins-with" and "ends-with"
8250
mean that the string starts or ends with the string you type in.
8252
Spaces in your input are normally handled specially, but you can turn that
8253
special handling off with the
8254
<A HREF="#disable-ad-hoc-space-substitution"><EM>disable-ad-hoc-space-substitution</EM></A>
8257
The usual default value for this option is <EM>begins-with</EM>.
8260
<DT> <A NAME="email-attribute"><EM>email-attribute</EM></A>
8262
<DD> This is the name of the attribute which is searched for when looking for
8263
an email address. The default value for this option is "mail" or
8264
"electronicmail".
8265
If the server you are using uses a different attribute name for the email
8266
address, put that attribute name here.
8268
This will affect the search filter used if your Search-Type is one that
8269
contains a search for "email".
8270
It will also cause the attribute value matching this attribute name to be used
8271
as the email address when you look up an entry from the composer.
8274
<DT> <A NAME="name-attribute"><EM>name-attribute</EM></A>
8276
<DD> This is the name of the attribute which is searched for when looking for
8277
the name of the entry. The default value for this option is "cn", which
8278
stands for common name.
8279
If the server you are using uses a different attribute name for the name,
8280
put that attribute name here.
8281
This will affect the search filter used if your Search-Type is one that
8282
contains a search for "name".
8285
<DT> <A NAME="surname-attribute"><EM>surname-attribute</EM></A>
8287
<DD> This is the name of the attribute which is searched for when looking for
8288
the surname of the entry. The default value for this option is "sn".
8289
If the server you are using uses a different attribute name for the surname,
8290
put that attribute name here.
8291
This will affect the search filter used if your Search-Type is one that
8292
contains a search for "surname".
8295
<DT> <A NAME="givenname-attribute"><EM>givenname-attribute</EM></A>
8297
<DD> This is the name of the attribute which is searched for when looking for
8298
the given name of the entry. The default value for this option is "givenname".
8299
If the server you are using uses a different attribute name for the given name,
8300
put that attribute name here.
8301
This will affect the search filter used if your Search-Type is one that
8302
contains a search for "givenname".
8305
<DT> <A NAME="timelimit"><EM>timelimit</EM></A>
8307
<DD> This places a limit on the number of seconds the LDAP search will continue.
8308
The default is 30 seconds. A value of 0 means no limit. Note that some servers
8309
may place limits of their own on searches.
8312
<DT> <A NAME="sizelimit"><EM>sizelimit</EM></A>
8314
<DD> This places a limit on the number of entries returned by the LDAP server.
8315
A value of 0 means no limit. The default is 0. Note that some servers
8316
may place limits of their own on searches.
8319
<DT> <A NAME="custom-search-filter"><EM>custom-search-filter</EM></A>
8321
<DD> This one is for advanced users only! If you define this, then the
8322
<A HREF="#search-type"><EM>search-type</EM></A>
8324
<A HREF="#search-rule"><EM>search-rule</EM></A>
8325
defined are both ignored.
8326
However, the feature
8327
<A HREF="#disable-ad-hoc-space-substitution"><EM>disable-ad-hoc-space-substitution</EM></A>
8329
That is, the space substitution will take place even in a custom filter unless
8332
If your LDAP service stops working and you suspect it might be because
8333
of your custom filter, just delete this filter and try using the
8334
<EM>search-type</EM> and <EM>search-rule</EM> instead.
8335
Another option that sometimes causes trouble is the
8336
<A HREF="#search-base"><EM>search-base</EM></A> option.
8338
This variable may be set to the string representation of an LDAP search
8339
filter (see RFC1960). In the places where you want the address string to be
8340
substituted in, put a '%s' in this filter string. Here are some examples:
8342
A "Search-Type" of "name" with "Search-Rule" of "begins-with"
8343
is equivalent to the "custom-search-filter"
8347
When you try to match against the string "string" the program replaces
8348
the "%s" with "string" (without the quotes). You may have multiple "%s"'s and
8349
they will all be replaced with the string. There is a limit of 10 "%s"'s.
8351
A "Search-Type" of "name-or-email" with "Search-Rule"
8352
of "contains" is equivalent to
8354
(|(cn=*%s*)(mail=*%s*))
8357
If your server uses a different attribute <EM>name</EM> than
8358
<EM>Pine</EM> uses by default,
8359
(for example, it uses "rfc822mail" instead of "mail"),
8360
then you may be able to use one or more of the four attribute configuration
8361
options instead of defining a custom filter:
8363
<LI><A HREF="#email-attribute"><EM>email-attribute</EM></A>
8366
<LI><A HREF="#name-attribute"><EM>name-attribute</EM></A>
8369
<LI><A HREF="#surname-attribute"><EM>surname-attribute</EM></A>
8372
<LI><A HREF="#givenname-attribute"><EM>givenname-attribute</EM></A>
8378
<H2><A NAME="color-config"></A>Color Configuration</H2>
8380
If the terminal or terminal emulator you are using is capable of using
8381
color (see <A HREF="#color-style"><EM>color-style</EM></A> option),
8382
or if you are using <EM>PC-Pine</EM>, then it is possible to
8383
set up <EM>Pine</EM> so that various parts of the display will be
8384
shown in colors you configure.
8385
This is done using the Setup Color screen.
8386
The Setup Color screen is divided into four broad sections: Options,
8387
General Colors, Index Colors, and Header Colors.
8388
In addition to these four categories you may also color lines in the
8389
MESSAGE INDEX screen by configuring the
8390
<A HREF="#index-color-config">Index Line Color</A>.
8392
Each color is defined as a foreground color (the color of the actual text)
8393
and a background color (the color of the area behind the text).
8395
<H3><A NAME="color-options"></A>Color Options</H3>
8399
<DT> <A NAME="cur-il-style"><EM>current-indexline-style</EM></A>
8401
This option affects the colors used to display the current line in the
8402
MESSAGE INDEX screen.
8404
<A HREF="#index-color-config">Index Line Colors</A>
8405
defined, then this option will have no effect.
8408
The available options include:
8412
<DT>flip-colors</DT>
8413
<DD>This is the default.
8414
If an index line is colored because it matches one of your
8415
Index Color Rules, then its colors will be reversed when it is the currently
8417
For example, if the line is normally red text on a blue background, then
8418
when it is the current line it will be drawn as blue text on a red background.
8420
The rest of the option values all revert to this flip-colors behavior if
8421
there is no Reverse Color defined.
8425
<DD>With this option the Reverse color is always used to highlight the
8430
<DD>The foreground part of the Reverse Color is used to highlight
8432
If this would cause the text to be unreadable (because the foreground and
8433
background colors are the same) or if it would cause no change in the
8434
color of the index line, then the colors are flipped instead.
8436
Some people think this works particularly well if you use different
8437
background colors to emphasize "interesting" lines,
8438
but always with the same Normal foreground color,
8439
and you use a different foreground color for the Reverse Color.
8442
<DT>reverse-fg-no-ambiguity</DT>
8443
<DD>With the "reverse-fg" rule above, it is possible that
8444
the resulting color will be exactly the same as the regular Reverse
8446
That can lead to some possible confusion because an
8447
"interesting"
8448
line which is the current line will be displayed exactly the same as a
8449
non-interesting line which is current.
8450
You can't tell whether the line is just a regular current line or if it is
8451
an "interesting" current line by looking at the color.
8452
Setting the option to this value removes that ambiguity.
8453
It is the same as the "reverse-fg" setting unless the resulting
8454
interesting current line would look just like a non-interesting current line.
8455
In that case, the interesting line's colors are simply flipped (like in the
8458
As an alternative way to preserve the line's interestingness in this case,
8459
you may find that using both a different foreground and a different
8460
background color for the interesting line will help.
8464
<DD>The background part of the Reverse Color is used to highlight
8466
If this would cause the text to be unreadable (because the foreground and
8467
background colors are the same) or if it would cause no change in the
8468
color of the index line, then the colors are flipped instead.
8470
Some people think this works particularly well if you use different
8471
foreground colors to emphasize "interesting" lines,
8472
but always with the same Normal background color,
8473
and you use a different background color for the Reverse Color.
8476
<DT>reverse-bg-no-ambiguity</DT>
8477
<DD>As with the "reverse-fg" case, the "reverse-bg"
8478
rule may also result in a color which is exactly the same as the regular
8480
Setting the option to this value removes that ambiguity.
8481
It is the same as the "reverse-bg" setting unless the resulting
8482
current line has the same color as the Reverse Color.
8483
In that case, the interesting line's colors are simply flipped (like in the
8488
<DT> <A NAME="titlebar-style"><EM>titlebar-color-style</EM></A>
8490
This option affects the colors used to display the titlebar (the top
8491
line on the screen) when viewing a message.
8494
The available options include:
8499
<DD>The color of the titlebar will be the color you set for the
8500
<A HREF="#title-color"><EM>Title Color</EM></A>.
8501
The Title Color may be set by using the
8505
<DD>The color of the titlebar will be the same as the color of the
8506
index line corresponding to the message being viewed.
8507
The rules which determine what color the index line will be may be set
8508
up by going to the Setup/Rules/Indexcolor screen.
8509
If the index line for a message is not colored explicitly by the
8510
Indexcolor rules, then the titlebar will be colored the same as for
8511
the "default" option above (which is not the same color that
8512
the index line itself will have).
8515
<DT>reverse-indexline</DT>
8516
<DD>This is similar to the "indexline" option except the
8517
foreground and background colors from the corresponding index line will
8519
For example, if the index line color is red letters on a white background,
8520
then the titlebar will be white letters on a red background.
8521
If the index line for a message is not colored explicitly by the
8522
Indexcolor rules, then the titlebar will be colored the same as for
8523
the "default" option above (which is not the same color that
8524
the index line itself will have).
8531
<H3><A NAME="general-colors"></A>General Colors</H3>
8535
<DT> <A NAME="normal-color"><EM>Normal Color</EM></A>
8537
<DD> This is the color which most of the screen is painted in.
8540
<DT> <A NAME="reverse-color"><EM>Reverse Color</EM></A>
8542
<DD> The color <EM>Pine</EM> uses for reverse video characters.
8543
Actually, the name is misleading. This used to be reverse video and so
8544
the name remains. It is still used to highlight certain parts of the
8545
screen but the color may be set to whatever you'd like.
8548
<DT> <A NAME="title-color"><EM>Title Color</EM></A>
8550
<DD> The color <EM>Pine</EM> uses for the titlebar (the top line on the
8552
By default, the Title Color is the same as the Reverse Color.
8553
The actual titlebar color may be different from the Title Color if
8555
<A HREF="#titlebar-color-style"><EM>titlebar-color-style</EM></A>
8556
is set to some value other than default.
8559
<DT> <A NAME="status-color"><EM>Status Color</EM></A>
8561
<DD> The color <EM>Pine</EM> uses for messages written to the status
8562
message line near the bottom of the screen.
8563
By default, the Status Color is the same as the Reverse Color.
8566
<DT> <A NAME="keylabel-color"><EM>KeyLabel Color</EM></A>
8568
<DD> The color <EM>Pine</EM> uses for the labels of the commands in the
8569
two-line menu at the bottom of the screen.
8570
The label is the long name, for example, "PrevMsg".
8571
By default, the KeyLabel Color is the same as the Normal Color.
8573
WARNING: Some terminal emulators have the property that the screen will scroll
8574
down one line whenever a character is written to the character cell in the
8575
lower right corner of the screen.
8576
<EM>Pine</EM> can usually avoid writing a character in that corner of the screen.
8577
However, if you have defined a KeyLabel Color then <EM>Pine</EM> does have to write
8578
a character in that cell in order to color the cell correctly.
8579
If you find that your display sometimes scrolls up a line this could be
8581
The most obvious symptom is probably that the titlebar at the top of the
8582
screen scrolls off the screen.
8583
Try setting KeyLabel Color to Default to see if that fixes the problem.
8586
<DT> <A NAME="keyname-color"><EM>KeyName Color</EM></A>
8588
<DD> The color <EM>Pine</EM> uses for the names of the commands in the
8589
two-line menu at the bottom of the screen.
8590
The KeyName is the shorter name in the menu. For example, the "W"
8591
before the "WhereIs".
8592
By default, the KeyName Color is the same as the Normal Color.
8595
<DT> <A NAME="selectable-item-color"><EM>Selectable-item Color</EM></A>
8597
<DD> The color <EM>Pine</EM> uses for displaying selectable items, such
8599
By default, the Selectable-item Color is the same as the Normal Color, except
8603
<DT> <A NAME="quote-colors"><EM>Quote Colors</EM></A>
8605
<DD> The colors <EM>Pine</EM> uses for coloring quoted text in the
8606
MESSAGE TEXT screen.
8607
If a line begins with a > character (or space followed by >) it
8608
is considered a quote. That line will be given the Quote1 Color (first
8609
level quote). If there is a second level of quoting then the Quote2 Color
8610
will be used. <EM>Pine</EM> considers there to be a second level of quoting if
8611
that first > is followed by another > (or space followed by >).
8612
If there are characters other than whitespace and > signs, then it isn't
8613
considered another level of quoting. Similarly, if there is a third level
8614
of quoting the Quote3 Color will be used. If there are more levels after
8615
that the Quote Colors are reused. If you define all three colors then it
8616
would repeat like Color1, Color2, Color3, Color1, Color2, Color3, ...
8617
If you only define the first two it would be Color1, Color2,
8619
If you define only the Quote1 Color, then the entire quote would be
8620
that color regardless of the quoting levels.
8621
By default, the Quote Colors are not defined.
8624
<DT> <A NAME="signature-color"><EM>Signature Color</EM></A>
8626
<DD> The color <EM>Pine</EM> uses for coloring the signature in the MESSAGE TEXT
8627
screen. According to USENET conventions, the signature is defined as the
8628
paragraph following the "sigdashes", that is, the special line
8629
consisting of the three characters
8630
"-- " (i.e., dash, dash, and space). <EM>Pine</EM> allows for one
8631
empty line right after the sigdashes to be considered as part of the
8633
By default, the Signature Color is not defined, so will be the same as
8637
<DT> <A NAME="prompt-color"><EM>Prompt Color</EM></A>
8639
<DD> The color <EM>Pine</EM> uses for confirmation prompts and questions
8640
which appear in the status message line near the bottom of the screen.
8641
By default, the Prompt Color is the same as the Reverse Color.
8646
<H3><A NAME="index-colors"></A>Index Colors</H3>
8648
You may add color to the single character symbols which give the status
8649
of each message in the MESSAGE INDEX.
8650
By default the characters "+", "*", "D",
8651
"A", and "N" show up near the left hand side of the
8652
screen, depending on whether the message is addressed to you, and whether
8653
the message is marked Important, is Deleted, is Answered, or is New.
8654
You may set the color of those symbols.
8655
By default, all of these symbols are drawn with the same color as the rest
8656
of the index line they are a part of.
8658
Besides coloring the message status symbols, you may also color the
8660
This is done by using the
8661
<A HREF="#index-color-config">Index Line Color</A> configuration screen.
8662
It is also possible to color
8663
(<A HREF="#keywords">keywords</A>
8664
in the index using the
8665
Setup/Kolor screen (<A HREF="h_config_kw_color">Keyword Colors</A>).
8670
<DT> <A NAME="index-to-me-color"><EM>Index-to-me Symbol Color</EM></A>
8672
<DD> The color used for drawing the "+" symbol which signifies a
8673
message is addressed directly to you.
8676
<DT> <A NAME="index-important-color"><EM>Index-important Symbol Color</EM></A>
8678
<DD> The color used for drawing the "*" symbol which signifies a
8679
message has been flagged Important.
8682
<DT> <A NAME="index-deleted-color"><EM>Index-deleted Symbol Color</EM></A>
8684
<DD> The color used for drawing the "D" symbol which signifies a
8685
message has been marked Deleted.
8688
<DT> <A NAME="index-answered-color"><EM>Index-answered Symbol Color</EM></A>
8690
<DD> The color used for drawing the "A" symbol which signifies a
8691
message has been answered.
8694
<DT> <A NAME="index-new-color"><EM>Index-new Symbol Color</EM></A>
8696
<DD> The color used for drawing the "N" symbol which signifies a
8700
<DT> <A NAME="index-recent-color"><EM>Index-recent Symbol Color</EM></A>
8702
<DD> The color used for drawing the "R" symbol which signifies a
8703
message is Recent (only visible if the "IMAPSTATUS" token is
8705
<A HREF="#index-format"><EM>index-format</EM></A> option).
8708
<DT> <A NAME="index-unseen-color"><EM>Index-unseen Symbol Color</EM></A>
8710
<DD> The color used for drawing the "U" symbol which signifies a
8711
message is Unseen (only visible if the "IMAPSTATUS" token is
8713
<A HREF="#index-format"><EM>Index-Format</EM></A> option).
8718
<H3><A NAME="header-colors"></A>Header Colors</H3>
8720
You may add color to the header fields in the MESSAGE TEXT screen.
8721
For example, you may set the color of the contents of the Subject field
8725
there is an additional line on the configuration
8726
screen labeled "Pattern to match".
8727
If you leave that blank, then the whole field for that header will
8729
However, if you give a pattern to match, the coloring will only take place
8730
if there is a match for that pattern in the value of the field.
8731
For example, if you are working on a color for the Subject header and
8732
you fill in a pattern of "important", then only Subjects which
8733
contain the word "important" will be colored.
8734
For address fields like From or To, a pattern match will cause only the
8735
addresses which match the pattern to be colored.
8737
If the pattern you enter is a comma-separated list of patterns, then coloring
8738
happens if any of those patterns matches.
8741
<H3><A NAME="keyword-colors"></A>Keyword Colors</H3>
8743
Sets the colors <EM>Pine</EM> uses for Keyword fields in the MESSAGE INDEX screen.
8744
Keywords may be displayed as part of the Subject of a message by using
8745
the "SUBJKEY" or "SUBJKEYINIT" tokens in the
8746
<A HREF="#index-format">Index-Format</A> option.
8747
Keywords may also be displayed in a column of their own in the MESSAGE INDEX
8748
screen by using the "KEY" or "KEYINIT" tokens.
8750
For example, you might have set up a Keyword
8751
"Work" using the
8752
<A HREF="#keywords">Keywords</A>
8753
option in the Setup/Config screen.
8754
You could cause that Keyword to show up as a special color
8755
by setting up the Keyword Color using this option, and then including it
8756
in the MESSAGE INDEX screen using one of the tokens listed above in the
8760
<H3><A NAME="index-line-colors"></A>Index Line Colors</H3>
8762
You may color whole index lines by using roles.
8763
This isn't configured in the Setup Colors screen, but is configured in
8764
the <A HREF="#index-color-config">Setup Rules IndexColor</A> screen.
8766
<H2><A NAME="index-color-config"></A>Index Line Color Configuration</H2>
8768
Index Line Color causes lines in the MESSAGE INDEX screen to be colored.
8769
This action is only available if your terminal is capable of displaying
8770
color and color display has been enabled with the
8771
<A HREF="#color-style"><EM>Color-Style</EM></A> option.
8772
(In PC-Pine, color is always enabled so there is no option to turn on.)
8774
Each rule has a "Pattern",
8775
which is used to decide which of the rules is used; and the color which
8776
is used if the Pattern matches a particular message.
8778
<H3>Rule Patterns</H3>
8780
In order to determine whether or not a message matches a rule the message is
8781
compared with the rule's Pattern.
8782
These Patterns are the same for use with Roles, Filtering, Index Coloring,
8783
and Scoring, so are described in only one place,
8784
"<A HREF="#patterns-section">here</A>".
8786
<H3>Index Line Color</H3>
8788
This is the color that index lines are colored when there is a matching
8790
This colors the whole index line, except possibly the status letters
8791
which may be colored separately using
8792
the <A HREF="#color-config">Setup Kolor</A> screen.
8794
<H2><A NAME="role-config"></A>Role Configuration</H2>
8796
You may play different roles depending on who you are replying to.
8797
For example, if you are replying to a message addressed to <EM>help-desk</EM> you
8798
may be acting as a Help Desk Worker.
8799
That role may require that you use a different return address and/or
8800
a different signature.
8803
If you set up roles they work like this: Each role has a set of
8804
"Uses", which indicate whether or not a role is eligible to be
8805
considered for a particular use; a "Pattern",
8806
which is used to decide which of the eligible roles is used; and a set
8807
of "Actions", which are taken when that role is used.
8808
When you reply to a message, the message you are replying to is compared
8809
with the Patterns of the roles marked as eligible for use when replying.
8810
The comparisons start with the first eligible role and keep going until there
8812
If a match is found, the matching role's Actions are taken.
8816
There are three types of use to be configured;
8817
one for Replying, one for Forwarding, and one for Composing.
8818
These indicate whether or not you want a role to be considered when you
8819
type the Reply, Forward, or Compose commands.
8820
(The Role command is an alternate form of the Compose command, and it is
8821
not affected by these settings.)
8822
Each of these Use types has three possible values.
8823
The value "Never"
8824
means that the role will never be considered as a candidate for use with
8825
the corresponding command.
8826
For example, if you set a role's Reply Use to Never, then when you Reply to
8827
a message, the role won't even be considered.
8828
(That isn't quite true. If the message you are replying to matches some other
8829
role which requires confirmation,
8830
then there will be a ^T command available which allows you to select a role
8831
from all of your roles, not just the reply-eligible roles.)
8834
The options "With confirmation" and "Without confirmation"
8835
both mean that you do want to consider this role when using the corresponding
8837
For either of these settings the role's Pattern will
8838
be checked to see if it matches the message.
8839
For Reply Use, the message used to compare the Patterns with is the message
8841
For Forward Use, the message used to compare the Pattern with is the message
8843
For Compose Use, there is no message, so the parts of the Pattern which depend
8844
on a message (everything other than Current Folder Type) are ignored.
8845
In all cases, the Current Folder is checked if defined.
8846
If there is a match then this role will either be used without confirmation
8847
or will be the default when confirmation is asked for, depending on
8848
which of the two options is selected.
8849
If confirmation is requested, you will have a chance to
8850
choose No Role instead of the offered role, or to
8851
change the role to any one of your other roles (with the ^T command).
8853
<H3>Role Patterns</H3>
8855
In order to determine whether or not a message matches a role the message is
8856
compared with the Role Pattern.
8857
These Patterns are the same for use with Roles, Filtering, Index Coloring,
8858
and Scoring, so are described in only one place,
8859
"<A HREF="#patterns-section">here</A>".
8861
Since header patterns, AllText patterns, and BodyText patterns which are unset are ignored,
8862
a role which has all header patterns unset, the AllText pattern unset,
8863
the BodyText pattern unset,
8864
the Score Interval unset, and the Current Folder Type set to
8865
"Any" may be used as a default role.
8866
It should be put last in the list of roles since the matching
8867
starts at the beginning and proceeds until one of the roles is a match.
8868
If no roles at all match, then <EM>Pine</EM> will
8869
use its regular methods of defining the role.
8870
If you wanted to, you could define a different "default" role
8871
for Replying, Forwarding, and Composing by setting the
8872
"Use" fields appropriately.
8874
<H3>Role Actions</H3>
8876
Once a role match is found, the role's Actions are taken.
8877
For each role there are several possible actions that may be defined.
8878
They are actions to set the From address, the Reply-To address,
8879
the Fcc, the Signature file, and the Template file.
8881
<H4>Initialize Settings Using Role</H4>
8883
This is a power user feature.
8884
You will usually want to leave this field empty.
8885
The value of this field is the nickname of another one of your roles.
8886
The Action values from that other role
8887
are used as the initial values of the Action items for this role.
8888
If you put something in any of the action fields for this role, that will
8889
override whatever was in the corresponding field of the initializer role.
8891
You might use this field if the "Action" part of one of your roles
8892
is something you want to use in more than one role.
8893
Instead of filling in those action values again for each role, you
8894
may give the nickname of the role where the values are filled in.
8895
It's just a shortcut way to define Role Actions.
8897
Here's an example to help explain how this works.
8898
Suppose you have a role with nickname "role1" and role1 has
8899
(among other things)
8901
<CENTER><SAMP>Set Reply-To = The Pres <president@example.com></SAMP></CENTER>
8904
If in "role2" you set "Initialize settings using role" to
8905
"role1", then role2 will inherit the Set Reply-To value
8906
from role1 by default (and any of the other inheritable action values
8910
<CENTER><SAMP>Set Reply-To = <No Value Set></SAMP></CENTER>
8912
defined, the Reply-To used with role2 would be "The Pres <president@example.com>"
8913
However, if role2 had
8915
<CENTER><SAMP>Set Reply-To = VP <vicepresident@example.com></SAMP></CENTER>
8917
defined, then the Reply-To used with role2 would be "VP <vicepresident@example.com>" instead.
8920
you may choose a nickname from your list of roles by using the
8921
"T" command.
8922
If the role you are using to initialize also has a role it initializes from,
8923
then that initialization happens first.
8924
That is, inheritance works as expected with the grandparent and
8925
great-grandparent (and so on) roles having the expected effect.
8929
This field consists of a single address which will be used as the From
8930
address on the message you are sending.
8931
This should be a fully-qualified address like
8933
<CENTER><SAMP>Full Name <user@domain></SAMP></CENTER>
8937
<CENTER><SAMP>user@domain</SAMP></CENTER>
8939
If this is left blank, then the normal From address will be used.
8941
<H4>Set Reply-To</H4>
8943
The Reply-To address is the address used on the Reply-To line of the message
8945
You don't need a Reply-To address unless it is different from the From address.
8946
This should be a fully-qualified address like
8948
<CENTER><SAMP>Full Name <user@domain></SAMP></CENTER>
8952
<CENTER><SAMP>user@domain</SAMP></CENTER>
8954
If this is left blank, then there won't be a Reply-To address unless
8955
you have configured one specially with the
8956
<A HREF="#cust-hdr"><EM>customized-hdrs</EM></A>
8957
configuration option.
8959
<H4>Set Other-Hdrs</H4>
8961
This field gives you a way to set values for headers besides
8962
"From" and "Reply-To".
8963
If you want to set either of those, use the specific
8964
"Set From" and "Set Reply-To" settings.
8966
This field is similar to the
8967
<A HREF="#cust-hdr"><EM>customized-hdrs</EM></A> option.
8968
Each header you specify here must include the header tag
8969
("To:", "Approved:", etc.)
8970
and may optionally include a value for that header.
8971
In order to see these headers when you compose using this role you
8972
must use the rich header command.
8973
Here's an example which shows how you might set the To address.
8975
<CENTER><SAMP>Set Other Hdrs = To: Full Name <user@domain></SAMP></CENTER>
8977
Headers set in this way are different from headers set with the
8978
customized-hdrs option in that the value you give for a header here
8979
will replace any value that already exists.
8980
For example, if you are Replying to a message there will already be at
8981
least one address in the To header (the address you are Replying to).
8982
However, if you Reply using a role which sets the To header, that role's
8983
To header value will be used instead.
8984
The customized-hdrs headers are defaults.
8986
Limitation: Because commas are used to separate the list of
8987
Other Headers, it is not possible to have the value of a
8988
header contain a comma;
8989
nor is there currently an "escape" mechanism provided
8994
This field consists of a single folder name which will be used in
8995
the Fcc field of the message you are sending.
8996
You may put anything here that you would normally type into the Fcc
8997
field from the composer.
8999
In addition, an fcc of "" (two double quotation marks) means
9002
A blank field here means that <EM>Pine</EM> will use its normal rules for deciding
9003
the default value of the Fcc field.
9004
For many roles, perhaps most, it may make more sense for you to use the
9005
other <EM>Pine</EM> facilities for setting the Fcc.
9006
In particular, if you want the Fcc to depend on who you are sending the
9007
message to then the <A HREF="#fcc-name-rule"><EM>fcc-name-rule</EM></A>
9008
is probably more useful.
9009
In that case, you would want to leave the Fcc field here blank.
9010
However, if you have a role that depends on who the message you are replying
9011
to was From, or what address that message was sent to;
9012
then it might make sense to set the Fcc for that role here.
9014
<H4>Set LiteralSig</H4>
9016
This field contains the actual text for your signature, as opposed to
9017
the name of a file containing your signature.
9018
If this is defined it takes precedence over any value set in the
9019
<EM>Set Signature</EM> field.
9021
This is simply a different way to store the signature.
9022
The signature is stored inside your Pine configuration file instead of in
9023
a separate signature file.
9024
Tokens work the same way they do with <EM>Set Signature</EM>.
9027
The two character sequence \n (backslash followed by
9028
the character n) will be used to signify a line-break in your signature.
9029
You don't have to enter the \n, but it will be visible in the
9030
CHANGE THIS ROLE RULE window after you are done editing the signature.
9032
<H4>Set Signature</H4>
9034
The Signature is the name of a file to be used as the signature file when
9035
this role is being used.
9036
If the filename is followed by a vertical bar (|) then instead
9037
of reading the contents of the file the file is assumed to be a
9038
program which will produce the text to be used on its standard output.
9039
The program can't have any arguments and doesn't receive any input from <EM>Pine</EM>,
9040
but the rest of the processing works as if the contents came from a file.
9043
Signature files may be stored remotely on an IMAP server.
9044
In order to do that you just give the file a remote name.
9045
This works just like the regular
9046
<A HREF="#sig-file">signature-file</A>
9047
option which is configured from the Setup/Configuration screen.
9048
A remote signature file name might look like:
9050
<CENTER><SAMP>{myimaphost.myschool.k12.wa.us}mail/sig3</SAMP></CENTER>
9052
or, if you have an SSL-capable version of <EM>Pine</EM>, you might try
9054
<CENTER><SAMP>{myimaphost.myschool.k12.wa.us/user=loginname/ssl}mail/sig3</SAMP></CENTER>
9056
Once you have named the remote signature file you create its
9057
contents by using the "F" "editFile" command when the
9058
cursor is on the "Set Signature"
9059
line of the role editor.
9062
Besides containing regular text, a signature file may also
9063
contain (or a signature program may produce) tokens which are replaced with text
9064
which depends on the message you are replying to or forwarding.
9065
The tokens all look like _word_ (a word surrounded by underscores).
9066
For example, if the token
9068
<CENTER><SAMP>_DATE_</SAMP></CENTER>
9070
is included in the text of the signature file, then when you reply to
9071
or forward a message, the token will be replaced with the actual date
9072
the message you are replying to or forwarding was sent.
9074
If you use a role which has a signature file for a plain composition
9075
(that is, not a reply or forward) then there is no original message, so
9076
any tokens which depend on the message will be replaced with nothing.
9077
So if you want a signature file to be useful for new compositions it
9078
shouldn't include any of the tokens which depend on the message being
9079
replied to or forwarded.
9081
The list of available tokens is
9082
<A HREF="#index-tokens">here</A>.
9084
Actually, for the adventurous, there is a way to conditionally include text based
9085
on whether or not a token would result in specific replacement text.
9086
For example, you could include some text based on whether or not
9087
the _NEWS_ token would result in any newsgroups if it was used.
9088
It's explained in detail
9089
<A HREF="#reply-token-conditionals">here</A>.
9091
In the very unlikely event that you want to include a literal token in
9092
a signature file, you must precede it with a backslash character.
9093
For example, to include the literal text _DATE_ you must actually use
9095
It is not possible to have a literal backslash followed by an expanded token.
9097
A blank field here means that <EM>Pine</EM> will use its normal rules for deciding
9098
which file (if any) to use for the signature file.
9100
<H4>Set Template</H4>
9102
A Template is the name of a file to be included in the message when this
9104
The template file is a file which is included at the top of the message you
9107
If the filename is followed by a vertical bar (|) then instead
9108
of reading the contents of the file the file is assumed to be a
9109
program which will produce the text to be used on its standard output.
9110
The program can't have any arguments and doesn't receive any input from <EM>Pine</EM>,
9111
but the rest of the processing works as if the contents came from a file.
9113
Template files may be stored remotely on an IMAP server.
9114
In order to do that you just give the file a remote name.
9115
This works just like the regular
9116
<A HREF="#sig-file">signature-file</A>
9117
option which is configured from the Setup/Configuration screen.
9118
A remote template file name might look like:
9120
<CENTER><SAMP>{myimaphost.myschool.k12.wa.us}mail/templ3</SAMP></CENTER>
9122
or, if you have an SSL-capable version of <EM>Pine</EM>, you might try
9124
<CENTER><SAMP>{myimaphost.myschool.k12.wa.us/user=loginname/ssl}mail/templ3</SAMP></CENTER>
9126
Once you have named the remote template file you create its
9127
contents by using the "F" "editFile" command when the
9128
cursor is on the "Set Template"
9129
line of the role editor.
9131
Besides containing regular text, a template file may also
9132
contain (or a template file program may produce) tokens which are replaced with text
9133
which depends on the message you are replying to or forwarding.
9134
The tokens all look like _word_ (a word surrounded by underscores).
9135
For example, if the token
9137
<CENTER><SAMP>_DATE_</SAMP></CENTER>
9139
is included in the text of the template file, then when you reply to
9140
or forward a message, the token will be replaced with the actual date
9141
the message you are replying to or forwarding was sent.
9143
If you use a role which has a template file for a plain composition
9144
(that is, not a reply or forward) then there is no original message, so
9145
any tokens which depend on the message will be replaced with nothing.
9146
So if you want a template file to be useful for new compositions it
9147
shouldn't include any of the tokens which depend on the message being
9148
replied to or forwarded.
9150
The list of available tokens is
9151
<A HREF="#index-tokens">here</A>.
9153
Actually, for the adventurous, there is a way to conditionally include text based
9154
on whether or not a token would result in specific replacement text.
9155
For example, you could include some text based on whether or not
9156
the _NEWS_ token would result in any newsgroups if it was used.
9157
It's explained in detail
9158
<A HREF="#reply-token-conditionals">here</A>.
9160
In the very unlikely event that you want to include a literal token in
9161
a template file, you must precede it with a backslash character.
9162
For example, to include the literal text _DATE_ you must actually use
9164
It is not possible to have a literal backslash followed by an expanded token.
9166
A blank field here means that <EM>Pine</EM> will not use a template file when
9167
this role is being used.
9169
<H4>Use SMTP Server</H4>
9171
If this field has a value, then it will be used as the SMTP server
9172
to send mail when this role is being used (unless the SMTP server variable
9173
is set in the system-wide fixed configuration file).
9174
It has the same semantics as the
9175
<A HREF="#smtp-server"><EM>smtp-server</EM></A>
9176
variable in the Setup/Config screen.
9177
When you postpone the composition this SMTP server list will be saved
9178
with the postponed composition and it cannot be changed later.
9179
Because of that, you may want to make this a list of SMTP servers
9180
with the preferred server at the front of the list and alternate servers
9184
If any of the actions are left unset, then the action depends on what
9185
is present in the "Initialize settings using role" field.
9186
If you've listed the nickname of another one of your roles there, then the
9187
corresponding action from that role will be used here.
9188
If that action is also blank, or if there is no nickname specified,
9189
then <EM>Pine</EM> will do whatever it normally does to set these actions.
9190
This depends on other configuration options and features you've set.
9192
<H2><A NAME="filter-config"></A>Filtering Configuration</H2>
9194
The software which actually delivers mail (the stuff that happens
9195
before <EM>Pine</EM> is involved) for you is in a better position to do mail filtering
9196
than <EM>Pine</EM> itself.
9197
If possible, you may want to look into using that sort of mail filtering to
9198
deliver mail to different folders, delete it, or forward it.
9199
However, if you'd like <EM>Pine</EM> to help with this, <EM>Pine</EM>'s filtering is for you.
9201
Filtering is a way to automatically move certain messages from one folder
9202
to another or to delete messages.
9203
It can also be used to set message status bits (Important, Deleted, New,
9205
<EM>Pine</EM> doesn't have the ability to forward mail to another address.
9207
Each filtering rule has a "Pattern" and a "Filter Action".
9208
When a folder is opened, when new mail arrives in an open folder, or
9209
when mail is Expunged from a folder; each
9210
message is compared with the Patterns of your filtering rules.
9211
The comparisons start with the first rule and keep going until there
9213
If a match is found, the message may be deleted or moved, depending on
9214
the setting of the Filter Action.
9215
If the message is not deleted, it may have its status altered.
9217
For efficiency, each message is usually only checked once.
9218
When new mail arrives, the new messages are checked but not the old.
9219
There are some exceptions to this rule.
9220
The expunge command will cause all messages to be rechecked, as will
9221
editing of the filtering rules.
9225
When setting up a Pattern used to delete messages,
9226
it is recommended that you test the Pattern first with a "Move"
9228
case unintended matches occur. Messages that are deleted will be removed
9229
from the folder and <EM>unrecoverable</EM> from within <EM>Pine</EM> after the
9230
next Expunge command or once the folder being filtered has been closed.
9232
<H3>Filter Patterns</H3>
9234
In order to determine whether or not a message matches a filter the message is
9235
compared with the Filter's Pattern.
9236
These Patterns are the same for use with Roles, Filtering, Index Coloring,
9237
Scoring, and Other Rules, so are described in only one place,
9238
"<A HREF="#patterns-section">here</A>".
9240
Since filtering is a potentially destructive action, if you have a filtering
9241
Pattern with nothing other than Current Folder Type set, that filtering
9244
<H3>Filter Actions</H3>
9246
Once a filter match is found for a particular message, there are some actions
9248
First, the message may have its status changed.
9249
This is the same message status that you can manipulate manually using the
9251
There are four elements of message status that you can control.
9252
You can set or clear the Important status, the New status, the Deleted
9253
status, and the Answered status.
9254
Of course, if the filter is going to delete the message,
9255
then there is no point in setting message status.
9256
You may also set or clear user-defined
9257
<A HREF="#keywords">keywords</A> for a message.
9259
Second, the filter may delete or move the message.
9260
Deleting the message marks it Deleted and removes it from view.
9261
It is effectively gone forever (though it technically is still there until
9262
the next expunge command, which may happen implicitly).
9263
Moving the message moves it from the open folder into the folder
9264
listed on the "Folder List" line of the filter configuration.
9265
If you list more than one folder name (separated by commas) then the message
9266
will be copied to each of those folders.
9267
In any case, if "Delete" or "Move" is set then the
9268
message is removed from the current folder.
9269
If you just want to set the messages status without deleting it from
9270
the folder, then set the filter action to
9271
"Just Set Message Status".
9273
(There is no way to do a Copy instead of a Move, due to the difficulties
9274
involved in keeping track of whether or not a message has
9275
already been copied by a previous <EM>Pine</EM> session.)
9277
<H4><A NAME="move-only-if-not-deleted"></A>Move-only-if-not-deleted option</H4>
9279
If you have specified a Move to Folder to filter messages into, then this
9280
option has an effect.
9281
If this option is set then messages will only be moved into the specified folder
9282
if they aren't already marked deleted.
9283
This might be useful if you have more than one <EM>Pine</EM> session running
9284
simultaneously and you don't want messages to be filtered into a folder
9286
This method is not foolproof.
9287
There may be cases where a message gets marked deleted and so it is never
9288
filtered into the folder.
9289
For example, if you deleted it in another <EM>Pine</EM> or
9290
another mail program that didn't know about the filtering rule.
9292
This option has no effect if the Filter Action is not set to Move.
9294
<H4><A NAME="dont-quit-even-if-rule-matches"></A>Dont-quit-even-if-rule-matches option</H4>
9296
If this option is set then this is a non-terminating rule.
9297
Usually, for each message, <EM>Pine</EM> searches through the filter rules until
9298
a match is found and then it performs the action associated with that rule.
9299
Rules following the match are not considered.
9300
If this option is set then the search for matches will continue at the next
9303
If a non-terminating rule matches then the actions associated with
9304
that rule, except for any implied deletion of the message, are performed
9305
before the match for the next rule is checked.
9306
For example, if the non-terminating rule sets the Important status, then that
9307
status will be set when the next rule is considered.
9308
However, if the non-terminating rule Moves the message, the message will
9309
actually be copied instead of copied and deleted so that it is still there
9311
A moved message is deleted after all the relevant rules have been checked.
9312
The name of the "Move" action is confusing in this case because
9313
a single message can be moved to more than one folder.
9314
It turns the Move into a Copy instead, but it is still followed by a deletion
9317
This option may be useful if you want to have a single message filtered to
9318
two different folders because it matches two different Patterns.
9319
For example, suppose you normally filter messages to a particular mailing
9320
list into one folder, and messages addressed directly to you into a second
9322
If a message is sent to both you and the list (and you can tell that by
9323
looking at the headers of the message) this option may give you a convenient
9324
way to capture a copy to each folder.
9325
(It may also cause you to capture two copies to each folder,
9326
depending on whether your mail system delivers one or two copies of the
9327
message to you and on how the list works.)
9329
<H2><A NAME="scoring-config"></A>Scoring Configuration</H2>
9331
Most people will not use scores at all, but if you do use them, here's how
9333
Using this screen, you may define Scoring rules.
9334
The score for a message is calculated by looking at every Score rule defined
9335
and adding up the Score Values for the ones which match the message.
9336
If there are no matches for a message, it has a score of zero.
9337
Message scores may be used a couple of ways in Pine.
9339
<H3>Sorting by Score</H3>
9341
One of the methods you may use to sort message indexes is to sort by
9343
The scores of all the messages in a folder will be calculated and then
9344
the index will be ordered by placing the messages in order of ascending or
9347
<H3>Scores for use in Patterns</H3>
9349
The Patterns used for Roles, Index Line Coloring, and Filtering have a
9350
category labeled "Score Interval".
9351
When a message is being compared with a Pattern to check for a match, if
9352
the Score Interval is set only messages which have a score somewhere in
9353
the interval are a match.
9355
<H3>Scoring Rule Patterns</H3>
9357
In order to determine whether or not a message matches a scoring rule
9358
the message is compared with the rule's Pattern.
9359
These Patterns are the same for use with Roles, Filtering, Index Coloring,
9360
and Scoring, so are described in only one place,
9361
"<A HREF="#patterns-section">here</A>".
9364
Actually, Scoring rule Patterns are slightly different from the other types of
9365
Patterns because Scoring rule Patterns don't contain a Score Interval.
9366
In other words, when calculating the score for a message, which is done
9367
by looking at the Scoring rule Patterns, scores aren't used.
9369
<H3>Score Value</H3>
9371
This is the value that will be added to the score for a message if the
9372
rule's Pattern is a match.
9373
Each individual Score Value is an integer between -100 and 100, and the
9374
values from matching rules are added together to get a message's score.
9376
<H2><A NAME="other-config"></A>Other Rules Configuration</H2>
9378
Using this screen, you may define configuration Rules which don't fit
9379
nicely into the other Rules categories.
9381
<H3>Other Rule Patterns</H3>
9383
Other Rules are a little different from the rest of the Rules because
9384
they depend only on the current folder, and not on a particular message.
9385
In order to determine whether or not a rule's actions should be applied
9386
the current folder is compared with the rule's Pattern, which consists
9387
of only the Current Folder Type.
9388
Current Folder Type works the same for Other Rules as it does for Roles,
9389
Filtering, Index Coloring, and Scoring.
9390
Keep in mind that the only part of the Pattern which applies to Other
9391
Rules is the Current Folder Type when looking at the description of
9393
"<A HREF="#patterns-section">here</A>".
9395
<H3>Other Rule Actions</H3>
9397
Once a pattern match is found, the rule's Actions are taken.
9398
Neither of the following two rule's depends on a message for its match.
9399
That means that all the parts of the Pattern which depend on matching an
9400
attribute of a message are ignored.
9401
So the only part of the Pattern that matters for these Actions is
9402
the Current Folder Type.
9404
<H4>Set Sort Order</H3>
9406
When you enter a new folder, these rules will be checked to see if you
9407
have set a sort order which is different from your default sort order.
9408
The default is set in the Setup/Config screen with
9409
the <A HREF="#sort-key">Sort-Key</A> option.
9410
If the Sort Order action is set, then the folder will be displayed sorted in
9411
that sort order instead of in the default order.
9413
A possible point of confusion arises when you change the configuration
9414
of the Sort Order for the currently open folder.
9415
The folder will normally be re-sorted when you go back to viewing the
9417
However, if you have manually sorted the folder with the
9418
Sort command, it will not be re-sorted.
9420
<H4>Set Index Format</H3>
9422
When you enter a new folder, these rules will be checked to see if you
9423
have set an Index Format which is different from your default Index Format,
9424
which is set with the
9425
<A HREF="#index-format"><EM>Index-Format</EM></A> option.
9426
If so, the index will be displayed with this format instead of the default.
9428
<H4>Set Startup Rule</H4>
9430
When you enter a new folder, these rules will be checked to see if you
9431
have set a startup rule which is different from the default startup rule.
9432
The default for incoming folders is set in the Setup/Config screen with
9433
the "incoming-startup-rule" option.
9434
The default for folders other than INBOX that are not part of your
9436
(see <A HREF="#enable-incoming-folders">enable-incoming-folders</A> feature)
9437
is to start with the last message in the folder.
9438
If the Startup Rule is set to something other than "default",
9439
then the rule will determine which message will be the current message when
9440
the folder is first opened.
9442
The various startup rule possibilities work the same here as they do in
9443
the incoming collection, except that the folder can be any specific
9444
folder or any folder type.
9446
<H2><A NAME="patterns-section"></A>Patterns</H2>
9448
Patterns are used with Roles, Filtering, Index Coloring,
9449
Scoring, and Other Rules.
9450
Patterns are compared with a message to see if there is a match.
9451
For Filtering, the messages being checked are all the messages in the
9452
folder, one at a time.
9453
For Index Line Coloring, each message that is visible on the screen is
9454
checked for matches with the Index Coloring Patterns.
9455
Roles are used with the Reply, Forward, and Compose commands.
9456
For Reply, the message used to compare the Pattern with is the message
9458
for Forward, the message used to compare the Pattern with is the message
9460
and for Compose, there is no message, so the parts of the Pattern which depend
9461
on a message (everything other than Current Folder Type and the
9462
Beginning of Month and Year)
9464
Only the Current Folder Type matters for Compose (plus the Beginning of
9465
Month or Year, which you wouldn't usually use for a Role).
9466
For Scoring, the message being scored is compared with all of the Score
9467
Patterns, and the Score Values from the ones that match are added together to
9468
get the message's score.
9469
For Other Rules, there is no message. Only the Current Folder Type is checked
9472
Each Pattern has several possible parts, all of which are optional.
9473
In order for there to be a match, <EM>ALL</EM> of the
9474
<EM>defined</EM> parts of the Pattern must match the message.
9475
If a part is not defined it is considered a match.
9476
For example, if the To pattern is not defined it will be
9479
<CENTER>To pattern = <No Value Set></CENTER>
9481
That is considered a match because it is not defined.
9482
This means that the Pattern with nothing defined is a match if the
9483
Current Folder Type matches, but there is an exception.
9484
Because filtering is a potentially destructive action, filtering Patterns
9485
with nothing other than Current Folder Type defined are ignored.
9486
If you really want a filtering Pattern to match all messages (subject to
9487
Current Folder Type) the best way to do it is to define a Score interval
9488
which includes all possible scores.
9489
This would be the score interval <SAMP>(-INF,INF)</SAMP>.
9490
This can be used even if you haven't defined any rules to Set Scores.
9492
There are six predefined header patterns called the To, From, Sender, Cc, News,
9493
and Subject patterns.
9494
Besides those six predefined header patterns, you may add
9495
additional header patterns with header fieldnames of your choosing.
9496
You add an extra header pattern by placing the cursor on one of the
9497
patterns while in the role editor and using the "eXtraHdr" command.
9498
The Recip pattern is a header pattern which stands for Recipient (To OR Cc)
9499
and the Partic pattern is a header pattern which stands for
9500
Participant (From OR To OR Cc).
9501
(Defining the Recip pattern does not have the same effect as defining both
9502
the To and Cc patterns. Recip is To <EM>OR</EM> Cc, not To <EM>AND</EM> Cc.)
9503
Similar to the header patterns are the AllText pattern and the BodyText pattern.
9504
Instead of comparing this pattern's text against only the contents of
9505
a particular header field, the text for the AllText pattern is compared
9506
with text anywhere in the message's header or body, and the text for the
9507
BodyText pattern is compared with text anywhere in the message's body.
9509
Any of the header patterns, the AllText pattern, or the BodyText pattern may be negated with the
9510
"!" "toggle NOT" command.
9511
You can tell that <EM>NOT</EM> has been turned on by looking for the character
9512
"!" at the beginning of the pattern line.
9513
When the "!" is present, it reverses the meaning of the match.
9514
That is, if the pattern matches then it is considered to NOT be a match, and
9515
if it does not match it is considered to be a match.
9517
Don't make the mistake of putting the "!" in the data field for
9519
For example, if you type the characters "!urgent" into the Subject
9520
pattern, the pattern will look like:
9523
Subject pattern = !urgent
9526
This means you want to match the 7 character sequence "!urgent".
9527
In order to match messages which do not have "urgent" in
9528
their Subject field, first type the characters "urgent" followed
9529
by carriage return for the value of the Subject pattern, then negate it
9530
by typing the "!" command.
9534
! Subject pattern = urgent
9537
The contents of each of these header patterns (or the AllText or BodyText patterns) may
9538
be a complete email address, part of an address, or a random set of
9539
characters to match against.
9540
It may also be a list of such patterns, which means you
9541
are looking for a match against the first pattern in the list <EM>OR</EM>
9542
the second pattern <EM>OR</EM> the third and so on.
9543
For example, a Subject pattern equal to
9546
Subject pattern = urgent
9551
would match all messages with a subject which contained at least one
9553
It would also match subjects containing the words "alerts" or
9554
"Urgently".
9556
The same example with "NOT" turned on would be
9559
! Subject pattern = urgent
9564
which would match all messages with a subject which did NOT contain any of
9566
You can use the "Add Value" command to add new words to the list,
9567
or you can enter them as a comma-separated list.
9569
(It is not possible to specify two patterns which must <EM>BOTH</EM> be
9570
present for a match.
9571
It is only possible to specify that <EM>EITHER</EM> pattern1 <EM>OR</EM>
9572
pattern2 must be present,
9573
and that is exactly what using a list does.)
9575
The "Current Folder Type" and the "Score Interval" are
9576
also part of the Pattern, although the "Score Interval" is not used
9577
when checking for matches for Scoring.
9578
There are five similar settings which relate to the status of the message.
9579
These settings rely on the message being New or not, Deleted or not,
9580
Answered or not, Important or not, and Recent or not.
9581
There are also some other miscellaneous settings.
9582
The first is the Age of the message in days.
9583
Another is the Size of the message in bytes.
9584
The third is a setting which detects whether or not the Subject of a
9585
message contains raw 8-bit characters (unencoded characters with the most
9586
significant bit set).
9587
There is a setting which detects whether or not this is the first time
9588
<EM>Pine</EM> has been run this month (doesn't depend on individual messages),
9589
and another which detects whether or not this is the first time <EM>Pine</EM> has
9591
Other parts of the Pattern detect whether or not the From address of a
9592
message appears in your address book, whether or not certain keywords
9593
are set for a message, and whether or not certain character sets are
9596
<H3>Parts of a Pattern</H3>
9598
<H4>Header patterns</H4>
9600
A header pattern is simply text which is searched for in the corresponding
9602
For example, if a Pattern has a From header pattern with the value
9603
"@company.com", then only messages which have a From header
9604
which contains the text "@company.com" will be possible
9606
Matches don't have to be exact.
9607
For example, if the relevant field of a message contains the text
9608
"mailbox@domain" somewhere
9609
in it, then header patterns of "box", or "x@d", or
9610
"mailbox@domain" are all matches.
9612
All parts of the Pattern must match so, for example,
9613
if a message matches a defined
9614
From pattern, it still must be checked against the other parts of the
9615
Pattern which have been defined.
9616
The To header pattern is a slightly special case.
9617
If the message being checked has a Resent-To header, the addresses
9618
there are used in place of the addresses in the To header.
9619
This is only true for the To header.
9620
Resent-cc and Resent-From headers are never used unless you add them
9621
with the eXtraHdrs command.
9623
The meaning of a header pattern may be negated with the
9624
"!" "toggle NOT" command.
9625
You can tell that <EM>NOT</EM> has been turned on by looking for the character
9626
"!" at the beginning of the pattern line.
9627
It would look something like
9630
! From pattern = susan@example.com
9633
When the "!" is present, it reverses the meaning of the match.
9635
If you want to check for the presence of a header field but don't care
9636
about its value, then
9637
the empty pattern which you get by entering a pair of
9638
double quotes ("") should match any message which
9639
has the corresponding header field.
9641
<H4><A NAME="pattern_alltext">AllText patterns</A></H4>
9643
AllText patterns are just like header patterns except that the text is
9644
searched for anywhere in the message's headers or body, not just in the
9645
contents of a particular header field.
9648
<H4><A NAME="pattern_bodytext">BodyText patterns</A></H3>
9650
BodyText patterns are just like header patterns except that the text is
9651
searched for anywhere in the message's body, not just in the
9652
contents of a particular header field.
9655
If there is more than one header pattern or AllText pattern or BodyText pattern
9656
for which you want to take the
9657
same action there is a shorthand notation which may be used.
9658
Any of these patterns may be a list of patterns instead of
9659
just a single pattern.
9660
If any one of the patterns in the list matches the message
9661
then it is considered a match.
9662
For example, if "company1" and "company2" both required
9663
you to use the same role when replying to messages, you might have
9664
a To pattern which looks like
9667
To pattern = company1.com
9671
This means that if the mail you are replying to was addressed to
9672
either "anything@company1.com" or "anything@company2.com",
9673
then this Pattern is a match and the same actions will be taken.
9675
The meaning of an AllText or BodyText pattern may be negated with the
9676
"!" "toggle NOT" command.
9677
You can tell that <EM>NOT</EM> has been turned on by looking for the character
9678
"!" at the beginning of the pattern line.
9679
When the "!" is present, it reverses the meaning of the match.
9681
A technicality: Since comma is the character used to separate multiple values
9682
in any of the fields which may have multiple values (such as header patterns,
9683
AllText patterns, BodyText patterns, keywords, folder lists, and so on),
9684
you must escape comma with a
9685
backslash (\) if you want to include a literal comma in one of those fields.
9686
In other words, if you type a backslash followed by a comma it will
9687
be interpreted as a comma by <EM>Pine</EM>, instead of as a separator between
9689
All other backslashes (those not followed by a comma) are literal
9690
backslashes and should not be escaped.
9691
It's unlikely you'll ever need to enter a literal comma or backslash in
9692
any of the patterns.
9694
<H4>Current Folder Type</H4>
9696
The "Current Folder Type" may be set to one of four different
9697
values: "Any", "News", "Email", or
9698
"Specific".
9699
If the value is set to "News", then the
9700
Pattern will only match if the currently open folder is a newsgroup.
9701
The value "Email" only matches if the current folder is not news and
9702
the value "Any" causes any folder to match.
9703
If the value of "Current Folder Type" is set to "Specific",
9704
then you must fill in a value for "Folder", which is on the line
9705
below the "Specific" line.
9706
In this case you will only get a match if the currently open folder is
9707
the specific folder you list.
9708
You may give a list of folders instead of just a single
9709
folder name, in which case the Pattern will match if the open folder is
9710
any one of the folders in the list.
9711
The name of each folder in the list may be either "INBOX",
9712
the technical specification
9713
of the folder (like what appears in your configuration file) or, if the
9714
folder is one of your incoming folders, it may be the nickname you've given
9716
Here are some samples of specific folder names:
9718
<CENTER><SAMP>{monet.art.example.com}mail/art-class</SAMP></CENTER>
9720
<CENTER><SAMP>{news.example.com/nntp}#news.comp.mail.pine</SAMP></CENTER>
9722
<CENTER><SAMP>mail/local-folder</SAMP></CENTER>
9724
The easiest way to fill in the "Folder" field is to use
9725
the "T" command which is available when the "Folder" line is
9726
hilighted, or to use the "Take" command with the configuration
9728
<A HREF="#enable-rules-under-take">"enable-rules-under-take"</A>
9731
When reading a newsgroup, there may be a performance penalty
9732
incurred when collecting the information necessary to check whether
9733
or not a Pattern matches a message.
9734
For this reason, the default Current Folder Type is set to "Email".
9735
If you have Patterns with a Current Folder Type of either
9736
"Any" or "News" and those Patterns are used for
9737
Index Line Coloring or Scoring, you may experience
9738
slower screen redrawing in the MESSAGE INDEX screen when in a newsgroup.
9740
<H4>Age Interval</H4>
9742
The "Age Interval" may be set to an interval of message
9743
ages which should be considered a match.
9744
Like the other parts of the Pattern, if it is unset it will be ignored.
9745
The Age Interval looks like
9747
<CENTER><SAMP>(min_age,max_age)</SAMP></CENTER>
9749
where "min_age" and "max_age" are integers greater
9750
than or equal to zero.
9751
The special value "INF" may be used for
9752
the max value. It represents infinity.
9754
Actually, this option may be defined as a list of intervals instead
9755
of just a single interval.
9756
The list is separated by commas.
9759
<CENTER><SAMP>(min_age1,max_age1),(min_age2,max_age2),...</SAMP></CENTER>
9761
When there is an Age Interval defined, it is a match if the age, in days, of
9762
the message is contained in any of the intervals.
9763
The intervals include both endpoints.
9765
Even though this option is called Age, it isn't actually
9766
the <EM>age</EM> of the message.
9767
Instead, it is how many days ago the message arrived in one of your folders.
9768
If the current time is a little past midnight, then a message that arrived
9769
just before midnight arrived yesterday, even though the message is only
9771
By default, the date being used is not the date in the Date
9772
header of the message.
9773
It is the date that the message arrived in one of your folders.
9774
When you Save a message from one folder to another that arrival date
9776
If you would like to use the date in the Date header that is possible.
9778
<EM>use-date-header-for-age</EM>
9779
near the bottom of the rule definition.
9781
A value of 0 is today, 1 is yesterday, 2 is the day before yesterday, and so on.
9783
<H4><A NAME="pattern_size_interval">Size Interval</A></H3>
9785
The "Size Interval" may be set to an interval of message
9786
sizes which should be considered a match.
9787
Like the other parts of the Pattern, if it is unset it will be ignored.
9788
The Size Interval looks like
9790
<CENTER><SAMP>(min_size,max_size)</SAMP></CENTER>
9792
where "min_size" and "max_size" are integers greater
9793
than or equal to zero.
9794
The special value "INF" may be used for
9795
the max value. It represents infinity.
9797
Actually, this option may be defined as a list of intervals instead
9798
of just a single interval.
9799
The list is separated by commas.
9802
<CENTER><SAMP>(min_size1,max_size1),(min_size2,max_size2),...</SAMP></CENTER>
9804
When there is a Size Interval defined, it is a match if the size, in bytes, of
9805
the message is contained in any of the intervals.
9806
The intervals include both endpoints.
9808
<H4>Score Interval</H4>
9810
The "Score Interval" may be set to an interval of message
9811
scores which should be considered a match.
9812
Like the other parts of the Pattern, if it is unset it will be ignored.
9813
The Score Interval looks like
9815
<CENTER><SAMP>(min_score,max_score)</SAMP></CENTER>
9817
where "min_score" and "max_score" are integers between
9819
The special values "-INF" and "INF" may be used for
9820
the min and max values to represent negative and positive infinity.
9822
Actually, a list of intervals may be used if you wish.
9823
A list would look like
9825
<CENTER><SAMP>(min_score1,max_score1),(min_score2,max_score2),...</SAMP></CENTER>
9827
When there is a Score Interval defined, it is a match if the score for
9828
the message is contained in any of the intervals in the list.
9829
The intervals include the endpoints.
9830
The score for a message is calculated by looking at every Score rule defined and
9831
adding up the Score Values for the ones which match the message.
9832
When deciding whether or not a Pattern matches a message for purposes of
9833
calculating the score, the Score Interval is ignored.
9835
<H4>Message Status</H4>
9837
There are five separate message status settings.
9838
By default, all five are set to the value "Don't care", which
9839
will match any message.
9840
The value "Yes" means that the particular status must be true
9841
for a match, and the value "No" means that the particular
9842
status must not be true for a match.
9843
For example, one of the five Message Status settings is whether a message
9844
is marked Important or not.
9845
A "Yes" means that the message must be Important to be
9846
considered a match and "No" means that the message must not be
9847
Important to be considered a match.
9848
The same is true of the other four message status settings which depend
9849
on whether or not the message is New; whether the message has
9850
been Answered or not; whether the message has been Deleted or not, and
9851
whether the message is Recent or not.
9852
The nomenclature is a bit confusing.
9853
New means that the message is Unseen.
9854
It could have been in your mailbox for a long time but if you haven't looked
9855
at it, it is still considered New.
9856
That matches the default <EM>Pine</EM> index display which shows an N for such a
9858
Recent means that the message was added to this folder since the last time
9859
you opened the folder.
9861
<H4>Message Keywords</H4>
9863
Keywords are similar to Message Status, but they are chosen by the user.
9864
Provided the mail server allows for it, you may add a set of possible keywords
9865
to a folder and then you may set those keywords or not for each message
9867
The syntax of this part of the Pattern is similar to the header patterns.
9868
It is a list of keywords.
9869
The Keyword part of the Pattern is a match if the message has any of
9870
the keywords in the list set.
9871
Like other parts of the Pattern, if this is unset it will be ignored.
9873
<H4>Message Character Set</H4>
9875
A message may use one or more character sets.
9876
This part of the Pattern matches messages which make use of one or more of
9877
the character sets specified in the pattern.
9878
It will be considered a match if a message uses any of the character
9879
sets in the list you give here.
9880
The syntax of this part of the Pattern is similar to the header patterns
9881
and the Message Keywords pattern.
9882
It is a list of character sets.
9885
Besides actual character set names (for example, ISO-8859-7, KOI8-R, or
9886
GB2312) you may also use some shorthand names that <EM>Pine</EM> provides.
9887
These names are more understandable shorthand names for sets of
9888
character set names.
9889
Two examples are "Cyrillic" and "Greek".
9890
Selecting one of these shorthand names is equivalent to selecting all of
9891
the character sets that make up the set.
9892
You can see all of these shorthand names and the lists of character sets
9893
they stand for by typing the "T" command with the Character
9894
Set pattern highlighted.
9895
The Character Set part of the Pattern is a match if the message uses any
9896
of the character sets in the list.
9897
Like other parts of the Pattern, if this is unset it will be ignored.
9899
<H4>Raw 8-bit in Subject</H4>
9901
It seems that lots of unwanted email contains unencoded 8-bit characters
9903
Normally, characters with the 8th bit set are not allowed in the Subject
9904
header unless they are MIME-encoded.
9905
This option gives you a way to match messages which have Subjects which
9906
contain unencoded 8-bit characters.
9907
Setting this option will affect performance in large folders because the
9908
subject of each message in the folder has to be checked.
9910
<H4>Beginning of Month</H4>
9912
This option gives you a way to take some action once per month.
9913
The value "Yes" means that this must be the first time <EM>Pine</EM> has
9914
been run this month in order to count as a match,
9916
<H4>Beginning of Year</H4>
9918
This option gives you a way to take some action once per year.
9919
The value "Yes" means that this must be the first time <EM>Pine</EM> has
9920
been run this year in order to count as a match,
9922
<H4>From or Reply-To address in Address Books</H4>
9924
This option gives you a way to match messages which have a From or
9926
which is in one of your address books.
9927
Only the simple entries in your address books are searched.
9928
Address book distribution lists are ignored!
9929
Setting this option will affect performance in large folders because the
9930
From and Reply-To of each message in the folder have to be checked.
9932
<H4>Categorizer Command</H4>
9934
This is a command that is run with its standard input set to the message
9935
being checked and its standard output discarded.
9936
The full directory path should be specified.
9937
The command will be run and then its exit status will be checked against
9938
the Exit Status Interval, which defaults to just the value zero.
9939
If the exit status of the command falls in the interval, it is considered
9940
a match, otherwise it is not a match.
9943
This option may actually be a list of commands.
9944
The first one that exists and is executable is used.
9945
That makes it possible to use the same configuration with Unix <EM>Pine</EM> and
9949
If none of the commands in the list exists and is executable then the rule
9950
is <EM>not</EM> a match.
9951
If it is possible that the command may not exist, you should be careful
9952
to structure your rules so that nothing destructive
9953
happens when the command does not exist.
9954
For example, you might have a filter that filters away spam when there is
9955
a match but does nothing when there is not a match.
9956
That would continue to work correctly if the command didn't exist.
9957
However, if you have a filter which filters away spam when there is not
9958
a match and keeps it when there is a match, that would filter everything
9959
if the categorizer command didn't exist.
9961
<H3><A NAME="help-for-pattern-config"></A>Help Configuring Pattern Fields</H3>
9965
<DT> <A NAME="role-nickname"><EM>Nickname</EM></A>
9967
<DD> This is a nickname to help you.
9968
You should have a different nickname for each role you define.
9969
The nickname will be used in the SETUP ROLE RULES screen to allow you to
9970
pick a role to edit.
9971
It will also be used when you send a message to let you know you are
9972
sending with a different role than you use by default, and
9973
it will be useful for choosing a role when composing with the Role command
9974
or when composing with one of the Role Uses set to With Confirmation.
9975
This field is not used in the outgoing message.
9978
<DT> <A NAME="role-comment"><EM>Comment</EM></A>
9980
<DD> This is a comment to help you.
9981
This comment does not play any functional role, it is simply an optional
9982
comment to help you remember what the rule is for.
9985
<DT> <A NAME="to-pattern"><EM>To pattern</EM></A>
9987
<DD> If this pattern is non-blank, then for this role to be considered a
9988
match, at least one of the recipients from
9989
the To line of the message being replied to or forwarded
9990
must match this pattern.
9991
In the case of the Compose command, this pattern and the other header
9992
patterns are ignored.
9993
If this pattern is a list of patterns, then at least one of the
9994
recipients must match at least one of the patterns.
9995
(Any other non-blank parts of the Pattern must match, too.)
9996
If the message being replied to or forwarded has a Resent-To header line,
9997
then that is used in place of the To line.
9998
(Note that this special Resent rule only applies to the To header. The
9999
Resent-From, Resent-Subject, and so on are not consulted.)
10001
It is possible to add a <EM>NOT</EM> to the To Pattern meaning with the
10002
"!" "toggle NOT" command.
10003
This changes the meaning of the To pattern so that it has the opposite meaning.
10004
It will be considered a match if there are no matches between the
10005
addresses in the To: line and the list of To patterns.
10007
Don't make the mistake of putting the "!" in the data field for
10009
For example, if you type the characters "!frizzle" into the To
10010
pattern, the pattern will look like:
10013
To pattern = !frizzle
10016
This means you want to match the 8 character sequence "!frizzle".
10017
In order to match messages which do not have "frizzle" in
10018
their To field, first type the characters "frizzle" followed
10019
by carriage return for the value of the To pattern, then negate it
10020
by typing the "!" command.
10021
It should end up looking like
10024
! To pattern = frizzle
10028
<DT> <A NAME="from-pattern"><EM>From pattern</EM></A>
10030
<DD> This is just like the
10031
<A HREF="#to-pattern"><EM>To pattern</EM></A>
10032
except that it is compared with
10033
the address from the From header of the message being replied to or forwarded instead
10034
of the addresses from the To header.
10037
<DT> <A NAME="sender-pattern"><EM>Sender pattern</EM></A>
10039
<DD> This is just like the
10040
<A HREF="#to-pattern"><EM>To pattern</EM></A>
10041
except that it is compared with
10042
the address from the Sender header of the message being replied to or forwarded instead
10043
of the addresses from the To header.
10044
If there is no Sender header, then the From header is used instead.
10047
<DT> <A NAME="cc-pattern"><EM>Cc pattern</EM></A>
10049
<DD> This is just like the
10050
<A HREF="#to-pattern"><EM>To pattern</EM></A>
10051
except that it is compared with
10052
the address from the CC header of the message being replied to or forwarded instead
10053
of the addresses from the To header.
10056
<DT> <A NAME="news-pattern"><EM>News pattern</EM></A>
10058
<DD> If this pattern is non-blank, then for this role to be considered a
10059
match, at least one of the newsgroups from
10060
the Newsgroups line of the message must match this pattern.
10061
If this pattern is a list of patterns, then at least one of the
10062
newsgroups must match at least one of the patterns.
10063
(Any other non-blank parts of the Pattern must match, too.)
10066
<DT> <A NAME="subject-pattern"><EM>Subject pattern</EM></A>
10068
<DD> This is similar to the other header patterns.
10069
It is compared with
10070
the contents from the Subject of the message being replied to or forwarded.
10072
If you enter non-ascii characters in this field then the search will be
10073
done using the character set you have defined with the
10074
<A HREF="#char-set">Character-Set</A>
10075
configuration variable.
10076
(The truly sophisticated may use an alternate character set for a search
10077
by entering the MIME encoding of the header string here.)
10080
<DT> <A NAME="extra-header-patterns"><EM>Extra header patterns</EM></A>
10082
<DD> There isn't actually a field called Extra header patterns, but you
10083
may add extra header patterns by moving the cursor to one of the header
10084
patterns and using the "eXtraHdr" command to add a new header
10086
You would do this if the six predefined header patterns don't cover the
10087
header you want to use for pattern matching.
10088
Once you've added an extra header pattern, you use it just like the
10090
Of course, it is compared with
10091
the contents from the particular header field of the message being replied
10092
to or forwarded rather than the contents from the subject field.
10093
To remove an extra header pattern from a role, use the "RemoveHdr"
10094
command on the highlighted extra header.
10096
If you enter non-ascii characters in this field then the search will be
10097
done using the character set you have defined with the
10098
<A HREF="#char-set">Character-Set</A>
10099
configuration variable.
10100
(The truly sophisticated may use an alternate character set for a search
10101
by entering the MIME encoding of the header string here.)
10104
<DT> <A NAME="recip-pattern"><EM>Recipient pattern</EM></A>
10106
<DD> This is just like the
10107
<A HREF="#to-pattern"><EM>To pattern</EM></A>
10108
except that it is compared with
10109
the addresses from both the To header and the Cc header
10110
instead of just the addresses from the To header.
10111
It's equivalent to having two different rules;
10112
one with a To pattern and the other with the same Cc pattern.
10115
<DT> <A NAME="partic-pattern"><EM>Participant pattern</EM></A>
10117
<DD> This is just like the
10118
<A HREF="#to-pattern"><EM>To pattern</EM></A>
10119
except that it is compared with
10120
the addresses from the To header, the Cc header, and the From header
10121
instead of just the addresses from the To header.
10122
It's equivalent to having three different rules;
10123
one with a To pattern, another with the same Cc pattern, and another
10124
with the same From pattern.
10127
<DT> <A NAME="alltext-pattern"><EM>AllText pattern</EM></A>
10129
<DD> This is similar to the header patterns.
10130
Instead of comparing with text in a particular header field it is compared with
10131
all of the text in the message header and body.
10133
If you enter non-ascii characters in this field then the search will be
10134
done using the character set you have defined with the
10135
<A HREF="#char-set">Character-Set</A>
10136
configuration variable.
10137
(The truly sophisticated may use an alternate character set for a search
10138
by entering the MIME encoding of the header string here.)
10141
<DT> <A NAME="bodytext-pattern"><EM>BodyText pattern</EM></A>
10143
<DD> Just like AllText, except it is compared only with the body of the
10144
message, not the body and header.
10147
If you enter non-ascii characters in this field then the search will be
10148
done using the character set you have defined with the
10149
<A HREF="#char-set">Character-Set</A>
10150
configuration variable.
10151
(The truly sophisticated may use an alternate character set for a search
10152
by entering the MIME encoding of the header string here.)
10155
<DT> <A NAME="age-interval"><EM>Age Interval</EM></A>
10157
<DD>The Age Interval, if defined, is part of the Pattern.
10158
If you use this, it should be set to something like:
10160
<CENTER><SAMP>(min_age,max_age)</SAMP></CENTER>
10162
where "min_age" and "max_age" are non-negative integers.
10163
The special value "INF" may be used for the max value.
10164
It represents infinity.
10166
In rare cases it may be useful to use the more general form of the value,
10167
which is a comma-separated list of intervals.
10168
It would look something like:
10170
<CENTER><SAMP>(min_age1,max_age1),(min_age2,max_age2),...</SAMP></CENTER>
10172
When there is an Age Interval defined, it is a match if the age, in days, of
10173
the message is contained in the interval.
10174
The interval includes both endpoints.
10175
If the option is set to a list of intervals then it is a match if the
10176
age of the message is contained in any of the intervals.
10178
Even though this option is called Age, it isn't actually
10179
the <EM>age</EM> of the message.
10180
Instead, it is how many days ago the message arrived in one of your folders.
10181
If the current time is a little past midnight, then a message that arrived
10182
just before midnight arrived yesterday, even though the message is only
10184
By default, the date being used is not the date in the Date
10185
header of the message.
10186
It is the date that the message arrived in one of your folders.
10187
When you Save a message from one folder to another that arrival date
10189
If you would like to use the date in the Date header that is possible.
10191
<EM>use-date-header-for-age</EM>
10192
near the bottom of the rule definition.
10194
A value of 0 is today, 1 is yesterday, 2 is the day before yesterday, and so on.
10197
<CENTER><SAMP>(2,2)</SAMP></CENTER>
10199
matches all messages that arrived on the day before yesterday.
10202
<CENTER><SAMP>(180,INF)</SAMP></CENTER>
10204
matches all messages that arrived at least 180 days before today.
10207
<CENTER><SAMP>(0,1)</SAMP></CENTER>
10209
matches all messages that arrived today or yesterday.
10212
<DT> <A NAME="score-interval"><EM>Score Interval</EM></A>
10214
<DD> The Score Interval, if defined, is part of the Pattern.
10215
If you use this, it should be set to something like:
10217
<CENTER><SAMP>(min_score,max_score)</SAMP></CENTER>
10219
where "min_score" and "max_score" are integers between
10221
The special values "-INF" and "INF" can be used for
10222
the min and max values.
10223
These represent negative and positive infinity.
10225
Actually, the value may be a list of intervals rather than just a
10226
single interval if that is useful.
10227
The elements of the list are separated by commas like:
10229
<CENTER><SAMP>(min_score1,max_score1),(min_score2,max_score2),...</SAMP></CENTER>
10231
When there is a Score Interval defined, it is a match if the score for
10232
the message is contained in any of the intervals.
10233
The intervals include both endpoints.
10234
The score for a message is calculated by looking at every scoring rule
10235
defined and adding up the Score Values for the rules which match the message.
10238
<DT> <A NAME="keyword-pattern"><EM>Keyword pattern</EM></A>
10240
<DD> A folder may have user-defined keywords.
10241
These are similar to the Important flag which the user may set using the
10243
The difference is that the Important flag is always present for each folder.
10244
User-defined keywords are picked by the user.
10245
You may add new keywords by defining them in the
10246
<A HREF="#keywords">Keywords</A> option in the Setup/Config screen.
10247
After you have added a potential keyword with the Keywords option,
10248
the Flag command may be used to set or clear the keyword on individual messages.
10249
If you have given a keyword a nickname when configuring it,
10250
that nickname may be used instead of the actual keyword.
10253
When filling in a value for this field, it may be easiest to use
10254
the "T" command, which presents you with a list of the keywords
10255
you have defined to choose from.
10258
This part of the Pattern matches messages with certain keywords set.
10259
It will be considered a match if a message has any of the keywords in the
10263
It is possible to add a <EM>NOT</EM> to the Keyword Pattern meaning with the
10264
"!" "toggle NOT" command.
10265
This changes the meaning of the Keyword pattern so that it has the opposite meaning.
10266
It will be considered a match if none of the keywords in the list are set
10269
Don't make the mistake of putting the "!" in the data field for
10271
For example, if you type the characters "!frizzle" into the Keyword
10272
pattern, the pattern will look like:
10275
Keyword pattern = !frizzle
10278
This means you want to match the 8 character sequence "!frizzle".
10279
In order to match messages which do not have the keyword "frizzle"
10280
set, first type the characters "frizzle" followed
10281
by carriage return for the value of the Keyword pattern, then negate it
10282
by typing the "!" command.
10283
It should end up looking like
10286
! Keyword pattern = frizzle
10290
<DT> <A NAME="charset-pattern"><EM>Character Set pattern</EM></A>
10292
<DD> A message may use one or more character sets.
10293
This part of the Pattern matches messages which make use of
10294
certain specified character sets.
10295
It will be considered a match if a message uses any of the character
10296
sets in the list you give here.
10299
When filling in a value for this field, you may use
10300
the "T" command, which presents you with a large list of
10301
possible character sets to choose from.
10302
You may also just type in the name of a character set, and it need not
10303
be one that Pine knows about.
10306
Besides actual character set names (for example, ISO-8859-7, KOI8-R, or
10307
GB2312) you may also use some shorthand names that Pine provides.
10308
These names are more understandable shorthand names for sets of
10309
character set names.
10310
Two examples are "Cyrillic" and "Greek".
10311
Selecting one of these shorthand names is equivalent to selecting all of
10312
the character sets that make up the set.
10313
You can see all of these shorthand names and the lists of character sets
10314
they stand for by typing the "T" command.
10317
For the purposes of this Pattern,
10318
<EM>Pine</EM> will search through a message for all of the text parts and
10319
collect the character sets declared for each part.
10320
It will also look in the Subject line for a character set used there.
10321
<EM>Pine</EM> does not actually look at the text of the message or the text
10322
of the Subject to determine if a declared character set is actually
10323
used, it looks only at the declarations themselves in the MIME part headers
10324
and in the Subject.
10327
It is possible to add a <EM>NOT</EM> to the Character Set Pattern meaning with the
10328
"!" "toggle NOT" command.
10329
This changes the meaning of the Character Set pattern so that
10330
it has the opposite meaning.
10331
It will be considered a match if none of the character sets in the
10332
list are used in a message.
10334
Don't make the mistake of putting the "!" in the data field for
10336
For example, if you type the characters "!GB2312" into the
10337
Character Set pattern, the pattern will look like:
10340
Charset pattern = !GB2312
10343
This means you want to match the 7 character sequence "!GB2312".
10344
In order to match messages which do not have the
10345
character set "GB2312"
10346
set, first type the characters "GB2312" followed
10347
by carriage return for the value of the Character Set pattern, then negate it
10348
by typing the "!" command.
10349
It should end up looking like
10352
! Charset pattern = GB2312
10355
A technicality: Since comma is the character used to separate multiple
10356
values in a pattern field, you have to escape comma with a backslash (\) if
10357
you want to include a literal comma in the field.
10358
In other words, if you type a backslash followed by a comma it will
10359
be interpreted as a comma by <EM>Pine</EM>, instead of as a separator between
10361
All other backslashes are literal backslashes and should not be escaped.
10364
<DT> <A NAME="current-folder-type"><EM>Current Folder Type</EM></A>
10366
<DD> The Current Folder Type is part of the Pattern.
10367
It refers to the type of the currently open folder, which is the folder
10368
you were last looking at from the MESSAGE INDEX or MESSAGE TEXT screen.
10369
In order for a pattern to be considered a match, the current folder must
10370
be of the type you set here.
10371
The three types "Any", "News", and "Email" are
10372
all what you might think.
10374
If the Current Folder Type for a Pattern is set to "News", for
10376
that will only be a match if the current folder is a newsgroup and
10377
the rest of the Pattern matches.
10378
The value "Specific" may be used when you want to limit the match
10379
to a specific folder (not just a specific type of folder), or to a list of
10381
In order to match a specific folder you must Select the "Specific"
10382
button <EM>AND</EM> you must fill in
10383
the name (or list of names) of
10384
the folder in the "Folder" field.
10385
If the current folder is any of the folders in the list, that is considered
10387
The name of each folder in the list may be either "INBOX", the technical specification
10388
of the folder (like what appears in your configuration file) or, if the
10389
folder is one of your incoming folders, it may be the nickname you've given
10391
Here are a couple samples of specific folder names:
10393
<CENTER><SAMP>{monet.art.example.com}mail/art-class</SAMP></CENTER>
10395
<CENTER><SAMP>{news.example.com/nntp}#news.comp.mail.pine</SAMP></CENTER>
10397
The easiest way to fill in the "Folder" field is to use
10398
the T command which is available when the "Folder" line is
10400
Note that you won't be able to edit the "Folder" line unless the
10401
Current Folder Type is set to "Specific", and any value that
10402
"Folder" has is ignored unless the type
10403
is set to "Specific".
10405
When reading a newsgroup, there may be a performance penalty
10406
incurred when collecting the information necessary to check a Pattern.
10407
For this reason, the default Current Folder Type is set to "Email".
10408
For example, a role with a non-Normal Index Line Color
10409
and a Current Folder Type of
10410
"Any" or "News" may cause the MESSAGE INDEX
10411
screen to draw more slowly when in a newsgroup.
10414
<DT> <A NAME="message-status-important"><EM>Message Status Important</EM></A>
10416
<DD> This part of the Pattern may have one of three possible values.
10417
The default value is "Don't care", which matches any message.
10418
The other two values are "Yes", which means the message must be
10419
flagged "Important" in order to be a match; or "No", which
10420
means the message must <EM>not</EM> be flagged "Important" in order
10421
to be considered a match.
10424
<DT> <A NAME="message-status-new"><EM>Message Status New</EM></A>
10426
<DD> This part of the Pattern may have one of three possible values.
10427
The default value is "Don't care", which matches any message.
10428
The other two values are "Yes", which means the message must be
10429
"New" in order to be a match; or "No", which
10430
means the message must <EM>not</EM> be "New" in order
10432
"New" is the same as <EM>Unseen</EM> and not "New" is the
10433
same as <EM>Seen</EM>.
10435
The nomenclature is a bit confusing.
10436
New means that the message is Unseen.
10437
It could have been in your mailbox for a long time but if you haven't looked
10438
at it, it is still considered New.
10439
That matches the default <EM>Pine</EM> index display which shows an N for such a
10441
Recent means that the message was added to this folder since the last time
10442
you opened the folder.
10445
<DT> <A NAME="message-status-recent"><EM>Message Status Recent</EM></A>
10447
<DD> This part of the Pattern may have one of three possible values.
10448
The default value is "Don't care", which matches any message.
10449
The other two values are "Yes", which means the message must be
10450
"Recent" in order to be a match; or "No", which
10451
means the message must <EM>not</EM> be "Recent" in order
10453
"Recent" means that the message was added to the folder since
10454
the last time the folder was opened.
10455
If more than one mail client has the folder opened, the message will
10456
appear to be "Recent" to only one of the clients.
10458
The nomenclature is a bit confusing.
10459
New means that the message is Unseen.
10460
It could have been in your mailbox for a long time but if you haven't looked
10461
at it, it is still considered New.
10462
That matches the default <EM>Pine</EM> index display which shows an N for such a
10464
Recent means that the message was added to this folder since the last time
10465
you opened the folder.
10468
<DT> <A NAME="message-status-deleted"><EM>Message Status Deleted</EM></A>
10470
<DD> This part of the Pattern may have one of three possible values.
10471
The default value is "Don't care", which matches any message.
10472
The other two values are "Yes", which means the message must be
10473
marked "Deleted" in order to be a match; or "No", which
10474
means the message must <EM>not</EM> be marked "Deleted" in order
10477
If you are thinking of using this part of the Pattern as a way to prevent
10478
messages from being filtered more than once in a Filter Pattern,
10479
take a look at the Filter Option
10480
<A HREF="#move-only-if-not-deleted">"move-only-if-not-deleted"</A>
10482
It should work better than using this field since it will hide the filtered
10483
messages even if they are already Deleted.
10486
<DT> <A NAME="message-status-answered"><EM>Message Status Answered</EM></A>
10488
<DD> This part of the Pattern may have one of three possible values.
10489
The default value is "Don't care", which matches any message.
10490
The other two values are "Yes", which means the message must be
10491
marked "Answered" in order to be a match; or "No", which
10492
means the message must <EM>not</EM> be marked "Answered" in order
10496
<DT> <A NAME="subject-contains-raw-8bit"><EM>Subject Contains Raw 8-bit</EM></A>
10498
<DD> This part of the Pattern may have one of three possible values.
10499
The default value is "Don't care", which matches any message.
10500
The other two values are "Yes", which means the Subject of
10501
the message must contain unencoded 8-bit characters (characters with the
10502
most significant bit set)
10503
in order to be a match; or "No", which
10504
means the Subject must <EM>not</EM>
10505
contain unencoded 8-bit characters in order to be a match.
10508
<DT> <A NAME="beginning-of-month"><EM>Beginning of Month</EM></A>
10510
<DD> This part of the Pattern may have one of three possible values.
10511
The default value is "Don't care", which matches any message.
10512
The other two values are "Yes", which means this is the first
10513
time <EM>Pine</EM> has been run this month;
10514
or "No", which
10515
means this is <EM>not</EM> the first time <EM>Pine</EM> has been run this month.
10516
The way that <EM>Pine</EM> decides if it is the beginning of the month or not is
10517
to compare today's date with the date stored in the
10518
<A HREF="#last-time">Last-Time-Prune-Questioned</A>
10519
variable in the config file.
10520
If the month of today's date is later than the month stored in the variable,
10521
then this is considered to be the first time you have run Pine this month, and
10522
that turns the Beginning of the Month option on.
10525
<DT> <A NAME="beginning-of-year"><EM>Beginning of Year</EM></A>
10527
<DD> This part of the Pattern may have one of three possible values.
10528
The default value is "Don't care", which matches any message.
10529
The other two values are "Yes", which means this is the first
10530
time <EM>Pine</EM> has been run this year;
10531
or "No", which
10532
means this is <EM>not</EM> the first time <EM>Pine</EM> has been run this year.
10533
The way that <EM>Pine</EM> decides if it is the beginning of the year or not is
10534
to compare today's date with the date stored in the
10535
<A HREF="#last-time">Last-Time-Prune-Questioned</A>
10536
variable in the config file.
10537
If the year of today's date is later than the year stored in the variable,
10538
then this is considered to be the first time you have run Pine this year, and
10539
that turns the Beginning of the Year option on.
10542
<DT> <A NAME="from-in-abook"><EM>From or Reply-To in Address Book</EM></A>
10544
<DD> This part of the Pattern may have one of five possible values.
10545
The default value is "Don't care", which matches any message.
10546
The value "Yes, in any address book" means either the From address
10547
or the Reply-To address of the message must be in at least one of your
10548
address books in order to be a match.
10549
The value "No, not in any address book"
10550
means neither the From nor the Reply-To addresses may
10551
be in any of your address books in order to be a match.
10553
The values "Yes, in specific address books" and
10554
"No, not in any of specific address books" are similar but instead
10555
of depending on all address books you are allowed to give a list of address
10557
Usually this would be a single address book but it may be a
10558
list of address books as well.
10559
For each of these "specific" address book options you Select which
10560
of the Specific options you want (Yes or No) <EM>AND</EM> fill in the
10561
name (or list of names) of the address book in the
10562
"Abook List" field.
10563
The names to be used are those that appear in the ADDRESS BOOK LIST screen.
10564
The easiest way to fill in the Abook List field it to use
10565
the "T" command which is available when the "Abook List"
10566
line is highlighted.
10567
Note that you won't be able to edit the "Abook List" line unless the
10568
option is set to one of the two "Specific", values.
10571
<DT> <A NAME="categorizer-cmd-explained"><EM>Categorizer Command</EM></A>
10573
<DD> This is a command that is run with its standard input set to the message
10574
being checked and its standard output discarded.
10575
The full directory path should be specified.
10576
The command will be run and then its exit status will be checked against
10577
the <EM>Exit Status Interval</EM>, which defaults to just the value zero.
10578
If the exit status of the command falls in the interval, it is considered
10579
a match, otherwise it is not a match.
10582
This option may actually be a list of commands.
10583
The first one that exists and is executable is used.
10584
That makes it possible to use the same configuration with Unix <EM>Pine</EM> and
10588
If none of the commands in the list exists and is executable then the rule
10589
is <EM>not</EM> a match.
10590
If it is possible that the command may not exist, you should be careful
10591
to structure your rules so that nothing destructive
10592
happens when the command does not exist.
10593
For example, you might have a filter that filters away spam when there is
10594
a match but does nothing when there is not a match.
10595
That would continue to work correctly if the command didn't exist.
10596
However, if you have a filter which filters away spam when there is not
10597
a match and keeps it when there is a match, that would filter everything
10598
if the categorizer command didn't exist.
10601
The categorizer command is run and the result is the exit status of
10603
If that exit status falls in the <EM>Exit Status Interval</EM>
10604
then it is considered a match, otherwise it is not a match.
10605
Of course for the entire rule to match, it must also be checked against
10606
the other defined parts of the Pattern.
10608
The <EM>Exit Status Interval</EM> defaults to the single value 0 (zero).
10609
If you define it, it should be set to something like:
10611
<CENTER><SAMP>(min_exit_value,max_exit_value)</SAMP></CENTER>
10613
where "min_exit_value" and "max_exit_value" are integers.
10614
The special values "INF" and "-INF" may be used for large
10615
positive and negative integers.
10617
Actually, a list of intervals may be used if you wish.
10618
A list would look like
10620
<CENTER><SAMP>(min_exit_value1,max_exit_value1),(min_exit_value2,max_exit_value2),...</SAMP></CENTER>
10622
When there is an <EM>Exit Status Interval</EM> defined, it is a match if the exit status
10623
of the categorizer command is contained in any of the intervals.
10624
The intervals include both endpoints.
10626
The default interval is
10628
<CENTER><SAMP>(0,0)</SAMP></CENTER>
10630
and it matches only if the command exits with exit status equal to zero.
10632
It is also possible to set a <EM>Character Limit</EM> for the categorizer command.
10633
Setting this option makes it possible to limit how much of the message
10634
is made available to the categorizer command as input.
10635
The default value (-1) means that the entire message is fed to the
10637
A value of 0 (zero) means that only the headers of the message are
10639
A positive integer means that the headers plus that many characters from
10640
the body of the message are passed to the categorizer.
10645
<H2><A NAME="configuring-news"></A>Configuring News</H2>
10647
<EM>Pine</EM> can access news folders in any one of three different ways:
10649
<DT>REMOTE NNTP</DT>
10650
<DD>Using the Network News Transport Protocol (NNTP) to
10651
access news on a remote news server. In this case the newsrc file is
10652
stored on the machine where <EM>Pine</EM> is running.
10655
To specify a remote news-collection accessed via NNTP use the
10656
SETUP/collectionList screen's "Add" command. Set the
10657
Server: value to the NNTP server's hostname appended with the
10658
communication method "/service=NNTP", and set the Path:
10659
value to the "#news." namespace (without the quotes).
10661
Instead of specifying a news-collection, you may simply set the
10662
<A HREF="#nntp-server">nntp-server</A>
10663
option, which will cause <EM>Pine</EM> to create a default news-collection for you.
10664
Another NNTP option which may be of interest is
10665
<A HREF="#nntp-range">nntp-range</A>.
10667
<DT>REMOTE IMAP</DT>
10668
<DD>Using the Internet Message Access Protocol (IMAP) to
10669
access news on a remote news server. In this case, your newsrc file is
10670
stored on the news server, in your home directory, so you must have an
10671
account on the news server, but you would be running <EM>Pine</EM> on a different
10672
machine. The news server must be running an IMAPd server process.
10675
To specify a remote news-collection accessed via IMAP use the
10676
SETUP/collectionList screen's "Add" command. Set the
10677
Server: value to the IMAP server's hostname, and set the Path: value
10678
to the "#news." namespace (without the quotes).
10683
<DD>Using local file access to the news database. In this
10684
case, your newsrc file is stored on the news server, in your home
10685
directory, so you must have an account on the news server, and you would
10686
be running <EM>Pine</EM> on the same machine.
10689
To specify a local news-collection use the SETUP/collectionList
10690
screen's "Add" command. Leave the Server: value blank, and
10691
set the Path: value to the "#news." namespace (without the
10699
NOTE: Should no news-collection be defined as above, <EM>Pine</EM> will
10700
automatically create one using the Setup/Config screen's
10701
"nntp-server" variable's value if defined. The collection
10702
will be created as a "Remote NNTP" as described above.
10706
If you are a <EM>PC-Pine</EM> user, either option 1 (NNTP) or option 2 (IMAP) is
10707
possible. If you don't have an account on the news server, or if the news
10708
server is not running an IMAP daemon, then you must use NNTP. (If you are not
10709
sure, ask your service provider, university, or company for help.) In
10710
this case, your Unix .newsrc file can be transferred to your PC. A good
10711
place to put it would be in the same directory as your PINERC file, under
10712
the name NEWSRC, but you can
10713
<A HREF="#newsrc-path">specify a different location</A>.
10716
Other configuration features related to news are
10717
<A HREF="#enable-8bit-nntp-posting">Enable-8bit-Nntp-Posting</A>.
10718
<A HREF="#compose-sets-newsgroup-without-confirm">Compose-Sets-Newsgroup-Without-Confirm</A>,
10719
<A HREF="#news-approximates-new-status">News-Approximates-New-Status</A>,
10720
<A HREF="#news-deletes-across-groups">News-Deletes-Across-Groups</A>,
10721
<A HREF="#news-offers-catchup-on-close">News-Offers-Catchup-On-Close</A>,
10722
<A HREF="#news-post-without-validation">News-Post-Without-Validation</A>,
10723
<A HREF="#news-read-in-newsrc-order">News-Read-in-Newsrc-Order</A>, and
10724
<A HREF="#quell-extra-post-prompt">Quell-Extra-Post-Prompt</A>.