Package: sensible-utils
Version: 0.0.20
Severity: minor
Tags: patch

Dear Maintainer,

here are some notes and editorial fixes for the man page.

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

"echo .kern 0 | groff -man -Z - " instead of "nroff -man"

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

-.-.

  If "man" (man-db) is used to check the manual, 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 sensible-pager.1":

mandoc: sensible-pager.1:7:2: WARNING: skipping paragraph macro: br at the end 
of SH
mandoc: sensible-pager.1:17:84: STYLE: input text line longer than 80 bytes: 
Documentation of beh...

-.-.

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

9:.BR sensible-pager

-.-.

"[" and "]", showing optional arguments to options, should be typeset in roman.

6:.BR sensible-pager " [OPTIONS...]"

-.-.

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

Kernel: Linux 6.3.7-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)

-- no debconf information
--- sensible-pager.1    2023-07-21 20:35:00.000000000 +0000
+++ sensible-pager.1.new        2023-07-21 20:39:23.000000000 +0000
@@ -3,10 +3,10 @@
 .SH NAME
 sensible-pager \- sensible paging
 .SH SYNOPSIS
-.BR sensible-pager " [OPTIONS...]"
-.br
+.B sensible-pager
+.RI [ OPTIONS... ]
 .SH DESCRIPTION
-.BR sensible-pager
+.B sensible-pager
 makes sensible decisions on which pager to call.
 Programs in Debian can use this script
 as their default pager, or emulate their behavior.
@@ -14,6 +14,6 @@ as their default pager, or emulate their
 Documentation of the PAGER variable in
 .BR environ (7)
 .SH "STANDARD"
-Documentation of behavior of sensible-utils under a debian system is available 
under
-section 11.4 of debian-policy usually installed under
+Documentation of behavior of sensible-utils under a debian system is
+available under section 11.4 of debian-policy usually installed under
 /usr/share/doc/debian-policy (you might need to install debian-policy)

Reply via email to