GNOME Bugzilla – Bug 311565
manual page
Last modified: 2020-06-19 18:53:08 UTC
Hi, Debian ships a manual page for gnome-terminal. Its source is in SGML format and is converted at build-time. I'm attaching it here for you to consider. Bye,
Created attachment 49761 [details] Debian manual page for gnome-terminal in SGML format
Moving to default Docs assignee. Sorry for the spam
Is the intention that we add material from this document in to the user manual, or that this file be added to gnome-terminal as a man page?
The intention is to provide a manual page for the gnome-terminal command. You may either import the SGML or the man page in your source tree (whatever format you prefer), and the man page can be pre-generated as for gtk-doc from the SGML if you opt for the SGML.
*** Bug 547962 has been marked as a duplicate of this bug. ***
Would be good to integrate this in a way that both the online help could use this to document the options and the man page be produced from it.
git commands call man when the output is a tty; would that work or would like regular help output?
I've used help2man in some of my projects and it's quite good. Doesn't give you Docbook sgml though, so it only solves one part of the problem.
In my experience, help2man is good to get a template man page; the proposed one might have been generated in this way. It makes x-compiling harder unless you ship the man page in the tarball, but that's perhaps not top priority either way.
Yes, of course shipping the generated man page in the tarball. I find using help2man much easier as it's mindless when updating code. Otherwise almost surely the man page falls out of date.
*** Bug 559223 has been marked as a duplicate of this bug. ***
*** Bug 576920 has been marked as a duplicate of this bug. ***
Is there any reason why we can't just use the Debian man page for gnome-terminal? I would prefer to have the man page at least shipped with the terminal rather than not at all. Given that it's been 8 years since the bug was filed, I don't think anyone would object to it being available in at least one place :)
I have started working on this bug, please await a patch in the next couple of days.
Created attachment 267196 [details] [review] Add man page Tested in JHBuild, works fine. I will notify Debian packagers that there would no need to repackage the man page along with release tarballs hereafter as it will be available within the tarball itself.
Hmm. Actually I was thinking that the manpage should be done like the manpages in e.g. glib, i.e. in xml that's processed to produce the manpage, *and* included in the devhelp (for gtk+; here that would be our yelp help) text as well.
Continued on https://gitlab.gnome.org/GNOME/gnome-terminal/-/issues/277