Bug 26090

Summary: more broken "SEE ALSO" references
Product: Documentation Reporter: rdm <rdm>
Component: Books & ArticlesAssignee: mpp
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description rdm 2001-03-26 07:30:01 UTC
	A number of SEE ALSO references point to nonexistent pages.
        In some cases, I have been able to supply a hint.  Here,
        in any event, is the list:

 Referencing page              Referenced page                            Hint
 ================              ===============                            ====
 appres(1)                     X(1)
 bdftopcf(1)                   X(1)
 ico(1)                        X(1)
 listres(1)                    X(1)
 oclock(1)                     X(1)
 showfont(1)                   fs(1)
 twm(1)                        X(1)
 viewres(1)                    X(1)
 x11perf(1)                    X(1)
 x11perf(1)                    xbench(1)
 x11perfcomp(1)                X(1)
 xbiff(1)                      X(1)
 xcalc(1)                      X(1)
 xclipboard(1)                 X(1)
 xcutsel(1)                    X(1)
 xditview(1)                   X(1)
 xdpyinfo(1)                   X(1)
 xev(1)                        X(1)
 xeyes(1)                      X(1)
 xfd(1)                        X(1)
 xfs(1)                        X(1)
 xfwp(1)                       ymngr(1)
 xgc(1)                        X(1)
 xieperf(1)                    X(1)
 xkbcomp(1)                    X(1)
 xkbevd(1)                     X(1)
 xkill(1)                      X(1)
 xlsatoms(1)                   X(1)
 xlsclients(1)                 X(1)
 xlsfonts(1)                   X(1)
 xmessage(1)                   X(1)
 xmodmap(1)                    X(1)
 xprop(1)                      X(1)
 xrefresh(1)                   X(1)
 xset(1)                       X(1)
 xsetroot(1)                   X(1)
 xstdcmap(1)                   X(1)
 xvidtune(1)                   XF86Config(4/5)                             (4)
 xwininfo(1)                   X(1)
 xmessage(1)                   X(1)

 X(3)                          XConsortium(1)                              (3)
 X(3)                          XStandards(1)                               (3)
 X(3)                          Xsecurity(1)                                (1)
 XCreateFontSet(3)             XExtentsofFontSet(3X11)           XExtentsOf...
 XCreateOC(3)                  XCreateOM(3X11)
 XDestroyOC(3)                 XCreateOM(3X11)
 XFreeFontPath(3)              XListFont(3X11)                XListFonts(3X11)
 XFreeFontPath(3)              XLoadFonts(3X11)                XLoadFont(3X11)
 XFreeFontSet(3)               XExtentsofFontSet(3X11)           XExtentsOf...
 XGetDeviceButtonMapping(3)    XChangeDeviceKeyboardControl(3X)
 XGetDeviceModifierMapping(3)  XSetDeviceKeyMapping(3X11)           XChange...
 XGetFontPath(3)               XListFont(3X11)                XListFonts(3X11)
 XGetFontPath(3)               XLoadFonts(3X11)                XLoadFont(3X11)
 XGetOCValues(3)               XCreateOM(3X11)
 XGrabKey(3)                   XAllowAccess(3X11)
 XInstallColormap(3)           XChangeWindowAtrributes(3X11)       ...Attri...
 XListInstalledColormaps(3)    XChangeWindowAtrributes(3X11)       ...Attri...
 XOMOfOC(3)                    XCreateOM(3X11)
 XSetDeviceButtonMapping(3)    XChangeDeviceKeyboardControl(3X)
 XSetDeviceModifierMapping(3)  XSetDeviceKeyMapping(3X11)           XChange...
 XSetFontPath(3)               XListFont(3X11)                XListFonts(3X11)
 XSetFontPath(3)               XLoadFonts(3X11)                XLoadFont(3X11)
 XSetOCValues(3)               XCreateOM(3X11)
 XUngrabKey(3)                 XAllowAccess(3X11)
 XUninstallColormap(3)         XChangeWindowAtrributes(3X11)       ...Attri...
 XmbDrawString(3)              XXDrawImageString(3X11)                XDraw...
 XtAppAddSignal(3)             dWorkProc(3Xt)
 XtInstallAccelerators(3)      XtParseTranslationTable(1)                  (3)
 XtInstallAllAccelerators(3)   XtParseTranslationTable(1)                  (3)
 XtNoticeSignal(3)             dWorkProc(3Xt)
 XtParseAcceleratorTable(3)    XtParseTranslationTable(1)                  (3)
 XtRemoveSignal(3)             dWorkProc(3Xt)
 XwcDrawString(3)              XXDrawImageString(3X11)                XDraw...

