Browse Source

updated MAN page

git-svn-id: svn+ssh://jackaudio.org/trunk/jack@548 0c269be4-1314-0410-8aa9-9f06e86f4224
tags/0.109.0
trutkin 22 years ago
parent
commit
7bbfc5ec0f
1 changed files with 54 additions and 54 deletions
  1. +54
    -54
      jackd/jackd.1.in

+ 54
- 54
jackd/jackd.1.in View File

@@ -29,12 +29,6 @@ For the latest JACK information, please consult the web site,
<\fBhttp://jackit.sourceforge.net\fR>. <\fBhttp://jackit.sourceforge.net\fR>.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-h, \-\-help\fR
.br
Print a brief usage message describing the main \fBjackd\fR options.
These do not include driver options, which are obtained using the
\fB\-\-help\fR option for that specific driver, instead.
.TP
\fB\-a, \-\-asio\fR \fB\-a, \-\-asio\fR
.br .br
Force absolute realtime behaviour on the system. Rather than allowing Force absolute realtime behaviour on the system. Rather than allowing
@@ -46,10 +40,16 @@ configuration where there are 2 periods per buffer (see
need to enforce strict realtime limits. It can be useful for testing need to enforce strict realtime limits. It can be useful for testing
the realtime behavior of a new JACK clients. the realtime behavior of a new JACK clients.
.TP .TP
\fB\-t, \-\-timeout \fIint\fR
\fB\-d, \-\-driver \fI driver \fR [ \fI driver-options \fR ]
.br .br
Set client timeout limit in microseconds. The default is 500 msec
when not in realtime mode (see: \-R).
Select the output driver. The only \fIdriver\fR currently documented
is \fBalsa\fR (see below).
.TP
\fB\-h, \-\-help\fR
.br
Print a brief usage message describing the main \fBjackd\fR options.
These do not include driver options, which are obtained using the
\fB\-\-help\fR option for that specific driver, instead.
.TP .TP
\fB\-R, \-\-realtime\fR \fB\-R, \-\-realtime\fR
.br .br
@@ -67,54 +67,42 @@ without running as root.
When running \fB\-\-realtime\fR, set the scheduler priority to When running \fB\-\-realtime\fR, set the scheduler priority to
\fIint\fR. \fIint\fR.
.TP .TP
\fB\-D, \-\-tmpdir \fIdirectory\fR
Set the \fIdirectory\fR to use for temporary files.
\fB\-\-silent\fR
Stops any output during operation.
.TP
\fB\-t, \-\-timeout \fIint\fR
.br
Set client timeout limit in microseconds. The default is 500 msec
when not in realtime mode (see: \-R).
.TP .TP
\fB\-v, \-\-verbose\fR \fB\-v, \-\-verbose\fR
Give verbose output. Give verbose output.
.TP .TP
\fB\-V, \-\-version\fR \fB\-V, \-\-version\fR
Print the current JACK version number and exit. Print the current JACK version number and exit.
.TP
\fB\-d, \-\-driver \fI driver \fR [ \fI driver-options \fR ]
.br
Select the output driver. The only \fIdriver\fR currently documented
is \fBalsa\fR (see below).
.SS ALSA DRIVER OPTIONS .SS ALSA DRIVER OPTIONS
.TP .TP
\fB\-h, \-\-help\fR Print a brief usage message describing only the
\fBalsa\fR driver options.
\fB\-C, \-\-capture\fR [ \fIname\fR ]
Provide only capture ports. Optionally set device name.
.TP .TP
\fB\-d, \-\-device \fIname\fR \fB\-d, \-\-device \fIname\fR
.br .br
The ALSA pcm device \fIname\fR to use ("hw:0" if none specified). The ALSA pcm device \fIname\fR to use ("hw:0" if none specified).
.TP .TP
\fB\-r, \-\-rate \fIint\fR
Specify the sample rate. The default is 48000.
.TP
\fB\-p, \-\-period \fIint\fR
.br
Specify the number of frames between JACK \fBprocess()\fR calls. 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 input latency in
seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
.TP
\fB\-n, \-\-nperiods \fIint\fR
.br
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 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.
\fB\-z, --dither [rectangular,triangular,shaped,none]
Set dithering mode. If \fBnone\fR or unspecified, dithering is off.
Only the first letter of the mode name is required.
.TP .TP
\fB\-D, \-\-duplex\fR \fB\-D, \-\-duplex\fR
Provide both capture and playback ports (the default). Provide both capture and playback ports (the default).
.TP .TP
\fB\-C, \-\-capture\fR [ \fIname\fR ]
Provide only capture ports. Optionally set device name.
\fB\-h, \-\-help\fR Print a brief usage message describing only the
\fBalsa\fR driver options.
.TP .TP
\fB\-P, \-\-playback\fR [ \fIname\fR ]
Provide only playback ports. Optionally set device name.
\fB\-M, \-\-hwmeter\fR
.br
Enable hardware metering for devices that support it. Otherwise, use
software metering.
.TP .TP
\fB\-H, \-\-hwmon\fR \fB\-H, \-\-hwmon\fR
.br .br
@@ -137,33 +125,45 @@ into system memory, then copy it back out to the hardware again,
imposing the basic JACK system latency determined by the imposing the basic JACK system latency determined by the
\fB\-\-period\fR and \fB\-\-nperiods\fR options. \fB\-\-period\fR and \fB\-\-nperiods\fR options.
.TP .TP
\fB\-M, \-\-hwmeter\fR
.br
Enable hardware metering for devices that support it. Otherwise, use
software metering.
.TP
\fB\-s, \-\-softmode\fR
.br
Ignore xruns reported by the ALSA driver. This makes JACK less likely
to disconnect unresponsive ports when running without
\fB\-\-realtime\fR.
.TP
\fB\-z, --dither [rectangular,triangular,shaped,none]
Set dithering mode. If \fBnone\fR or unspecified, dithering is off.
Only the first letter of the mode name is required.
.TP
\fB\-i, \-\-inchannels \fIint\fR \fB\-i, \-\-inchannels \fIint\fR
.br .br
Number of capture channels. Default is maximum supported by hardware. Number of capture channels. Default is maximum supported by hardware.
.TP .TP
\fB\-n, \-\-nperiods \fIint\fR
.br
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 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.
.TP
\fB\-o, \-\-outchannels \fIint\fR \fB\-o, \-\-outchannels \fIint\fR
.br .br
Number of playback channels. Default is maximum supported by hardware. Number of playback channels. Default is maximum supported by hardware.
.TP .TP
\fB\-P, \-\-playback\fR [ \fIname\fR ]
Provide only playback ports. Optionally set device name.
.TP
\fB\-p, \-\-period \fIint\fR
.br
Specify the number of frames between JACK \fBprocess()\fR calls. 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 input latency in
seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
.TP
\fB\-r, \-\-rate \fIint\fR
Specify the sample rate. The default is 48000.
.TP
\fB\-S, \-\-shorts \fB\-S, \-\-shorts
.br .br
Try to configure card for 16-bit samples first, only trying 32-bits if Try to configure card for 16-bit samples first, only trying 32-bits if
unsuccessful. Default is to prefer 32-bit samples. unsuccessful. Default is to prefer 32-bit samples.
.TP
\fB\-s, \-\-softmode\fR
.br
Ignore xruns reported by the ALSA driver. This makes JACK less likely
to disconnect unresponsive ports when running without
\fB\-\-realtime\fR.
.SH EXAMPLES .SH EXAMPLES
.PP .PP
Print usage message for options specific to the \fBalsa\fR driver. Print usage message for options specific to the \fBalsa\fR driver.


Loading…
Cancel
Save