-
Notifications
You must be signed in to change notification settings - Fork 391
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
More man page fixes #2652
More man page fixes #2652
Conversation
Thanks, but changing to e.g.,
am I missing something? |
Have you applied the full series? In particular: "man: fix formatting of underscores". |
Ah, testing the whole branch, I get e.g.
the underscore is unwanted. |
Since you're not a fan of the underscores, I've done some more research. :) As I mentioned in the commit message the reason to introduce the underscore was to allow mandb to parse the
Would hyphens be acceptable?
|
Oh, the But, a hyphen is acceptable though, since it's a bit less ugly, and since reflects the name of the manpage (i.e., |
Cool. I will go with the hyphens. |
1.12.0 includes a new mu-move.1 man-page but the list of man-pages in man/meson.build was not updated, so it is not built. Signed-off-by: Jeremy Sowden <azazel@debian.org>
There's a closing asterisk missing from a bold string. Signed-off-by: Jeremy Sowden <azazel@debian.org>
In org-mode, underscores are used to represent subscripts. Thus, `a_b` will be transcoded to `a\d\s-2b\s+2\u`. Configure org-mode only to do this for `a_{b}`. Signed-off-by: Jeremy Sowden <azazel@debian.org>
The tables don't define any captions, and ox-man outputs a `.TB` macro that groff does not support. Signed-off-by: Jeremy Sowden <azazel@debian.org>
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>
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>
0fb945d
to
721aadc
Compare
I've also tweaked a couple of commit messages and changed the order of the commits to put the short ones first. |
Merged -- thanks! |
Fixes for some warnings and formatting errors