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

142 lines
3.5 KiB
Plaintext
Raw Normal View History

Add man pages
2019-05-17 19:45:20 +02:00
aerc(1)
# NAME
aerc - the world's best email client
# SYNOPSIS
_aerc_
Mention aerc-tutorial(7) in aerc(1)
2019-06-05 02:32:05 +02:00
For a guided tutorial, use *:help tutorial* from aerc, or *man aerc-tutorial*
from your terminal.
Add man pages
2019-05-17 19:45:20 +02:00
# RUNTIME COMMANDS
New account wizard, part one
2019-05-21 22:31:04 +02: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 19:45:20 +02: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 20:00:02 +02:00
*pwd*
Displays aerc's current working directory in the status bar.
Add man pages
2019-05-17 19:45:20 +02: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 20:59:13 +02: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 19:45:20 +02: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 19:41:56 +02: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 19:45:20 +02:00
*copy* <target>
Copies the selected message to the target folder.
aerc(1): add :read and :unread command to docs
2019-06-09 20:59:13 +02:00
*delete*
Add man pages
2019-05-17 19:45:20 +02:00
Deletes the selected message.
Document :forward in aerc(1)
2019-05-26 02:33:36 +02:00
*forward*
Opens the composer to forward the selected message to another recipient.
Add man pages
2019-05-17 19:45:20 +02:00
*move* <target>
Moves the selected message to the target folder.
aerc(1): add :read and :unread command to docs
2019-06-09 20:59:13 +02: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-10 01:21:26 +02:00
*mkdir* <name>
Creates a new folder for this account and changes to that folder.
Add man pages
2019-05-17 19:45:20 +02: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 20:59:13 +02:00
*next* <n>[%], *prev-message* <n>[%]
Add man pages
2019-05-17 19:45:20 +02: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 20:59:13 +02:00
*select* <n>
Add man pages
2019-05-17 19:45:20 +02: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 20:59:13 +02:00
*view*
Add man pages
2019-05-17 19:45:20 +02:00
Opens the message viewer to display the selected message.
## MESSAGE VIEW COMMANDS
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 23:37:39 +02: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.
*save* <path>
Saves the current message part to the given path.
Add man pages
2019-05-17 19:45:20 +02:00
*close*
Closes the message viewer.
## TERMINAL COMMANDS
*close*
Closes the terminal.
# SEE ALSO
Mention aerc-tutorial(7) in aerc(1)
2019-06-05 02:32:05 +02:00
*aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) *aerc-tutorial*(7)
Add man pages
2019-05-17 19:45:20 +02: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.