The DnD Sanctuary

Pings => Otter Browser Forum => Topic started by: martinkg on 2014-08-28, 13:06:03

Title: manpage for otter-browser (#518)
Post by: martinkg on 2014-08-28, 13:06:03
Hi,
could you please add the manpage file for otter-browser ?
"otter-browser" "1" "05. Feb. 2014" "man page by Malcolm J Lewis"

you can download the file from:
https://www.dropbox.com/s/nx20w2odspi795h/otter-browser.1?dl=0

Mod edit: also see https://github.com/Emdek/otter/issues/518
Title: Re: manpage for otter-browser
Post by: ersi on 2014-08-28, 13:31:50
So it repeats the contents of otter-browser --help?

I actually think that all Linux apps should, as a minimum, repeat the --help contents as man page, even though a more elaborate man page would always be cooler. I hope it gets integrated in the next release :)
Title: Re: manpage for otter-browser
Post by: Emdek on 2014-08-31, 17:37:51
@ersi, yeah, it surely needs more contents.
Title: Re: manpage for otter-browser
Post by: Frenzie on 2015-01-04, 12:23:18
Note the existence of a tool called help2man, which automates the creation of this kind of man page.

A man page is a required component for Debian packaging, so this is one of the last major obstacles. One possible DRY-style solution could be to edit the man page on the Otter wiki, and to then automatically convert it to a man page using Pandoc. This could also be used to generate an HTML help file for use within the program.
Title: Re: manpage for otter-browser (#518)
Post by: Emdek on 2015-01-04, 15:22:56
@Frenzie, I would prefer to keep CMakeLists.txt clean, and man files don't change often enough to justify direct use of external commands to automate this. ;-)
It seems that there is variable for setting man directory after all, CMAKE_INSTALL_MANDIR.
I'll run some tests later.
Title: Re: manpage for otter-browser (#518)
Post by: Frenzie on 2015-01-04, 17:20:27
Sounds good. :)