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"

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

mandoc: sensible-terminal.1:6:32: STYLE: unterminated quoted argument
mandoc: sensible-terminal.1:7:2: WARNING: skipping paragraph macro: br at the 
end of SH
mandoc: sensible-terminal.1:19: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-terminal-emulator

-.-.

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

6:.BR sensible-terminal-emulator " [-T title] [--wait] [-e cmd...]

-.-.

Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-

6:.BR sensible-terminal-emulator " [-T title] [--wait] [-e cmd...]

-.-.

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

6:.BR sensible-terminal-emulator " [-T title] [--wait] [-e cmd...]
16:.B sh -c

-.-.



-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'stable-security')
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-terminal.1 2023-07-21 20:53:04.000000000 +0000
+++ sensible-terminal.1.new     2023-07-21 21:24:24.000000000 +0000
@@ -3,19 +3,20 @@
 .SH NAME
 sensible-terminal-emulator \- sensible terminal emulator
 .SH SYNOPSIS
-.BR sensible-terminal-emulator " [-T title] [--wait] [-e cmd...]
-.br
+.B sensible-terminal-emulator
+.RB [ "\-T \fItitle\fP" "] [" \-\-wait "] [" "\-e \fIcmd...\fP" ]
 .SH DESCRIPTION
-.BR sensible-terminal-emulator
+.B sensible-terminal-emulator
 makes sensible decisions on which terminal emulator to call.
 Programs in Debian can use this script
 as their default terminal emulator or emulate their behavior.
 .br
 TERMINAL_EMULATOR environment variable could be set, and will be used if set.
 Any string acceptable as a command_string operand to the
-.B sh -c
+.B sh \-c
 command shall be valid.
 .SH "STANDARD"
-Documentation of behavior of sensible-utils under a debian system is available 
under
+Documentation of behavior of sensible-utils under a debian system is
+available under
 sections 11.4-11.8 of debian-policy usually installed under
 /usr/share/doc/debian-policy (you might need to install debian-policy)

Reply via email to