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

mandoc: select-editor.1:7:2: WARNING: skipping paragraph macro: br at the end 
of SH
mandoc: select-editor.1:10:104: STYLE: input text line longer than 80 bytes: 
provides a coherent ...
mandoc: select-editor.1:11:92: STYLE: input text line longer than 80 bytes: It 
lists the availab...
mandoc: select-editor.1:12:102: STYLE: input text line longer than 80 bytes: 
The results are stor...
mandoc: select-editor.1:15:86: STYLE: input text line longer than 80 bytes: 
SELECTED_EDITOR vari...

-.-.

Increase type size of ~ (tilde) to make it more visible
in the output of "troff".

12:The results are stored as SELECTED_EDITOR variable in ~/.selected_editor, 
which is sourced and used by

-.-.

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

6:.BR select-editor
9:.BR select-editor
17:.BR select-editor

-.-.

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

select-editor.1: line 10        length 104
provides a coherent mechanism for selecting and storing a preferred 
sensible-editor on a per-user basis.

select-editor.1: line 12        length 102
The results are stored as SELECTED_EDITOR variable in ~/.selected_editor, which 
is sourced and used by


-.-.

Prohibit hyphenation of "~/.selected_editor" and "SELECTED_EDITOR" by
using '\%' in front of the words.

-.-.

-- 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
--- select-editor.1     2023-07-21 01:08:47.000000000 +0000
+++ select-editor.1.new 2023-07-21 01:31:10.000000000 +0000
@@ -3,18 +3,21 @@
 .SH NAME
 select-editor \- select your default sensible-editor from all installed editors
 .SH SYNOPSIS
-.BR select-editor
-.br
+.B select-editor
 .SH DESCRIPTION
-.BR select-editor
-provides a coherent mechanism for selecting and storing a preferred 
sensible-editor on a per-user basis.
-It lists the available editors on a system and interactively prompts the user 
to select one.
-The results are stored as SELECTED_EDITOR variable in ~/.selected_editor, 
which is sourced and used by
+.B select-editor
+provides a coherent mechanism for selecting and storing a preferred
+sensible-editor on a per-user basis.
+It lists the available editors on a system and interactively prompts
+the user to select one.
+The results are stored as SELECTED_EDITOR variable in 
\%\s+3~\s-3/.selected_editor,
+which is sourced and used by
 .B sensible-editor
 command.
-SELECTED_EDITOR variable is overridden by the VISUAL and EDITOR environment 
variables.
+\%SELECTED_EDITOR variable is overridden by the VISUAL and EDITOR
+environment variables.
 .SH AUTHOR
-.BR select-editor
+.B select-editor
 was written by Dustin Kirkland <kirkl...@canonical.com>.
 .SH "SEE ALSO"
 .BR sensible-editor (1)

Reply via email to