man page does not mention --sync / -S option but --help does - Githubissues

jackaudio / jack2

jack2 codebase

GNU General Public License v2.0

2.22k stars 376 forks source link

man page does not mention --sync / -S option but --help does #736

Open Be-ing opened 3 years ago

Be-ing commented 3 years ago

Describe the bug

The man page for jackd says:

-S, --shorts Try to configure card for 16-bit samples first, only trying 32-bits if unsuccessful. (default: 32-bit samples)

But jackd --help says:

[ --sync OR -S ]

As far as I can tell the difference between synchronous mode and asynchronous mode is not really documented anywhere except buried in a wiki page comparing JACK1 and JACK2. This is IMO concerning because it adds extra latency in contradiction to the JACK website.

Environment

JACK Version: 1.9.14
Operating System: Fedora 33
Installation: Fedora jack-audio-connection-kit package

Steps To Reproduce

$ man jackd
$ jackd --help

Expected vs. actual behavior

man jackd should document the -S option and explain the tradeoffs of using it versus not using it.

h1z1 commented 2 years ago

Several options are shared between different contexts depending on their order. The manpage lists all of them in one.

-S, --shorts is under the ALSA Backend options context not server

jackd -d alsa --help
-S, --shorts    Try 16-bit samples before 32-bit (default: false)

FWIW sync != low latency, it means synchronous. Whether that results in lower latency or not is implementation dependent.