slackbuilds/audio/listener/listener.1

140 lines
3.2 KiB
Groff
Raw Normal View History

.\" Man page generated from reStructuredText.
.
.TH LISTENER 1 "2017-08-13" "2.2" "SlackBuilds.org"
.SH NAME
listener \- listen for sound and record it
.
.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
..
.\" RST source for listener(1) man page. Convert with:
.
.\" rst2man.py listener.rst > listener.1
.
.\" rst2man.py comes from the SBo development/docutils package.
.
.SH SYNOPSIS
.sp
listener [\fI\-options\fP]
.SH DESCRIPTION
.sp
Listener listens for sound. If it detects any, it starts recording
automatically and also automatically stops when things become silent
again.
.SH OPTIONS
.sp
Most options can be set in the config file.
.INDENT 0.0
.TP
.BI \-c\fB <configfile>
Config file to use (default is \fB/etc/listener.conf\fP).
.TP
.BI \-l\fB <detect_level>
Detect level.
.TP
.BI \-m\fB <min_duration>
Minimum duration to record (samples).
.TP
.BI \-b\fB <rec_silence>
How many seconds to keep recording after no sound is heard.
.TP
.BI \-x\fB <max_duration>
Maximum duration to record (seconds).
.TP
.BI \-S\fB <pars>
Sets the sample rate, number of channels, output file type, etc.
e.g.: \fB44100,1,wav\fP
or: \fB2,ima_adpcm,10khz\fP\&.
See below for a list of fileformats and subtypes.
.TP
.B \-F
Use a fixed amplification factor.
.TP
.B \-o
Exit after 1 recording.
.TP
.BI \-w\fB <wav_path>
Where to write outfile files.
.TP
.B \-p
Read from pipe (together with splitaudio).
.TP
.BI \-y\fB <command>
Script to call as soon as the recording starts.
.TP
.BI \-e\fB <command>
Script to call after recording.
.TP
.B \-f
Fork into the background.
.TP
.BI \-a\fB <pidfile>
File to write the pid in.
.TP
.B \-s
Be silent.
.TP
.B \-h
Print help text and exit.
.UNINDENT
.sp
Supported file formats: wav, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5, pvf, xi, htk, sds, avr, wavex, sd2, flac, caf, wve, ogg, mpc2k, rf64
.sp
Supported sub\-types: pcm_s8, pcms8, pcm8, pcm_16, pcm16, pcm_24, pcm24, pcm_32, pcm32, pcm_u8, pcmu8, float, double, ulaw, alaw, ima_adpcm, ms_adpcm, gsm610, vox_adpcm, g721_32, g723_24, g723_40, dwvw_12, dwvw_16, dwvw_24, dwvw_n, dpcm_8, dpcm_16, vorbis
.SH FILES
.sp
/etc/listener.conf The default config file (when \fB\-c\fP not used).
.\" ENVIRONMENT
.
.\" ===========
.
.\" EXIT STATUS
.
.\" ===========
.
.\" BUGS
.
.\" ====
.
.\" EXAMPLES
.
.\" ========
.
.SH COPYRIGHT
.sp
See the file /usr/doc/listener\-2.2/license.txt for license information.
.SH AUTHORS
.sp
listener was written by \fI\%folkert@vanheusden.com\fP\&.
.sp
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
.sp
The listener homepage: \fI\%https://www.vanheusden.com/listener/\fP
.\" Generated by docutils manpage writer.
.