Package: sensible-utils Version: 0.0.20 Severity: minor Tags: patch Dear Maintainer,
here are some notes and editorial fixes in a patch for the man pages. 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) -.-. Change two HYPHEN-MINUSES (code 0x055, 2D) to an em-dash (\(em), if one is intended. An en-dash is usually surrounded by a space, while an em-dash is used without spaces. "man" (1 byte characters) transforms an en-dash (\(en ) to one HYPHEN-MINUS, and an em-dash to two HYPHEN-MINUSES without considering the space around it. If "--" are two single "-" (end of options) then use "\-\-". sensible-editor.1:31:- see environ(7) sensible-editor.1:34:- see environ(7) sensible-editor.1:39:- see select-editor(1) sensible-editor.1:42:- see editor(1), update-alternatives(1) -.-. Change -- in x--y to \(em (em-dash), or, if an option, to \-\- 21:.I --verbose -.-. Use the correct macro for the font change of a single argument or split the argument into two. 11:.BR sensible-editor -.-. Use \(en for a dash (en-dash) between space characters, not a minus (\-) or a hyphen (-), except in the NAME section. sensible-editor.1:31:- see environ(7) sensible-editor.1:34:- see environ(7) sensible-editor.1:39:- see select-editor(1) sensible-editor.1:42:- see editor(1), update-alternatives(1) -.-. The name of a man page is set in bold type and the section in roman (see man-pages(7)). 42:- see editor(1), update-alternatives(1) 60:sensible-browser(1), sensible-pager(1), select-editor(1), environ(7), 61:editor(1), update-alternatives(1) -.-. Name of a manual is set in bold, the section in roman. See man-pages(7). 31:- see environ(7) 34:- see environ(7) 39:- see select-editor(1) 42:- see editor(1), update-alternatives(1) 61:editor(1), update-alternatives(1) -.-. "[" and "]", showing optional arguments to options, should be typeset in roman. 6:.BR sensible-editor " [OPTIONS...]" -.-. Inhibit hyphenation for "EDITOR=sensitive-editor" and "update-alternatives". -- 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-editor.1 2023-07-21 11:51:13.000000000 +0000 +++ sensible-editor.1.new 2023-07-21 12:11:36.000000000 +0000 @@ -3,12 +3,13 @@ .SH NAME sensible-editor \- launch sensibly chosen text editor .SH SYNOPSIS -.BR sensible-editor " [OPTIONS...]" +.B sensible-editor +.RI [ OPTIONS... ] .SH DESCRIPTION .BR sensible-editor " makes sensible decisions on which editor to call. Programs in Debian can invoke this script to get a good default editor. .PP -.BR sensible-editor +.B sensible-editor looks for an appropriate choice of editor in a series of places, and uses the first candidate that works. It starts by checking environment variables, @@ -18,7 +19,7 @@ with a series of hard-coded command name .PP Variables will be skipped if unset or null, but may include extra whitespace-separated parameters such as a -.I --verbose +.B \-\-verbose flag. Once sensible-editor has a candidate commandline, it will try to run it (passing on the arguments it was given as the files to be edited). @@ -28,18 +29,22 @@ or was not found (exit code 127), it tri The specific candidates sensible-editor tries, in order, are: .IP \(bu 2 .B $VISUAL -- see environ(7) +\(en see +.BR environ (7) .IP \(bu 2 .B $EDITOR -- see environ(7) +\(en see +.BR environ (7) .IP \(bu 2 .B $SENSIBLE_EDITOR .IP \(bu 2 .B $SELECTED_EDITOR -- see select-editor(1) +\(en see +.BR select-editor (1) .IP \(bu 2 .B editor -- see editor(1), update-alternatives(1) +\(en see +.BR editor "(1), " update-alternatives (1) .IP \(bu 2 .B nano .IP \(bu 2 @@ -54,11 +59,15 @@ defaults. .SH BUGS This command takes precautions against launching itself in an infinite loop if a user sets -.B EDITOR=sensible-editor +.B \%EDITOR=sensible-editor but indirect loops are still possible. .SH "SEE ALSO" -sensible-browser(1), sensible-pager(1), select-editor(1), environ(7), -editor(1), update-alternatives(1) +.BR sensible-browser (1), +.BR sensible-pager (1), +.BR select-editor (1), +.BR environ (7), +.BR editor (1), +.BR \%update-alternatives (1) .SH "CONFORMS TO" The behavior of sensible-utils under a Debian system is documented in section 11.4 of Debian-Policy, available under
