[gtk-list] Re: Gtk manpages?

[br0ke shells clipboard com (Erik Greenwald)]

Didimo Emilio Grimaldo Tunon wrote:
>
> > Any plans to write Gtk/Gdk/Glib manpages similar to the manpages written for> > Xlib and libc?
> >
>
>  Convenient but I think HTML does a better job, and if one doesn't want
>  to spawn a full-blown graphical browser there is lynx. The HTML version
>  has the advantage of the links and that it can present the info in
>  a better way. Additionally, writing TROFF pages is a time-consuming
>  task :( [unless one uses a converter but I have better use for my
>  precious disk space] and has very little add on value. IMHO it is better
>  if the effort is concentrated on completing/updating the current docs
>  rather than adding another administrative nightmare :)

I agree that html is an excellent format for documentation. However, I
think there should be man and info pages too. GNU info provides hyper
links in a node format. I think we should have all three, and if you
decide you just don't want the man pages, I'd be more than happy to send
you a copy of this really nifty program called 'rm'. A lot of man pages
are under 2k so I don't see space as a serious problem if you already
have both X an gtk+ running? :) I can agree that we need the phrixxin
docs more complete before worrying about porting them to troff/groff
format. But if someone decides to convert them and add them to the doc
tree and/or gtk source tar, or convert them to sgml...? While on the
subject of poor documentation and various formats, what if we had an
html widget to use for online docs to a program? this would allow images
(of the program?) and hyperlinks, making it easy. What if we, ummm, made
up a tag to call a program peice? like <GTK
FUN="pref_box()">Preferences</GTK> so they could follow 'howto's from
the help page? (yeah, yeah, I know it sounds a LOT like m$'s help, but
our docs would be a lot smaller and portable, as well as forcable thru
nutscrape, gzilla, lynx...)

-Erik