search

jamulussoftware / jamuluswebsite

This is the GitHub Pages repository for the Jamulus main website. For the jamulus application source code, please visit jamulussoftware/jamulus.
https://jamulus.io
GNU Lesser General Public License v2.1
15 stars 82 forks source link

Add a man page #321

Closed ycollet closed 3 years ago

ycollet commented 4 years ago

A man page is always a good thing to have :)

gilgongo commented 4 years ago

Bearing in mind only about 5% of downloads are Linux though :-)

ycollet commented 4 years ago

Argh .... :)

gilgongo commented 4 years ago

No problem doing it if we can find some easy way of keeping it up to date from other sources. Right now though, the bulk of the docs are on GH wiki and they get tweaked quite a bit at the moment. We'd also like to localise the docs at some point too (does man have an i18n feature? Never thought about that...!)

trebmuh commented 4 years ago

jamulus.1 will be the EN man page jamulus.fr.1 will be the FR man page ...etc

gilgongo commented 4 years ago

OK - but I think the main challenge would be maintaining them over time.

WolfganP commented 4 years ago

I would add a simple description of what the program does and point to an URL with all the docs.

trebmuh commented 4 years ago

There is certainly a way to auto-generate it from jamulus -h which is much better than an URL alone (how about someone using an old version of jamulus, but reading a new version of the doc on the internet? how about someone setting up an intranet without access to the internet?). That said a "for more info, please visit URL" can be added somewhere in the manpage (at the end).

pljones commented 4 years ago

Ideally, the source code and translation strings that already exist could be used to generate the man pages.

There's also the signal handling I'd expect to be covered in the man page.

gilgongo commented 3 years ago

If anyone wants to pick this up that would be great, but the issue is ongoing maintenance and translation.

Meanwhile, moving to the website repo which is where all that gets done.

ann0see commented 3 years ago

Closing this due to inactivity