Package: mailcap
Version: 3.70+nmu1
Severity: minor
Tags: patch

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 edit.1":

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

-.-.

Input file is edit.1.

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, or is a symbol for standard input.

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

-.-.

Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

29:its encoding (e.g. compression), and filename together, separated by

-.-.

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.

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

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

-.-.

-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (990, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.4.13-1 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages mailcap depends on:
ii  media-types  10.1.0
ii  perl         5.36.0-9

Versions of packages mailcap recommends:
ii  bzip2     1.0.8-5+b1
ii  file      1:5.45-2
ii  xz-utils  5.4.4-0.1

mailcap suggests no packages.

-- no debconf information
--- edit.1	2023-09-19 02:11:08.000000000 +0000
+++ edit.1.new	2023-09-19 02:19:22.000000000 +0000
@@ -4,7 +4,8 @@
 .\"
 .TH RUN-MAILCAP 1 "1st Jan 2008" "Debian Project" "Run Mailcap Programs"
 .SH NAME
-run-mailcap, view, see, edit, compose, print \- execute programs via entries in the
+run-mailcap, view, see, edit, compose, print \- execute programs via
+entries in the
 .I mailcap
 file
 .SH SYNOPSIS
@@ -22,11 +23,10 @@ versions are just aliases that default t
 print actions (respectively).
 
 .SH DESCRIPTION
-.PP
 .B run-mailcap
 (or any of its aliases) will use the given action to process each
 mime-type/file in turn.  Each file is specified as its mime-type,
-its encoding (e.g. compression), and filename together, separated by
+its encoding (e.g., compression), and filename together, separated by
 colons.  If the mime-type is omitted, an attempt to determine the type
 is made by trying to match the file's extension with those in the
 .I mime.types
@@ -61,7 +61,7 @@ All options are in the form --<opt>=<val
 .BI \-\-action=<action>
 Performs the specified action on the files.  Valid actions are
 .IR view ,
-.IR cat
+.I cat
 (uses only "copiousoutput" rules and sends output to STDOUT) ,
 .IR compose ,
 .IR composetyped ,
@@ -71,21 +71,24 @@ and
 If no action is specified, the action will be determined by how the
 program was called.
 .TP
-.BI \-\-debug
+.B \-\-debug
 Turns on extra information to find out what is happening.
 .TP
-.BI \-\-nopager
+.B \-\-nopager
 Ignores any "copiousoutput" directive and sends output to STDOUT.
 .TP
-.BI \-\-norun
+.B \-\-norun
 Displays the found command without actually executing it.
 .SH SECURITY
-A temporary symbolic link to the file is opened if the file name matches the Perl
-regular expression "[^[:alnum:],.:/@%^+=_-]", in order to protect from the
-injection of shell commands, and to make sure that the name can always be
-displayed in the current locale.  In addition, the file is opened using its
-absolute path to prevent the injection of command-line arguments, for instance
-using file names starting with dashes.
+A temporary symbolic link to the file is opened if the file name
+matches the Perl regular expression "[^[:alnum:],.:/@%^+=_-]",
+in order to protect from the injection of shell commands,
+and to make sure that the name can always be displayed in the current
+locale.
+In addition,
+the file is opened using its absolute path to prevent the injection of command-line
+arguments,
+for instance using file names starting with dashes.
 .SH "SEE ALSO"
 .BR file "(1)"
 .BR mailcap "(5)"

Reply via email to