aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2023-10-11 21:28:30 +0200
committerRobin Jarry <robin@jarry.cc>2023-10-28 19:24:52 +0200
commit591659b52867cb118d1f82d41693a02123935e0c (patch)
tree8cf2e5f16a7891f690bc07f83e35f27994cd2530 /doc
parente54486ee40c9cedde9d4dae3e89d8b5f932188ee (diff)
downloadaerc-591659b52867cb118d1f82d41693a02123935e0c.tar.gz
main: parse command line args with go-opt
Use get-opt to make argument parsing more explicit and have automatic usage generation. Update the man page to include missing details. Add a -h flag to display verbose usage and descriptions of options. Signed-off-by: Robin Jarry <robin@jarry.cc> Reviewed-by: Koni Marti <koni.marti@gmail.com> Tested-by: Moritz Poldrack <moritz@poldrack.dev> Tested-by: Inwit <inwit@sindominio.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc.1.scd22
1 files changed, 14 insertions, 8 deletions
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index 8443302c..2c49948f 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -6,23 +6,26 @@ aerc - a pretty good email client.
# SYNOPSIS
-*aerc* [*-v*] [*-a* _<account>_[,_<account>_]] [*mailto:*_..._]
+*aerc* [*-h*] [*-v*] [*-a* _<account>_] [*mailto:*_..._ | *:*_<command...>_ | *mbox:*_<file>_]
For a guided tutorial, use *:help tutorial* from aerc, or *man aerc-tutorial*
from your terminal.
# OPTIONS
+*-h*
+ Show aerc usage help and exit.
+
*-v*
- Prints the installed version of aerc and exits.
+ Print the installed version of aerc and exit.
-*-a* _<account>_[,_<account>_]
- Load only the named accounts, as opposed to all configured accounts.
- List must be comma separated, with no spaces. The account order will be
- preserved.
+*-a* _<account>_
+ Load only the named account, as opposed to all configured accounts. It
+ can also be a comma separated list of names. This option may be
+ specified multiple times. The account order will be preserved.
*mailto:*_address[,address][?query[&query]]_
- Opens the composer with the address(es) in the To field. These
+ Open the composer with the address(es) in the To field. These
addresses must not be percent encoded.
If aerc is already running, the composer is started in this instance,
otherwise aerc will be started.
@@ -47,10 +50,13 @@ from your terminal.
Note that reserved characters in the queries must be percent encoded.
-\:*command* [...]
+*:*_<command...>_
Run an aerc-internal command as you would in Ex-Mode. See *RUNTIME
COMMANDS* below.
+*mbox:*_<file>_
+ Open the specified mbox file as a virtual temporary account.
+
# RUNTIME COMMANDS
To execute a command, press *:* to bring up the command interface. Commands may