Package: fontconfig
Version: 2.14.2-6
Severity: minor
Dear Maintainer,
here are some comments about the manual.
-.-
Get a later version of the man page generator.
Show the version of the generator.
-.-
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
"printf '%s\n%s\n' '.kern 0' '.ss 12 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 for warnings,
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 fc-cache.1":
mandoc: fc-cache.1:2:20: STYLE: normalizing date format to: TH August 13, 2008
mandoc: fc-cache.1:6:2: WARNING: skipping paragraph macro: sp after SH
mandoc: fc-cache.1:7:280: STYLE: whitespace at end of input line
mandoc: fc-cache.1:9:2: WARNING: skipping paragraph macro: PP after SH
mandoc: fc-cache.1:26:2: WARNING: skipping paragraph macro: PP after SH
mandoc: fc-cache.1:62:2: WARNING: skipping paragraph macro: PP after SH
mandoc: fc-cache.1:72:2: WARNING: skipping paragraph macro: PP after SH
mandoc: fc-cache.1:83:2: WARNING: skipping paragraph macro: PP after SH
-.-.
Input file is fc-cache.1.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
63:\fBfc-cache\fR returns zero if the caches successfully generated. otherwise
non-zero.
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
7:\fBfc-cache\fR [ \fB-EfrsvVh\fR ] [ \fB--error-on-no-fonts\fR ] [
\fB--force\fR ] [ \fB--really-force\fR ] [ \fB [ -y \fIdir\fB ] [ --sysroot
\fIdir\fB ] \fR ] [ \fB--system-only\fR ] [ \fB--verbose\fR ] [
\fB--version\fR ] [ \fB--help\fR ] [ \fB\fIdir\fB\fR\fI...\fR ]
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option, or is a symbol for standard input.
7:\fBfc-cache\fR [ \fB-EfrsvVh\fR ] [ \fB--error-on-no-fonts\fR ] [
\fB--force\fR ] [ \fB--really-force\fR ] [ \fB [ -y \fIdir\fB ] [ --sysroot
\fIdir\fB ] \fR ] [ \fB--system-only\fR ] [ \fB--verbose\fR ] [
\fB--version\fR ] [ \fB--help\fR ] [ \fB\fIdir\fB\fR\fI...\fR ]
31:\fB-E\fR
36:\fB-f\fR
40:\fB-r\fR
43:\fB-s\fR
47:\fB-v\fR
50:\fB-y\fR
53:\fB-h\fR
56:\fB-V\fR
-.-.
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.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
16:current font configuration. Each directory is scanned for
17:font files readable by FreeType. A cache is created which
28:with long options starting with two dashes (`-'). A summary of
63:\fBfc-cache\fR returns zero if the caches successfully generated. otherwise
non-zero.
68:and contain maps from file names to font properties. They are
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
fc-cache.1: line 7 length 280
\fBfc-cache\fR [ \fB-EfrsvVh\fR ] [ \fB--error-on-no-fonts\fR ] [
\fB--force\fR ] [ \fB--really-force\fR ] [ \fB [ -y \fIdir\fB ] [ --sysroot
\fIdir\fB ] \fR ] [ \fB--system-only\fR ] [ \fB--verbose\fR ] [
\fB--version\fR ] [ \fB--help\fR ] [ \fB\fIdir\fB\fR\fI...\fR ]
fc-cache.1: line 63 length 85
\fBfc-cache\fR returns zero if the caches successfully generated. otherwise
non-zero.
-.-.
Remove unnecessary second font change in a row.
7:\fBfc-cache\fR [ \fB-EfrsvVh\fR ] [ \fB--error-on-no-fonts\fR ] [
\fB--force\fR ] [ \fB--really-force\fR ] [ \fB [ -y \fIdir\fB ] [ --sysroot
\fIdir\fB ] \fR ] [ \fB--system-only\fR ] [ \fB--verbose\fR ] [
\fB--version\fR ] [ \fB--help\fR ] [ \fB\fIdir\fB\fR\fI...\fR ]
33:\fB\fIdir\fB\fR or directories
51:Prepend \fB\fIdir\fB\fR to all paths for scanning.
59:\fB\fIdir\fB\fR
66:\fB\fI%cachedir%/*-%arch%\&.cache-%version%\fB\fR
-.-.
Show the complete name of the generater (".pl" is missing) and version.
1:.\" auto-generated by docbook2man-spec from docbook-utils package
-.-.
[ "test-groff" is a developmental version of "groff" ]
Input file is ./fc-cache.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rCHECKSTYLE=0":
troff: backtrace: file '<stdin>':7
troff:<stdin>:7: warning: trailing space in the line
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (990, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.4.13-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 fontconfig depends on:
ii fontconfig-config 2.14.2-6
ii libc6 2.37-8
ii libfontconfig1 2.14.2-6
ii libfreetype6 2.13.2+dfsg-1
fontconfig recommends no packages.
fontconfig suggests no packages.
-- no debconf information
