X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-dump.rst;h=0a7a23876cf324f149c833eca85f561303577033;hb=3baa61e0e58402bc50c5df529fcf669bf4b2facb;hp=f8ec486871c120a729810b6a07d8585e0c0a0635;hpb=5d510221d17862a252955d98046508bebcd14573;p=notmuch diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index f8ec4868..0a7a2387 100644 --- a/doc/man1/notmuch-dump.rst +++ b/doc/man1/notmuch-dump.rst @@ -21,13 +21,13 @@ incremental backup than the native database files.) See **notmuch-search-terms(7)** for details of the supported syntax for . With no search terms, a dump of all messages in -the database will be generated. A "--" argument instructs notmuch that +the database will be generated. A ``--`` argument instructs notmuch that the remaining arguments are search terms. Supported options for **dump** include ``--gzip`` - Compress the output in a format compatible with **gzip(1)**. + Compress the output in a format compatible with :manpage:`gzip(1)`. ``--format=(sup|batch-tag)`` Notmuch restore supports two plain text dump formats, both with @@ -36,8 +36,8 @@ Supported options for **dump** include **batch-tag** The default **batch-tag** dump format is intended to more robust against malformed message-ids and tags containing - whitespace or non-\ **ascii(7)** characters. Each line has the - form:: + whitespace or non-\ :manpage:`ascii(7)` characters. Each line + has the form:: +<*encoded-tag*\ > +<*encoded-tag*\ > ... -- id:<*quoted-message-id*\ > @@ -54,11 +54,11 @@ Supported options for **dump** include **sup** The **sup** dump file format is specifically chosen to be - compatible with the format of files produced by sup-dump. So - if you've previously been using sup for mail, then the - **notmuch restore** command provides you a way to import all - of your tags (or labels as sup calls them). Each line has the - following form:: + compatible with the format of files produced by + :manpage:`sup-dump(1)`. So if you've previously been using sup + for mail, then the **notmuch restore** command provides you a + way to import all of your tags (or labels as sup calls + them). Each line has the following form:: <*message-id*\ > **(** <*tag*\ > ... **)**