On Sat, 24 Oct 2020 at 14:41, Julius Smith <[email protected]> wrote:
>
> help2man does a surprisingly good job!  We can use that output as a starting 
> point, or fiddle with the help output until it seems perfect (my first 
> choice, following the "Don't Repeat Yourself" dictum).

Yes, it does, and it's a good starting point, but typically a good
manual page goes beyond the command-line help. See, e.g., 'awk --help'
vs. 'man awk'.

> Jacktrip supports Linux, Mac, and Windows.  Do you know of any example FOSS 
> projects that install a man page optimally for all three?  Thanks for any 
> pointers.

AFAIK, Mac has /usr/share/man. I don't know about Windows.

> I've attached the latest generated man page so you can consider if it's worth 
> waiting for (I would vote yes).
> The only missing items right now are the new jitter-buffer-related options 
> (pull request expected as soon as this weekend).
> Everything can of course be followed on GitHub: 
> https://github.com/jacktrip/jacktrip

We'll wait for the next release, no problem. Thanks for considering this.

-- 
Iñaki Úcar
_______________________________________________
music mailing list -- [email protected]
To unsubscribe send an email to [email protected]
Fedora Code of Conduct: 
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: 
https://lists.fedoraproject.org/archives/list/[email protected]

Reply via email to