GNOME Bugzilla – Bug 713879
Create a man page for Geary
Last modified: 2019-01-15 06:42:27 UTC
---- Reported by geary-maint@gnome.bugs 2013-10-10 11:16:00 -0700 ---- Original Redmine bug id: 7621 Original URL: http://redmine.yorba.org/issues/7621 Searchable id: yorba-bug-7621 Original author: Thomas Moschny Original description: According to some distributions' policy, all programs need a man page, so could you please create one for Geary? ---- Additional Comments From geary-maint@gnome.bugs 2013-10-10 19:40:00 -0700 ---- ### History #### #1 Updated by Jim Nelson about 1 month ago * **Category** set to _documentation_ * **Target version** set to _0.5.0_ Yes, something we should've done a long time ago. --- Bug imported by chaz@yorba.org 2013-11-21 20:24 UTC --- This bug was previously known as _bug_ 7621 at http://redmine.yorba.org/show_bug.cgi?id=7621 Unknown milestone "unknown in product geary. Setting to default milestone for this product, "---". Setting qa contact to the default for this product. This bug either had no qa contact or an invalid one. Resolution set on an open status. Dropping resolution
Attaching man page donated on mailing list: https://mail.gnome.org/archives/geary-list/2014-July/msg00014.html
Created attachment 281736 [details] Man page
Is there anything else to be done to get this patch accepted? The man page currently used in Debian is very basic and doesn't list any command line option, which is very useful to remember how to provide good logs for bug reports.
Ok, just seen the comment of Jim on the mailing list: "This is certainly helpful, but what we really need is for the CMake file(s) to be updated to install this and update associated caches (i.e. apropos). Bonus points would include setting this up for translation as well, but that could be done later."
is there an howto to implement this?
What probably needs to happen here is the following: - Add the man page to an appropriate place in geary's source tree - probably as desktop/geary.1 - Add some rules to the CMake file in that directory (i.e. desktop/CMakeLists.txt) to do the following: - At built time, compile the man page (if needed) - At install time, copy the file or the compiled file to the appropriate path (something like $PREFIX/share/man/man1) and ideally look for an execute any programs needed to update apropos/man cache dbs. As Jim said, bonus points for also hooking it up to get translated, and installing the translations. Further bonus points for updating the deb packagaing config the the source tree to do Debian/Ubuntu specific things with it. As a start, I'd web search for something like "CMake install man page".
Mike, I think you can close it in favour of: https://gitlab.gnome.org/GNOME/geary/issues/87
You're right, cheers!