GNOME Bugzilla – Bug 133494
[PATCH] [docs/man] Update & revise manpages
Last modified: 2006-03-21 15:42:21 UTC
(Add manpages related issues here) TODO: - Revise and check correctnes of all manpages - Convert to DocBook - Add version tag stating version for which manpage is valid for every revised one - Add examples for gst-launch (almost done), check if everything is understandable for newbs
e.g. gst-register has options that are not in the man-page and the man page have old options (degugging stuff) documented that does not exist in this form anymore in the tools. This applies to other tools as well (gst-launch -t -T) Further please add to the docs of : gst-register that the default location of the registry is under $prefix/var/cache/gstreamer/registry.xml gst-compprep that the default location of the completion is under $prefix/var/cache/gstreamer/compreg.xml Both entries should go to a FILES section.
Created attachment 24092 [details] [review] corrects file location for compprep.xml
Created attachment 24093 [details] [review] adds docs for two new option and adds FILES section to gst-register manpage
Is this still relevant in 2.9.x?
Yes. Stefan, just apply.
Done. Stefan, again, feel free to apply yourself, that's why you have CVS access. I've added --tags to gst-launch.1.in as well.
Oh wait, I shouldn't close this, Maciej's things are still TODO. Maciej, what's the status?
Hmm, I remember someone from Sun offering SGML'd manpages, I'll go over it and ping people tomorrow. About the revising, I started doing that, but I think it's got lost somewhere, and would be obsolete by now anyway. I will see what did Sun's people do with the manpanges and then see what to do next.
Hi, the following problem was introduced in tools/gst-compprep.1.in: the man page uses @prefix@ and is not generated by config.status, but by a sed snipset in Makefile.am. I suggest including all the man pages to AC_OUTPUT() and using @GST_MAJORMINOR@ directly in the man pages instead of replacing the pipelines (which is ugly).
I added bug 133495 which has a patch from Sun for docbook support.
Javier Kohen writes: "Some pipeline examples in the gst-launch manpage refer to the now deprecated vorbisenc plug-in. It should be replaced by rawvorbisenc ! oggmux. Also note that it may be necessary to use audioconvert between mad and rawvorbisenc (also vorbisenc), because the former outputs int samples and the latter expects them in float point numbers. By the way, the examples refer to gst-launch, but the binary is called gst-launch-0.8 in Debian." The sed snipset is broken in tools/Makefile.am: s,gst-launch,gst-launch-@GST_MAJORMINOR@,g won't match gst\-launch in the man page. I don't know whether the Sun patch fixes the problem described by Javier Kohen in Debian bug <http://bugs.debian.org/311832>.
Please consider the following typos: man gst-feedback: "feeback" instead of feedback man gst-md5sum: "docuementation" instead of documentation reported in Debian bugs http://bugs.debian.org/305643 and http://bugs.debian.org/305645 by A. Costa.
Given the absence of gst-register in 0.10, added a FILE section to the gst-launch man page instead; typo in gst-feedback man page fixed; the rest is obsolete as far as I can tell.