emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity
mu/man/mu-info.1.org

33 lines
733 B
Org Mode
Raw Permalink Normal View History

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 10:13:00 +01:00
#+TITLE: MU INFO
#+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@"
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-17 23:21:52 +01:00
* NAME
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-02 13:00:31 +01:00
mu-info - show information
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-17 23:21:52 +01:00
* SYNOPSIS
cli: merge 'fields' with 'info' command Update the 'info' command to handle 'fields' as well; remove fields.
2023-07-03 17:44:13 +02:00
*mu [common options] info [<topic>]*
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-17 23:21:52 +01:00
* DESCRIPTION
cli: merge 'fields' with 'info' command Update the 'info' command to handle 'fields' as well; remove fields.
2023-07-03 17:44:13 +02:00
~mu info~ is the ~mu~ command for getting information about various topics:
mu-info: add 'topic mu' information; improve manpage Show some more runtime information in the 'mu' topic, and make that the default. Update manpage.
2023-07-26 18:09:18 +02:00
- *mu*: general mu build information (default)
cli: merge 'fields' with 'info' command Update the 'info' command to handle 'fields' as well; remove fields.
2023-07-03 17:44:13 +02:00
- *store*: information about the message store
- *fields*: table with all the query fields and flags
mu-info: add 'maildirs' topic For showing all maildirs under the root.
2023-09-16 10:09:11 +02:00
- *maildirs*: list all maildirs under the store's root-maildir
cli: merge 'fields' with 'info' command Update the 'info' command to handle 'fields' as well; remove fields.
2023-07-03 17:44:13 +02:00
mu-info: add 'topic mu' information; improve manpage Show some more runtime information in the 'mu' topic, and make that the default. Update manpage.
2023-07-26 18:09:18 +02:00
Note that while running (e.g. ~mu4e~), some of the ~store~ information can be
delayed due to database caching.
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-17 23:21:52 +01:00
#+include: "common-options.inc" :minlevel 1
#+include: "exit-code.inc" :minlevel 1
#+include: "prefooter.inc" :minlevel 1
* SEE ALSO
cli: merge 'fields' with 'info' command Update the 'info' command to handle 'fields' as well; remove fields.
2023-07-03 17:44:13 +02:00
*mu(1)*