#1052137 run-mailcap.1: some remarks and editorial changes for this man page

Package:
mailcap
Source:
mailcap
Submitter:
Bjarni Ingi Gislason
Date:
2023-09-19 05:00:03 UTC
Severity:
normal
Tags:
#1052137#5
Date:
2023-09-18 02:12:22 UTC
From:
To:
Dear Maintainer,

here are some notes and editorial fixes for the manual.

The patch is in the attachment.

-.-

The difference between the formatted outputs can be seen with:

  nroff -man <file1> > <out1>
  nroff -man <file2> > <out2>
  diff -u <out1> <out2>

and for groff, using

"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "

instead of "nroff -man"

  Add the option "-t", if the file contains a table.

  Read the output of "diff -u" with "less -R" or similar.

-.-.

  If "man" (man-db) is used to check the manual for warnings,
the following must be set:

  The option "-warnings=w"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT="-ww -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-.

Output from "mandoc -T lint run-mailcap.1":

mandoc: run-mailcap.1:7:83: STYLE: input text line longer than 80 bytes: run-mailcap, view, s...
mandoc: run-mailcap.1:25:2: WARNING: skipping paragraph macro: PP after SH
mandoc: run-mailcap.1:83:81: STYLE: input text line longer than 80 bytes: A temporary symbolic...

-.-.

Use the correct macro for the font change of a single argument or
split the argument into two.

64:.IR cat
74:.BI \-\-debug
77:.BI \-\-nopager
80:.BI \-\-norun

-.-.

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

46:(.Z).  A filename of "-" can be used to mean "standard input", but

-.-.

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

run-mailcap.1: line 7	length 83
run-mailcap, view, see, edit, compose, print \- execute programs via entries in the

run-mailcap.1: line 83	length 81
A temporary symbolic link to the file is opened if the file name matches the Perl

-.-.

Translate the character "~" (tilde) to "\(ti" to make it more visible
in the output of "troff".

51: Both the user's files (~/.mailcap; ~/.mime.types) and the system files

#1052137#10
Date:
2023-09-19 04:49:28 UTC
From:
To:
Dear Bjarni,

thank you for your report about this manpage and the other ones of this
package.

I am considering refactoring the whole package as a Perl module that might
be called App::Mailcap, and as part of this the manual pages would be
converted to Perldoc format.  Therefore, I do not intend to take action
direclty on the currently nroff-formated manpages.

This said, if you send a proper patch or a merge request, I will surely
take your changes.

Have a nice day,