aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-maildir.5.scd
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2022-11-22 20:39:21 +0100
committerRobin Jarry <robin@jarry.cc>2022-11-24 19:19:10 +0100
commitaf63bd0188d13ecf00628c30f88d0ee06c07e500 (patch)
treefe5bc06823aa372fbc209d8dea9cbce05a63e03e /doc/aerc-maildir.5.scd
parentfa294ef76fa015c090d1543630b147f2dca0b49a (diff)
downloadaerc-af63bd0188d13ecf00628c30f88d0ee06c07e500.tar.gz
doc: homogenize scdoc markup
For consistent rendering, it is best if every man page uses the same conventions. These are completely arbitrary and I only did some trial & error until I found something that looked visually OK. Update CONTRIBUTING.md with guidelines for scdoc markup conventions. Update all man pages according to these guidelines. Suggested-by: Inwit <inwit@sindominio.net> Signed-off-by: Robin Jarry <robin@jarry.cc> Acked-by: Koni Marti <koni.marti@gmail.com> Acked-by: Inwit <inwit@sindominio.net>
Diffstat (limited to 'doc/aerc-maildir.5.scd')
-rw-r--r--doc/aerc-maildir.5.scd8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
index ebd76b06..d11140ac 100644
--- a/doc/aerc-maildir.5.scd
+++ b/doc/aerc-maildir.5.scd
@@ -10,8 +10,8 @@ aerc implements the maildir format.
# CONFIGURATION
-Maildir accounts currently are not supported with the :new-account command and
-must be added manually to the *aerc-config*(5) file.
+Maildir accounts currently are not supported with the *:new-account* command and
+must be added manually to the _accounts.conf_ file.
The following maildir-specific options are available:
@@ -29,13 +29,13 @@ The following maildir-specific options are available:
Default: 10s
*source*
- maildir://path
+ maildir://_<path>_
The *source* indicates the path to the directory containing your maildirs
rather than one maildir specifically.
The path portion of the URL following _maildir://_ must be either an absolute
- path prefixed by */* or a path relative to your home directory prefixed with
+ path prefixed by _/_ or a path relative to your home directory prefixed with
*~*. For example:
source = maildir:///home/me/mail