Fix: 

The references will have to be analyzed and fixed on a case-
        by-case basis.
How-To-Repeat: 
	Run whatis(1) on the referenced pages and see what comes up.
Comment 1 mpp freebsd_committer freebsd_triage 2001-03-27 08:38:13 UTC
Responsible Changed
From-To: freebsd-doc->mpp

I'll look at this, but it looks like most of them are 3rd party man 
pages.
Comment 2 nik freebsd_committer freebsd_triage 2001-03-27 10:08:55 UTC
Rich,,

Most of these look like being problems with the X distribution, which we
don't maintain.  Can you follow this up with the XFree86 people?

On Sun, Mar 25, 2001 at 10:29:07PM -0800, Rich Morin wrote:
>  Referencing page              Referenced page                            Hint
>  ================              ===============                            ====
>  appres(1)                     X(1)


X(1) exists on my XFree86 3.3.6 system.  What version of X do you have
installed?  I've deleted all the other X(1) problems.

>  showfont(1)                   fs(1)


Real bug.

>  x11perf(1)                    xbench(1)


Real bug.

>  xfwp(1)                       ymngr(1)


The actual man page says:

       xfindproxy (1), Proxy Management Protocol spec V1.0, prox-
       ymngr(1), Xserver(1)

so that's the result of the hyphenation algorithm.  The actual command
is proxymngr(1).  This is a bug in the markup in the man page.

>  xvidtune(1)                   XF86Config(4/5)                             (4)


Exists, but the man page is written oddly, and it only exists in section
5, not section 4.

>  X(3)                          XConsortium(1)                              (3)


Exists on my system.

>  X(3)                          XStandards(1)                               (3)


Ditto.

>  X(3)                          Xsecurity(1)                                (1)


Ditto.

>  XCreateFontSet(3)             XExtentsofFontSet(3X11)           XExtentsOf...
>  XCreateOC(3)                  XCreateOM(3X11)
>  XDestroyOC(3)                 XCreateOM(3X11)
>  XFreeFontPath(3)              XListFont(3X11)                XListFonts(3X11)
>  XFreeFontPath(3)              XLoadFonts(3X11)                XLoadFont(3X11)
>  XFreeFontSet(3)               XExtentsofFontSet(3X11)           XExtentsOf...
>  XGetDeviceButtonMapping(3)    XChangeDeviceKeyboardControl(3X)
>  XGetDeviceModifierMapping(3)  XSetDeviceKeyMapping(3X11)           XChange...
>  XGetFontPath(3)               XListFont(3X11)                XListFonts(3X11)
>  XGetFontPath(3)               XLoadFonts(3X11)                XLoadFont(3X11)
>  XGetOCValues(3)               XCreateOM(3X11)
>  XGrabKey(3)                   XAllowAccess(3X11)
>  XInstallColormap(3)           XChangeWindowAtrributes(3X11)       ...Attri...
>  XListInstalledColormaps(3)    XChangeWindowAtrributes(3X11)       ...Attri...
>  XOMOfOC(3)                    XCreateOM(3X11)
>  XSetDeviceButtonMapping(3)    XChangeDeviceKeyboardControl(3X)
>  XSetDeviceModifierMapping(3)  XSetDeviceKeyMapping(3X11)           XChange...
>  XSetFontPath(3)               XListFont(3X11)                XListFonts(3X11)
>  XSetFontPath(3)               XLoadFonts(3X11)                XLoadFont(3X11)
>  XSetOCValues(3)               XCreateOM(3X11)
>  XUngrabKey(3)                 XAllowAccess(3X11)
>  XUninstallColormap(3)         XChangeWindowAtrributes(3X11)       ...Attri...
>  XmbDrawString(3)              XXDrawImageString(3X11)                XDraw...
>  XtAppAddSignal(3)             dWorkProc(3Xt)
>  XtInstallAccelerators(3)      XtParseTranslationTable(1)                  (3)
>  XtInstallAllAccelerators(3)   XtParseTranslationTable(1)                  (3)
>  XtNoticeSignal(3)             dWorkProc(3Xt)
>  XtParseAcceleratorTable(3)    XtParseTranslationTable(1)                  (3)
>  XtRemoveSignal(3)             dWorkProc(3Xt)
>  XwcDrawString(3)              XXDrawImageString(3X11)                XDraw...


