summaryrefslogtreecommitdiffstats
path: root/audio/japa/japa.1
diff options
context:
space:
mode:
Diffstat (limited to 'audio/japa/japa.1')
-rw-r--r--audio/japa/japa.1179
1 files changed, 114 insertions, 65 deletions
diff --git a/audio/japa/japa.1 b/audio/japa/japa.1
index 0a907f4311..a2610d1ab2 100644
--- a/audio/japa/japa.1
+++ b/audio/japa/japa.1
@@ -1,80 +1,129 @@
-.TH JAPA 1 "January 14, 2014"
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "JAPA" 1 "2021-11-29" "0.9.2" "SlackBuilds.org"
.SH NAME
-japa \- JACK or ALSA perceptual analyser
+japa \- JACK and ALSA Audio Analyser
+.\" RST source for japa(1) man page. Convert with:
+.
+.\" rst2man.py japa.rst > japa.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
.SH SYNOPSIS
-.B japa
-.RI { -h | -A | -J }
-.RI [ options ]
-.br
+.sp
+japa \fB\-J\fP [\fB\-name\fP \fIname\fP ] [\fB\-s\fP \fIserver\fP]
+.sp
+japa \fB\-A\fP [\fB\-name\fP \fIname\fP ] [\fB\-d\fP \fIdevice\fP] [\fB\-C\fP \fIdevice\fP ] [\fB\-P\fP \fIdevice\fP ] [\fB\-r\fP \fIrate\fP] [\fB\-p\fP \fIperiod\fP] [\fB\-n\fP \fInfrags\fP]
.SH DESCRIPTION
-.B Japa
-(JACK and ALSA Perceptual Analyser), is a 'perceptual' or 'psychoacoustic'
-audio spectrum analyser. Possible uses include spectrum monitoring while mixing
-or mastering, evaluation of ambient noise, and (using pink noise), equalisation
-of PA systems. For more information see /usr/doc/japa-@VERSION@/README.
+.sp
+japa (JACK and ALSA Perceptual Analyser), is a \(aqperceptual\(aq
+or \(aqpsychoacoustic\(aq audio spectrum analyser. In contrast to
+JAAA, this is more an acoustical or musical tool than a purely
+technical one. Possible uses include spectrum monitoring while
+mixing or mastering, evaluation of ambient noise, and (using
+pink noise), equalisation of PA systems. For more information see
+/usr/doc/japa\-0.9.2/README.
+.sp
+In JACK mode (\fB\-J\fP), japa creates 4 input ports (for spectrum
+analysis), named \fIjapa:in_<N>\fP (where \fI<N>\fP ranges 1 to 4) and
+2 output ports (for noise generation), named \fIjapa:pink\fP and
+\fIjapa:white\fP\&. By default, these aren\(aqt connected to anything; use
+e.g. \fBqjackctl\fP(1) or \fBjack_connect\fP(1) to connect to other JACK
+clients.
+.sp
+In ALSA mode, the inputs and outputs are connected directly to the
+ALSA device, meaning e.g. there will be 2 inputs and 2 outputs for
+a typical stereo audio card. Yes, this means the pink and white
+noise generators will be heard immediately on starting up japa;
+if you don\(aqt need them you can silence them with e.g. \fB\-C hw:0 \-P
+null\fP\&. If you get "Can\(aqt connect to ALSA", try a different device
+(use \fBalsamixer\fP(1) or \fBaplay\fP(1) to get a list of them).
.SH OPTIONS
-One out of
-.B \-A
-and
-.B \-J
-must be given.
+.sp
+Either \fB\-J\fP or \fB\-A\fP is required.
+.INDENT 0.0
.TP
-.B \-h
-Show summary of options.
+.B \fB\-h\fP
+Show built\-in help message.
.TP
-.B \-J
-Use JACK.
+.B \fB\-name\fP \fIname\fP
+Set X11 client name (and JACK client name, with \fB\-J\fP).
.TP
-.B \-s <server>
-Select JACK server. Default is 'default' or $JACK_DEFAULT_SERVER environment variable.
-Only valid with
-.B \-J
-option.
+.B \fB\-J\fP
+Use JACK for audio. This option is available in JACK mode:
+.INDENT 7.0
.TP
-.B \-A
-Use ALSA. Options
-.B \-d
-,
-.B \-C
-,
-.B \-P
-,
-.B \-r
-,
-.B \-p
-, and
-.B \-n
-are only valid with this option.
+.B \fB\-s\fP \fIserver\fP
+Connect to a specific JACK server. Default is \(aqdefault\(aq or
+\fB$JACK_DEFAULT_SERVER\fP environment variable.
+.UNINDENT
.TP
-.B \-d <device>
-Specify ALSA device. Defaults to hw:0.0. This option sets the
-playback and capture devices to the same device. For separate capture and playback,
-use
-.B \-C
-and
-.B \-P
-instead.
+.B \fB\-A\fP
+Use ALSA for audio. These options are available in ALSA mode:
+.INDENT 7.0
.TP
-.B \-C <device>
-Specify alsa capture device.
+.B \fB\-d\fP \fIdevice\fP
+ALSA device for capture and playback. This option sets the
+playback and capture devices to the same device. For separate
+capture and playback, use the \fB\-C\fP and \fB\-P\fP options.
+Default: \fBhw:0\fP unless \fB\-C\fP or \fB\-P\fP is used.
.TP
-.B \-P <device>
-Specify alsa playback device.
+.B \fB\-C\fP \fIdevice\fP
+ALSA device for capture. Default: not used.
.TP
-.B \-r <rate>
-Specify sample frequency. Defaults to 48000.
+.B \fB\-P\fP \fIdevice\fP
+ALSA device for playback. Default: not used.
.TP
-.B \-p <period>
-Specify period size. Defaults to 1024.
+.B \fB\-r\fP \fIrate\fP
+Sample frequency. Default: 48000.
.TP
-.B \-n <nfrags>
-Specify number of fragments. Defaults to 2.
+.B \fB\-p\fP \fIperiod\fP
+Period size. Default: 1024.
+.TP
+.B \fB\-n\fP \fInfrags\fP
+Number of fragments. Default: 2.
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+.sp
+See the file /usr/doc/japa\-0.9.2/COPYING for license information.
+.SH AUTHORS
+.sp
+japa was written by Fons Adriaensen <\fI\%fons@kokkinizita.net\fP>.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
-.BR jackd (1).
-.SH AUTHOR
-japa was written by Fons Adriaensen <fons@kokkinizita.net>.
-.PP
-This manual page was written by Helmut Grohne <helmut@subdivi.de>,
-for the Debian project (but may be used by others). It was modified
-by B. Watson <yalhcry@gmail.com) for the SlackBuilds.org project,
-and may still be used by others.
+.sp
+\fBjackd\fP(1), \fBjaaa\fP(1)
+.sp
+\fI\%https://kokkinizita.linuxaudio.org/linuxaudio/\fP
+.\" Generated by docutils manpage writer.
+.