Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review and update the Jamulus.1 manpage documentation #1043

Open
pljones opened this issue Sep 21, 2024 · 3 comments
Open

Review and update the Jamulus.1 manpage documentation #1043

pljones opened this issue Sep 21, 2024 · 3 comments

Comments

@pljones
Copy link
Contributor

pljones commented Sep 21, 2024

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
Copy link
Member

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
Copy link
Contributor Author

pljones commented Sep 21, 2024

Had a go: jamulussoftware/jamulus#3378

man linux/Jamulus.1

to proof read it. On your handy Linux partition.

@pljones
Copy link
Contributor Author

pljones commented Sep 21, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Triage
Development

No branches or pull requests

2 participants