Look like real bugs that the XFree86 project needs to fix.

N
-- 
FreeBSD: The Power to Serve             http://www.freebsd.org/
FreeBSD Documentation Project           http://www.freebsd.org/docproj/

          --- 15B8 3FFC DDB4 34B0 AA5F  94B7 93A8 0764 2C37 E375 ---
Comment 3 rdm 2001-03-27 17:42:41 UTC
I find it a bit peculiar to be sent scuttling off to talk to the XF86
folks.  In the first place, I don't even _use_ X11.  In the second, I
was perhaps a bit too credulous at BSDcon 2000 when the BSD folks said
that they handled all bugs in the distro themselves, unlike the Linux
folks who just referred folks off to the package authors.  Sigh...

Owell, I'll send them a note and see if they'll listen to me.


>X(1) exists on my XFree86 3.3.6 system.  What version of X do you have
>installed?  I've deleted all the other X(1) problems.

As my uname output indicates, I'm running FB 4.2.  The version of X11
is whatever was on the distro.

Getting back to the X(1) problem, however, the error lies in the fact
that the man page isn't really in section 1:

   /usr/X11R6/man/cat3/X.3.gz

>The actual man page says:
>
>        xfindproxy (1), Proxy Management Protocol spec V1.0, prox-
>        ymngr(1), Xserver(1)
>
>so that's the result of the hyphenation algorithm.  The actual command
>is proxymngr(1).  This is a bug in the markup in the man page.

Well, it's a poor job of hyphenation, to be sure, but it's also a bug
in my parsing code, which should splice hyphenated words back together.

>>   xvidtune(1)                   XF86Config(4/5)                      (4)
>
>Exists, but the man page is written oddly, and it only exists in section
>5, not section 4.

This is the only instance I have found of this kind of notation, so I
think it wouldn't be too outrageous to ask that it be normalized.

>>   X(3)                          XConsortium(1)                       (3)
>Exists on my system.
>>   X(3)                          XStandards(1)                        (3)
>Ditto.
>>   X(3)                          Xsecurity(1)                         (1)
>Ditto.

Yes, they exist, but they are all in section 3:

   /usr/X11R6/man/cat3/XConsortium.3.gz
   /usr/X11R6/man/cat3/Xsecurity.3.gz
   /usr/X11R6/man/cat3/XStandards.3.gz

>>   XCreateFontSet(3)             XExtentsofFontSet(3X11)        XExtentsOf...
>>...
>Look like real bugs that the XFree86 project needs to fix.

Agreed.  I'll send them a note...

-r
-- 
http://www.cfcl.com/rdm - home page, resume, etc.
http://www.cfcl.com/Meta/md_fb.html - The FreeBSD Browser
email: rdm@cfcl.com; phone: +1 650-873-7841
Comment 4 mpp freebsd_committer freebsd_triage 2001-07-22 13:04:06 UTC
State Changed
From-To: open->closed

These are all 3rd party package xrefs that we do not fix ourselves. 
Originator stated that he would try and contact the XFree organization 
about getting them fixed.