From ca3af4b0d8a8a8fd6c4ae72c24e4df6e18f83af9 Mon Sep 17 00:00:00 2001 From: David Runge Date: Mon, 3 Jan 2022 20:17:31 +0100 Subject: Remove example-clients and tools (#112) .gitmodules: Remove the submodules for example-clients and tools, as they are now tracked in the separate project jack-example-tools (https://github.com/jackaudio/jack-example-tools). {Makefile.am,configure.ac}: Remove all use of example-clients and tools and their respective dependencies from the build system. config/os/macosx/README: Remove mentions of example-clients dependencies from OSX README. doc/{Makefile.am,reference.doxygen.in}: Remove all use of example-clients from the documentation generation. man/*.0: Remove all man pages now owned by jack-example-tools. --- .gitmodules | 6 --- Makefile.am | 4 +- config/os/macosx/README | 2 - configure.ac | 76 ------------------------------- doc/Makefile.am | 2 - doc/reference.doxygen.in | 2 - man/alsa_in.0 | 98 ---------------------------------------- man/alsa_out.0 | 1 - man/jack_bufsize.0 | 14 ------ man/jack_connect.0 | 11 ----- man/jack_disconnect.0 | 1 - man/jack_freewheel.0 | 16 ------- man/jack_impulse_grabber.0 | 11 ----- man/jack_iodelay.0 | 53 ---------------------- man/jack_load.0 | 28 ------------ man/jack_load_test.0 | 11 ----- man/jack_lsp.0 | 51 --------------------- man/jack_metro.0 | 40 ----------------- man/jack_monitor_client.0 | 18 -------- man/jack_netsource.0 | 109 --------------------------------------------- man/jack_property.0 | 64 -------------------------- man/jack_samplerate.0 | 9 ---- man/jack_showtime.0 | 13 ------ man/jack_transport.0 | 13 ------ man/jack_unload.0 | 19 -------- man/jack_wait.0 | 41 ----------------- man/jackrec.0 | 23 ---------- 27 files changed, 2 insertions(+), 734 deletions(-) delete mode 100644 man/alsa_in.0 delete mode 100644 man/alsa_out.0 delete mode 100644 man/jack_bufsize.0 delete mode 100644 man/jack_connect.0 delete mode 100644 man/jack_disconnect.0 delete mode 100644 man/jack_freewheel.0 delete mode 100644 man/jack_impulse_grabber.0 delete mode 100644 man/jack_iodelay.0 delete mode 100644 man/jack_load.0 delete mode 100644 man/jack_load_test.0 delete mode 100644 man/jack_lsp.0 delete mode 100644 man/jack_metro.0 delete mode 100644 man/jack_monitor_client.0 delete mode 100644 man/jack_netsource.0 delete mode 100644 man/jack_property.0 delete mode 100644 man/jack_samplerate.0 delete mode 100644 man/jack_showtime.0 delete mode 100644 man/jack_transport.0 delete mode 100644 man/jack_unload.0 delete mode 100644 man/jack_wait.0 delete mode 100644 man/jackrec.0 diff --git a/.gitmodules b/.gitmodules index 24410fa..6a68287 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,9 +1,3 @@ -[submodule "example-clients"] - path = example-clients - url = https://github.com/jackaudio/example-clients [submodule "jack"] path = jack url = https://github.com/jackaudio/headers -[submodule "tools"] - path = tools - url = https://github.com/jackaudio/tools diff --git a/Makefile.am b/Makefile.am index 82b69d4..da912a8 100644 --- a/Makefile.am +++ b/Makefile.am @@ -15,8 +15,8 @@ dist-check-doxygen: @false endif -SUBDIRS = libjack jackd drivers example-clients tools config $(DOC_DIR) man python -DIST_SUBDIRS = config libjack jackd include drivers example-clients tools doc man python +SUBDIRS = libjack jackd drivers config $(DOC_DIR) man python +DIST_SUBDIRS = config libjack jackd include drivers doc man python pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = jack.pc diff --git a/config/os/macosx/README b/config/os/macosx/README index 33f5692..87e3e5e 100644 --- a/config/os/macosx/README +++ b/config/os/macosx/README @@ -17,8 +17,6 @@ optional tools libtool >= 1.5 (to build from CVS) pkg-config >= 0.15.0 (to build from CVS) doxygen (to build documentation) - libsndfile >= 1.0.0 (for some example-clients) - GNU readline (for some example-clients) All non-Apple tools are available from `fink' or `darwinports'. diff --git a/configure.ac b/configure.ac index 4aa387e..ee0683b 100644 --- a/configure.ac +++ b/configure.ac @@ -679,13 +679,6 @@ if test "x$USE_BARRIER" = "xyes"; then AC_DEFINE(USE_BARRIER, 1, [Use pthread barrier functions])) fi -# some example-clients need libsndfile -HAVE_SNDFILE=false -PKG_CHECK_MODULES(SNDFILE, sndfile >= 1.0,[HAVE_SNDFILE=true], [true]) -if test x$HAVE_SNDFILE = xfalse; then - AC_MSG_WARN([*** the jackrec example client will not be built]) -fi - # NetJack backend and internal client need libsamplerate HAVE_SAMPLERATE=false PKG_CHECK_MODULES(SAMPLERATE, samplerate >= 0.1.2,[HAVE_SAMPLERATE=true], [true]) @@ -698,45 +691,6 @@ else AC_DEFINE(HAVE_SAMPLERATE,1,"Whether libsamplerate is available") fi -# if we have Fons Adriensen's zita libs installed, we can build the zita-based -# internal clients for using additional (ALSA) devices with JACK - -HAVE_ZITA_BRIDGE_DEPS=false -HAVE_ZITA_RESAMPLE=false -HAVE_ZITA_ALSA_PCMI=false - -case $build_os in - linux*) - AC_CHECK_LIB(zita-resampler, _Z28zita_resampler_major_versionv, - [ - HAVE_ZITA_RESAMPLE=true - AC_MSG_RESULT(yes) - ]) - AC_CHECK_LIB(zita-alsa-pcmi, _Z28zita_alsa_pcmi_major_versionv, - [ - HAVE_ZITA_ALSA_PCMI=true - AC_MSG_RESULT(yes) - ]) - - AC_ARG_ENABLE(zalsa, - AC_HELP_STRING([--enable-zalsa],[Build clients using Fons Adriensen\'s Zita libraries for access to multiple devices (default=yes if required libraries are present)]), - [ - if test x$enable_zalsa != xno -a x$HAVE_ZITA_RESAMPLE = xtrue -a x$HAVE_ZITA_ALSA_PCMI = xtrue ; then - AC_DEFINE(HAVE_ZITA_BRIDGE_DEPS,1,"Whether we have the libs needed for Zita ALSA bridge support") - HAVE_ZITA_BRIDGE_DEPS=true - fi - ], - [ - if test x$HAVE_ZITA_RESAMPLE = xtrue -a x$HAVE_ZITA_ALSA_PCMI = xtrue ; then - AC_DEFINE(HAVE_ZITA_BRIDGE_DEPS,1,"Whether we have the libs needed for Zita ALSA bridge support") - HAVE_ZITA_BRIDGE_DEPS=true - fi - ] - ) - ;; -esac -AM_CONDITIONAL(HAVE_ZITA_ALSA_PCMI, $HAVE_ZITA_ALSA_PCMI) - # Celt low-latency audio codec. netjack transmission via internet. HAVE_CELT=false PKG_CHECK_MODULES(CELT, celt >= 0.8.0,[HAVE_CELT=true], [true]) @@ -923,44 +877,18 @@ AC_DEFINE_UNQUOTED(JACK_SEMAPHORE_KEY, [ an integer constant used as the semaphore and SysV SHM key. see libjack/shm.c for usage]) AC_SUBST(JACK_SEMAPHORE_KEY) -# On some systems, readline depends on termcap or ncurses. But, the -# MacOSX linker complains bitterly if these libraries are explicitly -# referenced. -# -# AC_CHECK_LIB() foolishly assumes that checking a library for an entry -# point always returns the same result regardless of any dependent -# libraries specified. The `unset ac_cv_lib_readline_readline' erases -# the cached result to work around this problem. -READLINE_DEPS="" -HAVE_READLINE=true -AC_CHECK_LIB(readline, readline, [:], - [unset ac_cv_lib_readline_readline - AC_CHECK_LIB(readline, readline, [READLINE_DEPS="-ltermcap"], - [unset ac_cv_lib_readline_readline - AC_CHECK_LIB(readline, readline, - [READLINE_DEPS="-lncurses"], [HAVE_READLINE=false], "-lncurses")], - "-ltermcap")]) -AC_CHECK_HEADER(readline/chardefs.h, [], [HAVE_READLINE=false]) -if test x$HAVE_READLINE = xfalse; then - AC_MSG_WARN([*** the jack_transport example client will not be built]) -fi -AC_SUBST(READLINE_DEPS) - # you need doxygen to make dist. AC_CHECK_PROG(HAVE_DOXYGEN, doxygen, true, false) if test $HAVE_DOXYGEN = "false"; then AC_MSG_WARN([*** doxygen not found, docs will not be built]) fi -AM_CONDITIONAL(HAVE_SNDFILE, $HAVE_SNDFILE) AM_CONDITIONAL(HAVE_CELT, $HAVE_CELT) AM_CONDITIONAL(HAVE_SAMPLERATE, $HAVE_SAMPLERATE) -AM_CONDITIONAL(HAVE_READLINE, $HAVE_READLINE) AM_CONDITIONAL(HAVE_DOXYGEN, $HAVE_DOXYGEN) AM_CONDITIONAL(USE_CAPABILITIES, $USE_CAPABILITIES) AM_CONDITIONAL(STRIPPED_JACKD, $STRIPPED_JACKD) AM_CONDITIONAL(HAVE_PPOLL, $HAVE_PPOLL) -AM_CONDITIONAL(HAVE_ZITA_BRIDGE_DEPS, $HAVE_ZITA_BRIDGE_DEPS) AC_OUTPUT( Makefile @@ -984,9 +912,6 @@ drivers/coreaudio/Makefile drivers/freebob/Makefile drivers/firewire/Makefile drivers/netjack/Makefile -example-clients/Makefile -tools/Makefile -tools/zalsa/Makefile man/Makefile jack.pc jack.spec @@ -1015,7 +940,6 @@ echo \| Build with CoreAudio support.......................... : $HAVE_COREAUDIO echo \| Build with PortAudio support.......................... : $HAVE_PA echo \| Build with Celt support............................... : $HAVE_CELT echo \| Build with dynamic buffer size support................ : $buffer_resizing -echo \| Build with ZITA ALSA bridge support................... : $HAVE_ZITA_BRIDGE_DEPS echo \| Compiler optimization flags........................... : $JACK_OPT_CFLAGS echo \| Compiler full flags................................... : $CFLAGS echo \| Install dir for libjack + backends.................... : $libdir/jack diff --git a/doc/Makefile.am b/doc/Makefile.am index 3c66318..fb04d89 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,8 +5,6 @@ CLEANFILES=doxygen-build.stamp DOX=reference.doxygen DOXSOURCES=mainpage.dox transport.dox porting.dox fsm.png fsm.eps \ - ../example-clients/inprocess.c \ - ../example-clients/simple_client.c \ ../jack/control.h \ ../jack/intclient.h \ ../jack/jack.h \ diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index fbbba0c..4f8294f 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -516,8 +516,6 @@ WARN_LOGFILE = INPUT = @top_srcdir@/doc/mainpage.dox \ @top_srcdir@/doc/transport.dox \ @top_srcdir@/doc/porting.dox \ - @top_srcdir@/example-clients/inprocess.c \ - @top_srcdir@/example-clients/simple_client.c \ @top_srcdir@/jack/control.h \ @top_srcdir@/jack/intclient.h \ @top_srcdir@/jack/jack.h \ diff --git a/man/alsa_in.0 b/man/alsa_in.0 deleted file mode 100644 index f97c5ca..0000000 --- a/man/alsa_in.0 +++ /dev/null @@ -1,98 +0,0 @@ -.TH ALSA_IO "1" "!DATE!" "!VERSION!" -.SH NAME -\fBalsa_in\fR, \fBalsa_out\fR \- Jack clients that perform I/O with an alternate audio interface -.SH SYNOPSIS -\fBalsa_in\fR [\fIoptions\fR] -.br -\fBalsa_out\fR [\fIoptions\fR] - -.SH DESCRIPTION -A JACK client that opens a specified audio interface (different to the -one used by the JACK server, if any) and moves audio data between its -JACK ports and the interface. alsa_in will provide data from the -interface (potentially for capture); alsa_out will deliver data to it -(for playback). - -The audio interface used by alsa_in/alsa_out does not need to be -synchronized with JACK backend (or the hardware it might be using). -alsa_in/alsa_out tries to resample the output stream in an attempt to -compensate for drift between the two clocks. - -As of jack-0.116.3 this works almost perfectly. It takes some time, to reach -absolute resample-rate stability. So give it some minutes (its intended to be -running permanently anyways) - -.SH OPTIONS -.TP -\fB\-j \fI jack_client_name\fR -.br -Set Client Name. -.TP -\fB\-d \fI alsa_device\fR -.br -Use this Soundcard. -.TP -\fB\-v\fR -.br -Verbose, prints out resample coefficient and other parameters useful for debugging, every 500ms. -also reports soft xruns. -.TP -\fB\-i\fR -.br -Instrumentation. This logs the 4 important parameters of the samplerate control algorithm every 1ms. -You can pipe this into a file, and plot it. Should only be necessary, if it does not work as -expected, and we need to adjust some of the obscure parameters, to make it work. -Find me on irc.freenode.org #jack in order to set this up correctly. -.TP -\fB\-c \fI channels\fR -.br -Set Number of channels. -.TP -\fB\-r \fI sample_rate\fR -.br -Set sample_rate. The program resamples as necessary. -So you can connect a 44k1 jackd to a soundcard only supporting -48k. (default is jack sample_rate) -.TP -\fB\-p \fI period_size\fR -.br -Set the period size. It is not related to the jackd period_size. -Sometimes it affects the quality of the delay measurements. -Setting this lower than the jackd period_size will only work, if you -use a higher number of periods. -.TP -\fB\-n \fI num_period\fR -.br -Set number of periods. See note for period_size. -.TP -\fB\-q \fI quality\fR -.br -Set the quality of the resampler from 0 to 4. This can significanly reduce -CPU usage. Higher values give better quality and more CPU usage. -.TP -\fB\-m \fI max_diff\fR -.br -The value when a soft xrun occurs. Basically the window, in which -the dma pointer may jitter. I don't think its necessary to play with this anymore. -.TP -\fB\-t \fI target_delay\fR -.br -The delay alsa_io should try to approach. Same as for max_diff. It will be setup based on \-p and \-n -which is generally sufficient. -.TP -\fB\-s \fI smooth_array_size\fR -.br -This parameter controls the size of the array used for smoothing the delay measurement. Its default is 256. -If you use a pretty low period size, you can lower the CPU usage a bit by decreasing this parameter. -However most CPU time is spent in the resampling so this will not be much. -.TP -\fB\-C \fI P Control Clamp\fR -.br -If you have a PCI card, then the default value (15) of this parameter is too high for \-p64 \-n2... Setting it to 5 should fix that. -Be aware that setting this parameter too low, lets the hf noise on the delay measurement come through onto the resamplerate, so this -might degrade the quality of the output. (but its a threshold value, and it has been chosen, to mask the noise of a USB card, -which has an amplitude which is 50 times higher than that of a PCI card, so 5 wont loose you any quality on a PCI card) - -.SH AUTHOR -Torben Hohn - diff --git a/man/alsa_out.0 b/man/alsa_out.0 deleted file mode 100644 index 7b63b85..0000000 --- a/man/alsa_out.0 +++ /dev/null @@ -1 +0,0 @@ -.so man1/alsa_in.1 diff --git a/man/jack_bufsize.0 b/man/jack_bufsize.0 deleted file mode 100644 index f9d0dd6..0000000 --- a/man/jack_bufsize.0 +++ /dev/null @@ -1,14 +0,0 @@ -.TH JACK_BUFSIZE "1" "!DATE!" "!VERSION!" -.SH NAME -jack_bufsize \- JACK toolkit client to change the JACK buffer size -.SH SYNOPSIS -.B jack_bufsize bufsize -.SH DESCRIPTION -.B jack_bufsize -jack_bufsize sets the size of the buffer (frames per period) used in JACK. -This change happens on-line (the JACK server and its clients do not need to be -restarted). -.br -When invoked without arguments, it prints the current bufsize, and exits. - - diff --git a/man/jack_connect.0 b/man/jack_connect.0 deleted file mode 100644 index 5ee8f8b..0000000 --- a/man/jack_connect.0 +++ /dev/null @@ -1,11 +0,0 @@ -.TH JACK_CONNECT "1" "!DATE!" "!VERSION!" -.SH NAME -\fBjack_connect\fR, \fBjack_disconnect\fR \- JACK toolkit clients for connecting & disconnecting ports -.SH SYNOPSIS -\fB jack_connect\fR [ \fI-s\fR | \fI--server servername\fR ] [\fI-h\fR | \fI--help\fR ] port1 port2 -\fB jack_disconnect\fR [ \fI-s\fR | \fI--server servername\fR ] [\fI-h\fR | \fI--help\fR ] port1 port2 -.SH DESCRIPTION -\fBjack_connect\fR connects the two named ports. \fBjack_disconnect\fR disconnects the two named ports. -.SH RETURNS -The exit status is zero if successful, 1 otherwise - diff --git a/man/jack_disconnect.0 b/man/jack_disconnect.0 deleted file mode 100644 index 90300cc..0000000 --- a/man/jack_disconnect.0 +++ /dev/null @@ -1 +0,0 @@ -.so man1/jack_connect.1 diff --git a/man/jack_freewheel.0 b/man/jack_freewheel.0 deleted file mode 100644 index 0941ffd..0000000 --- a/man/jack_freewheel.0 +++ /dev/null @@ -1,16 +0,0 @@ -.TH JACK_FREEWHEEL "1" "!DATE!" "!VERSION!" -.SH NAME -jack_freewheel \- JACK toolkit client to control freewheeling mode -.SH SYNOPSIS -.B jack_freewheel [y|n] -.SH DESCRIPTION -.B jack_freewheel -Turns freewheeling mode on (y) or off (n). While in freewheeling mode, -the JACK server does not wait in between process() calls, and does not -read or write data from/to any audio interface. That results in the JACK graph -processing data as fast as possible. Freewheeling makes fast exports to -files possible. -.PP -There is no useful reason to use this tool other than testing. JACK -clients that use freewheeling will turn it on and off themselves. - diff --git a/man/jack_impulse_grabber.0 b/man/jack_impulse_grabber.0 deleted file mode 100644 index 544716b..0000000 --- a/man/jack_impulse_grabber.0 +++ /dev/null @@ -1,11 +0,0 @@ -.TH JACK_IMPULSE_GRABBER "1" "!DATE!" "!VERSION!" -.SH NAME -jack_impulse_grabber \- JACK toolkit client to grab an impulse (response) -.SH SYNOPSIS -\fBjack_impulse_grabber\fR \fB-d\fR \fIduration\fR [\fI-f\fR (C|gnuplot)] -.SH DESCRIPTION -\fBjack_impulse_grabber\fR is a JACK example client for collecting -impulses recordings from JACK ports. - - - diff --git a/man/jack_iodelay.0 b/man/jack_iodelay.0 deleted file mode 100644 index 007e65a..0000000 --- a/man/jack_iodelay.0 +++ /dev/null @@ -1,53 +0,0 @@ -.TH JACK_IODELAY "1" "!DATE!" "!VERSION!" -.SH NAME -jack_iodelay \- JACK toolkit client to measure roundtrip latency -.SH SYNOPSIS -.B jack_iodelay -.SH DESCRIPTION -.B jack_iodelay -will create one input and one output port, and then -measures the latency (signal delay) between them. For this to work, -the output port must be connected to its input port. The measurement -is accurate to a resolution of greater than 1 sample. -.PP -The expected use is to connect jack_iodelay's output port to a -hardware playback port, then use a physical loopback cable from the -corresponding hardware output connector to an input connector, and to -connect that corresponding hardware capture port to jack_iodelay's -input port. This creates a roundtrip that goes through any -analog-to-digital or digital-converters that are present in the audio -hardware. -.PP -Although the hardware loopback latency is the expected use, it is also -possible to use jack_iodelay to measure the latency along any fully -connected signal path, such as those involving other JACK clients. -.PP -Once jack_iodelay completes its measurement it will print the total -latency it has detected. This will include the JACK period length in -addition to any other latency in the signal path. It will continue to -print the value every 0.5 seconds or so so that if you wish you can -vary aspects of the signal path to see their effect on the measured -latency. -.PP -If no incoming signal is detected from the input port, jack_iodelay -will print -.PP -\fT Signal below threshold... .\fR -.PP -every second until this changes (e.g. until you establish the correct connections). -.PP -To use the value measured by jack_iodelay with the -I and -O arguments -of a JACK backend (also called Input Latency and Output Latency in the -setup dialog of qjackctl), you must subtract the JACK period size from -the result. Then, if you believe that the latency is equally -distributed between the input and output parts of your audio hardware -(extremely likely), divide the result by two and use that for input -and/or output latency value. Doing this measurement will enable JACK -clients that use the JACK latency API to accurately position/delay -audio to keep signals synchronized even when there are inherent delays -in the end-to-end signal pathways. -.SH AUTHOR -Originally written in C++ by Fons Adriensen, ported to C by Torben Hohn. - - - diff --git a/man/jack_load.0 b/man/jack_load.0 deleted file mode 100644 index 599116e..0000000 --- a/man/jack_load.0 +++ /dev/null @@ -1,28 +0,0 @@ -.TH JACK_LOAD "1" "!DATE!" "!VERSION!" -.SH NAME -jack_load \- JACK toolkit client for loading in-process clients -.SH SYNOPSIS -\fBjack_load\fR [ \fI-i\fR initstring ] [ \fI-s\fR servername ] [\fI-w\fR ] client-name so-name [ initstring ] -.SH DESCRIPTION -\fBjack_load\fR is a JACK toolkit client. It loads the specified plugin and creates an in-process client. -.SH ARGUMENTS -.PP -The client-name must be a currently unused client name. -.PP -The so-name is the name of file that client code is stored in (typically, \fIclientname.so\fR) -.SH OPTIONS -.TP -\fB-i\fR, \fB--init\fR init-string -.br -initialization string passed to the in-process client. Note that this can also be specified as the last argument on the command line. -.TP -\fB-s\fR, \fB--server\fR servername -.br -Name of JACK server to connect to -.TP -\fB-w\fR, \fB--wait\fR -Wait for a signal (eg. from Ctrl-c) and then unload the client. -.SH AUTHOR -Jeremy Hall - - diff --git a/man/jack_load_test.0 b/man/jack_load_test.0 deleted file mode 100644 index 2122608..0000000 --- a/man/jack_load_test.0 +++ /dev/null @@ -1,11 +0,0 @@ -.TH JACK_LOAD_TEST "1" "!DATE!" "!VERSION!" -.SH NAME -jack_load_test \- JACK toolkit client which occupies the cpu for some time in process. -.SH SYNOPSIS -.B jack_load_test -t \fItime\fR -.SH DESCRIPTION -.B jack_load_test -jack_load_test is a client without ports, which just occupies the cpu for \fItime\fR -miliseconds. It is quite useful to test jackd behaviour under load. - - diff --git a/man/jack_lsp.0 b/man/jack_lsp.0 deleted file mode 100644 index c3f8a6b..0000000 --- a/man/jack_lsp.0 +++ /dev/null @@ -1,51 +0,0 @@ -.TH JACK_LSP "1" "!DATE!" "!VERSION!" -.SH NAME -jack_lsp \- JACK toolkit client to list informtion on ports -.SH SYNOPSIS -\fBjack_lsp\fR [ \fI-s\fR | \fI--server\fR servername ] [ \fI-AclLptvhuU\fR ] -.SH DESCRIPTION -\fBjack_lsp\fR lists all known ports associated with a JACK -server. It can also optionally list various kinds of information about each port. -.SH OPTIONS -.TP -\fB-s\fR, \fB--server\fR \fIservername\fR -.br -Connect to the jack server named \fIservername\fR -.TP -\fB-A\fR, \fB--aliases\fR -.br -List aliases for each port -.TP -\fB-c\fR, \fB--connections\fR -.br -List connections to/from each port -.TP -\fB-l\fR, \fB--latency\fR -.br -Display per-port latency in frames at each port -.TP -\fB-p\fR, \fB--properties\fR -.br -Display port properties. Output may include input|output, can-monitor, physical, terminal -.TP -\fB-t\fR, \fB--type\fR -.br -Display port type -.TP -\fB-u\fR, \fB--uuid\fR -.br -Display client UUIDs instead of names -.TP -\fB-U\fR -.br -Show port UUIDs as well as names -.TP -\fB-h\fR, \fB--help\fR -.br -Display help/usage message -.TP -\fB-v\fR, \fB--version\fR -.br -Output version information and exit - - diff --git a/man/jack_metro.0 b/man/jack_metro.0 deleted file mode 100644 index e38a954..0000000 --- a/man/jack_metro.0 +++ /dev/null @@ -1,40 +0,0 @@ -.TH JACK_METRO "1" "!DATE!" "!VERSION!" -.SH NAME -jack_metro \- JACK toolkit metronome -.SH SYNOPSIS -\fBjack_metro\fR [ \fI-n\fR name ] [ \fI-f\fR hz ] [ \fI-D\fR msecs ] [\fI-a\fR % ] [ \fI-d\fR % ] \fI-b\fR bpm -.SH DESCRIPTION -\fBjack_metro\fR is a simple metronome for JACK. It generates a -synthetic "tick" sound for every beat. Note that is does \fBnot\fR -connect its output port by default - to hear the sound it makes you must -connect them using some other tool. -.SH OPTIONS -.TP -\fB-n\fR, \fB--name\fR -.br -Specify a name for this instance of the metronome. -.TP -\fB-f\fR, \fB--frequency\fR Hz -.br -Define the frequency of the "tick" in Hz. -.TP -\fB-D\fR, \fB--duration\fR msecs -.br -Define the duration of the "tick" in milliseconds. -.TP -\fB-a\fR, \fB--attack\fR %-age -.br -Define the duration of the attack phase of the "tick" as a percentage -of the duration. -.TP -\fB-d\fR, \fB--decay\fR %-age -.br -Define the duration of the decay phase of the "tick" as a percentage -of the duration. -.TP -\fB--b\fR, \fB--bpm\fR bpm -.br -Define the number of beats per minute. -.SH AUTHOR -Anthony Van Groningen - diff --git a/man/jack_monitor_client.0 b/man/jack_monitor_client.0 deleted file mode 100644 index 0991107..0000000 --- a/man/jack_monitor_client.0 +++ /dev/null @@ -1,18 +0,0 @@ -.TH JACK_CONNECT "1" "!DATE!" "!VERSION!" -.SH NAME -jack_monitor_client \- The JACK Audio Connection Kit example client -.SH SYNOPSIS -.B jack_monitor_client -client-name -.PP -The client-name must be the name of a existing client that monitoring is -to be enabled for. -.SH DESCRIPTION -.B jack_monitor_client -is an example client for the JACK Audio Connection Kit. It enables -monitoring for the specified client. -.SH AUTHOR -Jeremy Hall -.PP -This manpage was written by Robert Jordens for Debian. - diff --git a/man/jack_netsource.0 b/man/jack_netsource.0 deleted file mode 100644 index 5de4af7..0000000 --- a/man/jack_netsource.0 +++ /dev/null @@ -1,109 +0,0 @@ -.TH JACK_NETSOURCE "1" "!DATE!" "!VERSION!" -.SH NAME -jack_netsource \- Netjack Master client for one slave -.SH SYNOPSIS -\fBjack_netsource\fR [ \fI-H\fR hostname ] [ \fIoptions\fR ] - -.SH DESCRIPTION -\fBjack_netsource\fR The Master side of a netjack connection. Represents the slave jackd -dnet in the master jack graph. -Most connection parameters are configured via the netsource, and the slave will set itself up according to the commandline -option given to jack_netsource. -.br -Netjack allows low latency audio connections over general IP networks. When using celt for compression, it is even possible -to establish transatlantic links, with latencies not much over the actual ping time. -.br -But the main usecase is of course a LAN, where it can achieve one jack period of latency. - -.SH OPTIONS -.TP -\fB-h\fR this help text -.TP -\fB-H\fR \fIslave host\fR -.br -Host name of the slave JACK -.TP -\fB-o\fR \fInum channels\fR -.br -Number of audio playback channels -.TP -\fB-i\fR \fInum channels\fR -.br -Number of audio capture channels -.TP -\fB-O\fR \fInum channels\fR -.br -Number of midi playback channels -.TP -\fB-I\fR \fInum channels\fR -.br -Number of midi capture channels -.TP -\fB-n\fR \fIperiods\fR -.br -Network latency in JACK periods -.TP -\fB-p\fR \fIport\fR -.br -UDP port that the slave is listening on -.TP -\fB-r\fR \fIreply port\fR -.br -UDP port that we are listening on -.TP -\fB-B\fR \fIbind port\fR -.br -reply port, for use in NAT environments -.TP -\fB-b\fR \fIbitdepth\fR -.br -Set transport to use 16bit or 8bit -.TP -\fB-c\fR \fIbytes\fR -.br -Use CELT encoding with per period and channel -.TP -\fB-m\fR \fImtu\fR -.br -Assume this mtu for the link -.TP -\fB-R\fR \fIN\fR -.br -Redundancy: send out packets N times. -.TP -\fB-e\fR -.br -skip host-to-network endianness conversion -.TP -\fB-N\fR \fIjack name\fR -.br -Reports a different client name to jack -.TP -.TP -\fB-s\fR, \fB--server\fR \fIservername\fR -.br -Connect to the jack server named \fIservername\fR -.TP -\fB-h\fR, \fB--help\fR -.br -Display help/usage message -.TP -\fB-v\fR, \fB--version\fR -.br -Output version information and exit - - -.SH EXAMPLES - -.PP -run a 4 audio channel bidirectional link with one period of latency and no midi channels. Audio data is flowing uncompressed over the wire: -.br -On \fIhostA\fR: -.IP -\fBjackd \-d alsa \fR -.br -\fBjack_netsource \-H hostB -n1 -i4 -o4 -I0 -O0 \fR -.PP -On \fIhostB\fR: -.IP -\fBjackd \-d net \fR - diff --git a/man/jack_property.0 b/man/jack_property.0 deleted file mode 100644 index c78ea12..0000000 --- a/man/jack_property.0 +++ /dev/null @@ -1,64 +0,0 @@ -.TH JACK_PROPERTY "1" "!DATE!" "!VERSION!" -.SH NAME -jack_property \- JACK client to list, set and delete metadata information -.SH SYNOPSIS -\fBjack_property\fR -l -.br -\fBjack_property\fR [ -c | -p ] -l \fIidentifier\fR -.br -\fBjack_property\fR [ -c | -p ] -l \fIidentifier\fR \fIkey\fR -.br -\fBjack_property\fR [ -c | -p ] -s \fIidentifier\fR \fIkey\fR \fIvalue\fR [ \fItype\fR ] -.br -\fBjack_property\fR [ -c | -p ] -d \fIidentifier\fR -.br -\fBjack_property\fR [ -c | -p ] -d \fIidentifier\fR \fIkey\fR -.br -\fBjack_property\fR -D -.SH DESCRIPTION -\fBjack_property\fR can be used to list, set and delete any and all metadata associated with the ports -and clients of a JACK server. -.P -There are three main ways to use the command. The \fB-l\fR option is used to list existing metadata. The \fB-s\fR option is used -to set metadata. The \fB-d/-D\fR options are used to delete metadata. -.P -The \fIidentifier\fR is normally a UUID (UUIDs for ports and clients can be shown with jack_lsp(1)). If the \fB-c\fR option is used, then \fIidentifier\fR will -be interpreted as a client name, and its UUID will be looked up internally and used for the relevant metadata operation. If the \fB-p\fR option is used, then \fIidentifier\fR will -be interpreted as a port name and its UUID will be looked up internally and used for the relevant metadata operation. -.P -The \fIkey\fR is an arbitary string that identifies the metadata to be operated upon. -.P -The \fIvalue\fR is an arbitrary string that defines the value of the metadata to be created. -.P -The \fItype\fR is an optional MIME type, given as a string. An empty type for a piece of metadata results in it being interpreted as "text/UTF-8". -.SH OPTIONS -.TP 6 --l -list all metadata currently defined -.TP --l identifier -list all metadata currently defined for \fIidentifier\fR -.TP --l identifier key -show the value of the metadata associated with key for \fIidentifier\fR -.TP --d identifier -deletes all metadata for \fIidentifier\fR -.TP --d identifier key -deletes the metadata associated with \fIkey\fR for \fIidentifier\fR -.TP --D -delete all currently defined metadata -.TP --s identifier key value [ type ] -sets the metadata associated with \fIkey\fR to \fIvalue\fR for \fIidentifer\fR, with its type set to \fItype\fR if given -.TP --c -interpret a given identifier as a client name rather than a UUID -.TP --p -interpret a given identifier as a port name rather than a UUID - - - diff --git a/man/jack_samplerate.0 b/man/jack_samplerate.0 deleted file mode 100644 index ef11ed0..0000000 --- a/man/jack_samplerate.0 +++ /dev/null @@ -1,9 +0,0 @@ -.TH JACK_SAMPLERATE "1" "!DATE!" "!VERSION!" -.SH NAME -jack_samplerate \- JACK toolkit client to print current samplerate -.SH SYNOPSIS -.B jack_samplerate -.SH DESCRIPTION -.B jack_samplerate prints the current samplerate, and exits. - - diff --git a/man/jack_showtime.0 b/man/jack_showtime.0 deleted file mode 100644 index 210caa7..0000000 --- a/man/jack_showtime.0 +++ /dev/null @@ -1,13 +0,0 @@ -.TH JACK_SHOWTIME "1" "!DATE!" "!VERSION!" -.SH NAME -jack_showtime \- The JACK Audio Connection Kit example client -.SH SYNOPSIS -.B jack_showtime -.SH DESCRIPTION -.B jack_showtime -prints the current timebase information to stdout -.SH AUTHOR -Paul Davis -.PP -This manpage was written by Stefan Schwandter - diff --git a/man/jack_transport.0 b/man/jack_transport.0 deleted file mode 100644 index 6aa8ddd..0000000 --- a/man/jack_transport.0 +++ /dev/null @@ -1,13 +0,0 @@ -.TH JACK_TRANSPORT "1" "!DATE!" "!VERSION!" -.SH NAME -jack_transport \- JACK toolkit client for transport control -.SH SYNOPSIS -.B jack_transport -.SH DESCRIPTION -.B jack_transport -is a toolkit client for the JACK Audio Connection Kit. It provides command-line -control over the JACK transport system. Type help at jack_transport's -command prompt to see the available commands. -.SH AUTHOR -Jeremy Hall - diff --git a/man/jack_unload.0 b/man/jack_unload.0 deleted file mode 100644 index 79b1e33..0000000 --- a/man/jack_unload.0 +++ /dev/null @@ -1,19 +0,0 @@ -.TH JACK_UNLOAD "1" "!DATE!" "!VERSION!" -.SH NAME -jack_unload \- The JACK Audio Connection Kit example client -.SH SYNOPSIS -.B jack_unload -client-name -.PP -The client-name must be the name of a loaded client that can be unloaded. -.SH DESCRIPTION -.B jack_unload -is the counterpart to -.B jack_load -and unloads the specified client. -.SH EXAMPLE -.B jack_unload in_process_test -.SH AUTHOR -Jeremy Hall -.PP -This manpage was written by Robert Jordens for Debian. diff --git a/man/jack_wait.0 b/man/jack_wait.0 deleted file mode 100644 index 239e8c2..0000000 --- a/man/jack_wait.0 +++ /dev/null @@ -1,41 +0,0 @@ -.TH JACK_WAIT "1" "!DATE!" "!VERSION!" -.SH NAME -jack_wait \- JACK toolkit client to check and wait for existence/exit of jackd. -.SH SYNOPSIS -\fBjack_wait\fR [ \fI-s\fR | \fI--server\fR servername ] [ \fI-t\fR | \fI--timeout\fR timeout_seconds [ \fI-cqwhv\fR ] -.SH DESCRIPTION -\fBjack_wait\fR When invoked with \fI-c\fR it only checks for the existence of a jack server. When invoked with \fI-w\fR the -program will wait for a jackd to be available. -The \fI-q\fR makes it wait for the jackd to exit. - -.SH OPTIONS -.TP -\fB-w\fR, \fB--wait\fR -.br -Wait for jackd to be available. -.TP -\fB-q\fR, \fB--quit\fR -.br -Wait for jackd quit. -.TP -\fB-c\fR, \fB--check\fR -.br -Only check for existence of jackd, and exit. -.TP -\fB-s\fR, \fB--server\fR \fIservername\fR -.br -Connect to the jack server named \fIservername\fR -.TP -\fB-t\fR, \fB--timeout\fR \fItimeout_seconds\fR -.br -Only wait \fItimeout_seconds\fR. -.TP -\fB-h\fR, \fB--help\fR -.br -Display help/usage message -.TP -\fB-v\fR, \fB--version\fR -.br -Output version information and exit - - diff --git a/man/jackrec.0 b/man/jackrec.0 deleted file mode 100644 index 1ea2a6f..0000000 --- a/man/jackrec.0 +++ /dev/null @@ -1,23 +0,0 @@ -.TH JACKREC "1" "!DATE!" "!VERSION!" -.SH NAME -jackrec \- JACK toolkit client for recording audio -.SH SYNOPSIS -.B jackrec -\-f filename \-d seconds [ \-b bitdepth ] port1 [ port2 ... ] -.SH DESCRIPTION -.B jackrec is a basic, but useful, audio recorder that will record -audio from 1 or more JACK ports to a file on disk. The file format is -always RIFF/WAV, with samples stored as signed integers. The sample -bit depth can be selected using the \fI-b\fR option. The file will -have as many channels as there are ports specified on the command line -- each channel will contain the data recorded from one port. The user -should generally specify the duration (in seconds) using the \fI-d\fR -option. If not specified, jackrec will record until terminated by a -signal (eg. from Ctrl-c). -.PP -This application is not intended to be a heavy duty audio recorder, -and originated as an example client to show how to handle threading -and disk I/O in a JACK client. However, it is a useful, simple -recorder and is included in the JACK toolkit as a result. - - -- cgit v1.2.1