--- /dev/null
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
+.TH JACKTRIP "1" "November 2021" "JackTrip VERSION: 1.4.1" "User Commands"
+.SH NAME
+JackTrip \- manual page for JackTrip VERSION: 1.4.1
+.SH SYNOPSIS
+.B jacktrip
+[\fI\,-s|-c|-S|-C hostIPAddressOrURL\/\fR] [\fI\,options\/\fR]
+.SH DESCRIPTION
+JackTrip: A System for High\-Quality Audio Network Performance
+over the Internet
+Copyright \(co 2008\-2021 Juan\-Pablo Caceres, Chris Chafe.
+SoundWIRE group at CCRMA, Stanford University
+This build of JackTrip is subject to LGPL license.
+JackTrip source code is released under MIT and GPL licenses.
+See LICENSE.md file for more information.
+VERSION: 1.4.1
+.SH OPTIONS
+.SS "REQUIRED ARGUMENTS: One of:"
+.TP
+\fB\-s\fR, \fB\-\-server\fR
+Run in P2P Server Mode
+.TP
+\fB\-c\fR, \fB\-\-client\fR <peer_hostname_or_IP_num>
+Run in P2P Client Mode
+.TP
+\fB\-S\fR, \fB\-\-jacktripserver\fR
+Run in Hub Server Mode
+.TP
+\fB\-C\fR, \fB\-\-pingtoserver\fR <peer_name_or_IP>
+Run in Hub Client Mode
+.SS "OPTIONAL ARGUMENTS:"
+.TP
+\fB\-n\fR, \fB\-\-numchannels\fR #
+Number of Input and Output Channels (# greater than 0, default: 2)
+.TP
+\fB\-\-receivechannels\fR #
+Number of receive Channels from the network (# greater than 0)
+.TP
+\fB\-\-sendchannels\fR #
+Number of send Channels to the network (# greater than 0)
+.TP
+\fB\-q\fR, \fB\-\-queue\fR # (2 or more)
+Queue Buffer Length, in Packet Size (default: 4)
+.TP
+\fB\-r\fR, \fB\-\-redundancy\fR # (1 or more)
+Packet Redundancy to avoid glitches with packet losses (default: 1)
+.TP
+\fB\-o\fR, \fB\-\-portoffset\fR #
+Receiving bind port and peer port offset from default 4464
+.TP
+\fB\-B\fR, \fB\-\-bindport\fR #
+Set only the bind port number (default: 4464)
+.TP
+\fB\-P\fR, \fB\-\-peerport\fR #
+Set only the peer port number (default: 4464)
+.TP
+\fB\-U\fR, \fB\-\-udpbaseport\fR
+Set only the server udp base port number (default: 61002)
+.TP
+\fB\-b\fR, \fB\-\-bitres\fR # (8, 16, 24, 32)
+Audio Bit Rate Resolutions (default: 16, 32 uses floating\-point)
+.TP
+\fB\-p\fR, \fB\-\-hubpatch\fR # (0, 1, 2, 3, 4, 5)
+Hub auto audio patch, only has effect if running HUB SERVER mode, 0=server\-to\-clients, 1=client loopback, 2=client fan out/in but not loopback, 3=reserved for TUB, 4=full mix, 5=no auto patching (default: 0)
+.TP
+\fB\-z\fR, \fB\-\-zerounderrun\fR
+Set buffer to zeros when underrun occurs (default: wavetable)
+.TP
+\fB\-t\fR, \fB\-\-timeout\fR
+Quit after 10 seconds of no network activity
+.TP
+\fB\-l\fR, \fB\-\-loopback\fR
+Run in Loop\-Back Mode
+.TP
+\fB\-j\fR, \fB\-\-jamlink\fR
+Run in JamLink Mode (Connect to a JamLink Box)
+.TP
+\fB\-J\fR, \fB\-\-clientname\fR
+Change default client name (default: JackTrip)
+.TP
+\fB\-K\fR, \fB\-\-remotename\fR
+Change default remote client name when connecting to a hub server (the default is derived from this computer's external facing IP address)
+.TP
+\fB\-\-appendthreadid\fR
+Append thread ID to client names
+.TP
+\fB\-L\fR, \fB\-\-localaddress\fR
+Change default local host IP address (default: 127.0.0.1)
+.TP
+\fB\-D\fR, \fB\-\-nojackportsconnect\fR
+Don't connect default audio ports in jack
+.TP
+\fB\-\-bufstrategy\fR # (0, 1, 2)
+Use alternative jitter buffer
+.TP
+\fB\-\-broadcast\fR <broadcast_queue>
+Duplicate receive ports with the specified broadcast_queue length. Broadcast outputs have higher latency but less packet loss.
+.TP
+\fB\-\-udprt\fR
+Use RT thread priority for network I/O
+.SS "OPTIONAL SIGNAL PROCESSING:"
+.TP
+\fB\-f\fR, \fB\-\-effects\fR # | paramString | help
+Turn on incoming and/or outgoing compressor and/or reverb in Client \- see `\-f help' for details
+.TP
+\fB\-O\fR, \fB\-\-overflowlimiting\fR i|o[w]|io[w]|n|help
+Use audio limiter(s) in Client, i=incoming from network, o=outgoing to network, io=both, n=no limiters, w=warn if limiting (default=n). Say \fB\-O\fR help for more.
+.TP
+\fB\-a\fR, \fB\-\-assumednumclients\fR help|# (1,2,..)
+Assumed number of Clients (sources) mixing at Hub Server (otherwise 2 assumed by \fB\-O\fR)
+.SS "ARGUMENTS TO DISPLAY IO STATISTICS:"
+.TP
+\fB\-I\fR, \fB\-\-iostat\fR <time_in_secs>
+Turn on IO stat reporting with specified interval (in seconds)
+.TP
+\fB\-G\fR, \fB\-\-iostatlog\fR <log_file>
+Save stat log into a file (default: print in stdout)
+.TP
+\fB\-x\fR, \fB\-\-examine\-audio\-delay\fR <print_interval_in_secs> | help
+Print round\-trip audio delay statistics. See `\-x help' for details.
+.SS "ARGUMENTS TO SIMULATE NETWORK ISSUES:"
+.TP
+\fB\-\-simloss\fR <rate>
+Simulate packet loss
+.TP
+\fB\-\-simjitter\fR <rate>,<d>
+Simulate jitter, d is max delay in packets
+.SS "ARGUMENTS FOR HUB CLIENT/SERVER AUTHENTICATION:"
+.TP
+\fB\-A\fR, \fB\-\-auth\fR
+Use authentication on the client side, or require it on the server side
+.TP
+\fB\-\-certfile\fR
+The certificate file to use on the hub server
+.TP
+\fB\-\-keyfile\fR
+The private key file to use on the hub server
+.TP
+\fB\-\-credsfile\fR
+The file containing the stored usernames and passwords
+.TP
+\fB\-\-username\fR
+The username to use when connecting as a hub client (if not supplied here, this is read from standard input)
+.TP
+\fB\-\-password\fR
+The password to use when connecting as a hub client (if not supplied here, this is read from standard input)
+.SS "HELP ARGUMENTS:"
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Prints Version Number
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+Verbose mode, prints debug messages
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints this Help
+.SH COPYRIGHT
+Copyright \(co 2008\-2021 Juan\-Pablo Caceres, Chris Chafe.
+SoundWIRE group at CCRMA, Stanford University
+This build of JackTrip is subject to LGPL license.
+JackTrip source code is released under MIT and GPL licenses.
+See LICENSE.md file for more information.
FLAVORS = cli gui
CONFIG_cli = -config nogui
+
builddir=debian/build/flavor-
export QT_SELECT=qt5
override_dh_clean:
dh_clean
rm -rf $(FLAVORS:%=$(builddir)%)
+ rm -f $(FLAVORS:%=jacktrip-%.1)
+.PHONY: $(patsubst %,configure_%,$(FLAVORS))
override_dh_auto_configure-arch: $(patsubst %,configure_%,$(FLAVORS))
configure_%:
dh_auto_configure -a -B $(builddir)$* -- $(strip $(CONFIG) $(CONFIG_$*)) $(CURDIR)/jacktrip.pro
-override_dh_auto_build-arch: $(patsubst %,build_%,$(FLAVORS))
+.PHONY: $(patsubst %,build_%,$(FLAVORS))
+override_dh_auto_build-arch: $(patsubst %,build_%,$(FLAVORS)) $(patsubst %,$(builddir)%/jacktrip.1,$(FLAVORS))
build_%:
dh_auto_build -a -B $(builddir)$* -- -f Makefile.Release
cp $(builddir)$*/jacktrip $(builddir)$*/jacktrip-$*
-
-
-override_dh_auto_install-arch:
- dh_auto_install -a -B $(builddir)cli -- -f Makefile.Release
+# manpages
+$(builddir)%/jacktrip.1: build_%
+ cp debian/jacktrip.1 $@
+ -help2man --no-info --section=1 --output $@ $(builddir)$*/jacktrip
+ cp $@ $(patsubst %.1,%-$*.1,$@)
override_dh_installchangelogs:
dh_installchangelogs docs/About/CHANGELOG.md
-
licensecheck:
licensecheck --deb-machine -r * \
-i 'documentation/img/.*|debian/(changelog|copyright(|_hints|_newhints))$$' \
projects / jacktrip.git / commitdiff