From c76aa5315652ac5eca6ae24829bcf77a261716c3 Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Sat, 2 Mar 2024 12:00:31 +0000 Subject: [PATCH] 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 --- man/mu-add.1.org | 2 +- man/mu-bookmarks.5.org | 2 +- man/mu-cfind.1.org | 2 +- man/mu-easy.7.org | 2 +- man/mu-extract.1.org | 2 +- man/mu-find.1.org | 2 +- man/mu-help.1.org | 2 +- man/mu-index.1.org | 2 +- man/mu-info.1.org | 2 +- man/mu-init.1.org | 2 +- man/mu-mkdir.1.org | 2 +- man/mu-move.1.org | 2 +- man/mu-query.7.org | 2 +- man/mu-remove.1.org | 3 +-- man/mu-server.1.org | 2 +- man/mu-verify.1.org | 2 +- man/mu-view.1.org | 2 +- man/mu.1.org | 2 +- 18 files changed, 18 insertions(+), 19 deletions(-) diff --git a/man/mu-add.1.org b/man/mu-add.1.org index a7f3ba7c..f2b644cb 100644 --- a/man/mu-add.1.org +++ b/man/mu-add.1.org @@ -3,7 +3,7 @@ * NAME -~mu add~ - add one or more messages to the database +mu-add - add one or more messages to the database * SYNOPSIS diff --git a/man/mu-bookmarks.5.org b/man/mu-bookmarks.5.org index 6fbbe35e..b7d275e0 100644 --- a/man/mu-bookmarks.5.org +++ b/man/mu-bookmarks.5.org @@ -3,7 +3,7 @@ * NAME -bookmarks - file with bookmarks (shortcuts) for mu search expressions +mu-bookmarks - file with bookmarks (shortcuts) for mu search expressions * DESCRIPTION diff --git a/man/mu-cfind.1.org b/man/mu-cfind.1.org index f8502dfc..d55aa3d5 100644 --- a/man/mu-cfind.1.org +++ b/man/mu-cfind.1.org @@ -3,7 +3,7 @@ * NAME -*mu cfind* is the *mu* command to find contacts in the *mu* database and export them +mu-cfind - find contacts in the *mu* database and export them for use in other programs. * SYNOPSIS diff --git a/man/mu-easy.7.org b/man/mu-easy.7.org index 8ebca999..2222f13b 100644 --- a/man/mu-easy.7.org +++ b/man/mu-easy.7.org @@ -3,7 +3,7 @@ * NAME -mu easy - a quick introduction to mu +mu-easy - a quick introduction to mu * DESCRIPTION diff --git a/man/mu-extract.1.org b/man/mu-extract.1.org index de8f6f0c..24c6e29c 100644 --- a/man/mu-extract.1.org +++ b/man/mu-extract.1.org @@ -3,7 +3,7 @@ * NAME -*mu extract* is the *mu* command to display and save message parts +mu-extract - display and save message parts (attachments), and open them with other tools. * SYNOPSIS diff --git a/man/mu-find.1.org b/man/mu-find.1.org index 1a4986c2..60444407 100644 --- a/man/mu-find.1.org +++ b/man/mu-find.1.org @@ -3,7 +3,7 @@ * NAME -*mu find* - find e-mail messages in the *mu* database. +mu-find - find e-mail messages in the *mu* database. * SYNOPSIS diff --git a/man/mu-help.1.org b/man/mu-help.1.org index e2831951..2a67dc2e 100644 --- a/man/mu-help.1.org +++ b/man/mu-help.1.org @@ -3,7 +3,7 @@ * NAME -*mu help* is a *mu* command that gives help information about mu commands. +mu-help - show help information about mu commands. * SYNOPSIS diff --git a/man/mu-index.1.org b/man/mu-index.1.org index c51d5054..db040cf6 100644 --- a/man/mu-index.1.org +++ b/man/mu-index.1.org @@ -3,7 +3,7 @@ * NAME -*mu index* -- index e-mail messages stored in Maildirs +mu-index - index e-mail messages stored in Maildirs * SYNOPSIS diff --git a/man/mu-info.1.org b/man/mu-info.1.org index 000f55f3..0d182d7c 100644 --- a/man/mu-info.1.org +++ b/man/mu-info.1.org @@ -3,7 +3,7 @@ * NAME -~mu info~ - show information +mu-info - show information * SYNOPSIS diff --git a/man/mu-init.1.org b/man/mu-init.1.org index 38195e8d..6e773eb1 100644 --- a/man/mu-init.1.org +++ b/man/mu-init.1.org @@ -3,7 +3,7 @@ * NAME -mu init -- initialize the mu message database +mu-init - initialize the mu message database * SYNOPSIS diff --git a/man/mu-mkdir.1.org b/man/mu-mkdir.1.org index a85d9f5a..f10a7149 100644 --- a/man/mu-mkdir.1.org +++ b/man/mu-mkdir.1.org @@ -3,7 +3,7 @@ * NAME -*mu mkdir* - create a new Maildir +mu-mkdir - create a new Maildir * SYNOPSIS diff --git a/man/mu-move.1.org b/man/mu-move.1.org index 5dae0e51..e46a5f8a 100644 --- a/man/mu-move.1.org +++ b/man/mu-move.1.org @@ -3,7 +3,7 @@ * NAME -*mu move* - move a message file or change its flags +mu-move - move a message file or change its flags * SYNOPSIS diff --git a/man/mu-query.7.org b/man/mu-query.7.org index a00a267e..719bd510 100644 --- a/man/mu-query.7.org +++ b/man/mu-query.7.org @@ -3,7 +3,7 @@ * NAME -mu query language -- a language for finding messages in *mu* databases. +mu-query - a language for finding messages in *mu* databases. * DESCRIPTION diff --git a/man/mu-remove.1.org b/man/mu-remove.1.org index 52adf94c..ff2c24c0 100644 --- a/man/mu-remove.1.org +++ b/man/mu-remove.1.org @@ -1,10 +1,9 @@ #+TITLE: MU REMOVE #+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@" - * NAME -*mu remove* - command to remove messages from the database. +mu-remove - remove messages from the database. * SYNOPSIS diff --git a/man/mu-server.1.org b/man/mu-server.1.org index 6919249d..18148605 100644 --- a/man/mu-server.1.org +++ b/man/mu-server.1.org @@ -3,7 +3,7 @@ * NAME -mu server - the mu backend for the mu4e e-mail client +mu-server - the mu backend for the mu4e e-mail client * SYNOPSIS diff --git a/man/mu-verify.1.org b/man/mu-verify.1.org index e7cee9cb..9cc0933d 100644 --- a/man/mu-verify.1.org +++ b/man/mu-verify.1.org @@ -3,7 +3,7 @@ * NAME -mu verify - verify message signatures and display information about them +mu-verify - verify message signatures and display information about them * SYNOPSIS diff --git a/man/mu-view.1.org b/man/mu-view.1.org index f9e26f0c..17351f74 100644 --- a/man/mu-view.1.org +++ b/man/mu-view.1.org @@ -3,7 +3,7 @@ * NAME -mu view - display an e-mail message file +mu-view - display an e-mail message file * SYNOPSIS diff --git a/man/mu.1.org b/man/mu.1.org index 64d30798..35b992ac 100644 --- a/man/mu.1.org +++ b/man/mu.1.org @@ -3,7 +3,7 @@ * NAME -~mu~ - a set of tools to deal with Maildirs and message files, in particular to +mu - a set of tools to deal with Maildirs and message files, in particular to index and search e-mail messages. * SYNOPSIS