From fc719e47c452564b56d2ed0b7828fc74e72fcef8 Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Fri, 17 May 2019 13:45:20 -0400 Subject: Add man pages --- doc/aerc.1.scd | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 doc/aerc.1.scd (limited to 'doc/aerc.1.scd') diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd new file mode 100644 index 0000000..5d501f0 --- /dev/null +++ b/doc/aerc.1.scd @@ -0,0 +1,103 @@ +aerc(1) + +# NAME + +aerc - the world's best email client + +# SYNOPSIS + +_aerc_ + +Starts the interactive aerc mail client on /dev/tty. + +# RUNTIME COMMANDS + +To execute a command, press : to summon the command interface. Commands may also +be bound to keys, see *aerc-config*(5) for details. + +Different commands work in different contexts, depending on the kind of tab you +have selected. + +## GLOBAL COMMANDS + +These commands work in any context. + +*cd* + Changes aerc's current working directory. + +*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. + +## MESSAGE LIST COMMANDS + +*cf* + 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. + +*copy* + Copies the selected message to the target folder. + +*delete-message* + Deletes the selected message. + +*move* + Moves the selected message to the target folder. + +*next-folder* , *prev-folder* + Cycles to the next (or previous) folder shown in the sidebar, repeated n + times (default: 1). + +*next-message* [%], *prev-message* [%] + 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* + Downloads and pipes the selected message into the given shell command, and + opens a new terminal tab to show the result. + +*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 + +*select-message* + Selects the nth message in the message list (and scrolls it into view if + necessary). + +*view-message* + Opens the message viewer to display the selected message. + +## MESSAGE VIEW COMMANDS + +*close* + Closes the message viewer. + +## TERMINAL COMMANDS + +*close* + Closes the terminal. + +# SEE ALSO + +*aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) + +# AUTHORS + +Maintained by Drew DeVault , who is assisted by other open +source contributors. For more information about aerc development, see +https://git.sr.ht/~sircmpwn/aerc. -- cgit 1.4.1-2-gfad0