Bug#251996: acknowledged by developer (Re: Bug#251995: gnome-applets: no manpages supplied)

Marc Dequènes (Duck) Marc Dequènes (Duck) , 251996@bugs.debian.org
Sat, 05 Jun 2004 18:23:59 +0200


--=-=-=
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


"Karsten M. Self" <kmself@ix.netcom.com> writes:

> There are numerous apps not in the path which have manpages.


that's right, but this is not sufficient to make it a good thing for all
packages.

> Moreover:  there are numerous _system_ features which have manpages
> though they're only accessible through programming interfaces.  The
> manual isn't strictly a user resource, it's a system documentation
> resource.  Memory is hazy, but IIRC the original UNIX system manual was
> for programming interfaces, shell commands were added later.

I agree, but here there is NO sysinfo/interface/... to documente on in
this case.

> Because among the places I go for system information on features is the
> man and apropos systems.   The GNOME applets have identifiable
> execuatables and show in the process table.  This is sufficient
> indication IMO that they should have manpages.
>
> A stub page describing the applet, how it's to be invoked, and where the
> extended docs live, would be good.  References as a URL, file ref, or
> GNOME docs ref, would be sufficient.   I may craft same time permitting.

Applets are described in the pkg descrition and in yelp, what else to
say it was not already ?

> Specific interest:  I wanted to know how to fix issues with several
> applets which weren't functioning properly.

Applets are not libraries, if you need information about how to make
one, use materials in libpanel-applet2-doc, and if you want to patch
one, UTSL.

I disagree to write a manpage on everything if it does not bring real
information. Nevertheless, as you think links to more detailed
information for developpers are lacking, i could add a note in
README.Debian, which is more appropriate for this kind of information,
as it is related to the entire package and not to a specific part of
him.

=2D-=20
Marc Dequ=C3=A8nes (Duck)

--=-=-=
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)

iD8DBQBAwfOksczZcpAmcIYRAnN1AKCcn9rVyYsBS30gAfA8kWlYHqVgBACfVtT3
QVwW9MDAsnK1zYeN0ay6RDQ=
=EfUL
-----END PGP SIGNATURE-----
--=-=-=--