Package: time
Version: 1.9-0.2
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the man page.
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
"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)
-.-.
Input file is time.1
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
If "Kilo" is 1000 (then use "kilo"), if 1024 then use "kibi"
185:Average size of the process's unshared data area, in Kilobytes.
196:Kilobytes.
199:Kilobytes.
220:Average amount of shared text in the process, in Kilobytes.
232:Average unshared stack size of the process, in Kilobytes.
238:Average resident set size of the process, in Kilobytes.
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
153:A backslash (`\\') introduces a `backslash escape', which is
154:translated into a single printing character upon output. `\\t' outputs
155:a tab character, `\\n' outputs a newline, and `\\\\' outputs a backslash.
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./time.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rSTYLECHECK=3":
an.tmac:<stdin>:4: style: .TH missing fourth argument; suggest package/project
name and version (e.g., "groff 1.23.0")
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':598: macro 'BI'
troff: backtrace: file '<stdin>':91
troff:<stdin>:91: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':598: macro 'BI'
troff: backtrace: file '<stdin>':103
troff:<stdin>:103: warning: trailing space in the line
an-end-check:<stdin>: Warning: Different number of .RS and .RE calls,
an-RS-open=2 at end of file
-.-.
Line:
%Uuser %Ssystem %Eelapsed %PCPU (%Xtext+%Ddata %Mmax)k
The 'k' at the end should remain (or use 'kilo') if "Kilobyte" means
1000 bytes, otherwise it should be "Ki" (or kibi).
-.-.
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (SMP w/2 CPU threads; PREEMPT)
Kernel taint flags: TAINT_WARN
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 time depends on:
ii libc6 2.37-5
time recommends no packages.
time suggests no packages.
-- no debconf information
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"
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)
-.-.
Input file is time.1, case 1
Change \' (acute) to \[aq], if used as a quote.
Change \' (acute) to ', if used as an apostrophe.
153:A backslash (`\\') introduces a `backslash escape', which is
155:a tab character, `\\n' outputs a newline, and `\\\\' outputs a backslash.
-.-.
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
If "Kilo" is 1000 (then use "kilo"), if 1024 then use "kibi"
185:Average size of the process's unshared data area, in Kilobytes.
196:Kilobytes.
199:Kilobytes.
220:Average amount of shared text in the process, in Kilobytes.
232:Average unshared stack size of the process, in Kilobytes.
238:Average resident set size of the process, in Kilobytes.
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
153:A backslash (`\\') introduces a `backslash escape', which is
154:translated into a single printing character upon output. `\\t' outputs
155:a tab character, `\\n' outputs a newline, and `\\\\' outputs a backslash.
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./time.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rSTYLECHECK=3":
an.tmac:<stdin>:4: style: .TH missing fourth argument; suggest package/project
name and version (e.g., "groff 1.23.0")
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':598: macro 'BI'
troff: backtrace: file '<stdin>':91
troff:<stdin>:91: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':598: macro 'BI'
troff: backtrace: file '<stdin>':103
troff:<stdin>:103: warning: trailing space in the line
an-end-check:<stdin>: Warning: Different number of .RS and .RE calls,
an-RS-open=2 at end of file
-.-.
Line:
%Uuser %Ssystem %Eelapsed %PCPU (%Xtext+%Ddata %Mmax)k
The 'k' at the end should remain (or use 'kilo') if Kilobyte means
1000 bytes, otherwise it should be "Ki" (or kibi).
