1
0
mirror of https://github.com/djcb/mu.git synced 2024-07-04 08:41:11 +02:00
mu/man/mu-mkdir.1.org
Jeremy Sowden 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

43 lines
879 B
Org Mode

#+TITLE: MU MKDIR
#+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@"
* NAME
mu-mkdir - create a new Maildir
* SYNOPSIS
*mu [common-options] mkdir [options] <dir> [<dirs>]*
* DESCRIPTION
*mu mkdir* is the command for creating Maildirs as per *maildir(5)*. A maildir is a
a directory with subdirectories ~new~, ~cur~ and ~tmp~.
The command does not use the mu database.
If creation fails for any reason, *no* attempt is made to remove any parts that
were created. This is for safety reasons.
* MKDIR OPTIONS
** --mode=<mode>
set the file access mode for the new maildir(s) as in *chmod(1)*. The default
is 0755.
#+include: "common-options.inc" :minlevel 1
* EXAMPLE
#+begin_example
$ mu mkdir tom dick harry
#+end_example
creates three maildirs, =tom=, =dick= and =harry=.
#+include: "prefooter.inc" :minlevel 1
* SEE ALSO
*maildir(5)*, *chmod(1)*