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
16 stars 80 forks source link

Review and update the Jamulus.1 manpage documentation #1043

Open pljones opened 1 day ago

pljones commented 1 day ago

I don't think we have a step in the release process to ensure the Jamulus.1 manual page documentation is up to date.

That could probably do with adding.

Ideally, we'd also have translated version of the Jamulus.1 manpage available to install, too.

There should be a lot of overlap between the manpage and the website and wiki. They should be kept aligned. The manpage needs reviewing because I think it's likely been left adrift and could do with an update.

gilgongo commented 1 day ago

Last time I tried to edit the man page, I found it pretty hard not to break it.

Might it be possible to maintain a familiar markdown document and convert that to groff? https://kramdown.gettalong.org/converter/man.html (not clear how we'd actually implement it as part of the workflow though but that's just my lack of GH understanding).

pljones commented 1 day ago

Had a go: https://github.com/jamulussoftware/jamulus/pull/3378

man linux/Jamulus.1

to proof read it. On your handy Linux partition.

pljones commented 1 day ago

Not that it's much benefit in the long run.

I had, as part of my rewrite of parsing the command line options, added a feature that supported documenting each option clearly and also generating HTML and manpage output for the options as well, to make maintenance trivial.

I might see if I can break that part out of the massive change (it got messed up trying to be too much, including tying each option to a stored config item...).