This is the mail archive of the
mailing list for the systemtap project.
Re: how to avoid a lengthy man page of stapprobes(5)?
- From: Bjoern Doebel <doebel at os dot inf dot tu-dresden dot de>
- To: systemtap at sources dot redhat dot com
- Date: Fri, 15 Sep 2006 18:35:55 +0200
- Subject: Re: how to avoid a lengthy man page of stapprobes(5)?
- References: <450A1562.email@example.com>
-----BEGIN PGP SIGNED MESSAGE-----
> We are documenting NFS and RPC tapsets into stapprobes(5) man page. But
> there are more than 60 probe points and each may have 3-5 arguments. If
> we document them in the same way(names, introductions, arguments,
> argument descriptions) as we did for other tapsets, it will make the
> stapprobe man page too long. And finally the user may find it difficult
> to find something there.
> So one way is to list probe point names and a short description in the
> manual page and guide the user to read the comments in the source for
> more details, i.e, the arguments and the description for each arguments
> if he wants to. Another way is that we need some better rearrangement of
> the stapprobe man page's layout to make it easier to find the desired
> probe point among a long list.
> Any suggestions?
Is it an option to create manpages of the form
and list them in the main man page?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
-----END PGP SIGNATURE-----