jamuluswebsite icon indicating copy to clipboard operation
jamuluswebsite copied to clipboard

Review and update the Jamulus.1 manpage documentation

Open pljones opened this issue 1 year ago • 3 comments

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.

pljones avatar Sep 21 '24 12:09 pljones

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).

gilgongo avatar Sep 21 '24 16:09 gilgongo

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

man linux/Jamulus.1

to proof read it. On your handy Linux partition.

pljones avatar Sep 21 '24 17:09 pljones

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...).

pljones avatar Sep 21 '24 17:09 pljones