🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: gnu.misc.discuss
Article #1377

Re: texinfo manual for C library functions

#1377
From: Christian Lynbech
Date: Wed, 16 Dec 1992 09:08
52 lines
2847 bytes
slhpv@cc.usu.edu writes:


>Has anyone created a texinfo file which documents the functions, types, and
>macros contained in a normal set of include files?

>If not, is there any interest in having access to such documentation?

>Specifically what I had in mind was a 'manual' organized according to
>include library, and indexed off function names.  A figure a typical entry
>would look like this:

[...stuff deleted...]

I think the idea is good and worthwhile, but would recommend some consideration
before plunging into the project. The C library is pretty huge, and thus
writing such a libc.info is a considerable task.

What is imporatnt is to assure one self that such a manual can do things that
tha manual system do not. I my opinion, if libc.info is just another format for
essentially the same information (perhaps with some crossreferencing), then
some sort of intelligent emacs interface to the man system would be a much
better investment of time and ressources.

For libc.info to be worth the effort, it should be like the elisp ref manual,
which contains tons of explanations and examples, and then we are talking a
major effort.

A man interface could deal with making of menus (based on for instance include
libraries), indexes and references, parsing up the information from the actual
manpages. The advantage of this would be that the system would go with whatever
OS you would be programming on, where writing an texinfo file would fix which
library we were talking about.

Such an interface may even exist already. One would for instance like to check
out the hyperbole package, which are supposed to deal with navigating through
massive amounts of information.



------------------------------------------------------------------------------
Christian Lynbech

DAIMI						office: R0.32   phone: 5034
University of Aarhus,DK-Denmark                 email: lynbech@daimi.aau.dk
------------------------------------------------------------------------------
			  EMACS, The One True Editor                       


Hit the philistines three times over the head with the Elisp reference manual.

                                        - petonic@hal.com (Michael A. Petonic)
Technical Details
Message-ID: <1992Dec16.090822.23542@daimi.aau.dk>
Path: arc1-ca.pugleaf.net!sparky!uunet!mcsun!sunic!dkuug!daimi!lynbech
References: <FISCHER.92Dec15014923@thor.iesd.auc.dk> <1992Dec15.042930.23371@pasteur.Berkeley.EDU> <DREIER.92Dec14235242@durban.berkeley.edu> <1glavuINNd1g@agate.berkeley.edu> <1992Dec15.194401.62079@cc.usu.edu>

Show Full Headers
Complete Article Headers
Newsgroups: gnu.misc.discuss
Path: arc1-ca.pugleaf.net!sparky!uunet!mcsun!sunic!dkuug!daimi!lynbech
From: lynbech@daimi.aau.dk (Christian Lynbech)
Subject: Re: texinfo manual for C library functions
Message-ID: <1992Dec16.090822.23542@daimi.aau.dk>
Sender: news@daimi.aau.dk
Organization: DAIMI: Computer Science Department, Aarhus University, Denmark
References: <FISCHER.92Dec15014923@thor.iesd.auc.dk> <1992Dec15.042930.23371@pasteur.Berkeley.EDU> <DREIER.92Dec14235242@durban.berkeley.edu> <1glavuINNd1g@agate.berkeley.edu> <1992Dec15.194401.62079@cc.usu.edu>
Date: Wed, 16 Dec 92 09:08:22 GMT
Lines: 54