After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 311565 - manual page
manual page
Product: gnome-terminal
Classification: Core
Component: docs
Other Linux
: Normal enhancement
: ---
Assigned To: Sindhu S
GNOME Terminal Maintainers
: 547962 559223 576920 (view as bug list)
Depends on:
Reported: 2005-07-26 09:37 UTC by Loïc Minier
Modified: 2020-06-19 18:53 UTC
See Also:
GNOME target: ---
GNOME version: ---

Debian manual page for gnome-terminal in SGML format (8.08 KB, text/plain)
2005-07-26 09:37 UTC, Loïc Minier
Add man page (4.73 KB, patch)
2014-01-25 19:28 UTC, Sindhu S
none Details | Review

Description Loïc Minier 2005-07-26 09:37:06 UTC

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.

Comment 1 Loïc Minier 2005-07-26 09:37:47 UTC
Created attachment 49761 [details]
Debian manual page for gnome-terminal in SGML format
Comment 2 Don Scorgie 2006-08-06 17:22:24 UTC
Moving to default Docs assignee.  Sorry for the spam
Comment 3 Joachim Noreiko 2006-08-26 16:34:13 UTC
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?
Comment 4 Loïc Minier 2006-08-27 16:20:42 UTC
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.
Comment 5 Christian Persch 2008-08-19 12:46:18 UTC
*** Bug 547962 has been marked as a duplicate of this bug. ***
Comment 6 Christian Persch 2008-10-24 10:16:45 UTC
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.
Comment 7 Loïc Minier 2008-10-24 10:42:59 UTC
git commands call man when the output is a tty; would that work or would like regular help output?
Comment 8 Behdad Esfahbod 2008-10-24 10:52:15 UTC
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.
Comment 9 Loïc Minier 2008-10-24 11:04:24 UTC
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.
Comment 10 Behdad Esfahbod 2008-10-24 11:35:41 UTC
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.
Comment 11 Behdad Esfahbod 2008-11-04 06:18:16 UTC
*** Bug 559223 has been marked as a duplicate of this bug. ***
Comment 12 Christian Persch 2009-04-12 10:41:52 UTC
*** Bug 576920 has been marked as a duplicate of this bug. ***
Comment 13 Kat 2013-10-26 10:59:15 UTC
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 :)
Comment 14 Sindhu S 2014-01-24 16:09:28 UTC
I have started working on this bug, please await a patch in the next couple of days.
Comment 15 Sindhu S 2014-01-25 19:28:16 UTC
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.
Comment 16 Christian Persch 2014-02-21 19:38:58 UTC
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.
Comment 17 Christian Persch 2020-06-19 18:53:08 UTC
Continued on