jack1 codebase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

683 lines
24KB

  1. .TH "JACKD" "1" "@VERSION@" "April 2006" ""
  2. .SH "NAME"
  3. jackd \- JACK Audio Connection Kit sound server
  4. .SH "SYNOPSIS"
  5. \fBjackd\fR [\fIoptions\fR] \fB\-d\fI backend \fR
  6. [\fIbackend\-parameters\fR]
  7. .br
  8. \fBjackd \-\-help\fR
  9. .SH "DESCRIPTION"
  10. \fBjackd\fR is the JACK audio server daemon, a low\-latency audio
  11. server. Originally written for the
  12. GNU/Linux operating system, it also supports Mac OS X and various Unix
  13. platforms. JACK can connect a number of different client applications
  14. to an audio device and also to each other. Most clients are external,
  15. running in their own processes as normal applications. JACK also
  16. supports internal clients, which run within the \fBjackd\fR process
  17. using a loadable "plugin" interface.
  18. JACK differs from other audio servers in being designed from the
  19. ground up for professional audio work. It focuses on two key areas:
  20. synchronous execution of all clients, and low latency operation.
  21. For the latest JACK information, please consult the web site,
  22. <\fBhttp://www.jackaudio.org\fR>.
  23. .SH "OPTIONS"
  24. .TP
  25. \fB\-d, \-\-driver \fIbackend\fR [\fIbackend\-parameters\fR ]
  26. .br
  27. Select the audio interface backend. The current list of supported
  28. backends is: \fBalsa\fR, \fBcoreaudio\fR, \fBdummy\fR, \fBfreebob\fR,
  29. \fBoss\fR \fBsun\fR \fBportaudio\fR and \fB sndio. They are not all available
  30. on all platforms. All \fIbackend\-parameters\fR are optional.
  31. .TP
  32. \fB\-h, \-\-help\fR
  33. .br
  34. Print a brief usage message describing the main \fBjackd\fR options.
  35. These do not include \fIbackend\-parameters\fR, which are listed using
  36. the \fB\-\-help\fR option for each specific backend. Examples below
  37. show how to list them.
  38. .TP
  39. \fB\-m, \-\-no\-mlock\fR
  40. Do not attempt to lock memory, even if \fB\-\-realtime\fR.
  41. .TP
  42. \fB\-A \fIdevice\fR, \fB\-A \fIdevice%p\fR, \fB\-A \fIdevice%c\fR
  43. .br
  44. (Linux-only) A simplified way to add additional audio I/O hardware to an instance
  45. of JACK. This argument is actually just a wrapper around the -I
  46. (internal client) version, requiring only the name of the ALSA "card"
  47. to be used. The name should \fBNOT\fR include any ALSA device access
  48. prefix (e.g. "hw:" or "plughw:") but can include a
  49. subdevice. If %p is added to the device name, it will be made
  50. available for playback only. If %c is added to the device name, it
  51. will be made available for capture (recording) only. If neither %p nor
  52. %c is added, it will be made available (if possible) for both capture
  53. and playback. Although device names may be visible in various places
  54. on your system, the file /proc/asound/cards shows them inside square
  55. braces.
  56. .br
  57. Examples:
  58. .br
  59. -A SB (adds playback and capture for the "SB" device)
  60. .br
  61. -A Codec,1%c (adds capture (recording) for the 2nd subdevice of the "Codec" device)
  62. .br
  63. -A MT1a2%p (adds playback the 1st subdevice of the "MT1a2" device)
  64. .br
  65. The use of -A CARD is actually equivalent to -I foo:zalsa_in/-dhw:CARD
  66. \fIand\fR -I CARD:zalsa_out/-dhw:CARD.
  67. .br
  68. The use of -A CARD%p is actually equivalent to -I CARD:zalsa_out/-dhw:CARD.
  69. .br
  70. The use of -A CARD%c is actually equivalent to -I CARD:zalsa_in/-dhw:CARD
  71. .br
  72. .br
  73. Note that this option (like -I) can be used regardless of the backend
  74. used, so even if you do not use the ALSA backend, you can still add
  75. ALSA-supported devices to an instance of JACK.
  76. .TP
  77. \fB\-I, \-\-internal-client \fIclient-spec\fR
  78. .br
  79. Load \fIclient-name\fR as an internal client. May be used multiple
  80. times. The form of \fIclient-spec\fR can be any of the following:
  81. .br
  82. client-path
  83. .br
  84. client-name:client-path
  85. .br
  86. client-name:client-path/init-string
  87. .br
  88. client-path/init-string
  89. .br
  90. The first form will cause jackd to attempt to load the client from a
  91. shared object named "client-path" with appropriate suffixes
  92. appended. If "client-path" is absolute, jackd will use that (adding
  93. a platform appropriate suffix for a shared object). If it is not
  94. absolute, jackd will look for "client-path" (with an appropriate
  95. suffix) in the same location that drivers and other JACK add-ons are
  96. located.
  97. .br
  98. The second form provides "client-name" as the desired name for the
  99. client once loaded, in addition to the "client-path".
  100. .br
  101. The third form provides an "init-string" in addition to a client name
  102. and path, which will be passed to the client's initialization
  103. function.
  104. .br
  105. The final form does not specify the client name, but does include
  106. the path to the client's shared object file and an initializations
  107. string.
  108. .br
  109. When invoking JACK from the shell, remember to quote the argument to
  110. -I if it includes spaces.
  111. .TP
  112. \fB\-M, \-\-midi\-bufsize\fR [ \fIevent-count\fR ]
  113. Specify the size of the buffer used for MIDI ports. Units are "MIDI
  114. events per process() cycle", where an event occupies up to 4 bytes (as most common MIDI events
  115. do). The default buffer size is 2048 bytes, which is about 500 MIDI events.
  116. Typical values for \fIevent-count\fR will range from 10 to about
  117. 1000. Be aware that using very high values along with a large number of
  118. ports may cause JACK to fail to start because of the amount of memory
  119. that would be required.
  120. .TP
  121. \fB\-n, \-\-name\fR \fIserver\-name\fR
  122. Name this \fBjackd\fR instance \fIserver\-name\fR. If unspecified,
  123. this name comes from the \fB$JACK_DEFAULT_SERVER\fR environment
  124. variable. It will be "default" if that is not defined.
  125. .TP
  126. \fB\-p, \-\-port\-max \fI n\fR
  127. Set the maximum number of ports the JACK server can manage.
  128. The default value is 256.
  129. .TP
  130. \fB\-\-replace-registry\fR
  131. .br
  132. Remove the shared memory registry used by all JACK server instances
  133. before startup. This should rarely be used, and is intended only
  134. for occasions when the structure of this registry changes in ways
  135. that are incompatible across JACK versions (which is rare).
  136. .TP
  137. \fB\-R, \-\-realtime\fR
  138. .br
  139. Use realtime scheduling (default = true). This is needed for reliable low\-latency
  140. performance. On many systems, it requires \fBjackd\fR to run with
  141. special scheduler and memory allocation privileges, which may be
  142. obtained in several ways.
  143. .TP
  144. \fB\-r, \-\-no-realtime\fR
  145. .br
  146. Do not use realtime scheduling.
  147. .TP
  148. \fB\-P, \-\-realtime\-priority \fIint\fR
  149. When running \fB\-\-realtime\fR, set the scheduler priority to
  150. \fIint\fR.
  151. .TP
  152. \fB\-\-silent\fR
  153. Silence any output during operation.
  154. .TP
  155. \fB\-S, \-\-sync\fR
  156. .br
  157. This option does nothing in this implementation of JACK, but exists
  158. for command-line compatibility with JACK2 and possibly other versions.
  159. .TP
  160. \fB\-T, \-\-temporary\fR
  161. Exit once all clients have closed their connections.
  162. .TP
  163. \fB\-t, \-\-timeout \fIint\fR
  164. .br
  165. Set client timeout limit in milliseconds. The default is 500 msec.
  166. .TP
  167. \fB\-X, \-\-slave-driver\fR \fIdriver-name\fR
  168. .br
  169. Asks the server to load the "slave" driver given by
  170. \fIdriver-name\fR. Slave drivers can provide builtin-access to other
  171. devices and protocols; the primary slave-driver at this time is the
  172. "alsa_midi" one which provides bridging on Linux between native ALSA
  173. MIDI and JACK MIDI.
  174. .TP
  175. \fB\-Z, \-\-nozombies\fR
  176. .br
  177. Prevent JACK from ever kicking out clients because they were too slow.
  178. This cancels the effect any specified timeout value.
  179. .TP
  180. \fB\-C, \-\-timeout-thres \fItime\fR
  181. .br
  182. Stop processing clients if JACK cannot complete the process cycle in time (typically caused by CPU overloading or misbehaved clients). The optional \fItime\fR
  183. argument specifies the number of miliseconds, during which consectutive process cycles must fail before JACK gives up (if the argument is not given, it defaults to 250). Processing will resume on the next change to the port
  184. graph (i.e. a port is added, removed, connected or disconnected)
  185. .TP
  186. \fB\-u, \-\-unlock\fR
  187. .br
  188. Unlock libraries GTK+, QT, FLTK, Wine.
  189. .TP
  190. \fB\-v, \-\-verbose\fR
  191. Give verbose output.
  192. .TP
  193. \fB\-c, \-\-clocksource\fR (\fI h(pet) \fR | \fI s(ystem) \fR)
  194. Select a specific wall clock (HPET timer or the system clock). Asking for
  195. the now removed cycle-counter timer usiung \fI-c c\fR will result in
  196. the use of the system clock.
  197. .TP
  198. \fB\-V, \-\-version\fR
  199. Print the current JACK version number and exit.
  200. .SS ALSA BACKEND OPTIONS
  201. .TP
  202. \fB\-C, \-\-capture\fR [ \fIname\fR ]
  203. Provide only capture ports, unless combined with \-D or \-P. Parameterally set
  204. capture device name.
  205. .TP
  206. \fB\-d, \-\-device \fIname\fR
  207. .br
  208. The ALSA pcm device \fIname\fR to use. If none is specified, JACK will
  209. use "hw:0", the first hardware card defined in \fB/etc/modules.conf\fR.
  210. .TP
  211. \fB\-z, \-\-dither [rectangular,triangular,shaped,none]
  212. Set dithering mode. If \fBnone\fR or unspecified, dithering is off.
  213. Only the first letter of the mode name is required.
  214. .TP
  215. \fB\-D, \-\-duplex\fR
  216. Provide both capture and playback ports. Defaults to on unless only one
  217. of \-P or \-C is specified.
  218. .TP
  219. \fB\-h, \-\-help\fR Print a brief usage message describing only the
  220. \fBalsa\fR backend parameters.
  221. .TP
  222. \fB\-M, \-\-hwmeter\fR
  223. .br
  224. Enable hardware metering for devices that support it. Otherwise, use
  225. software metering.
  226. .TP
  227. \fB\-H, \-\-hwmon\fR
  228. .br
  229. Enable hardware monitoring of capture ports. This is a method for
  230. obtaining "zero latency" monitoring of audio input. It requires
  231. support in hardware and from the underlying ALSA device driver.
  232. When enabled, requests to monitor capture ports will be satisfied by
  233. creating a direct signal path between audio interface input and output
  234. connectors, with no processing by the host computer at all. This
  235. offers the lowest possible latency for the monitored signal.
  236. Presently (March 2003), only the RME Hammerfall series and cards based
  237. on the ICE1712 chipset (M\-Audio Delta series, Terratec, and others)
  238. support \fB\-\-hwmon\fR. In the future, some consumer cards may also
  239. be supported by modifying their mixer settings.
  240. Without \fB\-\-hwmon\fR, port monitoring requires JACK to read audio
  241. into system memory, then copy it back out to the hardware again,
  242. imposing the basic JACK system latency determined by the
  243. \fB\-\-period\fR and \fB\-\-nperiods\fR parameters.
  244. .TP
  245. \fB\-i, \-\-inchannels \fIint\fR
  246. .br
  247. Number of capture channels. Default is maximum supported by hardware.
  248. .TP
  249. \fB\-n, \-\-nperiods \fIint\fR
  250. .br
  251. Specify the number of periods of playback latency. In seconds, this
  252. corresponds to \fB\-\-nperiods\fR times \fB\-\-period\fR divided by
  253. \fB\-\-rate\fR. The default is 2, the minimum allowable. For most
  254. devices, there is no need for any other value with the
  255. \fB\-\-realtime\fR option. Without realtime privileges or with boards
  256. providing unreliable interrupts (like ymfpci), a larger value may
  257. yield fewer xruns. This can also help if the system is not tuned for
  258. reliable realtime scheduling.
  259. For most ALSA devices, the hardware buffer has exactly
  260. \fB\-\-period\fR times \fB\-\-nperiods\fR frames. Some devices demand
  261. a larger buffer. If so, JACK will use the smallest possible buffer
  262. containing at least \fB\-\-nperiods\fR, but the playback latency does
  263. not increase.
  264. For USB audio devices it is recommended to use \fB\-n 3\fR. Firewire
  265. devices supported by FFADO (formerly Freebob) are configured with
  266. \fB\-n 3\fR by default.
  267. .TP
  268. \fB\-o, \-\-outchannels \fIint\fR
  269. .br
  270. Number of playback channels. Default is maximum supported by hardware.
  271. .TP
  272. \fB\-P, \-\-playback\fR [ \fIname\fR ]
  273. Provide only playback ports, unless combined with \-D or \-C. Optionally set
  274. playback device name.
  275. .TP
  276. \fB\-p, \-\-period \fIint\fR
  277. .br
  278. Specify the number of frames between JACK \fBprocess()\fR calls. This
  279. value must be a power of 2, and the default is 1024. If you need low
  280. latency, set \fB\-p\fR as low as you can go without seeing xruns. A larger
  281. period size yields higher latency, but makes xruns less likely. The JACK
  282. capture latency in seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
  283. .TP
  284. \fB\-r, \-\-rate \fIint\fR
  285. Specify the sample rate. The default is 48000.
  286. .TP
  287. \fB\-S, \-\-shorts
  288. .br
  289. Try to configure card for 16\-bit samples first, only trying 32\-bits if
  290. unsuccessful. Default is to prefer 32\-bit samples.
  291. .TP
  292. \fB\-s, \-\-softmode\fR
  293. .br
  294. Ignore xruns reported by the ALSA driver. This makes JACK less likely
  295. to disconnect unresponsive ports when running without \fB\-\-realtime\fR.
  296. .TP
  297. \fB\-X, \-\-midi seq
  298. .br
  299. Provide bridging between ALSA MIDI and JACK MIDI (using the ALSA
  300. sequencer system). All ALSA MIDI clients and MIDI hardware that exist
  301. when jackd starts will be represented by JACK MIDI ports.
  302. .br
  303. The "seq" argument has been retained from older versions of JACK, in
  304. part to provide for the possibility of alternate implementations.
  305. .SS COREAUDIO BACKEND PARAMETERS
  306. .TP
  307. \fB\-c \-\-channel\fR
  308. Maximum number of channels (default: 2)
  309. .TP
  310. \fB\-i \-\-channelin\fR
  311. Maximum number of input channels (default: 2)
  312. .TP
  313. \fB\-o \-\-channelout\fR
  314. Maximum number of output channels (default: 2)
  315. .TP
  316. \fB\-C \-\-capture\fR
  317. Whether or not to capture (default: true)
  318. .TP
  319. \fB\-P \-\-playback\fR
  320. Whether or not to playback (default: true)
  321. .TP
  322. \fB\-D \-\-duplex\fR
  323. Capture and playback (default: true)
  324. .TP
  325. \fB\-r \-\-rate\fR
  326. Sample rate (default: 44100)
  327. .TP
  328. \fB\-p \-\-period\fR
  329. Frames per period (default: 128). Must be a power of 2.
  330. .TP
  331. \fB\-n \-\-name\fR
  332. Driver name (default: none)
  333. .TP
  334. \fB\-I \-\-id\fR
  335. Audio Device ID (default: 0)
  336. .SS DUMMY BACKEND PARAMETERS
  337. .TP
  338. \fB\-C, \-\-capture \fIint\fR
  339. Specify number of capture ports. The default value is 2.
  340. .TP
  341. \fB\-P, \-\-playback \fIint\fR
  342. Specify number of playback ports. The default value is 2.
  343. .TP
  344. \fB\-r, \-\-rate \fIint\fR
  345. Specify sample rate. The default value is 48000.
  346. .TP
  347. \fB\-p, \-\-period \fIint\fR
  348. Specify the number of frames between JACK \fBprocess()\fR calls. This
  349. value must be a power of 2, and the default is 1024. If you need low
  350. latency, set \fB\-p\fR as low as you can go without seeing xruns. A larger
  351. period size yields higher latency, but makes xruns less likely. The JACK
  352. capture latency in seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
  353. .TP
  354. \fB\-w, \-\-wait \fIint\fR
  355. Specify number of usecs to wait between engine processes.
  356. The default value is 21333.
  357. .SS NET BACKEND PARAMETERS
  358. .TP
  359. \fB\-i, \-\-audio\-ins \fIint\fR
  360. Number of capture channels (default: 2)
  361. .TP
  362. \fB\-o, \-\-audio\-outs \fIint\fR
  363. Number of playback channels (default: 2)
  364. .TP
  365. \fB\-I, \-\-midi\-ins \fIint\fR
  366. Number of midi capture channels (default: 1)
  367. .TP
  368. \fB\-O, \-\-midi\-outs \fIint\fR
  369. Number of midi playback channels (default: 1)
  370. .TP
  371. \fB\-r, \-\-rate \fIint\fR
  372. Sample rate (default: 48000)
  373. .TP
  374. \fB\-p, \-\-period \fIint\fR
  375. Frames per period (default: 1024)
  376. .TP
  377. \fB\-n, \-\-num\-periods \fIint\fR
  378. Network latency setting in no. of periods (default: 5)
  379. .TP
  380. \fB\-l, \-\-listen\-port \fIint\fR
  381. The socket port we are listening on for sync packets (default: 3000)
  382. .TP
  383. \fB\-f, \-\-factor \fIint\fR
  384. Factor for sample rate reduction (default: 1)
  385. .TP
  386. \fB\-u, \-\-upstream\-factor \fIint\fR
  387. Factor for sample rate reduction on the upstream (default: 0)
  388. .TP
  389. \fB\-c, \-\-celt \fIint\fR
  390. sets celt encoding and number of kbits per channel (default: 0)
  391. .TP
  392. \fB\-b, \-\-bit\-depth \fIint\fR
  393. Sample bit\-depth (0 for float, 8 for 8bit and 16 for 16bit) (default: 0)
  394. .TP
  395. \fB\-t, \-\-transport\-sync \fIint\fR
  396. Whether to slave the transport to the master transport (default: true)
  397. .TP
  398. \fB\-a, \-\-autoconf \fIint\fR
  399. Whether to use Autoconfig, or just start. (default: true)
  400. .TP
  401. \fB\-R, \-\-redundancy \fIint\fR
  402. Send packets N times (default: 1)
  403. .TP
  404. \fB\-e, \-\-native\-endian \fIint\fR
  405. Dont convert samples to network byte order. (default: false)
  406. .TP
  407. \fB\-J, \-\-jitterval \fIint\fR
  408. attempted jitterbuffer microseconds on master (default: 0)
  409. .TP
  410. \fB\-D, \-\-always\-deadline \fIint\fR
  411. always use deadline (default: false)
  412. .SS OSS BACKEND PARAMETERS
  413. .TP
  414. \fB\-r, \-\-rate \fIint\fR
  415. Specify the sample rate. The default is 48000.
  416. .TP
  417. \fB\-p, \-\-period \fIint\fR
  418. Specify the number of frames between JACK \fBprocess()\fR calls. This
  419. value must be a power of 2, and the default is 1024. If you need low
  420. latency, set \fB\-p\fR as low as you can go without seeing xruns. A larger
  421. period size yields higher latency, but makes xruns less likely. The JACK
  422. capture latency in seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
  423. .TP
  424. \fB\-n, \-\-nperiods \fIint\fR
  425. Specify the number of periods in the hardware buffer. The default is
  426. 2. The period size (\fB\-p\fR) times \fB\-\-nperiods\fR times four is
  427. the JACK buffer size in bytes. The JACK output latency in seconds is
  428. \fB\-\-nperiods\fR times \fB\-\-period\fR divided by \fB\-\-rate\fR.
  429. .TP
  430. \fB\-w, \-\-wordlength \fIint\fR
  431. Specify the sample size in bits. The default is 16.
  432. .TP
  433. \fB\-i, \-\-inchannels \fIint\fR
  434. Specify how many channels to capture (default: 2)
  435. .TP
  436. \fB\-o, \-\-outchannels \fIint\fR
  437. Specify number of playback channels (default: 2)
  438. .TP
  439. \fB\-C, \-\-capture \fIdevice_file\fR
  440. Specify input device for capture (default: /dev/dsp)
  441. .TP
  442. \fB\-P, \-\-playback \fIdevice_file\fR
  443. Specify output device for playback (default: /dev/dsp)
  444. .TP
  445. \fB\-b, \-\-ignorehwbuf \fIboolean\fR
  446. Specify, whether to ignore hardware period size (default: false)
  447. .SS SUN BACKEND PARAMETERS
  448. .TP
  449. \fB\-r, \-\-rate \fIint\fR
  450. Specify the sample rate. The default is 48000.
  451. .TP
  452. \fB\-p, \-\-period \fIint\fR
  453. Specify the number of frames between JACK \fBprocess()\fR calls. This
  454. value must be a power of 2, and the default is 1024. If you need low
  455. latency, set \fB\-p\fR as low as you can go without seeing xruns. A larger
  456. period size yields higher latency, but makes xruns less likely. The JACK
  457. capture latency in seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
  458. .TP
  459. \fB\-n, \-\-nperiods \fIint\fR
  460. Specify the number of periods in the hardware buffer. The default is
  461. 2. The period size (\fB\-p\fR) times \fB\-\-nperiods\fR times four
  462. (assuming 2 channels 16-bit samples) is the JACK buffer size in bytes.
  463. The JACK output latency in seconds is \fB\-\-nperiods\fR times
  464. \fB\-\-period\fR divided by \fB\-\-rate\fR.
  465. .TP
  466. \fB\-w, \-\-wordlength \fIint\fR
  467. Specify the sample size in bits. The default is 16.
  468. .TP
  469. \fB\-i, \-\-inchannels \fIint\fR
  470. Specify how many channels to capture (default: 2)
  471. .TP
  472. \fB\-o, \-\-outchannels \fIint\fR
  473. Specify number of playback channels (default: 2)
  474. .TP
  475. \fB\-C, \-\-capture \fIdevice_file\fR
  476. Specify input device for capture (default: /dev/audio)
  477. .TP
  478. \fB\-P, \-\-playback \fIdevice_file\fR
  479. Specify output device for playback (default: /dev/audio)
  480. .TP
  481. \fB\-b, \-\-ignorehwbuf \fIboolean\fR
  482. Specify, whether to ignore hardware period size (default: false)
  483. .SS PORTAUDIO BACKEND PARAMETERS
  484. .TP
  485. \fB\-c \-\-channel\fR
  486. Maximum number of channels (default: all available hardware channels)
  487. .TP
  488. \fB\-i \-\-channelin\fR
  489. Maximum number of input channels (default: all available hardware channels)
  490. .TP
  491. \fB\-o \-\-channelout\fR
  492. Maximum number of output channels (default: all available hardware channels)
  493. .TP
  494. \fB\-C \-\-capture\fR
  495. Whether or not to capture (default: true)
  496. .TP
  497. \fB\-P \-\-playback\fR
  498. Whether or not to playback (default: true)
  499. .TP
  500. \fB\-D \-\-duplex\fR
  501. Capture and playback (default: true)
  502. .TP
  503. \fB\-r \-\-rate\fR
  504. Sample rate (default: 48000)
  505. .TP
  506. \fB\-p \-\-period\fR
  507. Frames per period (default: 1024). Must be a power of 2.
  508. .TP
  509. \fB\-n \-\-name\fR
  510. Driver name (default: none)
  511. .TP
  512. \fB\-z \-\-dither\fR
  513. Dithering mode (default: none)
  514. .SS SNDIO BACKEND PARAMETERS
  515. .TP
  516. \fB\-r, \-\-rate \fIint\fR
  517. Specify the sample rate. The default is 44100.
  518. .TP
  519. \fB\-p, \-\-period \fIint\fR
  520. Specify the number of frames between JACK \fBprocess()\fR calls. This
  521. value must be a power of 2, and the default is 1024. If you need low
  522. latency, set \fB\-p\fR as low as you can go without seeing xruns. A larger
  523. period size yields higher latency, but makes xruns less likely. The JACK
  524. capture latency in seconds is \fB\-\-period\fR divided by \fB\-\-rate\fR.
  525. Note that this value is mostly advisory when aucat server is running
  526. and may be updated internally.
  527. .TP
  528. \fB\-n, \-\-nperiods \fIint\fR
  529. Specify the number of periods in the hardware buffer. The default is
  530. 2. The period size (\fB\-p\fR) times \fB\-\-nperiods\fR times four
  531. (assuming 2 channels 16-bit samples) is the JACK buffer size in bytes.
  532. The JACK output latency in seconds is \fB\-\-nperiods\fR times
  533. \fB\-\-period\fR divided by \fB\-\-rate\fR.
  534. Note that this value is mostly advisory when aucat server is running
  535. and may be updated internally.
  536. .TP
  537. \fB\-w, \-\-wordlength \fIint\fR
  538. Specify the sample size in bits. The default is 16.
  539. .TP
  540. \fB\-i, \-\-inchannels \fIint\fR
  541. Specify how many channels to capture (default: 2)
  542. .TP
  543. \fB\-o, \-\-outchannels \fIint\fR
  544. Specify number of playback channels (default: 2)
  545. .TP
  546. \fB\-d, \-\-device \fIdevice_file\fR
  547. Specify device for capture and playback (default: NULL)
  548. .TP
  549. \fB\-b, \-\-ignorehwbuf \fIboolean\fR
  550. Specify, whether to ignore hardware period size (default: false)
  551. .SH "EXAMPLES"
  552. .PP
  553. Print usage message for the parameters specific to each backend.
  554. .IP
  555. \fBjackd \-d alsa \-\-help\fR
  556. .br
  557. \fBjackd \-d coreaudio \-\-help\fR
  558. .br
  559. \fBjackd \-d net \-\-help\fR
  560. .br
  561. \fBjackd \-d dummy \-\-help\fR
  562. .br
  563. \fBjackd \-d firewire \-\-help\fR
  564. .br
  565. \fBjackd \-d freebob \-\-help\fR
  566. .br
  567. \fBjackd \-d oss \-\-help\fR
  568. .br
  569. \fBjackd \-d sun \-\-help\fR
  570. .br
  571. \fBjackd \-d portaudio \-\-help\fR
  572. .br
  573. \fBjackd \-d sndio \-\-help\fR
  574. .PP
  575. Run the JACK daemon with realtime priority using the first ALSA
  576. hardware card defined in \fB/etc/modules.conf\fR.
  577. .IP
  578. \fBjackstart \-\-realtime \-\-driver=alsa\fR
  579. .PP
  580. Run the JACK daemon with low latency giving verbose output, which can
  581. be helpful for trouble\-shooting system latency problems. A
  582. reasonably well\-tuned system with a good sound card and a
  583. low\-latency kernel can handle these values reliably. Some can do
  584. better. If you get xrun messages, try a larger buffer. Tuning a
  585. system for low latency can be challenging. The JACK FAQ,
  586. .I http://jackit.sourceforge.net/docs/faq.php\fR
  587. has some useful suggestions.
  588. .IP
  589. \fBjackstart \-Rv \-d alsa \-p 128 \-n 2 \-r 44100\fR
  590. .PP
  591. Run \fBjackd\fR with realtime priority using the "sblive" ALSA device
  592. defined in ~/.asoundrc. Apply shaped dithering to playback audio.
  593. .IP
  594. \fBjackd \-R \-d alsa \-d sblive \-\-dither=shaped\fR
  595. .PP
  596. Run \fBjackd\fR with no special privileges using the second ALSA
  597. hardware card defined in \fB/etc/modules.conf\fR. Any xruns reported
  598. by the ALSA backend will be ignored. The larger buffer helps reduce
  599. data loss. Rectangular dithering will be used for playback.
  600. .IP
  601. \fBjackd \-d alsa \-d hw:1 \-p2048 \-n3 \-\-softmode \-zr\fR
  602. .PP
  603. Run \fBjackd\fR in full\-duplex mode using the ALSA hw:0,0 device for
  604. playback and the hw:0,2 device for capture.
  605. .IP
  606. \fBjackd \-d alsa \-P hw:0,0 \-C hw:0,2\fR
  607. .PP
  608. Run \fBjackd\fR in playback\-only mode using the ALSA hw:0,0 device.
  609. .IP
  610. \fBjackd \-d alsa \-P hw:0,0\fR
  611. .SH "ENVIRONMENT"
  612. .br
  613. JACK is evolving a mechanism for automatically starting the server
  614. when needed. Any client started without a running JACK server will
  615. attempt to start one itself using the command line found in the first
  616. line of \fB$HOME/.jackdrc\fR if it exists, or \fB/etc/jackdrc\fR if it
  617. does not. If neither file exists, a built\-in default command will be
  618. used, including the \fB\-T\fR flag, which causes the server to shut
  619. down when all clients have exited.
  620. As a transition, this only happens when \fB$JACK_START_SERVER\fR is
  621. defined in the environment of the calling process. In the future this
  622. will become normal behavior. In either case, defining
  623. \fB$JACK_NO_START_SERVER\fR disables this feature.
  624. To change where JACK looks for the backend drivers, set
  625. \fB$JACK_DRIVER_DIR\fR.
  626. \fB$JACK_DEFAULT_SERVER\fR specifies the default server name. If not
  627. defined, the string "default" is used. If set in their respective
  628. environments, this affects \fBjackd\fR unless its \fB\-\-name\fR
  629. parameter is set, and all JACK clients unless they pass an explicit
  630. name to \fBjack_client_open()\fR.
  631. .SH "SEE ALSO:"
  632. .PP
  633. .I http://www.jackaudio.org
  634. .br
  635. The official JACK website with news, docs and a list of JACK clients.
  636. .PP
  637. .I http://jackaudio.org/email
  638. .br
  639. The JACK developers' mailing list. Subscribe, to take part in
  640. development of JACK or JACK clients. User questions are also welcome,
  641. there is no user-specific mailing list.
  642. .PP
  643. .I http://www.jackosx.com/
  644. .br
  645. Tools specific to the Mac OS X version of JACK.
  646. .PP
  647. .I http://www.alsa\-project.org
  648. .br
  649. The Advanced Linux Sound Architecture.
  650. .SH "BUGS"
  651. Please report bugs to
  652. .br
  653. .I http://trac.jackaudio.org/
  654. .SH "AUTHORS"
  655. Architect and original implementor: Paul Davis
  656. .PP
  657. Original design Group: Paul Davis, David Olofson, Kai Vehmanen, Benno Sennoner,
  658. Richard Guenther, and other members of the Linux Audio Developers group.
  659. .PP
  660. Programming: Paul Davis, Jack O'Quin, Taybin Rutkin, Stephane Letz, Fernando
  661. Pablo Lopez-Lezcano, Steve Harris, Jeremy Hall, Andy Wingo, Kai
  662. Vehmanen, Melanie Thielker, Jussi Laako, Tilman Linneweh, Johnny
  663. Petrantoni, Torben Hohn.
  664. .PP
  665. Manpage written by Stefan Schwandter, Jack O'Quin and Alexandre
  666. Prokoudine.