From 8510e4a75a36095166fee7e3958d7995559b7722 Mon Sep 17 00:00:00 2001 From: paul Date: Fri, 5 Dec 2008 15:33:40 +0000 Subject: [PATCH] more man page write-ups git-svn-id: svn+ssh://jackaudio.org/trunk/jack@3180 0c269be4-1314-0410-8aa9-9f06e86f4224 --- man/alsa_in.0 | 2 +- man/jack_lsp.0 | 52 +++++++++++++++++++++++++++++++++++++++--------- man/jack_metro.0 | 48 +++++++++++++++++++++++++++++++------------- man/jackrec.0 | 19 +++++++++++++++--- 4 files changed, 94 insertions(+), 27 deletions(-) diff --git a/man/alsa_in.0 b/man/alsa_in.0 index c7abbbc..8841b1d 100644 --- a/man/alsa_in.0 +++ b/man/alsa_in.0 @@ -1,7 +1,7 @@ .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 SYNOPSYS +.SH SYNOPSIS \fBalsa_in\fR [\fIoptions\fR] .br \fBalsa_out\fR [\fIoptions\fR] diff --git a/man/jack_lsp.0 b/man/jack_lsp.0 index 94fec5f..d1c4781 100644 --- a/man/jack_lsp.0 +++ b/man/jack_lsp.0 @@ -1,13 +1,47 @@ .TH JACK_LSP "1" "!DATE!" "!VERSION!" .SH NAME -jack_lsp \- The JACK Audio Connection Kit example client -.SH SYNOPSYS -.B jack_lsp +jack_lsp \- JACK toolkit client to list informtion on ports +.SH SYNOPSIS +\fBjack_lsp\fR [ \fI-s\fR | \fI--server\fR servername ] [ \fI-AclLptvh\fR ] .SH DESCRIPTION -.B jack_lsp -lists all JACK ports. -.SH AUTHOR -Paul Davis -.PP -This manpage was written by Stefan Schwandter +\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-L\fR, \fI--latency\fR +.br +Display total 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-h\fR, \fB--help\fR +.br +Display help/usage message +.TP +\fB-v\fR, \fB--version\fR +.br +Output version information and exit\n + diff --git a/man/jack_metro.0 b/man/jack_metro.0 index 31ca8d2..02d15e1 100644 --- a/man/jack_metro.0 +++ b/man/jack_metro.0 @@ -1,20 +1,40 @@ .TH JACK_METRO "1" "!DATE!" "!VERSION!" .SH NAME -jack_metro \- The JACK Audio Connection Kit example client -.SH SYNOPSYS -.B jack_metro -[ --frequency OR -f frequency (in Hz) ] -[ --amplitude OR -A maximum amplitude (between 0 and 1) ] -[ --duration OR -D duration (in ms) ] -[ --attack OR -a attack (in percent of duration) ] -[ --decay OR -d decay (in percent of duration) ] -[ --name OR -n jack name for metronome client ] ---bpm OR -b beats per minute +jack_metro \- JACK toolkit metronome +.SH SYNOPSIS +\fBjack_metro\fR [ \fI-n\fR name ] [ \fI-f\R hz ] [ \fI-D\fR msecs ] [\fI-a\fR % ] [ \fI-d\fR % ] \fI-b\fR bpm .SH DESCRIPTION -.B jack_metro -is a simple metronome for JACK. +\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 -.PP -This manpage was written by Stefan Schwandter diff --git a/man/jackrec.0 b/man/jackrec.0 index 01a8489..0e8b5d4 100644 --- a/man/jackrec.0 +++ b/man/jackrec.0 @@ -1,10 +1,23 @@ .TH JACKREC "1" "!DATE!" "!VERSION!" .SH NAME -jackrec \- The JACK Audio Connection Kit example client +jackrec \- JACK toolkit client for recording audio .SH SYNOPSYS .B jackrec --f filename [ -d second ] [ -b bitdepth ] port1 [ port2 ... ] +-f filename -d seconds [ -b bitdepth ] port1 [ port2 ... ] .SH DESCRIPTION -.B jackrec +.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.