| 1 |
.TH alpine 1 "Version 2.26" |
| 2 |
.SH NAME |
| 3 |
alpine \- an Alternatively Licensed Program for Internet News and Email |
| 4 |
.SH SYNTAX |
| 5 |
|
| 6 |
.B alpine |
| 7 |
[ |
| 8 |
.I options |
| 9 |
] [ |
| 10 |
.I address |
| 11 |
, |
| 12 |
.I address |
| 13 |
] |
| 14 |
|
| 15 |
.B alpinef |
| 16 |
[ |
| 17 |
.I options |
| 18 |
] [ |
| 19 |
.I address |
| 20 |
, |
| 21 |
.I address |
| 22 |
] |
| 23 |
.SH DESCRIPTION |
| 24 |
|
| 25 |
Alpine is a screen-oriented message-handling tool. In its default |
| 26 |
configuration, Alpine offers an intentionally limited set of |
| 27 |
functions geared toward the novice user, but it also has a large |
| 28 |
list of optional "power-user" and personal-preference features. |
| 29 |
.I alpinef |
| 30 |
is a variant of Alpine that uses function keys rather than mnemonic |
| 31 |
single-letter commands. |
| 32 |
Alpine's basic feature set includes: |
| 33 |
.IP |
| 34 |
View, Save, Export, Delete, Print, Reply and Forward messages. |
| 35 |
.IP |
| 36 |
Compose messages in a simple editor (Pico) with word-wrap and a spelling |
| 37 |
checker. Messages may be postponed for later completion. |
| 38 |
.IP |
| 39 |
Full-screen selection and management of message folders. |
| 40 |
.IP |
| 41 |
Address book to keep a list of long or frequently-used addresses. |
| 42 |
Personal distribution lists may be defined. |
| 43 |
Addresses may be taken into the address book from |
| 44 |
incoming mail without retyping them. |
| 45 |
.IP |
| 46 |
New mail checking and notification occurs automatically every 2.5 minutes |
| 47 |
and after certain commands, e.g. refresh-screen (Ctrl-L). |
| 48 |
.IP |
| 49 |
On-line, context-sensitive help screens. |
| 50 |
.PP |
| 51 |
Alpine supports MIME (Multipurpose Internet Mail Extensions), an Internet |
| 52 |
Standard for representing multipart and multimedia data in email. |
| 53 |
Alpine allows you to save MIME objects to files, and in some |
| 54 |
cases, can also initiate the correct program for viewing the object. |
| 55 |
It uses the system's |
| 56 |
.I mailcap |
| 57 |
configuration file to determine what program can process a particular MIME |
| 58 |
object type. |
| 59 |
Alpine's message composer does not have integral multimedia capability, but |
| 60 |
any type of data file --including multimedia-- can be attached to a text |
| 61 |
message and sent using MIME's encoding rules. This allows any group of |
| 62 |
individuals with MIME-capable mail software (e.g. Alpine, PC-Alpine, or many |
| 63 |
other programs) to exchange formatted documents, spread-sheets, image |
| 64 |
files, etc, via Internet email. |
| 65 |
.PP |
| 66 |
Alpine uses the |
| 67 |
.I c-client |
| 68 |
messaging API to access local and remote mail folders. This |
| 69 |
library provides a variety of low-level message-handling functions, |
| 70 |
including drivers |
| 71 |
for a variety of different mail file formats, as well as routines |
| 72 |
to access remote mail and news servers, using IMAP (Internet Message |
| 73 |
Access Protocol) and NNTP (Network News Transport Protocol). Outgoing mail |
| 74 |
is usually posted directly via SMTP |
| 75 |
(Simple Mail Transfer Protocol). |
| 76 |
.SH OPTIONS |
| 77 |
.if n .ta 2.8i |
| 78 |
.if t .ta 2.1i |
| 79 |
|
| 80 |
The command line options/arguments are: |
| 81 |
.IP \fIaddress\fR 20 |
| 82 |
Send mail to |
| 83 |
.I address. |
| 84 |
This will cause Alpine to go directly into the message composer. |
| 85 |
.IP \fB-attach\ \fIfile\fR 20 |
| 86 |
Send mail with the listed |
| 87 |
.I file |
| 88 |
as an attachment. |
| 89 |
.IP \fB-attachlist\ \fIfile-list\fR 20 |
| 90 |
Send mail with the listed |
| 91 |
.I file-list |
| 92 |
as an attachments. |
| 93 |
.IP \fB-attach_and_delete\ \fIfile\fR 20 |
| 94 |
Send mail with the listed |
| 95 |
.I file |
| 96 |
as an attachment, and remove the file |
| 97 |
after the message is sent. |
| 98 |
.IP \fB-aux\ \fIlocal_directory\fR 20 |
| 99 |
PC-Alpine only. When using a remote configuration (-p <remote_config>) this tells |
| 100 |
PC-Alpine the local directory to use for storing auxiliary files, like debug |
| 101 |
files, address books, and signature files. |
| 102 |
.IP \fB-bail\fR 20 |
| 103 |
Exit if the pinerc file does not exist. This might be useful if the config |
| 104 |
file is accessed using some remote filesystem protocol. If the remote mount |
| 105 |
is missing this will cause Alpine to quit instead of creating a new pinerc. |
| 106 |
.IP \fB-c\ \fIcontext-number\fR 20 |
| 107 |
context-number is the number corresponding to the |
| 108 |
folder-collection to which the |
| 109 |
.I -f |
| 110 |
command line argument should be applied. By default the |
| 111 |
.I -f |
| 112 |
argument is applied to the first defined folder-collection. |
| 113 |
.IP \fB-conf\fR 20 |
| 114 |
Produce a sample/fresh copy of the |
| 115 |
system-wide configuration file, |
| 116 |
.I pine.conf, |
| 117 |
on the standard output. This is distinct from the per-user |
| 118 |
.I .pinerc |
| 119 |
file. |
| 120 |
.IP \fB-convert_sigs\ \fI-p\ pinerc\fR 20 |
| 121 |
Convert signature files into literal signatures. |
| 122 |
.IP \fB-copy_abook\ <\fIlocal_abook\fR>\ <\fIremote_abook\fR> 20 |
| 123 |
Copy the local address book file to a remote address book folder. |
| 124 |
.IP \fB-copy_pinerc\ <\fIlocal_pinerc\fR>\ <\fIremote_pinerc\fR> 20 |
| 125 |
Copy the local pinerc file to a remote pinerc folder. |
| 126 |
.IP \fB-d\ \fIdebug-level\fR 20 |
| 127 |
Output diagnostic info at |
| 128 |
.I debug-level |
| 129 |
(0-9) to the current |
| 130 |
.I .pine-debug[1-4] |
| 131 |
file. A value of 0 turns debugging off and suppresses the |
| 132 |
.I .pine-debug |
| 133 |
file. |
| 134 |
.IP \fB-d\ \fIkey[=val]\fR 20 |
| 135 |
Fine tuned output of diagnostic messages where "flush" causes |
| 136 |
debug file writing without buffering, "timestamp" appends |
| 137 |
each message with a timestamp, "imap=n" where n is between |
| 138 |
0 and 4 representing none to verbose IMAP telemetry reporting, |
| 139 |
"numfiles=n" where n is between 0 and 31 corresponding to the |
| 140 |
number of debug files to maintain, and "verbose=n" where n is |
| 141 |
between 0 and 9 indicating an inverse threshold for message |
| 142 |
output. |
| 143 |
.IP \fB-f\ \fIfolder\fR 20 |
| 144 |
Open |
| 145 |
.I folder |
| 146 |
(in first defined folder collection, use |
| 147 |
.I -c n |
| 148 |
to specify another collection) instead of INBOX. |
| 149 |
.IP \fB-F\ \fIfile\fR 20 |
| 150 |
Open named text file and view with Alpine's browser. |
| 151 |
.IP \fB-h\fR 20 |
| 152 |
Help: list valid command-line options. |
| 153 |
.IP \fB-i\fR 20 |
| 154 |
Start up in the FOLDER INDEX screen. |
| 155 |
.IP \fB-I\ \fIkeystrokes\fR 20 |
| 156 |
Initial (comma separated list of) keystrokes which Alpine should execute |
| 157 |
on startup. |
| 158 |
.IP \fB-install\fR 20 |
| 159 |
For PC-Alpine only, this option causes PC-Alpine to prompt for some basic |
| 160 |
setup information, then exits. |
| 161 |
.IP \fB-k\fR 20 |
| 162 |
Use function keys for commands. This is the same as running the command |
| 163 |
.IR alpinef . |
| 164 |
.IP \fB-n\ \fInumber\fR 20 |
| 165 |
Start up with current message-number set to |
| 166 |
.I number. |
| 167 |
.IP \fB-nowrite_password_cache\fR 20 |
| 168 |
Read from a password cache if there is one, but |
| 169 |
never offer to write a password to the cache |
| 170 |
.IP \fB-o\fR 20 |
| 171 |
Open first folder read-only. |
| 172 |
.IP \fB-p\ \fIconfig-file\fR 20 |
| 173 |
Use |
| 174 |
.I config-file |
| 175 |
as the personal configuration file instead of the default |
| 176 |
.IR .pinerc . |
| 177 |
.IP \fB-P\ \fIconfig-file\fR 20 |
| 178 |
Use |
| 179 |
.I config-file |
| 180 |
as the configuration file instead of default |
| 181 |
system-wide configuration file |
| 182 |
.IR pine.conf . |
| 183 |
.IP \fB-passfile\ \fI<fully-qualified-path>\fR 20 |
| 184 |
When password file support is compiled in, use the file specified in |
| 185 |
.I <fully-qualified-path> |
| 186 |
instead of the default. |
| 187 |
.IP \fB-pinerc\ \fIfile\fR 20 |
| 188 |
Output fresh pinerc configuration to |
| 189 |
.I file, preserving the settings of variables that the user has made. |
| 190 |
Use \fIfile\fR set to ``-'' to make output go to standard out. |
| 191 |
.IP \fB-pwdcertdir\ \fI<fully-qualified-path>\fR 20 |
| 192 |
When SMIME and password file support are compiled in, this variable sets |
| 193 |
the directory to store your personal key and certificate to encrypt and |
| 194 |
decrypt your password file. |
| 195 |
.IP \fB-r\fR 20 |
| 196 |
Use restricted/demo mode. |
| 197 |
.I Alpine |
| 198 |
will only send mail to itself |
| 199 |
and functions like save and export are restricted. |
| 200 |
.IP \fB-registry\ \fIcmd\fR 20 |
| 201 |
For PC-Alpine only, this option affects the values of |
| 202 |
Alpine's registry entries. |
| 203 |
Possible values for \fIcmd\fR are set, clear, and dump. |
| 204 |
\fISet\fR will always reset Alpine's registry |
| 205 |
entries according to its current settings. |
| 206 |
\fIClear\fR will clear the registry values. |
| 207 |
\fIClearsilent\fR will silently clear the registry values. |
| 208 |
\fIDump\fR will display the values of current registry settings. |
| 209 |
Note that the dump command is currently disabled. |
| 210 |
Without the -registry option, PC-Alpine will write values into |
| 211 |
the registry only if there currently aren't any values set. |
| 212 |
.IP \fB-smimedir\ \fI<fully-qualified-path>\fR |
| 213 |
If SMIME is compiled in, this argument sets the directory where the |
| 214 |
public, private, and certificate authorities certificates and keys |
| 215 |
are stored. If not set by the command line the default is |
| 216 |
~/.alpine-smime |
| 217 |
.IP \fB-sort\ \fIorder\fR |
| 218 |
Sort the FOLDER INDEX display in one of the following orders: |
| 219 |
.I arrival, date, subject, orderedsubj, thread, from, size, score, to, cc, |
| 220 |
or |
| 221 |
.I reverse. Arrival |
| 222 |
order is the default. |
| 223 |
The OrderedSubj choice simulates a threaded sort. |
| 224 |
Any sort may be reversed by adding |
| 225 |
.I /reverse |
| 226 |
to it. |
| 227 |
.I Reverse |
| 228 |
by itself is the same as |
| 229 |
.IR arrival/reverse . |
| 230 |
.IP \fB-supported\fR 20 |
| 231 |
Some options may or may not be supported depending on how Alpine |
| 232 |
was compiled. |
| 233 |
This is a way to determine which options are supported in the particular |
| 234 |
copy of Alpine you are using. |
| 235 |
.IP \fB-uninstall\fR 20 |
| 236 |
For PC-Alpine only, this option causes PC-Alpine to remove references to |
| 237 |
Alpine in Windows settings. |
| 238 |
.IP \fB-url\ \fIurl\fR 20 |
| 239 |
Open the given |
| 240 |
.I url. |
| 241 |
Cannot be used with |
| 242 |
.I -f |
| 243 |
or |
| 244 |
.I -F |
| 245 |
options. |
| 246 |
.IP \fB-v\fR 20 |
| 247 |
Version: Print version information. |
| 248 |
.IP \fB-version\fR 20 |
| 249 |
Version: Print version information. |
| 250 |
.IP \fB-x\ \fIconfig\fR 20 |
| 251 |
Use configuration exceptions in |
| 252 |
.I config. |
| 253 |
Exceptions are used to override your default pinerc |
| 254 |
settings for a particular platform, can be a local file or |
| 255 |
a remote folder. |
| 256 |
.IP \fB-xoauth2-server\ \fIServerName\fR 20 |
| 257 |
Name of the service that XOAUTH2 authentication will be attempted. |
| 258 |
The only service supported as of this writing is Gmail. Note that |
| 259 |
all of the options -xoauth2-server, -xoauth2-client-id and |
| 260 |
-xoauth2-client-secret must be used simultaneously. Example: |
| 261 |
-xoauth2-server Gmail. |
| 262 |
.IP \fB-xoauth2-client-id\ \fIClient-Id\fR 20 |
| 263 |
String that identifies Alpine with the service provider that provides |
| 264 |
XOAUTH2 authentication. Note that |
| 265 |
all of the options -xoauth2-server, -xoauth2-client-id and |
| 266 |
-xoauth2-client-secret must be used simultaneously. |
| 267 |
.IP \fB-xoauth2-client-secret\ \fIClient-Secret\fR 20 |
| 268 |
Secret string that identifies the Alpine with |
| 269 |
the service provider that provides XOAUTH2 authentication. |
| 270 |
Note that |
| 271 |
all of the options -xoauth2-server, -xoauth2-client-id and |
| 272 |
-xoauth2-client-secret must be used simultaneously. |
| 273 |
.IP \fB-z\fR 20 |
| 274 |
Enable ^Z and SIGTSTP so alpine may be suspended. |
| 275 |
.IP \fI-option\=\fIvalue\fR 20 |
| 276 |
Assign |
| 277 |
.I value |
| 278 |
to the config option |
| 279 |
.I option |
| 280 |
e.g. -signature-file=sig1 or -feature-list=signature-at-bottom |
| 281 |
(Note: feature-list values are additive) |
| 282 |
.SH CONFIGURATION |
| 283 |
|
| 284 |
There are several levels of Alpine configuration. Configuration values at |
| 285 |
a given level over-ride corresponding values at lower levels. In order of |
| 286 |
increasing precedence: |
| 287 |
|
| 288 |
o built-in defaults. |
| 289 |
.br |
| 290 |
o system-wide |
| 291 |
.I pine.conf |
| 292 |
file. |
| 293 |
.br |
| 294 |
o personal |
| 295 |
.I .pinerc |
| 296 |
file (may be set via built-in Setup/Config menu.) |
| 297 |
.br |
| 298 |
o command-line options. |
| 299 |
.br |
| 300 |
o system-wide |
| 301 |
.I pine.conf.fixed |
| 302 |
file. |
| 303 |
|
| 304 |
There is one exception to the rule that configuration values are replaced |
| 305 |
by the value of the same option in a higher-precedence file: the |
| 306 |
feature-list variable has values that are additive, but can be negated by |
| 307 |
prepending "no-" in front of an individual feature name. Unix Alpine also |
| 308 |
uses the following environment variables: |
| 309 |
|
| 310 |
TERM |
| 311 |
.br |
| 312 |
DISPLAY (determines if Alpine can display IMAGE attachments.) |
| 313 |
.br |
| 314 |
SHELL (if not set, default is /bin/sh ) |
| 315 |
.br |
| 316 |
MAILCAPS (semicolon delimited list of path names to mailcap files) |
| 317 |
.SH FILES |
| 318 |
.if n .ta 2.8i |
| 319 |
.if t .ta 2.1i |
| 320 |
|
| 321 |
/var/spool/mail/xxxx Default folder for incoming mail. |
| 322 |
.br |
| 323 |
~/mail Default directory for mail folders. |
| 324 |
.br |
| 325 |
~/.addressbook Default address book file. |
| 326 |
.br |
| 327 |
~/.signature File used for signature, appended to every message. |
| 328 |
.br |
| 329 |
~/.pine-debug[1-4] Diagnostic log for debugging. |
| 330 |
.br |
| 331 |
~/.pinerc Personal alpine config file. |
| 332 |
.br |
| 333 |
~/.pine-crash Debug information useful to debug a crash. |
| 334 |
.br |
| 335 |
~/.newsrc News subscription/state file. |
| 336 |
.br |
| 337 |
~/.mailcap Personal mail capabilities file. |
| 338 |
.br |
| 339 |
~/.mime.types Personal file extension to MIME type mapping |
| 340 |
.br |
| 341 |
/etc/mailcap System-wide mail capabilities file. |
| 342 |
.br |
| 343 |
/etc/mime.types System-wide file ext. to MIME type mapping |
| 344 |
.br |
| 345 |
/etc/pine.info Local pointer to system administrator. |
| 346 |
.br |
| 347 |
/etc/pine.conf System-wide configuration file. |
| 348 |
.br |
| 349 |
/etc/pine.conf.fixed Non-overridable configuration file. |
| 350 |
.br |
| 351 |
~/.alpine-smime/ca Directory that contains Certificate Authority files. |
| 352 |
.br |
| 353 |
~/.alpine-smime/private Directory that contains private key(s). |
| 354 |
.br |
| 355 |
~/.alpine-smime/public Directory that contains public key(s). |
| 356 |
.br |
| 357 |
/tmp/.\\usr\\spool\\mail\\xxxx Per-folder mailbox lock files. |
| 358 |
.br |
| 359 |
~/.pine-interrupted-mail Message which was interrupted. |
| 360 |
.br |
| 361 |
~/mail/postponed-msgs For postponed messages (drafts) |
| 362 |
.br |
| 363 |
~/mail/sent-mail Outgoing message archive (FCC). |
| 364 |
.br |
| 365 |
~/mail/saved-messages Default destination for Saving messages. |
| 366 |
.SH "SEE ALSO" |
| 367 |
|
| 368 |
pico(1), binmail(1), aliases(5), mailaddr(7), sendmail(8), spell(1), imapd(8) |
| 369 |
|
| 370 |
.br |
| 371 |
Newsgroup: comp.mail.pine |
| 372 |
|
| 373 |
.br |
| 374 |
Mailing List: |
| 375 |
.br |
| 376 |
Alpine-info, at https://www.washington.edu/alpine/alpine-info/ |
| 377 |
|
| 378 |
.br |
| 379 |
Main Alpine distribution site: |
| 380 |
.br |
| 381 |
http://repo.or.cz/alpine.git |
| 382 |
|
| 383 |
.br |
| 384 |
Alpine Technical Notes, included in the source distribution. |
| 385 |
|
| 386 |
.br |
| 387 |
C-Client messaging API library, included in the source distribution. |
| 388 |
.SH ACKNOWLEDGMENTS |
| 389 |
.na |
| 390 |
.nf |
| 391 |
|
| 392 |
This software is the result of the contribution of many individuals |
| 393 |
who have dedicated their time to support, improve and suggest ways |
| 394 |
to improve Alpine through the years. This software would not be |
| 395 |
possible without the support of the University of Washington in |
| 396 |
Seattle, Washington. The Alpine community extends its most sincere |
| 397 |
thanks to all contributors and invites everyone to join in and |
| 398 |
contribute to this project. |