[PATCH 1/5] doc: bring notmuch-dump manual page in line with the rest
Jani Nikula writes: > Fix indentation of options. Move search terms description before > options. Fix synopsis. pushed the first 4 patches. d
Re: [PATCH 1/5] doc: bring notmuch-dump manual page in line with the rest
Jani Nikula j...@nikula.org writes: Fix indentation of options. Move search terms description before options. Fix synopsis. pushed the first 4 patches. d ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH 1/5] doc: bring notmuch-dump manual page in line with the rest
Fix indentation of options. Move search terms description before options. Fix synopsis. --- doc/man1/notmuch-dump.rst | 100 -- 1 file changed, 53 insertions(+), 47 deletions(-) diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index d94cb4f84496..3a6d0b34f505 100644 --- a/doc/man1/notmuch-dump.rst +++ b/doc/man1/notmuch-dump.rst @@ -5,7 +5,7 @@ notmuch-dump SYNOPSIS -**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*search-term*> ...] +**notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=<*file*>] [--] [<*search-term*> ...] DESCRIPTION === @@ -19,52 +19,58 @@ recreated from the messages themselves. The output of notmuch dump is therefore the only critical thing to backup (and much more friendly to incremental backup than the native database files.) -``--gzip`` -Compress the output in a format compatible with **gzip(1)**. - -``--format=(sup|batch-tag)`` -Notmuch restore supports two plain text dump formats, both with one -message-id per line, followed by a list of tags. - -**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 - -+<*encoded-tag*\ > +<*encoded-tag*\ > ... -- -id:<*quoted-message-id*\ > - -Tags are hex-encoded by replacing every byte not matching the -regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is the two -digit hex encoding. The message ID is a valid Xapian query, -quoted using Xapian boolean term quoting rules: if the ID -contains whitespace or a close paren or starts with a double -quote, it must be enclosed in double quotes and double quotes -inside the ID must be doubled. The astute reader will notice -this is a special case of the batch input format for -**notmuch-tag(1)**; note that the single message-id query is -mandatory for **notmuch-restore(1)**. - -**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 - -<*message-id*\ > **(** <*tag*\ > ... **)** - -with zero or more tags are separated by spaces. Note that -(malformed) message-ids may contain arbitrary non-null -characters. Note also that tags with spaces will not be -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 . +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 remaining arguments are search terms. + +Supported options for **dump** include + +``--gzip`` +Compress the output in a format compatible with **gzip(1)**. + +``--format=(sup|batch-tag)`` +Notmuch restore supports two plain text dump formats, both with one +message-id per line, followed by a list of tags. + +**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 + ++<*encoded-tag*\ > +<*encoded-tag*\ > ... -- +id:<*quoted-message-id*\ > + +Tags are hex-encoded by replacing every byte not matching +the regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is +the two digit hex encoding. The message ID is a valid +Xapian query, quoted using Xapian boolean term quoting +rules: if the ID contains whitespace or a close paren or +starts with a double quote, it must be enclosed in double +quotes and double quotes inside the ID must be +doubled. The astute reader will notice this is a special +case of the batch input format for **notmuch-tag(1)**; +note that the single message-id query is mandatory for +**notmuch-restore(1)**. + +**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
[PATCH 1/5] doc: bring notmuch-dump manual page in line with the rest
Fix indentation of options. Move search terms description before options. Fix synopsis. --- doc/man1/notmuch-dump.rst | 100 -- 1 file changed, 53 insertions(+), 47 deletions(-) diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index d94cb4f84496..3a6d0b34f505 100644 --- a/doc/man1/notmuch-dump.rst +++ b/doc/man1/notmuch-dump.rst @@ -5,7 +5,7 @@ notmuch-dump SYNOPSIS -**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=*file*] [--] [*search-term* ...] +**notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=*file*] [--] [*search-term* ...] DESCRIPTION === @@ -19,52 +19,58 @@ recreated from the messages themselves. The output of notmuch dump is therefore the only critical thing to backup (and much more friendly to incremental backup than the native database files.) -``--gzip`` -Compress the output in a format compatible with **gzip(1)**. - -``--format=(sup|batch-tag)`` -Notmuch restore supports two plain text dump formats, both with one -message-id per line, followed by a list of tags. - -**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 - -+*encoded-tag*\ +*encoded-tag*\ ... -- -id:*quoted-message-id*\ - -Tags are hex-encoded by replacing every byte not matching the -regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is the two -digit hex encoding. The message ID is a valid Xapian query, -quoted using Xapian boolean term quoting rules: if the ID -contains whitespace or a close paren or starts with a double -quote, it must be enclosed in double quotes and double quotes -inside the ID must be doubled. The astute reader will notice -this is a special case of the batch input format for -**notmuch-tag(1)**; note that the single message-id query is -mandatory for **notmuch-restore(1)**. - -**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 - -*message-id*\ **(** *tag*\ ... **)** - -with zero or more tags are separated by spaces. Note that -(malformed) message-ids may contain arbitrary non-null -characters. Note also that tags with spaces will not be -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 **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)**. + +``--format=(sup|batch-tag)`` +Notmuch restore supports two plain text dump formats, both with one +message-id per line, followed by a list of tags. + +**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 + ++*encoded-tag*\ +*encoded-tag*\ ... -- +id:*quoted-message-id*\ + +Tags are hex-encoded by replacing every byte not matching +the regex **[A-Za-z0-9@=.,\_+-]** with **%nn** where nn is +the two digit hex encoding. The message ID is a valid +Xapian query, quoted using Xapian boolean term quoting +rules: if the ID contains whitespace or a close paren or +starts with a double quote, it must be enclosed in double +quotes and double quotes inside the ID must be +doubled. The astute reader will notice this is a special +case of the batch input format for **notmuch-tag(1)**; +note that the single message-id query is mandatory for +**notmuch-restore(1)**. + +**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
