Package: ucf
Version: 3.0043+nmu1
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the man page.
-.-.
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
"groff -man -Z" instead of "nroff -man"
-.-.
Output from "mandoc -T lint lcf.1":
mandoc: lcf.1:1:52: STYLE: whitespace at end of input line
mandoc: lcf.1:2:14: STYLE: whitespace at end of input line
mandoc: lcf.1:3:71: STYLE: whitespace at end of input line
mandoc: lcf.1:11:23: STYLE: whitespace at end of input line
mandoc: lcf.1:12:23: STYLE: whitespace at end of input line
mandoc: lcf.1:13:4: STYLE: whitespace at end of input line
mandoc: lcf.1:50:11: STYLE: whitespace at end of input line
mandoc: lcf.1:54:19: STYLE: whitespace at end of input line
mandoc: lcf.1:55:24: STYLE: whitespace at end of input line
mandoc: lcf.1:69:6: STYLE: whitespace at end of input line
mandoc: lcf.1:75:2: WARNING: skipping paragraph macro: PP after SH
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
60:.B "-h, --help"
63:.B "-n, --no-action"
67:.B "-d [n], --debug [n]"
72:.B "-v, --verbose"
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
60:.B "-h, --help"
63:.B "-n, --no-action"
67:.B "-d [n], --debug [n]"
72:.B "-v, --verbose"
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
48:the installed version corresponds to a historical version. lcf uses
53:expected to live. Specifically, the historical md5sums are looked for
64:Dry run. Print the actions that would be taken if the script is
70:(n defaults to 1). This turns on copious debugging information.
82:There are no bugs. Any resemblance thereof is delirium. Really.
-.-.
Use \(en for a dash (en-dash) between space characters, not a minus
(\-) or a hyphen (-), except in the NAME section.
lcf.1:33:.\" Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
80:ucf.conf(5).
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
79:ucf(1)
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./lcf.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rSTYLECHECK=3":
troff: backtrace: file '<stdin>':50
troff:<stdin>:50: warning: trailing space in the line
troff: backtrace: file '<stdin>':54
troff:<stdin>:54: warning: trailing space in the line
-.-.
--- lcf.1 2023-07-07 21:07:36.000000000 +0000
+++ lcf.1.new 2023-07-07 21:25:41.000000000 +0000
@@ -1,6 +1,6 @@
-.\" -*- Mode: Nroff -*-
-.\" lcf.1 ---
-.\" Author : Manoj Srivastava ( sriva...@green-gryphon.com )
+.\" -*- Mode: Nroff -*-
+.\" lcf.1 ---
+.\" Author : Manoj Srivastava ( sriva...@green-gryphon.com )
.\" Created On : Fri Feb 1 11:17:32 2002
.\" Created On Node : glaurung.green-gryphon.com
.\" Last Modified By : Manoj Srivastava
@@ -8,9 +8,9 @@
.\" Last Machine Used: glaurung.internal.golden-gryphon.com
.\" Update Count : 28
.\" Status : Unknown, Use with caution!
-.\" HISTORY :
-.\" Description :
-.\"
+.\" HISTORY :
+.\" Description :
+.\"
.\" Copyright (c) 2002 Manoj Srivastava <sriva...@debian.org>
.\"
.\" This is free documentation; you can redistribute it and/or
@@ -30,7 +30,7 @@
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+.\" Software Foundation, Inc., 59 Temple Place \(en Suite 330, Boston, MA
.\" 02111-1307, USA.
.\"
.\" $Id: lcf.1,v 1.1 2002/02/26 20:12:06 srivasta Exp $
@@ -45,41 +45,45 @@ lcf \- Determine which of the historical
.SH DESCRIPTION
This script, given a destination file name, and a directory containing
md5sums of historical versions of the file, attempts to determine if
-the installed version corresponds to a historical version. lcf uses
+the installed version corresponds to a historical version.
+lcf uses
the same algorithm that ucf uses, and should exhibit the same
-behaviour.
+behaviour.
.PP
The source directory is the place where historical md5sums are
-expected to live. Specifically, the historical md5sums are looked for
-in either the file
-.I ${filename}.md5sum,
+expected to live.
+Specifically, the historical md5sums are looked for
+in either the file
+.I ${filename}.md5sum,
or the subdirectory
.I ${filename}.md5sum.d/
.SH OPTIONS
.TP
-.B "-h, --help"
+.B "\-h, \-\-help"
Print a short usage message
.TP
-.B "-n, --no-action"
-Dry run. Print the actions that would be taken if the script is
+.B "\-n, \-\-no-action"
+Dry run.
+Print the actions that would be taken if the script is
invoked, but take no action.
.TP
-.B "-d [n], --debug [n]"
+.B "\-d [n], \-\-debug [n]"
Set the debug level to the (optional) level
-.I n
-(n defaults to 1). This turns on copious debugging information.
+.I n
+(n defaults to 1).
+This turns on copious debugging information.
.TP
-.B "-v, --verbose"
+.B "\-v, \-\-verbose"
Make the script be very verbose about setting internal variables.
.SH FILES
-.PP
.I /var/lib/ucf/hashfile,
.I /etc/ucf.conf
.SH "SEE ALSO"
-ucf(1)
-ucf.conf(5).
+.BR ucf (1),
+.BR ucf.conf (5).
.SH BUGS
-There are no bugs. Any resemblance thereof is delirium. Really.
+There are no bugs. Any resemblance thereof is delirium.
+Really.
.SH AUTHOR
This manual page was written Manoj Srivastava <sriva...@debian.org>,
for the Debian GNU/Linux system.
-- 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)
Versions of packages ucf depends on:
ii debconf [debconf-2.0] 1.5.82
ii sensible-utils 0.0.20
ucf recommends no packages.
ucf suggests no packages.
-- debconf information:
ucf/show_diff:
ucf/conflicts_found:
ucf/changeprompt: keep_current
ucf/title:
ucf/changeprompt_threeway: keep_current
