alpine(1)
๐ alpine(1) ยท General Commands Manual ๐
Manual: alpine(1) ๐ (General Commands Manual, bestie!)
๐ NAME ๐
alpine is an Alternatively Licensed Program for Internet News and Email ๐จโจ It's giving news AND email, no cap.
๐ธ SYNTAX ๐ธ
alpine [ options ] [ address , address ]
alpinef [ options ] [ address , address ]
๐ DESCRIPTION ๐
Okay so alpine is a screen-oriented message-handling tool ๐ฅ๏ธ๐ฆ By default it keeps things intentionally simple and geared toward novice users ๐ฑ but it also has a huge list of optional "power-user" and personal-preference features ๐ Literally something for everyone.
alpinef is a variant of Alpine that uses function keys instead of mnemonic single-letter commands โจ๏ธ๐ฅ Same queen, different vibe.
Alpine's basic feature set is giving:
- View, Save, Export, Delete, Print, Reply and Forward messages ๐
- Compose messages in a simple editor (Pico) with word-wrap and a spelling checker โ๏ธ Messages can be postponed for later completion, so you don't have to finish everything in one go ๐ซถ
- Full-screen selection and management of message folders ๐โจ
- An address book to keep track of long or frequently-used addresses ๐ Personal distribution lists can be defined ๐ and addresses can be taken into the address book from incoming mail without retyping them ๐ the efficiency is unmatched
- New mail checking and notification happens automatically every 2.5 minutes and after certain commands, e.g.
refresh-screen(Ctrl-L) ๐๐ - On-line, context-sensitive help screens ๐ง whenever you're lost, it's got you
Alpine supports MIME (Multipurpose Internet Mail Extensions), an Internet Standard for representing multipart and multimedia data in email ๐ธ Alpine lets you save MIME objects to files, and in some cases it can even start the correct program to view the object ๐ฌ It uses the system's mailcap configuration file to figure out which program can process a particular MIME object type ๐ง
Alpine's message composer doesn't have built-in multimedia capability, BUT any type of data file --including multimedia-- can be attached to a text message and sent using MIME's encoding rules ๐๐ This means any group of people with MIME-capable mail software (e.g. Alpine, PC-Alpine, or many other programs) can swap formatted documents, spread-sheets, image files, etc, via Internet email ๐ฅน๐ Friendship goals, honestly.
Alpine uses the c-client messaging API to access local and remote mail folders โญ This library gives you a bunch of low-level message-handling functions ๐ ๏ธ including drivers for a variety of different mail file formats, plus routines to access remote mail and news servers using IMAP (Internet Message Access Protocol) and NNTP (Network News Transport Protocol) ๐ Outgoing mail is usually posted directly via SMTP (Simple Mail Transfer Protocol) ๐คโจ
โจ OPTIONS โจ
okay so here's the command line stuff, and bestie there are a LOT of options ๐ Everything is listed below. Some of them are only for PC-Alpine, and I'll flag those ๐ซถ
addressโ Pop an address in and Alpine skips the menus and drops you straight into the message composer ๐ Mail goes to that address.-attach fileโ Send mail with that file attached ๐-attachlist file-listโ Same vibe, but you hand it a whole list of files in file-list and they all get attached as attachments ๐๏ธ-attach_and_delete fileโ Attaches the file like-attach, but then it removes the file after the message is sent ๐๏ธ
โ ๏ธ Heads up bestie: -attach_and_delete deletes the file once the message goes out. It's a whole-ass delete, not a suggestion ๐
-aux local_directoryโ PC-Alpine only ๐ช When you're using a remote config (-p <remote_config>), this tells PC-Alpine which local directory to stash its auxiliary files in, like debug files, address books, and signature files ๐ง-bailโ Exit if the pinerc file doesn't exist ๐ช This can be super handy if the config file is reached through some remote filesystem protocol. If the remote mount is missing, Alpine just quits instead of making itself a brand new pinerc ๐ โโ๏ธ-c context-numberโ context-number is the number of the folder-collection that the-fargument should apply to ๐ If you don't pick one,-fgoes to the first defined folder-collection-confโ Prints a sample/fresh copy of the system-wide config file,pine.conf, to standard output โจ This is different from your personal.pinercfile, so don't mix them up ๐ซ-convert_sigs -p pinercโ Converts your signature files into literal signatures ๐๏ธ-copy_abook <local_abook> <remote_abook>โ Copies your local address book file into a remote address book folder ๐-copy_pinerc <local_pinerc> <remote_pinerc>โ Copies your local pinerc file into a remote pinerc folder ๐-d debug-levelโ Dumps diagnostic info at debug-level (anywhere from 0-9) into the current.pine-debug[1-4]file ๐ Set it to0and debugging turns off, and the.pine-debugfile doesn't get made at all ๐-d key[=val]โ The fine-tuned version of debugging, bestie ๐ Here's what you can pick:flushmakes the debug file write without buffering ๐งtimestampslaps a timestamp on every message ๐ฐ๏ธimap=n, where n is 0-4, goes from no IMAP telemetry (0) all the way to verbose (4) ๐กnumfiles=n, where n is 0-31, is how many debug files get kept around ๐๏ธverbose=n, where n is 0-9, is an inverse threshold for message output ๐ข
-f folderโ Opens folder instead of INBOX ๐ฅ It goes in the first defined folder collection, but you can use-c nto pick a different collection-F fileโ Opens the named text file and lets you read it with Alpine's browser ๐-hโ Help! ๐ Lists all the valid command-line options-iโ Starts you up on the FOLDER INDEX screen ๐-I keystrokesโ An initial (comma separated) list of keystrokes that Alpine runs the second it starts up โจ๏ธ-installโ PC-Alpine only ๐ช Asks you for some basic setup info, then exits ๐ซ-kโ Uses function keys for commands. It's the exact same as runningalpinef๐-n numberโ Starts up with the current message-number set to number ๐ข-nowrite_password_cacheโ Reads from a password cache if there's one, but never offers to write a password into the cache ๐ โโ๏ธ-oโ Opens the first folder read-only ๐-p config-fileโ Uses config-file as your personal configuration file instead of the default.pinerc๐-P config-fileโ Uses config-file as the configuration file instead of the default system-widepine.conf๐-passfile <fully-qualified-path>โ If password file support is compiled in, this uses the file at fully-qualified-path instead of the default ๐-pinerc fileโ Outputs a fresh pinerc configuration to file, but keeps any settings the user already changed ๐ Set file to-and the output goes to standard out instead-pwdcertdir <fully-qualified-path>โ If SMIME and password file support are both compiled in, this sets the directory where your personal key and certificate go. Those are what encrypt and decrypt your password file ๐๏ธ-rโ Restricted/demo mode ๐ญ Alpine will only send mail to itself, and functions like save and export are restricted ๐ซ-registry cmdโ PC-Alpine only ๐ช This one messes with Alpine's registry entries. The possible values for cmd areset,clear, anddump:setalways resets Alpine's registry entries to match its current settings ๐clearclears the registry values ๐งนclearsilentclears the registry values silently ๐คซdumpshows you the values of your current registry settings ๐
๐ The dump command is currently disabled, so that one's a no-go for now.
Without the -registry option, PC-Alpine only writes values into the registry if there aren't any values set yet ๐ธ
-smimedir <fully-qualified-path>โ If SMIME is compiled in, this sets the directory where the public, private, and certificate authorities' certificates and keys live ๐ If you don't set it on the command line, the default is~/.alpine-smime๐-sort orderโ Sorts the FOLDER INDEX display in one of these orders:arrival,date,subject,orderedsubj,thread,from,size,score,to,cc, orreverse๐arrivalis the default.OrderedSubjpretends to be a threaded sort ๐งต Any sort can be flipped by adding/reverseto the end. Justreverseon its own is the same asarrival/reverse๐-supportedโ Some options are supported or not depending on how Alpine was compiled ๐ ๏ธ This one tells you which options your copy of Alpine actually supports โ-uninstallโ PC-Alpine only ๐ช Removes the references to Alpine in your Windows settings ๐งผ-url urlโ Opens the given url ๐ Can't be used with-for-F-vโ Version! Prints the version info ๐ฆ-versionโ Also version! Prints the version info too ๐ฆ-x configโ Uses the configuration exceptions in config ๐ฏ Exceptions override your default pinerc settings for one particular platform. The config can be a local file or a remote folder ๐-xoauth2-server ServerNameโ The name of the service that XOAUTH2 authentication will be tried with ๐ As of writing, Gmail is the only service supported. Example:-xoauth2-server Gmail
โ ๏ธ-xoauth2-server,-xoauth2-client-id, and-xoauth2-client-secretall have to be used at the same time, no exceptions ๐ซถ
-xoauth2-client-id Client-Idโ The string that tells the XOAUTH2 service provider who Alpine is ๐ชช Same rule:-xoauth2-server,-xoauth2-client-id, and-xoauth2-client-secretmust all be used simultaneously-xoauth2-client-secret Client-Secretโ The secret string that identifies Alpine to the XOAUTH2 service provider ๐ค Same rule:-xoauth2-server,-xoauth2-client-id, and-xoauth2-client-secretmust all be used simultaneously-zโ Turns on ^Z and SIGTSTP so you can suspend alpine โธ๏ธ-option=valueโ Assigns value to the config option option ๐ For example,-signature-file=sig1or-feature-list=signature-at-bottom. (Note: feature-list values are additive ๐)
โจ CONFIGURATION โจ
okay so Alpine has like, a few different levels of config, and the higher one always wins over the lower one ๐ Here's the order from lowest priority to highest, so you know who's boss:
- built-in defaults ๐งฑ
- system-wide
pine.conffile ๐ข - personal
.pinercfile (you can set this one through the built-in Setup/Config menu ๐ ๏ธ) - command-line options ๐ป
- system-wide
pine.conf.fixedfile ๐
There's one exception to the "higher level replaces lower level" rule, and it's the feature-list variable ๐ Its values are additive instead, so they stack up. You can also negate a single feature by putting no- in front of its name, like no-feature.
Unix Alpine also reads these environment variables ๐ธ
TERMDISPLAYโ decides if Alpine can display IMAGE attachments ๐ผ๏ธSHELLโ if it isn't set, the default is/bin/sh๐MAILCAPSโ a semicolon-delimited list of path names to mailcap files ๐
๐ FILES ๐
okay so this section is basically a map of every file alpine cares about, bestie ๐บ๏ธโจ
/var/spool/mail/xxxxโ where incoming mail lands by default ๐ฌ~/mailโ the default home base for your mail folders ๐~/.addressbookโ default address book file ๐~/.signatureโ the file that gets appended to every message โ๏ธ~/.pine-debug[1-4]โ diagnostic log for debugging ๐~/.pinercโ your personal alpine config file โ๏ธ~/.pine-crashโ debug info that's useful when alpine crashes ๐ฅ~/.newsrcโ news subscription and state file ๐ฐ~/.mailcapโ your personal mail capabilities file ๐~/.mime.typesโ your personal file extension to MIME type mapping ๐๏ธ/etc/mailcapโ the system-wide mail capabilities file ๐/etc/mime.typesโ the system-wide file extension to MIME type mapping ๐/etc/pine.infoโ local pointer to your system administrator ๐งโ๐ป/etc/pine.confโ the system-wide configuration file ๐๏ธ/etc/pine.conf.fixedโ non-overridable configuration file, so nobody can change it, not even you ๐ซ~/.alpine-smime/caโ directory that holds the Certificate Authority files ๐~/.alpine-smime/privateโ directory that holds private key(s) ๐~/.alpine-smime/publicโ directory that holds public key(s) ๐/tmp/.\usr\spool\mail\xxxxโ per-folder mailbox lock files ๐~/.pine-interrupted-mailโ a message that got interrupted mid-send ๐~/mail/postponed-msgsโ for postponed messages (drafts) ๐~/mail/sent-mailโ outgoing message archive, aka the FCC ๐ค~/mail/saved-messagesโ default destination when you save messages ๐พ
๐ SEE ALSO ๐
ngl, these are the vibes you'll want to check out next ๐ซถ
pico(1)binmail(1)aliases(5)mailaddr(7)sendmail(8)spell(1)imapd(8)
Newsgroup: comp.mail.pine ๐ฌ
Mailing List: Alpine-info, at https://www.washington.edu/alpine/alpine-info/ ๐ฎ
Main Alpine distribution site: http://repo.or.cz/alpine.git ๐ธ
- Alpine Technical Notes, included in the source distribution ๐
- C-Client messaging API library, included in the source distribution ๐ง
๐ ACKNOWLEDGMENTS ๐
this part is so sweet ๐ฅน Alpine is the result of so many people who gave their time to support it, improve it, and suggest ways to make it better over the years ๐ None of it would've happened without the University of Washington in Seattle, Washington ๐ The whole Alpine community sends its most sincere thanks to every contributor, and they invite everyone to jump in and contribute too โจ
That's the whole page, bestie! ๐ Alpine Version 2.26, manual page, fully served ๐ ๐๐ฆ
๐ฆ where this page comes from
- debian bookworm: alpine 2.26+dfsg-1 ยท Apache-2.0
- debian trixie: alpine 2.26+dfsg-3 ยท Apache-2.0
- ubuntu noble: alpine 2.26+dfsg-1build3 ยท Apache-2.0
- ubuntu questing: alpine 2.26+dfsg-3
- ubuntu resolute: alpine 2.26+dfsg-5 ยท Apache-2.0
- ubuntu stonking: alpine 2.26+dfsg-6build1 ยท Apache-2.0
- ๐ girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms