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

mandoc: sensible-browser.1:7:2: WARNING: skipping paragraph macro: br at the 
end of SH
mandoc: sensible-browser.1:15:57: STYLE: whitespace at end of input line

-.-.

Input file is sensible-browser.1

Remove space characters at the end of lines.

Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

15:Any string acceptable as a command_string operand to the 

-.-.

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

9:.BR sensible-browser

-.-.

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

16:.B sh -c

-.-.

[ "test-groff" is a developmental version of "groff" ]

Input file is ./sensible-browser.1

Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z 
-rCHECKSTYLE=0":

troff: backtrace: file '<stdin>':15
troff:<stdin>:15: warning: trailing space in the line

-.-.



-- 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-browser.1  2023-07-20 21:31:57.000000000 +0000
+++ sensible-browser.1.new      2023-07-20 21:37:36.000000000 +0000
@@ -4,16 +4,15 @@
 sensible-browser \- sensible web browsing
 .SH SYNOPSIS
 .BR sensible-browser " url"
-.br
 .SH DESCRIPTION
-.BR sensible-browser
+.B sensible-browser
 makes sensible decisions on which web browser to call.
 Programs in Debian can use this script
 as their default web browser or emulate their behavior.
 .br
 BROWSER environment variable could be set, and will be used if set.
-Any string acceptable as a command_string operand to the 
-.B sh -c
+Any string acceptable as a command_string operand to the
+.B sh \-c
 command shall be valid.
 .SH "STANDARD"
 Documentation of behavior of sensible-utils under a debian system is available 
under

Reply via email to