debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-25 04:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: bring notmuch-dump manual page in line with the rest

Browse source 
Fix indentation of options. Move search terms description before
options. Fix synopsis.
This commit is contained in:
Jani Nikula 2015-01-27 21:48:14 +02:00 committed by David Bremner
parent 625401eb2f
commit 6cc1c8d149
1 changed files with 44 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
doc/man1/notmuch-dump.rst
View file

@ -5,7 +5,7 @@ notmuch-dump
SYNOPSIS SYNOPSIS
======== ========
**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*search-term*> ...] **notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=<*file*>] [--] [<*search-term*> ...]
DESCRIPTION DESCRIPTION
=========== ===========
@ -19,38 +19,50 @@ recreated from the messages themselves. The output of notmuch dump is
therefore the only critical thing to backup (and much more friendly to therefore the only critical thing to backup (and much more friendly to
incremental backup than the native database files.) incremental backup than the native database files.)
``--gzip`` See **notmuch-search-terms(7)** for details of the supported syntax
for <search-terms>. With no search terms, a dump of all messages in
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 **gzip(1)**.
``--format=(sup|batch-tag)`` ``--format=(sup|batch-tag)``
Notmuch restore supports two plain text dump formats, both with one Notmuch restore supports two plain text dump formats, both with one
message-id per line, followed by a list of tags. message-id per line, followed by a list of tags.
**batch-tag** **batch-tag**
The default **batch-tag** dump format is intended to more robust
against malformed message-ids and tags containing whitespace or The default **batch-tag** dump format is intended to more
non-\ **ascii(7)** characters. Each line has the form robust against malformed message-ids and tags containing
whitespace or non-\ **ascii(7)** characters. Each line has
the form
+<*encoded-tag*\ > +<*encoded-tag*\ > ... -- +<*encoded-tag*\ > +<*encoded-tag*\ > ... --
id:<*quoted-message-id*\ > id:<*quoted-message-id*\ >
Tags are hex-encoded by replacing every byte not matching the Tags are hex-encoded by replacing every byte not matching
regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is the two the regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is
digit hex encoding. The message ID is a valid Xapian query, the two digit hex encoding. The message ID is a valid
quoted using Xapian boolean term quoting rules: if the ID Xapian query, quoted using Xapian boolean term quoting
contains whitespace or a close paren or starts with a double rules: if the ID contains whitespace or a close paren or
quote, it must be enclosed in double quotes and double quotes starts with a double quote, it must be enclosed in double
inside the ID must be doubled. The astute reader will notice quotes and double quotes inside the ID must be
this is a special case of the batch input format for doubled. The astute reader will notice this is a special
**notmuch-tag(1)**; note that the single message-id query is case of the batch input format for **notmuch-tag(1)**;
mandatory for **notmuch-restore(1)**. note that the single message-id query is mandatory for
**notmuch-restore(1)**.
**sup** **sup**
The **sup** dump file format is specifically chosen to be The **sup** dump file format is specifically chosen to be
compatible with the format of files produced by sup-dump. So if compatible with the format of files produced by
you've previously been using sup for mail, then the **notmuch sup-dump. So if you've previously been using sup for mail,
restore** command provides you a way to import all of your tags then the **notmuch restore** command provides you a way to
(or labels as sup calls them). Each line has the following form import all of your tags (or labels as sup calls
them). Each line has the following form
<*message-id*\ > **(** <*tag*\ > ... **)** <*message-id*\ > **(** <*tag*\ > ... **)**
@ -59,12 +71,6 @@ incremental backup than the native database files.)
characters. Note also that tags with spaces will not be characters. Note also that tags with spaces will not be
correctly restored with this format. correctly restored with this format.
With no search terms, a dump of all messages in the database will be
generated. A "--" argument instructs notmuch that the remaining
arguments are search terms.
See **notmuch-search-terms(7)** for details of the supported syntax
for <search-terms>.
SEE ALSO SEE ALSO
======== ========