summaryrefslogtreecommitdiff
path: root/jackd/jackd.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'jackd/jackd.1.in')
-rw-r--r--jackd/jackd.1.in41
1 files changed, 40 insertions, 1 deletions
diff --git a/jackd/jackd.1.in b/jackd/jackd.1.in
index 1bc7c9c..6b86210 100644
--- a/jackd/jackd.1.in
+++ b/jackd/jackd.1.in
@@ -28,7 +28,7 @@ For the latest JACK information, please consult the web site,
.br
Select the audio interface backend. The current list of supported
backends is: \fBalsa\fR, \fBcoreaudio\fR, \fBdummy\fR, \fBfreebob\fR,
-\fBoss\fR \fBsun\fR and \fBportaudio\fR. They are not all available
+\fBoss\fR \fBsun\fR \fBportaudio\fR and \fB sndio. They are not all available
on all platforms. All \fIbackend\-parameters\fR are optional.
.TP
\fB\-h, \-\-help\fR
@@ -523,6 +523,43 @@ Driver name (default: none)
.TP
\fB\-z \-\-dither\fR
Dithering mode (default: none)
+.SS SNDIO BACKEND PARAMETERS
+.TP
+\fB\-r, \-\-rate \fIint\fR
+Specify the sample rate. The default is 44100.
+.TP
+\fB\-p, \-\-period \fIint\fR
+Specify the number of frames between JACK \fBprocess()\fR calls. This
+value must be a power of 2, and the default is 1024. If you need low
+latency, set \fB\-p\fR as low as you can go without seeing xruns. A larger
+period size yields higher latency, but makes xruns less likely. The JACK
+capture latency in seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
+Note that this value is mostly advisory when aucat server is running
+and may be updated internally.
+.TP
+\fB\-n, \-\-nperiods \fIint\fR
+Specify the number of periods in the hardware buffer. The default is
+2. The period size (\fB\-p\fR) times \fB\-\-nperiods\fR times four
+(assuming 2 channels 16-bit samples) is the JACK buffer size in bytes.
+The JACK output latency in seconds is \fB\-\-nperiods\fR times
+\fB\-\-period\fR divided by \fB\-\-rate\fR.
+Note that this value is mostly advisory when aucat server is running
+and may be updated internally.
+.TP
+\fB\-w, \-\-wordlength \fIint\fR
+Specify the sample size in bits. The default is 16.
+.TP
+\fB\-i, \-\-inchannels \fIint\fR
+Specify how many channels to capture (default: 2)
+.TP
+\fB\-o, \-\-outchannels \fIint\fR
+Specify number of playback channels (default: 2)
+.TP
+\fB\-d, \-\-device \fIdevice_file\fR
+Specify device for capture and playback (default: NULL)
+.TP
+\fB\-b, \-\-ignorehwbuf \fIboolean\fR
+Specify, whether to ignore hardware period size (default: false)
.SH "EXAMPLES"
.PP
Print usage message for the parameters specific to each backend.
@@ -544,6 +581,8 @@ Print usage message for the parameters specific to each backend.
\fBjackd \-d sun \-\-help\fR
.br
\fBjackd \-d portaudio \-\-help\fR
+.br
+\fBjackd \-d sndio \-\-help\fR
.PP
Run the JACK daemon with realtime priority using the first ALSA
hardware card defined in \fB/etc/modules.conf\fR.