Dear Maintainer,
here are some notes and editrorial fixes for the man page.
The patch is in the attachment.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man -t <file1> > <out1>
nroff -man -t <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -t -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 '-' (\-) to '\(en' (en-dash) for a numeric range.
Xserver.1:121:sets key-click volume (allowable range: 0-100).
Xserver.1:165:sets beep (bell) volume (allowable range: 0-100).
Xserver.1:168:sets fake presenter screen default fps (allowable range: 1-600).
-.-.
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.
57:devices (e.g. \fI/dev/mouse\fP) is restricted. Where applicable, the
81:sets pointer acceleration (i.e. the ratio of how much is reported to how much
106:May be useful for smooth transition with eg. fbdev driver.
266:sets pointer acceleration threshold in pixels (i.e. after how many pixels
406:X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
461:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
-.-.
Change - to \- if it shall be printed as a minus sign.
Xserver.1:299:enables(+) or disables(-) the XINERAMA extension. The default state is
Xserver.1:413:enables(+) or disables(-) AccessX key sequences.
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
112:pattern. This is the default unless -retro or -wr is specified.
247:.B -retro
251:servers, this implies -zap.
-.-.
Strings longer than 3/4 of a standard line length (80)
527 /usr/share/fonts/X11/misc,/usr/share/fonts/X11/cyrillic,/usr/share/fonts/X11/100dpi/:unscaled,/usr/share/fonts/X11/75dpi/:unscaled,/usr/share/fonts/X11/Type1,/usr/share/fonts/X11/100dpi,/usr/share/fonts/X11/75dpi,built-ins .
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
57:devices (e.g. \fI/dev/mouse\fP) is restricted. Where applicable, the
81:sets pointer acceleration (i.e. the ratio of how much is reported to how much
266:sets pointer acceleration threshold in pixels (i.e. after how many pixels
461:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
-.-.
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.
N.B
The number of lines affected is too large to be in the patch.
57:devices (e.g. \fI/dev/mouse\fP) is restricted. Where applicable, the
81:sets pointer acceleration (i.e. the ratio of how much is reported to how much
106:May be useful for smooth transition with eg. fbdev driver.
112:pattern. This is the default unless -retro or -wr is specified.
157:disables named extension. If an unknown extension name is specified,
161:enables named extension. If an unknown extension name is specified,
250:until the first time an application calls XDefineCursor(). For kdrive
260:seat to run on. Takes a string identifying a seat in a platform
261:specific syntax. On platforms which support this feature this may be
266:sets pointer acceleration threshold in pixels (i.e. after how many pixels
275:the delay. At the end of this grace period if no client is
406:X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
461:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
530:prefix. Directories specified this way can contain symlinks pointing to the
531:real font directories. See the FONTPATH.D section for details.
541:will be passed through to the underlying fontfile FPE. The only exception is
557:the attribute 'unscaled' etc. This is functionally equivalent to setting
-.-.
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.
Xserver.1: line 412 length 101
.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
Xserver.1: line 527 length 224
/usr/share/fonts/X11/misc,/usr/share/fonts/X11/cyrillic,/usr/share/fonts/X11/100dpi/:unscaled,/usr/share/fonts/X11/75dpi/:unscaled,/usr/share/fonts/X11/Type1,/usr/share/fonts/X11/100dpi,/usr/share/fonts/X11/75dpi,built-ins .
-.-.
Do not use more than two space characters between sentences or (better)
only a new line character.
112:pattern. This is the default unless -retro or -wr is specified.
157:disables named extension. If an unknown extension name is specified,
161:enables named extension. If an unknown extension name is specified,
-.-.
Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line
(by splitting the line into more lines).
540:The symlink can be suffixed by attributes such as '\fBunscaled\fR', which
542:the newly introduced '\fBpri\fR' attribute, which will be used for ordering
557:the attribute 'unscaled' etc. This is functionally equivalent to setting
-.-.
"[" and "]", showing optional arguments to options, should be typeset in roman.
412:.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./Xserver.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rSTYLECHECK=3":
an.tmac:<stdin>:104: style: .BI expects at least 2 arguments, got 1
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':524: macro 'B'
troff: backtrace: file '<stdin>':167
troff:<stdin>:167: warning: cannot select font 'F'
troff: backtrace: file '<stdin>':527
troff:<stdin>:527: warning [page 6, 8.5i]: cannot break line
-.-.