From 0e0457190d0f40797cf82a0dc892f5939bff0439 Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 14:45:42 +0000 Subject: [PATCH 1/6] man: build mu-move.1 1.12.0 includes a new mu-move.1 man-page but the list of man-pages in man/meson.build was not updated, so it is not built. Signed-off-by: Jeremy Sowden --- man/meson.build | 1 + 1 file changed, 1 insertion(+) diff --git a/man/meson.build b/man/meson.build index 2dedf8e8..1866c3c3 100644 --- a/man/meson.build +++ b/man/meson.build @@ -55,6 +55,7 @@ man_orgs=[ 'mu-info.1.org', 'mu-init.1.org', 'mu-mkdir.1.org', + 'mu-move.1.org', 'mu-query.7.org', 'mu-remove.1.org', 'mu-server.1.org', From f70efd3ceca85eef8eaf0ebea28b3e6727229b90 Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 12:36:26 +0000 Subject: [PATCH 2/6] man: fix bold syntax-error There's a closing asterisk missing from a bold string. Signed-off-by: Jeremy Sowden --- man/mu-cfind.1.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org index 61c0e58a..eb99e929 100644 --- a/man/mu-cfind.1.org +++ b/man/mu-cfind.1.org @@ -61,7 +61,7 @@ sets the output format to the given value. The following are available: | json | JSON format | -[1] *CSV is not fully standardized, but *mu cfind* follows some common practices: +[1] *CSV* is not fully standardized, but *mu cfind* follows some common practices: any double-quote is replaced by a double-double quote (thus, "hello" become ""hello"", and fields with commas are put in double-quotes. Normally, this should only apply to name fields. From d8389e972137f4ed1877f099195a996248dffc51 Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 14:06:35 +0000 Subject: [PATCH 3/6] man: fix formatting of underscores In org-mode, underscores are used to represent subscripts. Thus, `a_b` will be transcoded to `a\d\s-2b\s+2\u`. Configure org-mode only to do this for `a_{b}`. Signed-off-by: Jeremy Sowden --- man/meson.build | 1 + 1 file changed, 1 insertion(+) diff --git a/man/meson.build b/man/meson.build index 1866c3c3..de4ba29d 100644 --- a/man/meson.build +++ b/man/meson.build @@ -82,6 +82,7 @@ foreach src : man_orgs expr_tmpl = ''.join([ '(progn', ' (require \'ox-man)', + ' (setq org-export-with-sub-superscripts \'{})', ' (org-export-to-file \'man "@0@"))']) expr = expr_tmpl.format(org.substring(0,-4)) sectiondir = join_paths(mandir, 'man' + section) From e5fe18c2c2d6ed6cfe34ffb8f0cc6adfb4bcc7f1 Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 12:37:25 +0000 Subject: [PATCH 4/6] man: disable captions in tables The tables don't define any captions, and ox-man outputs a `.TB` macro that groff does not support. Signed-off-by: Jeremy Sowden --- man/mu-cfind.1.org | 2 ++ man/mu-find.1.org | 1 + man/mu-index.1.org | 1 + man/mu-move.1.org | 2 ++ man/mu-query.7.org | 1 + man/mu-server.1.org | 1 + 6 files changed, 8 insertions(+) diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org index eb99e929..f8502dfc 100644 --- a/man/mu-cfind.1.org +++ b/man/mu-cfind.1.org @@ -49,6 +49,7 @@ The regular expressions are basic case-insensitive PCRE, see *pcre(3)*. ** --format=plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv sets the output format to the given value. The following are available: +#+ATTR_MAN: :disable-caption t | --format= | description | |-------------+-----------------------------------| | plain | default, simple list | @@ -112,6 +113,7 @@ With ~--format=json~, the matching contacts come out as a JSON array, e.g., Each contact has the following fields: +#+ATTR_MAN: :disable-caption t | property | description | |---------------+--------------------------------------------------------------------------| | ~email~ | the email-address | diff --git a/man/mu-find.1.org b/man/mu-find.1.org index 845db60c..1a4986c2 100644 --- a/man/mu-find.1.org +++ b/man/mu-find.1.org @@ -289,6 +289,7 @@ taking the total number for 10 test runs. 2. time (repeat 10 mu find "" -n 50000 --include-related --threads > /dev/null) +#+ATTR_MAN: :disable-caption t | release | time 1 (sec) | time 2 (sec) | |---------------+--------------+--------------| | 1.4 | 8.9s | 59.3s | diff --git a/man/mu-index.1.org b/man/mu-index.1.org index 5efc3549..c51d5054 100644 --- a/man/mu-index.1.org +++ b/man/mu-index.1.org @@ -183,6 +183,7 @@ too! Indexing the the same 93000-message mail corpus with the last few releases: +#+ATTR_MAN: :disable-caption t | release | time (sec) | notes | |---------------+------------+------------------------------------------| | 1.4 | 160s | | diff --git a/man/mu-move.1.org b/man/mu-move.1.org index 540c158f..5dae0e51 100644 --- a/man/mu-move.1.org +++ b/man/mu-move.1.org @@ -55,6 +55,7 @@ The message flags specify the Maildir-metadata for a message and are represented by uppercase letters at the end of the message file name for all 'non-new' messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir. +#+ATTR_MAN: :disable-caption t | Flag | Meaning | |------+------------------------------------| | D | Draft message | @@ -67,6 +68,7 @@ messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir. New messages (in the ~new/~ sub-directory) do not have flags encoded in their file-name; but we *mu* uses 'N' in the ~--flags~ to represent that: +#+ATTR_MAN: :disable-caption t | Flag | Meaning | |------+---------| | N | New | diff --git a/man/mu-query.7.org b/man/mu-query.7.org index db8fe7e3..a00a267e 100644 --- a/man/mu-query.7.org +++ b/man/mu-query.7.org @@ -118,6 +118,7 @@ We already saw a number of search fields, such as *subject:* and *body:*. For th full table with all details, including single-char shortcuts, try the command: ~mu info fields~. +#+ATTR_MAN: :disable-caption t |------------+-----------+--------------------------------| | field-name | alias | description | | bcc | | Blind carbon-copy recipient | diff --git a/man/mu-server.1.org b/man/mu-server.1.org index a5e53e1c..6919249d 100644 --- a/man/mu-server.1.org +++ b/man/mu-server.1.org @@ -73,6 +73,7 @@ time build/mu/mu server --allow-temp-file --eval '(find :query "\"\"" :include-r #+end_src (and ~--allow-temp-file~ for 1.11) +#+ATTR_MAN: :disable-caption t | release | time (sec) | |---------------+------------| | 1.8 | 8.6s | From c76aa5315652ac5eca6ae24829bcf77a261716c3 Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 12:00:31 +0000 Subject: [PATCH 5/6] man: fix formatting of `NAME` sections The command names are formatted inconsistently, e.g.: * NAME ~mu add~ - add one or more messages to the database versus: * NAME *mu cfind* is the *mu* command to find contacts in the *mu* database and export them versus: * NAME mu server - the mu backend for the mu4e e-mail client and the format, with a space between "mu" and the subcommand, is not compatible with mandb(8). Use formatting which is consistent and replace the spaces with hyphens. Signed-off-by: Jeremy Sowden --- man/mu-add.1.org | 2 +- man/mu-bookmarks.5.org | 2 +- man/mu-cfind.1.org | 2 +- man/mu-easy.7.org | 2 +- man/mu-extract.1.org | 2 +- man/mu-find.1.org | 2 +- man/mu-help.1.org | 2 +- man/mu-index.1.org | 2 +- man/mu-info.1.org | 2 +- man/mu-init.1.org | 2 +- man/mu-mkdir.1.org | 2 +- man/mu-move.1.org | 2 +- man/mu-query.7.org | 2 +- man/mu-remove.1.org | 3 +-- man/mu-server.1.org | 2 +- man/mu-verify.1.org | 2 +- man/mu-view.1.org | 2 +- man/mu.1.org | 2 +- 18 files changed, 18 insertions(+), 19 deletions(-) diff --git a/man/mu-add.1.org b/man/mu-add.1.org index a7f3ba7c..f2b644cb 100644 --- a/man/mu-add.1.org +++ b/man/mu-add.1.org @@ -3,7 +3,7 @@ * NAME -~mu add~ - add one or more messages to the database +mu-add - add one or more messages to the database * SYNOPSIS diff --git a/man/mu-bookmarks.5.org b/man/mu-bookmarks.5.org index 6fbbe35e..b7d275e0 100644 --- a/man/mu-bookmarks.5.org +++ b/man/mu-bookmarks.5.org @@ -3,7 +3,7 @@ * NAME -bookmarks - file with bookmarks (shortcuts) for mu search expressions +mu-bookmarks - file with bookmarks (shortcuts) for mu search expressions * DESCRIPTION diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org index f8502dfc..d55aa3d5 100644 --- a/man/mu-cfind.1.org +++ b/man/mu-cfind.1.org @@ -3,7 +3,7 @@ * NAME -*mu cfind* is the *mu* command to find contacts in the *mu* database and export them +mu-cfind - find contacts in the *mu* database and export them for use in other programs. * SYNOPSIS diff --git a/man/mu-easy.7.org b/man/mu-easy.7.org index 8ebca999..2222f13b 100644 --- a/man/mu-easy.7.org +++ b/man/mu-easy.7.org @@ -3,7 +3,7 @@ * NAME -mu easy - a quick introduction to mu +mu-easy - a quick introduction to mu * DESCRIPTION diff --git a/man/mu-extract.1.org b/man/mu-extract.1.org index de8f6f0c..24c6e29c 100644 --- a/man/mu-extract.1.org +++ b/man/mu-extract.1.org @@ -3,7 +3,7 @@ * NAME -*mu extract* is the *mu* command to display and save message parts +mu-extract - display and save message parts (attachments), and open them with other tools. * SYNOPSIS diff --git a/man/mu-find.1.org b/man/mu-find.1.org index 1a4986c2..60444407 100644 --- a/man/mu-find.1.org +++ b/man/mu-find.1.org @@ -3,7 +3,7 @@ * NAME -*mu find* - find e-mail messages in the *mu* database. +mu-find - find e-mail messages in the *mu* database. * SYNOPSIS diff --git a/man/mu-help.1.org b/man/mu-help.1.org index e2831951..2a67dc2e 100644 --- a/man/mu-help.1.org +++ b/man/mu-help.1.org @@ -3,7 +3,7 @@ * NAME -*mu help* is a *mu* command that gives help information about mu commands. +mu-help - show help information about mu commands. * SYNOPSIS diff --git a/man/mu-index.1.org b/man/mu-index.1.org index c51d5054..db040cf6 100644 --- a/man/mu-index.1.org +++ b/man/mu-index.1.org @@ -3,7 +3,7 @@ * NAME -*mu index* -- index e-mail messages stored in Maildirs +mu-index - index e-mail messages stored in Maildirs * SYNOPSIS diff --git a/man/mu-info.1.org b/man/mu-info.1.org index 000f55f3..0d182d7c 100644 --- a/man/mu-info.1.org +++ b/man/mu-info.1.org @@ -3,7 +3,7 @@ * NAME -~mu info~ - show information +mu-info - show information * SYNOPSIS diff --git a/man/mu-init.1.org b/man/mu-init.1.org index 38195e8d..6e773eb1 100644 --- a/man/mu-init.1.org +++ b/man/mu-init.1.org @@ -3,7 +3,7 @@ * NAME -mu init -- initialize the mu message database +mu-init - initialize the mu message database * SYNOPSIS diff --git a/man/mu-mkdir.1.org b/man/mu-mkdir.1.org index a85d9f5a..f10a7149 100644 --- a/man/mu-mkdir.1.org +++ b/man/mu-mkdir.1.org @@ -3,7 +3,7 @@ * NAME -*mu mkdir* - create a new Maildir +mu-mkdir - create a new Maildir * SYNOPSIS diff --git a/man/mu-move.1.org b/man/mu-move.1.org index 5dae0e51..e46a5f8a 100644 --- a/man/mu-move.1.org +++ b/man/mu-move.1.org @@ -3,7 +3,7 @@ * NAME -*mu move* - move a message file or change its flags +mu-move - move a message file or change its flags * SYNOPSIS diff --git a/man/mu-query.7.org b/man/mu-query.7.org index a00a267e..719bd510 100644 --- a/man/mu-query.7.org +++ b/man/mu-query.7.org @@ -3,7 +3,7 @@ * NAME -mu query language -- a language for finding messages in *mu* databases. +mu-query - a language for finding messages in *mu* databases. * DESCRIPTION diff --git a/man/mu-remove.1.org b/man/mu-remove.1.org index 52adf94c..ff2c24c0 100644 --- a/man/mu-remove.1.org +++ b/man/mu-remove.1.org @@ -1,10 +1,9 @@ #+TITLE: MU REMOVE #+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@" - * NAME -*mu remove* - command to remove messages from the database. +mu-remove - remove messages from the database. * SYNOPSIS diff --git a/man/mu-server.1.org b/man/mu-server.1.org index 6919249d..18148605 100644 --- a/man/mu-server.1.org +++ b/man/mu-server.1.org @@ -3,7 +3,7 @@ * NAME -mu server - the mu backend for the mu4e e-mail client +mu-server - the mu backend for the mu4e e-mail client * SYNOPSIS diff --git a/man/mu-verify.1.org b/man/mu-verify.1.org index e7cee9cb..9cc0933d 100644 --- a/man/mu-verify.1.org +++ b/man/mu-verify.1.org @@ -3,7 +3,7 @@ * NAME -mu verify - verify message signatures and display information about them +mu-verify - verify message signatures and display information about them * SYNOPSIS diff --git a/man/mu-view.1.org b/man/mu-view.1.org index f9e26f0c..17351f74 100644 --- a/man/mu-view.1.org +++ b/man/mu-view.1.org @@ -3,7 +3,7 @@ * NAME -mu view - display an e-mail message file +mu-view - display an e-mail message file * SYNOPSIS diff --git a/man/mu.1.org b/man/mu.1.org index 64d30798..35b992ac 100644 --- a/man/mu.1.org +++ b/man/mu.1.org @@ -3,7 +3,7 @@ * NAME -~mu~ - a set of tools to deal with Maildirs and message files, in particular to +mu - a set of tools to deal with Maildirs and message files, in particular to index and search e-mail messages. * SYNOPSIS From 721aadc140f221bba022f665faad8450b5458aaa Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 13:25:56 +0000 Subject: [PATCH 6/6] man: change quoting style MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The man-page sources use single quotes to quote text. However, this can be problematic in man-pages because if a single quote appears at the beginning of a line the following word is interpreted by troff as a macro. For example, this paragraph in mu-easy.7: What if we want to see some of the body of the message? You can get a 'summary' of the first lines of the message using the \fI\-\-summary\-len\fP option, which will 'summarize' the first \fIn\fP lines of the message: elicits this warning: $ man --warnings obj-x86_64-linux-gnu/man/mu-easy.7 >/dev/null troff::166: warning: macro 'summarize'' not defined and gets truncated: What if we want to see some of the body of the message? You can get a 'summary' of the first lines of the message using the --summary-len op‐ tion, which will One could adjust the line-wrapping to move the quoted text away from the beginning of the line, but that is fragile. Another possibility would be to use the troff escape-sequences for open and close quotes (`\(oq` and `\(cq` respectively), but ox-man is being used precisely to avoid having to handle troff directly. Instead use back-ticks for left quotes. Thus: What if we want to see some of the body of the message? You can get a `summary' of the first lines of the message using the \fI\-\-summary\-len\fP option, which will `summarize' the first \fIn\fP lines of the message: which is rendered correctly: What if we want to see some of the body of the message? You can get a `summary' of the first lines of the message using the --summary-len op- tion, which will `summarize' the first n lines of the message: Signed-off-by: Jeremy Sowden --- man/mu-cfind.1.org | 2 +- man/mu-easy.7.org | 20 ++++++++++---------- man/mu-extract.1.org | 6 +++--- man/mu-find.1.org | 18 +++++++++--------- man/mu-index.1.org | 6 +++--- man/mu-init.1.org | 8 ++++---- man/mu-move.1.org | 10 +++++----- man/mu-query.7.org | 36 ++++++++++++++++++------------------ man/mu.1.org | 2 +- 9 files changed, 54 insertions(+), 54 deletions(-) diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org index d55aa3d5..0c14dc6b 100644 --- a/man/mu-cfind.1.org +++ b/man/mu-cfind.1.org @@ -67,7 +67,7 @@ any double-quote is replaced by a double-double quote (thus, "hello" become ""hello"", and fields with commas are put in double-quotes. Normally, this should only apply to name fields. -** --personal,-p only show addresses seen in messages where one of 'my' e-mail +** --personal,-p only show addresses seen in messages where one of `my' e-mail addresses was seen in one of the address fields; this is to exclude addresses only seen in mailing-list messages. See the ~--my-address~ parameter to *mu init*. diff --git a/man/mu-easy.7.org b/man/mu-easy.7.org index 2222f13b..662a3149 100644 --- a/man/mu-easy.7.org +++ b/man/mu-easy.7.org @@ -54,7 +54,7 @@ can use the =--maildir= option to specify the top-level directory that should be processed. See the *mu-index(1)* man page for more details. Normally, *mu index* visits all the directories under the top-level Maildir; -however, you can exclude certain directories (say, the 'trash' or 'spam' +however, you can exclude certain directories (say, the `trash' or `spam' folders) by creating a file called =.noindex= in the directory. When *mu* sees such a file, it will exclude this directory and its sub-directories from indexing. Also see *.noupdate* in the *mu-index(1)* manpage. @@ -83,7 +83,7 @@ This should return something like: 2008-07-31T21:57:25 EEST John Milton Fere libenter homines id quod volunt credunt #+end_example -This means there is a message to 'julius' with 'fruit' somewhere in the message. +This means there is a message to `julius' with `fruit' somewhere in the message. In this case, it's a message from John Milton. Note that the date format depends on your the language/locale you are using. @@ -96,7 +96,7 @@ date/sender/subject. However, we can change this using the =--fields= parameter $ mu find --fields="t s" t:julius fruit #+end_example -In other words, display the 'To:'-field (t) and the subject (s). This should +In other words, display the `To:'-field (t) and the subject (s). This should return something like: #+begin_example Julius Caesar Fere libenter homines id quod volunt credunt @@ -121,9 +121,9 @@ from Socrates. This could return something like: 2008-07-31T21:57:25 EEST John Milton Fere libenter homines id quod volunt credunt #+end_example -What if we want to see some of the body of the message? You can get a 'summary' +What if we want to see some of the body of the message? You can get a `summary' of the first lines of the message using the =--summary-len= option, which will -'summarize' the first =n= lines of the message: +`summarize' the first =n= lines of the message: #+begin_example $ mu find --summary-len=3 napoleon m:/archive @@ -206,7 +206,7 @@ for: #+end_example and get mails about soccer, Socrates, society, and so on. Note, it's important to quote the search query, otherwise the shell will interpret -the '*'. +the `*'. You can also search for messages with a certain attachment using their filename, for example: @@ -214,7 +214,7 @@ filename, for example: #+begin_example *$ mu find 'file:pic*'* #+end_example -will get you all messages with an attachment starting with 'pic'. +will get you all messages with an attachment starting with `pic'. If you want to find attachments with a certain MIME-type, you can use the following: @@ -232,9 +232,9 @@ Get all messages with image attachments: #+end_example -Note that (1) the '*' wildcard can only be used as the rightmost thing in a +Note that (1) the `*' wildcard can only be used as the rightmost thing in a search query, and (2) that you need to quote the search term, because -otherwise your shell will interpret the '*' (expanding it to all files in the +otherwise your shell will interpret the `*' (expanding it to all files in the current directory -- probably not what you want). * DISPLAYING MESSAGES @@ -282,7 +282,7 @@ your contacts. $ mu cfind julius #+end_example -will find all contacts with 'julius' in either name or e-mail address. Note that +will find all contacts with `julius' in either name or e-mail address. Note that *mu cfind* accepts a =regular expression= (as per *pcre(3)*) *mu cfind* also supports a =--format==-parameter, which sets the output to some diff --git a/man/mu-extract.1.org b/man/mu-extract.1.org index 24c6e29c..596a6637 100644 --- a/man/mu-extract.1.org +++ b/man/mu-extract.1.org @@ -27,7 +27,7 @@ with filenames matching that pattern will be extracted. The regular expressions are basic PCRE, and are case-sensitive by default; see *pcre(3)* for more details. Without any options, *mu extract* simply outputs the list of leaf MIME-parts in -the message. Only 'leaf' MIME-parts (including RFC822 attachments) are +the message. Only `leaf' MIME-parts (including RFC822 attachments) are considered, *multipart/** etc. are ignored. Without a filename parameter, ~mu extract~ reads a message from standard-input. In @@ -66,7 +66,7 @@ expressions are basic PCRE, and are case-sensitive by default; see *pcre(3)* for more details. ** --play -Try to 'play' (open) the attachment with the default application for the +Try to `play' (open) the attachment with the default application for the particular file type. On MacOS, this uses the *open* program, on other platforms it uses *xdg-open*. You can choose a different program by setting the *MU_PLAY_PROGRAM* environment variable. @@ -86,7 +86,7 @@ the same name: $ mu extract --parts=3,4 --overwrite msgfile #+end_example -To extract all files ending in '.jpg' (case-insensitive): +To extract all files ending in `.jpg' (case-insensitive): #+begin_example $ mu extract msgfile '.*\.jpg' #+end_example diff --git a/man/mu-find.1.org b/man/mu-find.1.org index 60444407..a8fc9fee 100644 --- a/man/mu-find.1.org +++ b/man/mu-find.1.org @@ -25,7 +25,7 @@ For example: $ mu find subject:snow and date:2009.. #+end_example -would find all messages in 2009 with 'snow' in the subject field, e.g: +would find all messages in 2009 with `snow' in the subject field, e.g: #+begin_example 2009-03-05 17:57:33 EET Lucia running in the snow @@ -63,7 +63,7 @@ For example: $ mu find subject:snow --fields "d f s" #+end_example -lists the date, subject and sender of all messages with 'snow' in the their +lists the date, subject and sender of all messages with `snow' in the their subject. The table of replacement characters is superset of the list mentions for search @@ -82,12 +82,12 @@ parameters, such as: For the complete list, try the command: ~mu info fields~. The message flags are described in *mu-query(7)*. As an example, a message which -is 'seen', has an attachment and is signed would have 'asz' as its corresponding -output string, while an encrypted new message would have 'nx'. +is `seen', has an attachment and is signed would have `asz' as its corresponding +output string, while an encrypted new message would have `nx'. ** -s, --sortfield= and -z,--reverse specify the field to sort the search results by and the direction (i.e., -'reverse' means that the sort should be reverted - Z-A). Examples include: +`reverse' means that the sort should be reverted - Z-A). Examples include: #+begin_example cc,c Cc (carbon-copy) recipient(s) @@ -164,7 +164,7 @@ This is assuming the GNU *date* command. ** --exec= the ~--exec~ coption causes the =command= to be executed on each matched message; -for example, to see the raw text of all messages matching 'milkshake', you could +for example, to see the raw text of all messages matching `milkshake', you could use: #+begin_example $ mu find milkshake --exec='less' @@ -188,10 +188,10 @@ common occurrence when using e.g. Gmail together with *offlineimap*. ** -r, --include-related include messages being referred to by the matched messages -- i.e.. include messages that are part of the same message thread as some matched messages. This -is useful if you want Gmail-style 'conversations'. +is useful if you want Gmail-style `conversations'. ** -t, --threads -show messages in a 'threaded' format -- that is, with indentation and arrows +show messages in a `threaded' format -- that is, with indentation and arrows showing the conversation threads in the list of matching messages. When using this, sorting is chronological (by date), based on the newest message in a thread. @@ -206,7 +206,7 @@ message, as in the following table: | other | |-> | |*> | |=> | #+end_example -Here, an 'orphan' is a message without a parent message (in the list of +Here, an `orphan' is a message without a parent message (in the list of matches), and a duplicate is a message whose message-id was already seen before; not this may not really be the same message, if the message-id was copied. diff --git a/man/mu-index.1.org b/man/mu-index.1.org index db040cf6..44cbfd57 100644 --- a/man/mu-index.1.org +++ b/man/mu-index.1.org @@ -50,9 +50,9 @@ below for details. The first run of *mu index* may take a few minutes if you have a lot of mail (tens of thousands of messages). Fortunately, such a full scan needs to be done only once; after that it suffices to index the changes, which goes much faster. See -the 'PERFORMANCE (i,ii,iii)' below for more information. +the `PERFORMANCE (i,ii,iii)' below for more information. -The optional 'phase two' of the indexing-process is the removal of messages from +The optional `phase two' of the indexing-process is the removal of messages from the database for which there is no longer a corresponding file in the Maildir. If you do not want this, you can use ~-n~, ~--nocleanup~. @@ -108,7 +108,7 @@ $ time mu index --quiet (more than 56818 messages per second) Note that each test flushes the caches first; a more common use case might be to -run *mu index* when new mail has arrived; the cache may stay quite 'warm' in that +run *mu index* when new mail has arrived; the cache may stay quite `warm' in that case: #+begin_example diff --git a/man/mu-init.1.org b/man/mu-init.1.org index 6e773eb1..6c3d4c94 100644 --- a/man/mu-init.1.org +++ b/man/mu-init.1.org @@ -27,9 +27,9 @@ performed). ** --my-address= -specifies that some e-mail address is 'my-address' (the option can be used +specifies that some e-mail address is `my-address' (the option can be used multiple times). Any message in which at least one of the contact fields -contains such an address is considered a 'personal' messages; this can then be +contains such an address is considered a `personal' messages; this can then be used for filtering in *mu-find(1)*, *mu-cfind(1)* and *mu4e*, e.g. to filter-out mailing list messages. @@ -58,7 +58,7 @@ the number of changes after which they are committed to the database; decreasing the value reduces the memory requirements, at the cost of make indexing substantially slower. Usually, the default of 250000 should be fine. -Batch-size 0 is interpreted as 'use the default'. +Batch-size 0 is interpreted as `use the default'. ** --support-ngrams @@ -76,7 +76,7 @@ options. * NGRAM SUPPORT -*mu*'s underlying Xapian database supports 'ngrams', which improve searching for +*mu*'s underlying Xapian database supports `ngrams', which improve searching for languages/scripts that do not have explicit word breaks, such as Chinese, Japanese and Korean. It is fairly intrusive, and influences both indexing and query-parsing; it is not enabled by default, and is recommended only if you need diff --git a/man/mu-move.1.org b/man/mu-move.1.org index e46a5f8a..d43a3faa 100644 --- a/man/mu-move.1.org +++ b/man/mu-move.1.org @@ -42,7 +42,7 @@ the source message. print the target filename(s), but don't change anything. Note that with the ~--change-name~, the target name is not constant, so you cannot -use a dry-run to predict the exact name when doing a 'real' run. +use a dry-run to predict the exact name when doing a `real' run. #+include: "common-options.inc" :minlevel 1 @@ -52,7 +52,7 @@ use a dry-run to predict the exact name when doing a 'real' run. man-page, or see http://cr.yp.to/proto/maildir.html) The message flags specify the Maildir-metadata for a message and are represented -by uppercase letters at the end of the message file name for all 'non-new' +by uppercase letters at the end of the message file name for all `non-new' messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir. #+ATTR_MAN: :disable-caption t @@ -60,13 +60,13 @@ messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir. |------+------------------------------------| | D | Draft message | | F | Flagged message | -| P | Passed message (i.e., 'forwarded') | +| P | Passed message (i.e., `forwarded') | | R | Replied message | | S | Seen message | | T | Trashed; to be deleted later | New messages (in the ~new/~ sub-directory) do not have flags encoded in their -file-name; but we *mu* uses 'N' in the ~--flags~ to represent that: +file-name; but we *mu* uses `N' in the ~--flags~ to represent that: #+ATTR_MAN: :disable-caption t | Flag | Meaning | @@ -74,7 +74,7 @@ file-name; but we *mu* uses 'N' in the ~--flags~ to represent that: | N | New | Thus, changing flags means changing the letters at the end of the message -file-name, except when setting or removing the 'N' (new) flag. Setting or +file-name, except when setting or removing the `N' (new) flag. Setting or un-setting the New flag causes the message is to be moved from ~cur/~ to ~new/~ or vice-versa, respectively. When marking a message as New, it looses the other flags. diff --git a/man/mu-query.7.org b/man/mu-query.7.org index 719bd510..09059766 100644 --- a/man/mu-query.7.org +++ b/man/mu-query.7.org @@ -26,7 +26,7 @@ quote any characters that would otherwise be interpreted by the shell, such as * TERMS The basic building blocks of a query are *terms*; these are just normal words like -'banana' or 'hello', or words prefixed with a field-name which makes them apply +`banana' or `hello', or words prefixed with a field-name which makes them apply to just that field. See *mu info fields* for all the available fields. Some example queries: @@ -36,13 +36,13 @@ subject:capybara maildir:/inbox #+end_example -Terms without an explicit field-prefix, (like 'vacation' above) are interpreted +Terms without an explicit field-prefix, (like `vacation' above) are interpreted like: #+begin_example to:vacation or subject:vacation or body:vacation or ... #+end_example -The language is case-insensitive for terms and attempts to 'flatten' diacritics, +The language is case-insensitive for terms and attempts to `flatten' diacritics, so =angtrom= matches =Ångström=. If terms contain whitespace, they need to be quoted: @@ -80,7 +80,7 @@ subject:chip AND subject:dale #+end_example are equivalent. For readability, we recommend the second version. -Note that a =pure not= - e.g. searching for *not apples* is quite a 'heavy' query. +Note that a =pure not= - e.g. searching for *not apples* is quite a `heavy' query. * REGULAR EXPRESSIONS AND WILDCARDS @@ -93,9 +93,9 @@ subject:/h.llo/ # match hallo, hello, ... subject:/ #+end_example -Note the difference between 'maildir:/foo' and 'maildir:/foo/'; the former -matches messages in the '/foo' maildir, while the latter matches all messages in -all maildirs that match 'foo', such as '/foo', '/bar/cuux/foo', '/fooishbar' +Note the difference between `maildir:/foo' and `maildir:/foo/'; the former +matches messages in the `/foo' maildir, while the latter matches all messages in +all maildirs that match `foo', such as `/foo', `/bar/cuux/foo', `/fooishbar' etc. Wildcards are another mechanism for matching where a term with a rightmost *** @@ -171,10 +171,10 @@ an open range. Dates are expressed in local time and using ISO-8601 format (YYYY-MM-DD HH:MM:SS); you can leave out the right part and *mu* adds the rest, depending on whether this is the beginning or end of the range (e.g., as a lower bound, -'2015' would be interpreted as the start of that year; as an upper bound as the +`2015' would be interpreted as the start of that year; as an upper bound as the end of the year). -You can use '/' , '.', '-', ':' and 'T' to make dates more human-readable. +You can use `/' , `.', `-', `:' and `T' to make dates more human-readable. Some examples: #+begin_example @@ -185,13 +185,13 @@ date:2015-06-01.. date:2016..2016 #+end_example -You can also use the special 'dates' *now* and *today*: +You can also use the special `dates' *now* and *today*: #+begin_example date:20170505..now date:today.. #+end_example -Finally, you can use relative 'ago' times which express some time before now and +Finally, you can use relative `ago' times which express some time before now and consist of a number followed by a unit, with units *s* for seconds, *M* for minutes, *h* for hours, *d* for days, *w* for week, *m* for months and *y* for years. Some examples: @@ -222,7 +222,7 @@ available: f,flagged Flagged l,list Mailing-list message n,new New message (in new/ Maildir) - p,passed Passed ('Handled') + p,passed Passed (`Handled') r,replied Replied s,seen Seen t,trashed Marked for deletion @@ -259,8 +259,8 @@ find it (and all the other messages in that same maildir) with: maildir:/lists/running #+end_example -Note the starting '/'. If you want to match mails in the 'root' maildir, you can -do with a single '/': +Note the starting `/'. If you want to match mails in the `root' maildir, you can +do with a single `/': #+begin_example maildir:/ #+end_example @@ -287,7 +287,7 @@ queries using various logical operators, parentheses and so on, but in the author's experience, it's usually faster to find a message with a simple query just searching for some words. -Find all messages with both 'bee' and 'bird' (in any field) +Find all messages with both `bee' and `bird' (in any field) #+begin_example bee AND bird #+end_example @@ -297,12 +297,12 @@ Find all messages with either Frodo or Sam: Frodo OR Sam #+end_example -Find all messages with the 'wombat' as subject, and 'capybara' anywhere: +Find all messages with the `wombat' as subject, and `capybara' anywhere: #+begin_example subject:wombat and capybara #+end_example -Find all messages in the 'Archive' folder from Fred: +Find all messages in the `Archive' folder from Fred: #+begin_example from:fred and maildir:/Archive #+end_example @@ -322,7 +322,7 @@ Find all messages with attached images: mime:image/* #+end_example -Find all messages written in Dutch or German with the word 'hallo': +Find all messages written in Dutch or German with the word `hallo': #+begin_example hallo and (lang:nl or lang:de) #+end_example diff --git a/man/mu.1.org b/man/mu.1.org index 35b992ac..026fd329 100644 --- a/man/mu.1.org +++ b/man/mu.1.org @@ -36,7 +36,7 @@ in them. ~mu~'s main purpose is to enable searching of e-mail messages. It does so by periodically scanning a Maildir directory tree and -analyzing the e-mail messages found (this is called 'indexing'). The +analyzing the e-mail messages found (this is called `indexing'). The results of this analysis are stored in a database, which can then be queried.