Commit Graph

357 Commits

Author SHA1 Message Date
8c706a77db mu-init: automatic export labels with --reinit
When re-initializing the store, automatically write the labels to a file in mu's
cache, so user can later import them.
2025-08-16 16:20:33 +03:00
d843c9eb8e man: update man-pages (label / typos) 2025-08-15 21:03:19 +03:00
46fa4f2aa2 mu: add 'label' command + manpage + tests
Add a label command and document it.
2025-08-15 21:03:19 +03:00
812d78be49 mu-scm: add options, some tweaks
Add the (options) procedure + docs.

Some internal tweaks / clean-ups.
2025-06-30 21:57:29 +03:00
24a6d7725e mu-scm: add man-page
Not much yet.
2025-06-19 14:58:03 +03:00
cc10fbd22a man: update mu-index manpage
Make it a bit more explicit what we ignore.
2025-05-31 08:40:53 +03:00
f75e1203d4 mu: rename --my-address into --personal-address
This makes things a bit more uniform with all the places where we use
"personal".

--my-address remains as an alias for the command-line option.

Add unit test.

Resolves #2806.
2025-05-24 17:17:00 +03:00
3a506f4065 Merge pull request #2828 from a3a3el/bugfix/man-page-quoting-fixes/v1
man: fix some single-quoted strings
2025-05-04 16:23:53 +03:00
44ba631a34 mu-find: implement format=json2
Implement a new experimental json2 format for mu-find, which gets rid of
the ":" prefixes for fields, i.e., "subject" instead of ":subject".
Document it as well.
2025-03-23 19:47:09 +02:00
3dd922ff6c man: escape a couple of back-slashes
Otherwise:

    (with the \040 specifying a space in the regular expression, and and extra '\' to escape it)

is rendered as:

    (with the $ 40 specifying a space in the regular expression, and and extra `$´ to escape it)

Fixes: 5e2b7d52b2 ("mu-query.7: update documentation")
Signed-off-by: Jeremy Sowden <jeremy@azazel.net>
2025-03-10 21:44:28 +00:00
9364d25af7 man: fix some single-quoted strings
Commit 721aadc140 ("man: change quoting style") replaced single-quoted strings
of the form:

    'lorem ipsum'

with:

    `lorem ipsum'

to prevent the possibility of single quotes appearing at the beginning of lines,
because these will be misinterpreted by troff.  However, changes to the man-page
sources in 1.12.9 reintroduced some of these, including one which does appear at
the beginning of a line in mu-query(7):

    '"', '*', '(' and ')'. The details are shell-specific. In case of doubt, the

which results in the following warning:

    troff:<standard input>:25: warning: macro '"',' not defined

and the omission of that line from the rendered paragraph:

    NOTE:  if  you  use  queries on the command-line (say, for mu find), you
    need to quote any characters that would otherwise be interpreted by  the
    shell, such as *--analyze option can be useful.

Use back-ticks for the opening quotes.

Fixes: 5e2b7d52b2 ("mu-query.7: update documentation")
Signed-off-by: Jeremy Sowden <jeremy@azazel.net>
2025-03-10 21:23:11 +00:00
3dbd8b9763 mu4e: handle conversion from pcre regexps
mu server uses PCRE-compatible regular expressions, but mu4e needs
Emacs-style. In simple cases, the two are the same, but when it gets
slightly more complicated they do not.

E.g.,
  (foo|bar) => \(foo\|bar\)

Mu4e can do the conversion automatically, but for this the pcre2el
package (available in MELPA) is required, and is used if user installs
is. Anyway, this code implements the automatic conversion and adds some
documentation.

Fixes #2816.
2025-02-16 18:47:49 +02:00
a33530e917 mu.1.org: update COLOR information 2025-01-26 18:56:38 +02:00
5e2b7d52b2 mu-query.7: update documentation
In particular, regex searches.
2025-01-08 22:12:47 +02:00
1b2d9d3847 mu-find: insist on --linksdir for links
Fixes #2790.
2024-12-04 23:18:15 +02:00
8fefc52eee query: add related: combi-field + test
Add a new combination (pseudo) field "related:", which combines
"message-id" and "references"
2024-12-02 11:43:14 +02:00
05be072676 man: improve mu-query manpage 2024-12-01 23:45:28 +02:00
b0d8d42dd2 indexer: make lazy check even lazier
In lazy-mode, we were skipping directories that did not change; however,
this didn't help for the case were users received new messages in big
maildirs.

So, add another check where we compare the ctime of message files with
the time of the last indexing operation. If it's smaller, ignore the
message-file. This is faster than having to consult the Xapian database
for each message.

Note that this requires in mu4e:
      (setq mu4e-index-lazy-check t)
or
   --lazy-check
as a parameter for 'mu index'.
2024-11-10 13:47:54 +02:00
27ba0a0d02 Merge pull request #2760 from markk/mk/query-man-page
Correct mu-query man page
2024-09-25 19:32:56 +03:00
9e0d0b8355 mu-init: fix typo in manpage, improve 2024-09-25 19:27:14 +03:00
23b39759e0 man: update description of logging
Fixes #2762.
2024-09-24 23:33:00 +03:00
6426363e01 Correct mu-query man page
Update mu-query man page to point to the mu info fields command.
2024-09-15 09:46:34 +01:00
61ba9296b2 man: attempt to avoid \u escape in man building
This may help for #2756
2024-09-15 10:59:44 +03:00
QP
0282c8551d Replace zero-width spaces in man pages with an empty string.
The zero-width spaces are added by the `man-link` macro to ensure bold text
formatting when exporting from org, but they interfere with man page
functionality in Emacs.
2024-09-04 12:34:53 +02:00
547cc4ce74 mu-man: typeset option values differently
Use underlining only, do not use <>, as it is the most often done.
2024-07-22 16:09:17 +09:00
cee4823f33 mu-man: typeset file names using underlining
Make the emphasis more consistent, and do it using underscores in
Org documents, since verbatim is rendered as underlined anyway.
2024-07-22 15:40:57 +09:00
d46b428f7b mu-man: delete suspicious words 2024-07-22 15:28:47 +09:00
5ed773aa4d mu-man: include whole prefooter in mu-view 2024-07-22 15:26:31 +09:00
ec42817a5c mu-man: typeset reference in included file 2024-07-22 15:26:27 +09:00
b09ac79330 mu-man: fix the BUGS section of mu-view 2024-07-22 15:21:09 +09:00
dcc3807155 mu-man: improve typesetting of references
Try to stick to the man-pages(7) standard.
2024-07-22 15:18:46 +09:00
d2ec1751eb mu-man: add macro for referencing manual pages 2024-07-22 14:48:29 +09:00
96f8729cb5 mu-man: use more bold text
Make occurences of "mu", small commands such as "mu init", and
command-line arguments bold.
2024-07-18 10:01:45 +09:00
f1a2153578 mu-man: improve typesetting of synopses 2024-07-17 23:51:39 +09:00
fab36e283a common-options: capitalize first sentences 2024-07-16 14:11:50 +09:00
f66a4a37f5 mu-1: slightly improve syntax 2024-07-16 11:44:17 +09:00
a9872fc536 mu-1: remove extra '~' 2024-07-16 11:02:25 +09:00
a23fc80e37 mu-1: add missing word 2024-07-16 11:01:54 +09:00
f813498f4d mu: add --reindex option for mu index
I.e. without having to reinit explicitly.
2024-04-05 19:03:42 +03:00
9275068204 man: Escape Org heading-like lines in example 2024-03-28 11:04:05 -05:00
fcdc47fcec mu-index.1: fix typo 2024-03-19 08:31:42 +01:00
7e89e3715b mu-query: use mu info tables 2024-03-17 10:59:37 +02:00
7ca566bda6 Document personal and calendar flags 2024-03-16 15:44:09 -07:00
0b68afe9aa mu-index.1: add note about encryption
mu index does not decrypt.

Fixes #2660.
2024-03-07 22:56:10 +02:00
721aadc140 man: change quoting style
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:<standard input>: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 <azazel@debian.org>
2024-03-06 21:12:32 +00:00
c76aa53156 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 <azazel@debian.org>
2024-03-06 21:12:32 +00:00
e5fe18c2c2 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 <azazel@debian.org>
2024-03-06 21:12:32 +00:00
d8389e9721 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 <azazel@debian.org>
2024-03-06 21:12:32 +00:00
f70efd3cec man: fix bold syntax-error
There's a closing asterisk missing from a bold string.

Signed-off-by: Jeremy Sowden <azazel@debian.org>
2024-03-06 21:12:32 +00:00
0e0457190d 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 <azazel@debian.org>
2024-03-06 21:12:32 +00:00