721aadc140
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>
#+TITLE:mu
[ Note: you are looking at the development branch, which is where new code is being developed and tested, and which may occasionally break. Distributions and non-adventurous users are instead recommended to use the 1.10 Release Branch or to pick up one of the 1.10 Releases. ]
Welcome to mu!
Latest development news: NEWS.org.
With the enormous amounts of e-mail many people gather and the importance of e-mail message in our work-flows, it's essential to quickly deal with all that mail - in particular, to instantly find that one important e-mail you need right now, and quickly file away message for later use.
mu is a tool for dealing with e-mail messages stored in the Maildir-format. mu's
purpose in life is to help you to quickly find the messages you need; in
addition, it allows you to view messages, extract attachments, create new
maildirs, and so on.
After indexing your messages into a Xapian-database, you can search them using a custom query language. You can use various message fields or words in the body text to find the right messages.
Built on top of mu are some extensions (included in this package):
mu4e: a full-featured e-mail client that runs inside emacsmu-guile: bindings for the Guile/Scheme programming language (version 3.0 and later)
mu is written in C++; mu4e is written in elisp and mu-guile in a mix of C++ and
Scheme.
mu is available in Linux distributions (e.g. Debian/Ubuntu and Fedora) under the
name maildir-utils; apparently because they don't like short names. All of the
code is distributed under the terms of the GNU General Public License version 3
(or higher).
Installation
Note: building from source is an advanced subject, especially if something goes wrong. The below simple examples are a start, but all tools involved have many options; there are differences between systems, versions etc. So if this is all a bit daunting we recommend to wait for someone else to build it for you, such as a Linux distribution. Many have packages available.
Requirements
To be able to build mu, ensure you have:
- a C++17 compiler (
gccorclangare known to work) - development packages for Xapian and GMime and GLib (see
meson.buildfor thex versions) - basic tools such as
make,sed,grep meson
For mu4e, you also need emacs.
Note, support for Windows is very much experimental, that is, it works for some people, but we can't really support it due to lack of the specific expertise. Help is welcome!
Building
$ git clone git://github.com/djcb/mu.git $ cd mu
mu uses meson for building, so you can use that directly, and all the usual
commands apply. You can also use it indirectly through the provided Makefile,
which provides a number of useful targets.
For instance, using the Makefile, you could install mu using:
$ ./autogen.sh && make $ sudo make install
Alternatively, you can run meson directly (see the meson documentation for
more details):
$ meson setup -C build $ meson compile -C build $ meson install -C build
Contributing
Contributions are welcome! See the Github issue list and IDEAS.org.