summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Riehs <tristan.riehs@bordeaux-inp.fr>2024-07-22 15:40:57 +0900
committerTristan Riehs <tristan.riehs@bordeaux-inp.fr>2024-07-22 15:40:57 +0900
commitcee4823f33684fb3f72961d4e9c2798854a65096 (patch)
tree93a639baeff27877b2347f330e5a73f44a7a56fc
parentd46b428f7b60879ff86f6e4f6ced113ea6f2378d (diff)
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.
-rw-r--r--man/mu-bookmarks.5.org4
-rw-r--r--man/mu-cfind.1.org2
-rw-r--r--man/mu-easy.7.org10
-rw-r--r--man/mu-find.1.org8
-rw-r--r--man/mu-index.1.org14
-rw-r--r--man/mu-init.1.org6
-rw-r--r--man/mu-mkdir.1.org6
-rw-r--r--man/mu-move.1.org8
-rw-r--r--man/mu-query.7.org2
-rw-r--r--man/mu-view.1.org2
-rw-r--r--man/muhome.inc6
11 files changed, 34 insertions, 34 deletions
diff --git a/man/mu-bookmarks.5.org b/man/mu-bookmarks.5.org
index 12c2af5..5b13ffb 100644
--- a/man/mu-bookmarks.5.org
+++ b/man/mu-bookmarks.5.org
@@ -12,8 +12,8 @@ Bookmarks are named shortcuts for search queries. They allow using a convenient
name for often-used queries. The bookmarks are also visible as shortcuts in the
*mu* experimental user interfaces, =mug= and =mug2=.
-The bookmarks file is read from =<muhome>/bookmarks=. On Unix this would typically
-be =~/.config/mu/bookmarks=, but this can be influenced using the *--muhome*
+The bookmarks file is read from _<muhome>/bookmarks_. On Unix this would typically
+be _~/.config/mu/bookmarks_, but this can be influenced using the *--muhome*
parameter for {{{man-link(mu-find,1)}}}.
The bookmarks file is a typical key=value *.ini*-file, which is best shown by
diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org
index b8a5b8c..32f4fb4 100644
--- a/man/mu-cfind.1.org
+++ b/man/mu-cfind.1.org
@@ -135,7 +135,7 @@ $ mu cfind --format=json --personal | jq -r '.[] | ."last-seen-iso" + " " + .dis
* INTEGRATION WITH MUTT
You can use *mu cfind* as an external address book server for *mutt*.
-For this to work, add the following to your =muttrc=:
+For this to work, add the following to your _muttrc_:
#+begin_example
set query_command = "mu cfind --format=mutt-ab '%s'"
diff --git a/man/mu-easy.7.org b/man/mu-easy.7.org
index d2810ae..9891321 100644
--- a/man/mu-easy.7.org
+++ b/man/mu-easy.7.org
@@ -56,7 +56,7 @@ processed. See the {{{man-link(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'
-folders) by creating a file called =.noindex= in the directory. When *mu* sees such
+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 {{{man-link(mu-index,1)}}} manpage.
@@ -106,8 +106,8 @@ Julius Caesar <jc@example.com> Fere libenter homines id quod volunt credunt
This is the same message found before, only with some different fields
displayed.
-By default, *mu* uses the logical ~AND~ for the search parameters -- that is, it
-displays messages that match all the parameters. However, we can use logical ~OR~
+By default, *mu* uses the logical _AND_ for the search parameters -- that is, it
+displays messages that match all the parameters. However, we can use logical _OR_
as well:
#+begin_example
@@ -141,7 +141,7 @@ The summary consists of the first /n/ lines of the message with all superfluous
whitespace removed.
Also note the *m:/archive* parameter in the query. This means that we only match
-messages in a maildir called ~'/archive'~.
+messages in a maildir called _'/archive'_.
* MORE QUERIES
@@ -296,7 +296,7 @@ $ mu cfind --format=mutt-alias > ~/mutt-aliases
#+end_example
Then, you can use them in *mutt* if you add something like *source ~/mutt-aliases*
-to your =muttrc=.
+to your _muttrc_.
#+include: "prefooter.inc" :minlevel 1
diff --git a/man/mu-find.1.org b/man/mu-find.1.org
index af889e4..576e640 100644
--- a/man/mu-find.1.org
+++ b/man/mu-find.1.org
@@ -145,9 +145,9 @@ will delete any symlink it finds, so be careful.
$ mu find grolsch --format=links --linksdir=~/Maildir/search --clearlinks
#+end_example
-stores links to found messages in =~/Maildir/search=. If the directory does not
+stores links to found messages in _~/Maildir/search_. If the directory does not
exist yet, it will be created. Note: when *mu* creates a Maildir for these links,
-it automatically inserts a =.noindex= file, to exclude the directory from *mu
+it automatically inserts a _.noindex_ file, to exclude the directory from *mu
index*.
** --after=<timestamp>
@@ -232,7 +232,7 @@ It is possible to integrate *mu find* with some mail clients
** *mutt*
-For *mutt* you can use the following in your =muttrc=; pressing the F8 key will
+For *mutt* you can use the following in your *muttrc*; pressing the F8 key will
start a search, and F9 will take you to the results.
#+begin_example
@@ -263,7 +263,7 @@ your Wanderlust configuration file:
Now, you can search using the *g* key binding; you can also create permanent
virtual folders when the messages matching some expression by adding something
-like the following to your =folders= file.
+like the following to your _folders_ file.
#+begin_example
VFolders {
diff --git a/man/mu-index.1.org b/man/mu-index.1.org
index 9300b0b..5794ffc 100644
--- a/man/mu-index.1.org
+++ b/man/mu-index.1.org
@@ -22,27 +22,27 @@ database.
*index* understands Maildirs as defined by Daniel Bernstein for
{{{man-link(qmail,7)}}}. In addition, it understands recursive Maildirs
(Maildirs within Maildirs), Maildir++. It also supports VFAT-based Maildirs
-which use =!= or =;= as the separators instead of =:=.
+which use *!* or *;* as the separators instead of *:*.
E-mail messages which are not stored in something resembling a maildir
-leaf-directory (=cur= and =new=) are ignored, as are the cache directories for
-=notmuch= and =gnus=, and any dot-directory.
+leaf-directory (_cur_ and _new_) are ignored, as are the cache directories for
+_notmuch_ and _gnus_, and any dot-directory.
Symlinks are followed, and the directories can be spread over multiple
filesystems; however note that moving files around is much faster when multiple
filesystems are not involved. Be careful to avoid self-referential symlinks!
-If there is a file called =.noindex= in a directory, the contents of that
+If there is a file called _.noindex_ in a directory, the contents of that
directory and all of its subdirectories will be ignored. This can be useful to
exclude certain directories from the indexing process, for example directories
with spam-messages.
-If there is a file called =.noupdate= in a directory, the contents of that
+If there is a file called _.noupdate_ in a directory, the contents of that
directory and all of its subdirectories will be ignored. This can be useful to
speed up things you have some maildirs that never change.
-=.noupdate= does not affect already-indexed message: you can still search for
-them. =.noupdate= is ignored when you start indexing with an empty database (such
+_.noupdate_ does not affect already-indexed message: you can still search for
+them. _.noupdate_ is ignored when you start indexing with an empty database (such
as directly after *mu init*).
There also the option *--lazy-check* which can greatly speed up indexing; see
diff --git a/man/mu-init.1.org b/man/mu-init.1.org
index 2e9bf29..0850a6d 100644
--- a/man/mu-init.1.org
+++ b/man/mu-init.1.org
@@ -21,7 +21,7 @@ has completed, you can run *mu index*
use =<maildir>= as the root-maildir.
-By default, *mu* uses the *MAILDIR* environment; if it is not set, it uses =~/Maildir=
+By default, *mu* uses the *MAILDIR* environment; if it is not set, it uses _~/Maildir_
if it is an existing directory. If neither of those can be used, the *--maildir*
option is required; it must be an absolute path (but ~~/~ expansion is
performed).
@@ -47,7 +47,7 @@ option can be used multiple times). Such addresses then cannot be found with
{{{man-link(mu-cfind,1)}}} or in the Mu4e contacts cache.
=<my-email-address>= can be either a plain e-mail address or a regexp, just like
-for the =--my-address= option.
+for the *--my-address* option.
** --max-message-size=<size>
@@ -85,7 +85,7 @@ query-parsing; it is not enabled by default, and is recommended only if you need
to search for messages written in such languages.
When enabled, *mu* automatically uses ngrams automatically. Xapian environment
-variables such as ~XAPIAN_CJK_NGRAM~ are ignored.
+variables such as *XAPIAN_CJK_NGRAM* are ignored.
#+include: "exit-code.inc" :minlevel 1
diff --git a/man/mu-mkdir.1.org b/man/mu-mkdir.1.org
index 7f67edd..c1587c3 100644
--- a/man/mu-mkdir.1.org
+++ b/man/mu-mkdir.1.org
@@ -13,8 +13,8 @@ mu-mkdir - create a new Maildir
* DESCRIPTION
*mu mkdir* is the command for creating Maildirs as per
-{{{man-link(maildir,5)}}}. A maildir is a a directory with subdirectories ~new~,
-~cur~ and ~tmp~.
+{{{man-link(maildir,5)}}}. A maildir is a a directory with subdirectories _new_,
+_cur_ and _tmp_.
The command does not use the *mu* database.
@@ -35,7 +35,7 @@ set the file access mode for the new maildir(s) as in
$ mu mkdir tom dick harry
#+end_example
-creates three maildirs, =tom=, =dick= and =harry=.
+creates three maildirs, _tom_, _dick_ and _harry_.
#+include: "prefooter.inc" :minlevel 1
diff --git a/man/mu-move.1.org b/man/mu-move.1.org
index 53fd5a3..c389c0d 100644
--- a/man/mu-move.1.org
+++ b/man/mu-move.1.org
@@ -55,7 +55,7 @@ use a dry-run to predict the exact name when doing a `real' run.
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.
+messages, i.e. messages that live in the _cur/_ sub-directory of a Maildir.
#+ATTR_MAN: :disable-caption t
| Flag | Meaning |
@@ -67,7 +67,7 @@ messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir.
| S | Seen message |
| T | Trashed; to be deleted later |
-New messages (in the ~new/~ sub-directory) do not have flags encoded in their
+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
@@ -77,7 +77,7 @@ file-name; but we *mu* uses `N' in the *--flags* to represent that:
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
-un-setting the New flag causes the message is to be moved from ~cur/~ to ~new/~ 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.
@@ -91,7 +91,7 @@ Absolute flags just specify the new flags by their letters; e.g. to specify a
#+end_example
Relative flags are relative to the current flags for some message, and each of
-the flags is prefixed with either ~+~ ("add this flag") or ~-~ ("remove this flag").
+the flags is prefixed with either *+* ("add this flag") or *-* ("remove this flag").
So to add the /Seen/ flag and remove the /Draft/ flag from whatever the message
already has, *--flags +S-D*.
diff --git a/man/mu-query.7.org b/man/mu-query.7.org
index 4169c52..bbc242e 100644
--- a/man/mu-query.7.org
+++ b/man/mu-query.7.org
@@ -281,7 +281,7 @@ prio:high
The Maildir field describes the directory path starting *after* the Maildir root
directory, and before the =/cur/= or =/new/= part. So, for example, if there's a
-message with the file name =~/Maildir/lists/running/cur/1234.213:2,=, you could
+message with the file name _~/Maildir/lists/running/cur/1234.213:2,_, you could
find it (and all the other messages in that same maildir) with:
#+begin_example
maildir:/lists/running
diff --git a/man/mu-view.1.org b/man/mu-view.1.org
index 6f741cf..7dc2081 100644
--- a/man/mu-view.1.org
+++ b/man/mu-view.1.org
@@ -13,7 +13,7 @@ mu-view - display an e-mail message file
* DESCRIPTION
*mu view* is the *mu* command for displaying e-mail message files. It works on
-message files and does =not= require the message to be indexed in the database.
+message files and does _not_ require the message to be indexed in the database.
The command shows some common headers (From:, To:, Cc:, Bcc:, Subject: and
Date:), the list of attachments and either the plain-text or html body of the
diff --git a/man/muhome.inc b/man/muhome.inc
index 177b8de..f3414c1 100644
--- a/man/muhome.inc
+++ b/man/muhome.inc
@@ -1,10 +1,10 @@
** --muhome
use a non-default directory to store and read the database, write the logs, etc.
By default, *mu* uses the XDG Base Directory Specification (e.g. on GNU/Linux this
-defaults to =~/.cache/mu= and =~/.config/mu=). Earlier versions of *mu* defaulted to
-=~/.mu=, which now requires *--muhome=~/.mu*.
+defaults to _~/.cache/mu_ and _~/.config/mu_). Earlier versions of *mu* defaulted to
+_~/.mu_, which now requires *--muhome=~/.mu*.
-The environment variable ~MUHOME~ can be used as an alternative to *--muhome*. The
+The environment variable *MUHOME* can be used as an alternative to *--muhome*. The
latter has precedence.
# Local Variables: