missing line continuation in many man3 pages
Hello,
Many X man3 manpages uses the 'ds' groff macro to define a string and use it
later. Unfortunately (probably with the time), some of these strings do
not fit in one line, and thus this string is truncated, and the other
piece of string is displayed at the wrong place.
Before submitting a bug report, I'm willing to know which king of patch
will have more chance to be applied:
* adding an input line continuation character (\ at the end of the line)
* removing those .ds, which are pure evil IMHO (these strings are most
of the time used once, this makes the man more complex, and - this
mail prove it - less maintainable [1]).
Notes:
+ some of the .ds could be kept, like those of the header:
.ds xL Xlib \- C Language X Interface
+ Maybe there is a use for these string variables, but I could no
find any.
The two kinds of patch are attached (only XcmsLaQMC.man is patched, but
much more pages are affected)
[1]: the line continuation characters where removed in 2001, with the
"Minor man page preprocessing cleanups" logs:
http://cvsweb.xfree86.org/cvsweb/xc/doc/man/X11/XcmsLaQMC.man.diff?r1=1.2&r2=1.3
Thanks in advance,
--
Nekral
diff -rau ../doc.orig/man/X11/XcmsLaQMC.man ./man/X11/XcmsLaQMC.man
--- ../doc.orig/man/X11/XcmsLaQMC.man 2005-02-28 18:35:18.000000000 +0100
+++ ./man/X11/XcmsLaQMC.man 2005-08-30 16:54:44.000000000 +0200
@@ -164,9 +164,9 @@
.ds Ch maximum lightness (MaxL) or minimum lightness (MinL)
.IP \fIchroma\fP 1i
Specifies the chroma at which to find \*(Ch.
-.ds Lc maximum chroma (MaxC and MaxLC), maximum lightnes (MaxL),
+.ds Lc maximum chroma (MaxC and MaxLC), maximum lightnes (MaxL), \
or minimum lightness (MinL)
-.ds lC hue angle and lightness (MaxC), hue angle and chroma (MaxL and MinL),
+.ds lC hue angle and lightness (MaxC), hue angle and chroma (MaxL and MinL), \
or hue angle (MaxLC)
.IP \fIcolor_return\fP 1i
Returns the CIE L*a*b* coordinates of \*(Lc
@@ -174,7 +174,7 @@
The white point associated with the returned
color specification is the Screen White Point.
The value returned in the pixel member is undefined.
-.ds Ha maximum chroma (MaxC and MaxLC), maximum lightness (MaxL),
+.ds Ha maximum chroma (MaxC and MaxLC), maximum lightness (MaxL), \
or minimum lightness (MinL)
.IP \fIhue_angle\fP 1i
Specifies the hue angle (in degrees) at which to find \*(Ha.
diff -rau ../doc.orig/man/X11/XcmsLaQMC.man ./man/X11/XcmsLaQMC.man
--- ../doc.orig/man/X11/XcmsLaQMC.man 2005-02-28 18:35:18.000000000 +0100
+++ ./man/X11/XcmsLaQMC.man 2005-08-30 17:10:20.000000000 +0200
@@ -161,26 +161,22 @@
Specifies the CCC.
Note that the CCC's Client White Point and White Point Adjustment procedures
are ignored.
-.ds Ch maximum lightness (MaxL) or minimum lightness (MinL)
.IP \fIchroma\fP 1i
-Specifies the chroma at which to find \*(Ch.
-.ds Lc maximum chroma (MaxC and MaxLC), maximum lightnes (MaxL),
-or minimum lightness (MinL)
-.ds lC hue angle and lightness (MaxC), hue angle and chroma (MaxL and MinL),
-or hue angle (MaxLC)
+Specifies the chroma at which to find maximum lightness (MaxL) or minimum
+lightness (MinL).
.IP \fIcolor_return\fP 1i
-Returns the CIE L*a*b* coordinates of \*(Lc
-displayable by the screen for the given \*(lC.
+Returns the CIE L*a*b* coordinates of maximum chroma (MaxC and MaxLC),
+maximum lightnes (MaxL), or minimum lightness (MinL)
+displayable by the screen for the given hue angle and lightness (MaxC),
+hue angle and chroma (MaxL and MinL), or hue angle (MaxLC).
The white point associated with the returned
color specification is the Screen White Point.
The value returned in the pixel member is undefined.
-.ds Ha maximum chroma (MaxC and MaxLC), maximum lightness (MaxL),
-or minimum lightness (MinL)
.IP \fIhue_angle\fP 1i
-Specifies the hue angle (in degrees) at which to find \*(Ha.
-.ds Ls maximum chroma (MaxC)
+Specifies the hue angle (in degrees) at which to find maximum chroma (MaxC
+and MaxLC), maximum lightness (MaxL), or minimum lightness (MinL).
.IP \fIL_star\fP 1i
-Specifies the lightness (L*) at which to find \*(Ls.
+Specifies the lightness (L*) at which to find maximum chroma (MaxC).
.SH DESCRIPTION
The
.ZN XcmsCIELabQueryMaxC
Reply to: