_
/
aerc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
aerc/doc/aerc.1.scd

161 lines
3.9 KiB
Plaintext
Raw Normal View History

Add man pages
2019-05-17 17:45:20 +00:00
aerc(1)
# NAME
aerc - the world's best email client
# SYNOPSIS
Add aerc -v to print the installed version
2019-06-18 13:42:41 +00:00
_aerc_ [-v]
Add man pages
2019-05-17 17:45:20 +00:00
Mention aerc-tutorial(7) in aerc(1)
2019-06-05 00:32:05 +00:00
For a guided tutorial, use *:help tutorial* from aerc, or *man aerc-tutorial*
from your terminal.
Add man pages
2019-05-17 17:45:20 +00:00
Add aerc -v to print the installed version
2019-06-18 13:42:41 +00:00
# OPTIONS
*-v*
Prints the installed version of aerc and exits.
Add man pages
2019-05-17 17:45:20 +00:00
# RUNTIME COMMANDS
New account wizard, part one
2019-05-21 20:31:04 +00:00
To execute a command, press ':' to bring up the command interface. Commands may
also be bound to keys, see *aerc-config*(5) for details. In some contexts, such
as the terminal emulator, ';' is used to bring up the command interface.
Add man pages
2019-05-17 17:45:20 +00:00
Different commands work in different contexts, depending on the kind of tab you
have selected.
## GLOBAL COMMANDS
These commands work in any context.
*cd* <directory>
Changes aerc's current working directory.
Implement :pwd command
2019-05-19 18:00:02 +00:00
*pwd*
Displays aerc's current working directory in the status bar.
Add man pages
2019-05-17 17:45:20 +00:00
*term* [command...]
Opens a new terminal tab with a shell running in the current working
directory, or the specified command.
*prev-tab* [n], *next-tab* [n]
Cycles to the previous or next tab in the list, repeating n times
(default: 1).
*quit*
Exits aerc.
aerc(1): add :read and :unread command to docs
2019-06-09 18:59:13 +00:00
## MESSAGE COMMANDS
These commands are valid in any context that has a selected message (e.g. the
message list, the message in the message viewer, etc).
Add man pages
2019-05-17 17:45:20 +00:00
Add archive command Adds an archive command that moves the current message into the folder specified in the account config entry. Supports three layouts at this point: - flat: puts all messages next to each other - year: creates a folder per year - month: same as above, plus folders per month This also adds a "-p" argument to "cp" and "mv" that works like "--parents" on mkdir(1). We use this to auto-create the directories for the archive layout.
2019-06-08 17:41:56 +00:00
*archive* <scheme>
Moves the selected message to the archive. The available schemes are:
*flat*: No special structure, all messages in the archive directory
*year*: Messages are stored in folders per year
*month*: Messages are stored in folders per year and subfolders per month
Add man pages
2019-05-17 17:45:20 +00:00
*copy* <target>
Copies the selected message to the target folder.
aerc(1): add :read and :unread command to docs
2019-06-09 18:59:13 +00:00
*delete*
Add man pages
2019-05-17 17:45:20 +00:00
Deletes the selected message.
Document :forward in aerc(1)
2019-05-26 00:33:36 +00:00
*forward*
Opens the composer to forward the selected message to another recipient.
Add man pages
2019-05-17 17:45:20 +00:00
*move* <target>
Moves the selected message to the target folder.
aerc(1): add :read and :unread command to docs
2019-06-09 18:59:13 +00:00
*reply* [-aq]
Opens the composer to reply to the selected message.
*-a*: Reply all
*-q*: Insert a quoted version of the selected message into the reply editor
*read*
Marks the selected message as read.
*unread*
Marks the selected message as unread.
## MESSAGE LIST COMMANDS
*cf* <folder>
Change the folder shown in the message list.
*compose*
Open the compose window to send a new email. The new email will be sent with
the current account's outgoing transport configuration, see
*aerc-config*(5) for details on configuring outgoing emails.
Implement :mkdir command
2019-06-09 23:21:26 +00:00
*mkdir* <name>
Creates a new folder for this account and changes to that folder.
Add man pages
2019-05-17 17:45:20 +00:00
*next-folder* <n>, *prev-folder* <n>
Cycles to the next (or previous) folder shown in the sidebar, repeated n
times (default: 1).
aerc(1): add :read and :unread command to docs
2019-06-09 18:59:13 +00:00
*next* <n>[%], *prev-message* <n>[%]
Add man pages
2019-05-17 17:45:20 +00:00
Selects the next (or previous) message in the message list. If specified as
a percentage, the percentage is applied to the number of messages shown on
screen and the cursor advances that far.
*pipe* <cmd>
Downloads and pipes the selected message into the given shell command, and
opens a new terminal tab to show the result.
aerc(1): add :read and :unread command to docs
2019-06-09 18:59:13 +00:00
*select* <n>
Add man pages
2019-05-17 17:45:20 +00:00
Selects the nth message in the message list (and scrolls it into view if
necessary).
aerc(1): add :read and :unread command to docs
2019-06-09 18:59:13 +00:00
*view*
Add man pages
2019-05-17 17:45:20 +00:00
Opens the message viewer to display the selected message.
## MESSAGE VIEW COMMANDS
commands/msgview: add open command
2019-06-16 20:52:44 +00:00
*open*
Saves the current message part in a temporary file and opens it
with xdg-open.
Add :save and :pipe commands to viewer * :save takes a path and saves the current message part to that location * :pipe is the same as pipe on the account page, but uses the current message part rather than the whole email (ie :pipe gzip -d) * Refactored account:pipe and extracted common pipe code to commands.util.QuickTerm * Added helper command aerc.PushError
2019-05-26 21:37:39 +00:00
*pipe* <cmd>
Downloads and pipes the current message part into the given shell command,
and opens a new terminal tab to show the result.
Support directories in path to :save This adds new functionality to :save in the message view for specifying directories in the path. A new flag, -p, is also added to :save for automatically creating any directories in the path that do not exist. If the path ends in a / (e.g. "Downloads/mail/") or if the path is an existing directory, the part's file name is the filename from the mail header for the part. Otherwise, it uses the last element in the path as the filename (e.g. 'blah.jpg' is the filename if the path is 'Downloads/mail/blah.jpg')
2019-06-11 18:26:13 +00:00
*save* [-p] <path>
Add :save and :pipe commands to viewer * :save takes a path and saves the current message part to that location * :pipe is the same as pipe on the account page, but uses the current message part rather than the whole email (ie :pipe gzip -d) * Refactored account:pipe and extracted common pipe code to commands.util.QuickTerm * Added helper command aerc.PushError
2019-05-26 21:37:39 +00:00
Saves the current message part to the given path.
Support directories in path to :save This adds new functionality to :save in the message view for specifying directories in the path. A new flag, -p, is also added to :save for automatically creating any directories in the path that do not exist. If the path ends in a / (e.g. "Downloads/mail/") or if the path is an existing directory, the part's file name is the filename from the mail header for the part. Otherwise, it uses the last element in the path as the filename (e.g. 'blah.jpg' is the filename if the path is 'Downloads/mail/blah.jpg')
2019-06-11 18:26:13 +00:00
*-p*: Make any directories in the path that do not exist
Add man pages
2019-05-17 17:45:20 +00:00
*close*
Closes the message viewer.
## TERMINAL COMMANDS
*close*
Closes the terminal.
Document collecting log output Redirecting stdout writes log output to that file, but this wasn't easily discoverable. v2 removes changes to aerc-tutorial; I was also on the fence about that, and agree that it isn't on-topic for the tutorial. Addresses https://todo.sr.ht/~sircmpwn/aerc2/180
2019-06-12 16:20:49 +00:00
# LOGGING
Aerc does not log by default, but collecting log output can be useful for
troubleshooting and reporting issues. Redirecting stdout when invoking aerc will
write log messages to that file:
$ aerc > log
Add man pages
2019-05-17 17:45:20 +00:00
# SEE ALSO
Mention aerc-tutorial(7) in aerc(1)
2019-06-05 00:32:05 +00:00
*aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) *aerc-tutorial*(7)
Add man pages
2019-05-17 17:45:20 +00:00
# AUTHORS
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
source contributors. For more information about aerc development, see
https://git.sr.ht/~sircmpwn/aerc.