Debian Codegraph @

upstream/fedora-44/man1/alpine.1

raw
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-noutf8\fR 20
168 Warns Alpine that piped input is not encoded in UTF-8.
169 .IP \fB-nowrite_password_cache\fR 20
170 Read from a password cache if there is one, but
171 never offer to write a password to the cache
172 .IP \fB-o\fR 20
173 Open first folder read-only.
174 .IP \fB-p\ \fIconfig-file\fR 20
175 Use
176 .I config-file
177 as the personal configuration file instead of the default
178 .IR .pinerc .
179 .IP \fB-P\ \fIconfig-file\fR 20
180 Use
181 .I config-file
182 as the configuration file instead of default
183 system-wide configuration file
184 .IR pine.conf .
185 .IP \fB-passfile\ \fI<fully-qualified-path>\fR 20
186 When password file support is compiled in, use the file specified in
187 .I <fully-qualified-path>
188 instead of the default.
189 .IP \fB-pinerc\ \fIfile\fR 20
190 Output fresh pinerc configuration to
191 .I file, preserving the settings of variables that the user has made.
192 Use \fIfile\fR set to ``-'' to make output go to standard out.
193 .IP \fB-pwdcertdir\ \fI<fully-qualified-path>\fR 20
194 When SMIME and password file support are compiled in, this variable sets
195 the directory to store your personal key and certificate to encrypt and
196 decrypt your password file.
197 .IP \fB-r\fR 20
198 Use restricted/demo mode.
199 .I Alpine
200 will only send mail to itself
201 and functions like save and export are restricted.
202 .IP \fB-registry\ \fIcmd\fR 20
203 For PC-Alpine only, this option affects the values of
204 Alpine's registry entries.
205 Possible values for \fIcmd\fR are set, clear, and dump.
206 \fISet\fR will always reset Alpine's registry
207 entries according to its current settings.
208 \fIClear\fR will clear the registry values.
209 \fIClearsilent\fR will silently clear the registry values.
210 \fIDump\fR will display the values of current registry settings.
211 Note that the dump command is currently disabled.
212 Without the -registry option, PC-Alpine will write values into
213 the registry only if there currently aren't any values set.
214 .IP \fB-smimedir\ \fI<fully-qualified-path>\fR
215 If SMIME is compiled in, this argument sets the directory where the
216 public, private, and certificate authorities certificates and keys
217 are stored. If not set by the command line the default is
218 ~/.alpine-smime
219 .IP \fB-sort\ \fIorder\fR
220 Sort the FOLDER INDEX display in one of the following orders:
221 .I arrival, date, subject, orderedsubj, thread, from, size, score, to, cc,
222 or
223 .I reverse. Arrival
224 order is the default.
225 The OrderedSubj choice simulates a threaded sort.
226 Any sort may be reversed by adding
227 .I /reverse
228 to it.
229 .I Reverse
230 by itself is the same as
231 .IR arrival/reverse .
232 .IP \fB-supported\fR 20
233 Some options may or may not be supported depending on how Alpine
234 was compiled.
235 This is a way to determine which options are supported in the particular
236 copy of Alpine you are using.
237 .IP \fB-uninstall\fR 20
238 For PC-Alpine only, this option causes PC-Alpine to remove references to
239 Alpine in Windows settings.
240 .IP \fB-url\ \fIurl\fR 20
241 Open the given
242 .I url.
243 Cannot be used with
244 .I -f
245 or
246 .I -F
247 options.
248 .IP \fB-v\fR 20
249 Version: Print version information.
250 .IP \fB-version\fR 20
251 Version: Print version information.
252 .IP \fB-x\ \fIconfig\fR 20
253 Use configuration exceptions in
254 .I config.
255 Exceptions are used to override your default pinerc
256 settings for a particular platform, can be a local file or
257 a remote folder.
258 .IP \fB-xoauth2-server\ \fIServerName\fR 20
259 Name of the service that XOAUTH2 authentication will be attempted.
260 The only service supported as of this writing is Gmail. Note that
261 all of the options -xoauth2-server, -xoauth2-client-id and
262 -xoauth2-client-secret must be used simultaneously. Example:
263 -xoauth2-server Gmail.
264 .IP \fB-xoauth2-client-id\ \fIClient-Id\fR 20
265 String that identifies Alpine with the service provider that provides
266 XOAUTH2 authentication. Note that
267 all of the options -xoauth2-server, -xoauth2-client-id and
268 -xoauth2-client-secret must be used simultaneously.
269 .IP \fB-xoauth2-client-secret\ \fIClient-Secret\fR 20
270 Secret string that identifies the Alpine with
271 the service provider that provides XOAUTH2 authentication.
272 Note that
273 all of the options -xoauth2-server, -xoauth2-client-id and
274 -xoauth2-client-secret must be used simultaneously.
275 .IP \fB-z\fR 20
276 Enable ^Z and SIGTSTP so alpine may be suspended.
277 .IP \fI-option\=\fIvalue\fR 20
278 Assign
279 .I value
280 to the config option
281 .I option
282 e.g. -signature-file=sig1 or -feature-list=signature-at-bottom
283 (Note: feature-list values are additive)
284 .SH CONFIGURATION
285
286 There are several levels of Alpine configuration. Configuration values at
287 a given level over-ride corresponding values at lower levels. In order of
288 increasing precedence:
289
290 o built-in defaults.
291 .br
292 o system-wide
293 .I pine.conf
294 file.
295 .br
296 o personal
297 .I .pinerc
298 file (may be set via built-in Setup/Config menu.)
299 .br
300 o command-line options.
301 .br
302 o system-wide
303 .I pine.conf.fixed
304 file.
305
306 There is one exception to the rule that configuration values are replaced
307 by the value of the same option in a higher-precedence file: the
308 feature-list variable has values that are additive, but can be negated by
309 prepending "no-" in front of an individual feature name. Unix Alpine also
310 uses the following environment variables:
311
312 TERM
313 .br
314 DISPLAY (determines if Alpine can display IMAGE attachments.)
315 .br
316 SHELL (if not set, default is /bin/sh )
317 .br
318 MAILCAPS (semicolon delimited list of path names to mailcap files)
319 .SH FILES
320 .if n .ta 2.8i
321 .if t .ta 2.1i
322
323 /usr/spool/mail/xxxx Default folder for incoming mail.
324 .br
325 ~/mail Default directory for mail folders.
326 .br
327 ~/.addressbook Default address book file.
328 .br
329 ~/.signature File used for signature, appended to every message.
330 .br
331 ~/.pine-debug[1-4] Diagnostic log for debugging.
332 .br
333 ~/.pinerc Personal alpine config file.
334 .br
335 ~/.pine-crash Debug information useful to debug a crash.
336 .br
337 ~/.newsrc News subscription/state file.
338 .br
339 ~/.mailcap Personal mail capabilities file.
340 .br
341 ~/.mime.types Personal file extension to MIME type mapping
342 .br
343 /etc/mailcap System-wide mail capabilities file.
344 .br
345 /etc/mime.types System-wide file ext. to MIME type mapping
346 .br
347 /usr/local/lib/pine.info Local pointer to system administrator.
348 .br
349 /usr/local/lib/pine.conf System-wide configuration file.
350 .br
351 /usr/local/lib/pine.conf.fixed Non-overridable configuration file.
352 .br
353 ~/.alpine-smime/ca Directory that contains Certificate Authority files.
354 .br
355 ~/.alpine-smime/private Directory that contains private key(s).
356 .br
357 ~/.alpine-smime/public Directory that contains public key(s).
358 .br
359 /tmp/.\\usr\\spool\\mail\\xxxx Per-folder mailbox lock files.
360 .br
361 ~/.pine-interrupted-mail Message which was interrupted.
362 .br
363 ~/mail/postponed-msgs For postponed messages (drafts)
364 .br
365 ~/mail/sent-mail Outgoing message archive (FCC).
366 .br
367 ~/mail/saved-messages Default destination for Saving messages.
368 .SH "SEE ALSO"
369
370 pico(1), binmail(1), aliases(5), mailaddr(7), sendmail(8), spell(1), imapd(8)
371
372 .br
373 Newsgroup: comp.mail.pine
374
375 .br
376 Mailing List:
377 .br
378 Alpine-info, at https://www.washington.edu/alpine/alpine-info/
379
380 .br
381 Main Alpine distribution site:
382 .br
383 http://repo.or.cz/alpine.git
384
385 .br
386 Alpine Technical Notes, included in the source distribution.
387
388 .br
389 C-Client messaging API library, included in the source distribution.
390 .SH ACKNOWLEDGMENTS
391 .na
392 .nf
393
394 This software is the result of the contribution of many individuals
395 who have dedicated their time to support, improve and suggest ways
396 to improve Alpine through the years. This software would not be
397 possible without the support of the University of Washington in
398 Seattle, Washington. The Alpine community extends its most sincere
399 thanks to all contributors and invites everyone to join in and
400 contribute to this project.