[1374] in testers
more manpage screw-ups (long!)
daemon@ATHENA.MIT.EDU (daemon@ATHENA.MIT.EDU)
Fri Dec 7 12:28:24 1990
From: vanharen@ATHENA.MIT.EDU
Date: Fri, 7 Dec 90 12:27:57 -0500
To: testers@ATHENA.MIT.EDU
The recent mail to testers-announce outlining all the changes to 7.2
thus far listed several manpage fixes. I decided that it should not be
too difficult to find most, if not all, of the manpages that were left
to be fixed...
The following contains descriptions and listings of all the problems I
could find in 'whatis', with only a cursory look. I would be willing to
make the changes necessary to fix these if it is deemed important
enough. The order of grouping is somewhat indicative of relative
importance (IMHO).
-Chris.
===============================================================================
>>
>> The following manpages have bad 'whatis' entries:
>>
\&.mh\(ruprofile (5) - user customization for MH message system
.PP xfontsel (1) - point & click interface for selecting X11 font names .PP
rkinitd (8) - server for .I rkinit, a remote kerberos ticket establishment utility
sabertool - Saber-C programming environment for the SunView window system .br xsaber (1) - Saber-C programming environment for the X11 window system
soelim (1) - eliminate \&.so's from nroff input
unlog (1V) - Tell the .I Andrew Cache Manager to delete some or all of the user's Andrew File System authentication information.
xditview \(em display ditroff DVI files(1)
expunge, purge (1) - permanent removal of delete\^d files
>>
>> This program does not exist anymore (not even on the "unsupported"
>> locker, so its manpage should be removed.
>>
.B infoclient (1) - client program for information services
>>
>> There is only one "X" manpage. The other is the "Xserver" manpage.
>> It should be referenced as such in the 'whatis' file.
>>
X (1) - X Window System server
X (1) - a portable, network-transparent window system
>>
>> The 'whatis' entries for the following do not lend themselves to
>> finding the manpages very easily. The manpages can be referenced as
>> "XConsortium" and "XStandards", respectively. They should show up in
>> 'whatis' as such, and have "MIT X Consortium" and "X Standards"
>> (respectively) as their descriptions.
>>
MIT X Consortium(1)
X Standards(1)
>>
>> These manpages have no decriptions after the name. While this is not
>> a huge problem, it would be nice if they had one, in order to be
>> consistent with the rest of the manpages, and so that people would know
>> what they were for. The authors should probably be contacted to
>> write description entries.
>>
rkinit, rkinit_errmsg(3)
XtCreatePopupShell(3Xt)
mr_connect, mr_host, mr_auth, mr_disconnect, mr_noop, mr_access, mr_query, mr_do_update, mr_motd, mr_set_alternate_input, format_filesys_type, parse_filesys_type, canonicalize_hostname, strsave, strtrim, sq_create, sq_destroy, sq_get_data, sq_remove_data, sq_empty, sq_save_args, sq_save_data, sq_save_unique_data, sq_save_unique_string(3)
>>
>> Lots o' problems here.
>> The "tu" manpage gets screwed up by /usr/lib/makewhatis. makewhatis
>> strips "VAX-11" from manpage descriptions. This is really wrong -- I
>> don't know why makewhatis should do this. The only 3 manpages I could
>> find with "VAX-11" in their descriptions. They are "as", "cons", and
>> "tu", on the VAX. The string "VAX-11" should just be left in for "cons"
>> and "tu", as they are vax-specific, I think. The RT has a different
>> "cons" manpage, but "tu" should possibly be removed from the set of
>> manpages on the RT. The "as" manpage should either NOT say "VAX-11" in
>> it, or should be re-written for the RT. It should probably just say
>> "VAX", anyway, not "VAX-11".
>> Anyway, in my opinion, the way to resolve this one is to change
>> /usr/lib/makewhatis to remove line 29 ("-e 's/ VAX-11//' \").
>>
tu (4) -/730 and VAX-11/750 TU58 console cassette interface
>>
>> Getting nitpicky here. The following manpages have either (a) no space
>> after the dash in the decription, (b) two spaces after the dash, or (c)
>> two dashes. These are trivial to fix, but not crucial.
>>
datapros (1) -concatenate ATK data with prose inclusions
eqn, neqn, checkeq (1) - typeset mathematics
fp (1) - Functional Programming language compiler/interpreter
kdb_edit (8) - Kerberos key distribution center database editing utility
kdb_util (8) - Kerberos key distribution center database utility
mh (1) - mail message handler
runapp (1) -run an Andrew application
scheme (1) -- interpreter for Scheme dialect of Lisp
style (1) - analyze surface characteristics of a document
>>
>> Another nitpicky one. Not crucial to fix...
>> The following manpages all have backslashes in them. They should either
>> be fixed so that there is no backslash in them, or /usr/lib/makewhatis
>> can be hacked to strip out backslashes. I'm kinda partial to hacking
>> makewhatis since it's fast (and I've already figure out what line to
>> add to it and where), but really these manpages should be fixed.
>> Since most of them are X manpages (all except tf_init), we should
>> send this back to the X consortium.
>>
XAllocClassHint, XSetClassHint, XGetClassHint, XClassHint \ (3X11) - allocate class hints structure and set or read a window's WM_CLASS property
XAllocIconSize, XSetIconSizes, XGetIconSizes, XIconSize \ (3X11) - allocate icon size structure and set or read a window's WM_ICON_SIZES property
XAllocSizeHints, XSetWMNormalHints, XGetWMNormalHints, \ XSetWMSizeHints, XGetWMSizeHints, XSizeHints \ (3X11) - allocate size hints structure and set or read a window's WM_NORMAL_HINTS property
XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints \ (3X11) - allocate window manager hints structure and set or read a window's WM_HINTS property
XIfEvent, XCheckIfEvent, XPeekIfEvent \ (3X11) - check the event queue with a predicate procedure
XInstallColormap, XUninstallColormap, XListInstalledColormaps \ (3X11) - control colormaps
XSaveContext, XFindContext, XDeleteContext, XUniqueContext \ (3X11) - associative look-up routines
XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName \ (3X11) - set or read a window's WM_ICON_NAME property
XSetWMName, XGetWMName, XStoreName, XFetchName \ (3X11) - set or read a window's WM_NAME property
XStringListToTextProperty, XTextPropertyToStringList, XFreeStringList, \ XTextProperty (3X11) - convert string lists and text property structure
XtAddCallback, XtAddCallbacks, XtRemoveCallback, XtRemoveCallbacks, \ XtRemoveAllCallbacks (3Xt) - add and remove callback procedures
XtAddEventHandler, XtAddRawEventHandler, XtRemoveEventHandler \ XtRemoveRawEventHandler (3Xt) - add and remove event handlers
XtAppAddWorkProc, XtRemoveWorkProc \ (3Xt) - Add and remove background processing procedures
XtAppError, XtAppSetErrorHandler, XtAppSetWarningHandler, XtAppWarning \ (3Xt) - low-level error handlers
XtAppErrorMsg, XtAppSetErrorMsgHandler, XtAppSetWarningMsgHandler, \ XtAppWarningMsg (3Xt) - high-level error handlers
XtAppGetSelectionTimeout, XtAppSetSelectionTimeout\ (3Xt) - set and obtain selection timeout values
XtAppNextEvent, XtAppPending, XtAppPeekEvent, XtAppProcessEvent, \ XtDispatchEvent, XtAppMainLoop (3Xt) - query and process events and input
XtClass, XtSuperClass, XtIsSubclass, XtCheckSubclass, XtIsComposite, \ XtIsManaged (3Xt) - obtain and verify a widget's class
XtCreateApplicationContext, XtDestroyApplicationContext, \ XtWidgetToApplicationContext, XtToolkitInitialize \ (3Xt) - create, destroy, and obtain an application context
XtCreateWidget, XtCreateManagedWidget, XtDestroyWidget (3Xt) - \ create and destroy widgets
XtDisplay, XtParent, XtScreen, XtWindow \ (3Xt) - obtain window information about a widget
XtDisplayInitialize, XtOpenDisplay, XtDatabase, \ XtCloseDisplay (3Xt) - initialize, open, or close a display
XtGetSubresources, XtGetApplicationResources \ (3Xt) - obtain subresources or application resources
XtManageChildren, XtManageChild, XtUnmanageChildren, XtUnmanageChild \ (3Xt) - manage and unmanage children
XtNameToWidget, XtWidgetToWindow \ (3Xt) - translating strings to widgets or widgets to windows
XtOwnSelection, XtDisownSelection \ (3Xt) - set selection owner
XtParseAcceleratorTable, XtInstallAccelerators, XtInstallAllAccelerators \ (3Xt) - managing accelerator tables
XtParseTranslationTable, XtAugmentTranslations, XtOverrideTranslations, \ XtUninstallTranslations (3Xt) - manage translation tables
XtPopup, XtCallbackNone, XtCallbackNonexclusive, XtCallbackExclusive, \ MenuPopup (3Xt) - map a pop-up
XtRealizeWidget, XtIsRealized, XtUnrealizeWidget \ (3Xt) - realize and unrealize widgets
XtSetKeyTranslator, XtTranslateKeycode, XtRegisterCaseConverter, \ XtConvertCase (3Xt) - convert KeySym to KeyCodes
XtSetValues, XtSetSubvalues, XtGetValues, XtGetSubvalues \ (3Xt) - obtain and set widget resources
tf_init, tf_get_pname, tf_get_pinst, tf_get_cred, tf_close \ (3) - Routines for manipulating a Kerberos ticket file