Commit Graph

18 Commits

Author SHA1 Message Date
cc10fbd22a man: update mu-index manpage
Make it a bit more explicit what we ignore.
2025-05-31 08:40:53 +03: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
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
dcc3807155 mu-man: improve typesetting of references
Try to stick to the man-pages(7) standard.
2024-07-22 15:18:46 +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
f813498f4d mu: add --reindex option for mu index
I.e. without having to reinit explicitly.
2024-04-05 19:03:42 +03:00
fcdc47fcec mu-index.1: fix typo 2024-03-19 08:31:42 +01: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
fa2ceec4ae man: add performance notes to find/index/server manpages 2023-08-06 16:19:43 +03:00
f3c303106d man: update mu-index manpage 2023-07-18 23:14:25 +03:00
4449ac9d29 man: improve exit code descriptions 2023-01-29 15:38:06 +02:00
4b00ea0635 man: update man pages
Explicitly mention PCRE where appropriate.

Include section headers (through MAN_CLASS_OPTIONS)

Fix mu-easy manpage

Make date dynamic
2022-12-30 11:15:03 +02:00
a259ae4162 man: generate manpages from .org files
Generate the manpages from org-documents which makes it a bit easier to
keep them update to date since I find org-syntax easier than troff, and
we can use include files.
2022-12-29 10:41:16 +02:00