Merge branch 'master' into ladi-experimental
[jackdbus.git] / man / jack_netsource.0
blob5de4af7f271d28205f1d5eed5b5c7b3d0fd27941
1 .TH JACK_NETSOURCE "1" "!DATE!" "!VERSION!"
2 .SH NAME
3 jack_netsource \- Netjack Master client for one slave
4 .SH SYNOPSIS
5 \fBjack_netsource\fR [ \fI-H\fR hostname ] [ \fIoptions\fR ]
7 .SH DESCRIPTION
8 \fBjack_netsource\fR The Master side of a netjack connection. Represents the slave jackd -dnet in the master jack graph.
9 Most connection parameters are configured via the netsource, and the slave will set itself up according to the commandline
10 option given to jack_netsource.
11 .br
12 Netjack allows low latency audio connections over general IP networks. When using celt for compression, it is even possible
13 to establish transatlantic links, with latencies not much over the actual ping time. 
14 .br
15 But the main usecase is of course a LAN, where it can achieve one jack period of latency.
17 .SH OPTIONS
18 .TP
19 \fB-h\fR this help text
20 .TP
21 \fB-H\fR \fIslave host\fR
22 .br
23 Host name of the slave JACK
24 .TP
25 \fB-o\fR \fInum channels\fR
26 .br
27 Number of audio playback channels
28 .TP
29 \fB-i\fR \fInum channels\fR
30 .br
31 Number of audio capture channels
32 .TP
33 \fB-O\fR \fInum channels\fR
34 .br
35 Number of midi playback channels
36 .TP
37 \fB-I\fR \fInum channels\fR
38 .br
39 Number of midi capture channels
40 .TP
41 \fB-n\fR \fIperiods\fR
42 .br
43 Network latency in JACK periods
44 .TP
45 \fB-p\fR \fIport\fR
46 .br
47 UDP port that the slave is listening on
48 .TP
49 \fB-r\fR \fIreply port\fR
50 .br
51 UDP port that we are listening on
52 .TP
53 \fB-B\fR \fIbind port\fR
54 .br
55 reply port, for use in NAT environments
56 .TP
57 \fB-b\fR \fIbitdepth\fR
58 .br
59 Set transport to use 16bit or 8bit
60 .TP
61 \fB-c\fR \fIbytes\fR
62 .br
63 Use CELT encoding with <bytes> per period and channel
64 .TP
65 \fB-m\fR \fImtu\fR
66 .br
67 Assume this mtu for the link
68 .TP
69 \fB-R\fR \fIN\fR
70 .br
71 Redundancy: send out packets N times.
72 .TP
73 \fB-e\fR
74 .br
75 skip host-to-network endianness conversion
76 .TP
77 \fB-N\fR \fIjack name\fR
78 .br
79 Reports a different client name to jack
80 .TP
81 .TP
82 \fB-s\fR, \fB--server\fR \fIservername\fR
83 .br
84 Connect to the jack server named \fIservername\fR
85 .TP
86 \fB-h\fR, \fB--help\fR
87 .br
88 Display help/usage message
89 .TP
90 \fB-v\fR, \fB--version\fR
91 .br
92 Output version information and exit
95 .SH EXAMPLES
97 .PP
98 run a 4 audio channel bidirectional link with one period of latency and no midi channels. Audio data is flowing uncompressed over the wire:
99 .br
100 On \fIhostA\fR:
102 \fBjackd \-d alsa \fR
104 \fBjack_netsource \-H hostB -n1 -i4 -o4 -I0 -O0 \fR
106 On \fIhostB\fR:
108 \fBjackd \-d net \fR