mirror of
https://github.com/alsa-project/alsa-utils
synced 2024-11-08 16:28:22 +01:00
Several formatting fixes for manpages.
Fix many occurrences of unescaped “-”. Fix minor English issue. Signed-off-by: Jordi Mallach <jordi@debian.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Jordi Mallach
Takashi Iwai
parent
48554fc28b
commit
093a371a27
5 changed files with 63 additions and 63 deletions
|
|
@ -1,6 +1,6 @@
|
|||
.TH ALSALOOP 1 "5 Aug 2010"
|
||||
.SH NAME
|
||||
alsaloop \- command-line PCM loopback
|
||||
alsaloop \- command\-line PCM loopback
|
||||
.SH SYNOPSIS
|
||||
\fBalsaloop\fP [\fI\-option\fP] [\fIcmd\fP]
|
||||
.SH DESCRIPTION
|
||||
|
|
@ -27,10 +27,10 @@ Use given configuration file. The syntax of this file is simple: one line
|
|||
contains the command line options for one job. The '#' means comment and
|
||||
rest of line is ignored. Example:
|
||||
|
||||
# First line - comment, second line - first job
|
||||
-C hw:1,0 -P hw:0,0 -t 50000 -T 1
|
||||
# Third line - comment, fourth line - second job
|
||||
-C hw:1,1 -P hw:0,1 -t 40000 -T 2
|
||||
# First line \- comment, second line \- first job
|
||||
\-C hw:1,0 \-P hw:0,0 \-t 50000 \-T 1
|
||||
# Third line \- comment, fourth line \- second job
|
||||
\-C hw:1,1 \-P hw:0,1 \-t 40000 \-T 2
|
||||
|
||||
.TP
|
||||
\fI\-d\fP | \fI\-\-daemonize\fP
|
||||
|
|
@ -70,7 +70,7 @@ Requested latency in usec (1/1000000sec).
|
|||
.TP
|
||||
\fI\-f <format>\fP | \fI\-\-format=<format>\fP
|
||||
|
||||
Format specification (usually S16_LE S32_LE). Use -h to list all formats.
|
||||
Format specification (usually S16_LE S32_LE). Use \-h to list all formats.
|
||||
Default format is S16_LE.
|
||||
|
||||
.TP
|
||||
|
|
@ -86,19 +86,19 @@ Rate specification. Default value is 48000 (Hz).
|
|||
.TP
|
||||
\fI\-n\fP | \fI\-\-resample\fP
|
||||
|
||||
Allow rate resampling using alsa-lib.
|
||||
Allow rate resampling using alsa\-lib.
|
||||
|
||||
.TP
|
||||
\fI\-A <converter>\fP | \fI\-\-samplerate=<converter>\fP
|
||||
|
||||
Use libsamplerate and choose a converter:
|
||||
|
||||
0 or sincbest - best quality
|
||||
1 or sincmedium - medium quality
|
||||
2 or sincfastest - lowest quality
|
||||
3 or zerohold - hold zero samples
|
||||
4 or linear - worst quality - linear resampling
|
||||
5 or auto - choose best method
|
||||
0 or sincbest \- best quality
|
||||
1 or sincmedium \- medium quality
|
||||
2 or sincfastest \- lowest quality
|
||||
3 or zerohold \- hold zero samples
|
||||
4 or linear \- worst quality - linear resampling
|
||||
5 or auto \- choose best method
|
||||
|
||||
.TP
|
||||
\fI\-B <size>\fP | \fI\-\-buffer=<size>\fP
|
||||
|
|
@ -118,30 +118,30 @@ Duration of loop in seconds.
|
|||
.TP
|
||||
\fI\-b\fP | \fI\-\-nblock\fP
|
||||
|
||||
Non-block mode (very early process wakeup). Eats more CPU.
|
||||
Non\-block mode (very early process wakeup). Eats more CPU.
|
||||
|
||||
.TP
|
||||
\fI\-S <mode>\fP | \fI\-\-sync=<mode>\fP
|
||||
|
||||
Sync mode specification for capture to playback stream:
|
||||
0 or none - do not touch the stream
|
||||
1 or simple - add or remove samples to keep
|
||||
0 or none \- do not touch the stream
|
||||
1 or simple \- add or remove samples to keep
|
||||
both streams synchronized
|
||||
2 or captshift - use driver for the capture device
|
||||
2 or captshift \- use driver for the capture device
|
||||
(if supported) to compensate
|
||||
the rate shift
|
||||
3 or playshift - use driver for the playback device
|
||||
3 or playshift \- use driver for the playback device
|
||||
(if supported) to compensate
|
||||
the rate shift
|
||||
4 or samplerate - use samplerate library to do rate resampling
|
||||
5 or auto - automatically selects the best method
|
||||
4 or samplerate \- use samplerate library to do rate resampling
|
||||
5 or auto \- automatically selects the best method
|
||||
in this order: captshift, playshift,
|
||||
samplerate, simple
|
||||
|
||||
.TP
|
||||
\fI\-T <num>\fP | \fI\-\-thread=<num>\fP
|
||||
|
||||
Thread number (-1 means create a unique thread). All jobs with same
|
||||
Thread number (\-1 means create a unique thread). All jobs with same
|
||||
thread numbers are run within one thread.
|
||||
|
||||
.TP
|
||||
|
|
@ -155,12 +155,12 @@ Redirect mixer control from the playback card to the capture card. Format of
|
|||
|
||||
Known attributes:
|
||||
|
||||
name - control ID name
|
||||
index - control ID index
|
||||
device - control ID device
|
||||
subdevice - control ID subdevice
|
||||
iface - control ID interface
|
||||
numid - control ID numid
|
||||
name \- control ID name
|
||||
index \- control ID index
|
||||
device \- control ID device
|
||||
subdevice \- control ID subdevice
|
||||
iface \- control ID interface
|
||||
numid \- control ID numid
|
||||
|
||||
.TP
|
||||
\fI\-O <ossmixid>\fP | \fI\-\-ossmixer=<midid>\fP
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ amidi \- read from and write to ALSA RawMIDI ports
|
|||
|
||||
.SH DESCRIPTION
|
||||
.B amidi
|
||||
is a command-line utility which allows to receive and send
|
||||
is a command-line utility which allows one to receive and send
|
||||
SysEx (system exclusive) data from/to external MIDI devices.
|
||||
It can also send any other MIDI commands.
|
||||
|
||||
|
|
@ -141,7 +141,7 @@ creates a virtual RawMIDI port and prints all data sent to this port.
|
|||
default rawmidi definitions
|
||||
.br
|
||||
.I /etc/asound.conf
|
||||
system-wide rawmidi definitions
|
||||
system\-wide rawmidi definitions
|
||||
.br
|
||||
.I ~/.asoundrc
|
||||
user specific rawmidi definitions
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ amixer \- command-line mixer for ALSA soundcard driver
|
|||
.SH SYNOPSIS
|
||||
\fBamixer\fP [\fI\-option\fP] [\fIcmd\fP]
|
||||
.SH DESCRIPTION
|
||||
\fBamixer\fP allows command-line control of the mixer for the ALSA
|
||||
\fBamixer\fP allows command\-line control of the mixer for the ALSA
|
||||
soundcard driver.
|
||||
\fBamixer\fP supports multiple soundcards.
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ Shows a complete list of simple mixer controls with their contents.
|
|||
\fIset\fP or \fIsset\fP <\fISCONTROL\fP> <\fIPARAMETER\fP> ...
|
||||
Sets the simple mixer control contents. The parameter can be the volume
|
||||
either as a percentage from 0% to 100% with \fI%\fP suffix,
|
||||
a dB gain with \fIdB\fP suffix (like -12.5dB), or an exact hardware value.
|
||||
a dB gain with \fIdB\fP suffix (like \-12.5dB), or an exact hardware value.
|
||||
The dB gain can be used only for the mixer elements with available
|
||||
dB information.
|
||||
When plus(+) or minus(\-) letter is appended after
|
||||
|
|
@ -96,7 +96,7 @@ Select the device name to control. The default control name is 'default'.
|
|||
\fI\-s\fP | \fI\-\-stdin\fP
|
||||
|
||||
Read from stdin and execute the command on each line sequentially.
|
||||
When this option is given, the command in command-line arguments is ignored.
|
||||
When this option is given, the command in command\-line arguments is ignored.
|
||||
|
||||
Only sset and cset are accepted. Other commands are ignored.
|
||||
The commands to unmatched ids are ignored without errors too.
|
||||
|
|
@ -128,8 +128,8 @@ right line input to 40%, unmute it, and select it as a source for
|
|||
capture (recording).\fR
|
||||
|
||||
.TP
|
||||
\fBamixer \-c 1 \-\- sset Master playback -20dB\fR
|
||||
will set the master volume of the second card to -20dB. If the master
|
||||
\fBamixer \-c 1 \-\- sset Master playback \-20dB\fR
|
||||
will set the master volume of the second card to \-20dB. If the master
|
||||
has multiple channels, all channels are set to the same value.
|
||||
|
||||
.TP
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.TH APLAY 1 "1 January 2010"
|
||||
.SH NAME
|
||||
arecord, aplay \- command-line sound recorder and player for ALSA
|
||||
arecord, aplay \- command\-line sound recorder and player for ALSA
|
||||
soundcard driver
|
||||
.SH SYNOPSIS
|
||||
\fBarecord\fP [\fIflags\fP] [filename]
|
||||
|
|
@ -8,7 +8,7 @@ soundcard driver
|
|||
\fBaplay\fP [\fIflags\fP] [filename [filename]] ...
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fBarecord\fP is a command-line soundfile recorder for the ALSA soundcard
|
||||
\fBarecord\fP is a command\-line soundfile recorder for the ALSA soundcard
|
||||
driver. It supports several file formats and multiple soundcards with
|
||||
multiple devices. If recording with interleaved mode samples the file is
|
||||
automatically split before the 2GB filesize.
|
||||
|
|
@ -81,11 +81,11 @@ The default is zero, so if this option is omitted then the arecord process will
|
|||
Min ticks to sleep. The default is not to sleep.
|
||||
.TP
|
||||
\fI\-M, \-\-mmap\fP
|
||||
Use memory-mapped (mmap) I/O mode for the audio stream.
|
||||
Use memory\-mapped (mmap) I/O mode for the audio stream.
|
||||
If this option is not set, the read/write I/O mode will be used.
|
||||
.TP
|
||||
\fI\-N, \-\-nonblock\fP
|
||||
Open the audio device in non-blocking mode. If the device is busy the program will exit immediately.
|
||||
Open the audio device in non\-blocking mode. If the device is busy the program will exit immediately.
|
||||
If this option is not set the program will block until the audio device is available again.
|
||||
.TP
|
||||
\fI\-F, \-\-period\-time=#\fP
|
||||
|
|
@ -120,8 +120,8 @@ This option is accumulative. The VU meter is displayed when this
|
|||
is given twice or three times.
|
||||
.TP
|
||||
\fI\-V, \-\-vumeter=TYPE\fP
|
||||
Specifies the VU-meter type, either \fIstereo\fP or \fImono\fP.
|
||||
The stereo VU-meter is available only for 2-channel stereo samples
|
||||
Specifies the VU\-meter type, either \fIstereo\fP or \fImono\fP.
|
||||
The stereo VU\-meter is available only for 2\-channel stereo samples
|
||||
with interleaved format.
|
||||
.TP
|
||||
\fI\-I, \-\-separate\-channels\fP
|
||||
|
|
@ -173,7 +173,7 @@ Expression for validation is: coef * (buffer_size / 2).
|
|||
Minimum value is 1.
|
||||
.TP
|
||||
\fI\-\-test\-nowait\fP
|
||||
Do not wait for the ring buffer--eats the whole CPU.
|
||||
Do not wait for the ring buffer \(hy eats the whole CPU.
|
||||
.TP
|
||||
\fI\-\-max\-file\-time\fP
|
||||
While recording, when the output file has been accumulating
|
||||
|
|
@ -188,7 +188,7 @@ aplay writes its process ID here, so other programs can
|
|||
send signals to it.
|
||||
.TP
|
||||
\fI\-\-use\-strftime\fP
|
||||
When recording, interpret %-codes in the file name parameter using
|
||||
When recording, interpret %\-codes in the file name parameter using
|
||||
the strftime facility whenever the output file is opened. The
|
||||
important strftime codes are: %Y is the year, %m month, %d day of
|
||||
the month, %H hour, %M minute and %S second. In addition, %v is
|
||||
|
|
@ -218,11 +218,11 @@ and continue recording. However, SIGUSR1 does not work with
|
|||
.TP
|
||||
\fBaplay \-c 1 \-t raw \-r 22050 \-f mu_law foobar\fR
|
||||
will play the raw file "foobar" as a
|
||||
22050-Hz, mono, 8-bit, Mu-Law .au file.
|
||||
22050\-Hz, mono, 8\-bit, Mu\-Law .au file.
|
||||
|
||||
.TP
|
||||
\fBarecord \-d 10 \-f cd \-t wav \-D copy foobar.wav\fP
|
||||
will record foobar.wav as a 10-second, CD-quality wave file, using the
|
||||
will record foobar.wav as a 10\-second, CD\-quality wave file, using the
|
||||
PCM "copy" (which might be defined in the user's .asoundrc file as:
|
||||
.nf
|
||||
pcm.copy {
|
||||
|
|
@ -235,14 +235,14 @@ pcm.copy {
|
|||
.fi
|
||||
|
||||
.TP
|
||||
\fBarecord \-t wav \-\-max-file-time 30 mon.wav\fP
|
||||
\fBarecord \-t wav \-\-max\-file\-time 30 mon.wav\fP
|
||||
Record from the default audio source in monaural, 8,000 samples
|
||||
per second, 8 bits per sample. Start a new file every
|
||||
30 seconds. File names are mon-nn.wav, where nn increases
|
||||
from 01. The file after mon-99.wav is mon-100.wav.
|
||||
30 seconds. File names are mon\-nn.wav, where nn increases
|
||||
from 01. The file after mon\-99.wav is mon\-100.wav.
|
||||
|
||||
.TP
|
||||
\fBarecord \-f cd \-t wav \-\-max-file-time 3600 --use-strftime %Y/%m/%d/listen-%H-%M-%v.wav\fP
|
||||
\fBarecord \-f cd \-t wav \-\-max\-file\-time 3600 \-\-use-strftime %Y/%m/%d/listen-%H-%M-%v.wav\fP
|
||||
Record in stereo from the default audio source. Create a new file
|
||||
every hour. The files are placed in directories based on their start dates
|
||||
and have names which include their start times and file numbers.
|
||||
|
|
|
|||
|
|
@ -11,26 +11,26 @@
|
|||
. fi
|
||||
. PP
|
||||
..
|
||||
.TH SPEAKER\-TEST 1 "April 2nd, 2011" speaker-test
|
||||
.TH SPEAKER\-TEST 1 "April 2nd, 2011" speaker\-test
|
||||
.SH NAME
|
||||
speaker\-test \- command-line speaker test tone generator for ALSA
|
||||
speaker\-test \- command\-line speaker test tone generator for ALSA
|
||||
.SH SYNOPSIS
|
||||
.B speaker\-test [\-options]
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
|
||||
|
||||
\fBspeaker-test\fP by default will test the \fIdefault\fP device. If you
|
||||
\fBspeaker\-test\fP by default will test the \fIdefault\fP device. If you
|
||||
want to test another sound device you will have first to get a list of
|
||||
all of the sound cards in your system and the devices associated with
|
||||
those cards. Notice that there might be for example, one device for
|
||||
analog sound, one for digital sound and one for HDMI sound.
|
||||
To get the list of available cards and devices you can run \fBaplay -L\fR.
|
||||
To get the list of available cards and devices you can run \fBaplay \-L\fR.
|
||||
|
||||
.P \fBaplay\fR's output will be similar to this one:
|
||||
|
||||
.nf
|
||||
$ aplay -L
|
||||
$ aplay \-L
|
||||
null
|
||||
Discard all samples (playback) or generate zero samples (capture)
|
||||
default:CARD=ICH5
|
||||
|
|
@ -48,7 +48,7 @@ surround40:CARD=ICH5,DEV=0
|
|||
.P Each of the devices is listed in the beginning of the definition so,
|
||||
in the above example, there are four devices listed: null, default, front
|
||||
and surround40. So, if you want to test the last device you can
|
||||
run \fBspeaker-test -Dsurround40:ICH5 -c 6\fR. The \fB-c\fR option will
|
||||
run \fBspeaker\-test \-Dsurround40:ICH5 \-c 6\fR. The \fB\-c\fR option will
|
||||
indicate that the six audio channels in the device have to be tested.
|
||||
|
||||
|
||||
|
|
@ -141,38 +141,38 @@ required, pass the channel position strings to this option.
|
|||
|
||||
Produce stereo sound from one stereo jack:
|
||||
.EX
|
||||
speaker-test -Dplug:front -c2
|
||||
speaker\-test \-Dplug:front \-c2
|
||||
.EE
|
||||
|
||||
Produce 4 speaker sound from two stereo jacks:
|
||||
.EX
|
||||
speaker-test -Dplug:surround40 -c4
|
||||
speaker\-test \-Dplug:surround40 \-c4
|
||||
.EE
|
||||
|
||||
Produce 5.1 speaker sound from three stereo jacks:
|
||||
.EX
|
||||
speaker-test -Dplug:surround51 -c6
|
||||
speaker\-test \-Dplug:surround51 \-c6
|
||||
.EE
|
||||
|
||||
To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
|
||||
.EX
|
||||
speaker-test -Dplug:surround51 -c6 -s1 -f75
|
||||
speaker\-test \-Dplug:surround51 \-c6 \-s1 \-f75
|
||||
.EE
|
||||
|
||||
To do a 2-speaker test using the spdif (coax or optical) output:
|
||||
To do a 2\-speaker test using the spdif (coax or optical) output:
|
||||
.EX
|
||||
speaker-test -Dplug:spdif -c2
|
||||
speaker\-test \-Dplug:spdif \-c2
|
||||
.EE
|
||||
|
||||
Play in the order of front-right and front-left from the front PCM
|
||||
Play in the order of front\-right and front-left from the front PCM
|
||||
.EX
|
||||
speaker-test -Dplug:front -c2 -mFR,FL
|
||||
speaker\-test \-Dplug:front \-c2 \-mFR,FL
|
||||
.EE
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR aplay(1)
|
||||
|
||||
.SH AUTHOR
|
||||
The speaker-test program was written by James Courtier-Dutton.
|
||||
The speaker\-test program was written by James Courtier-Dutton.
|
||||
Pink noise support was added by Nathan Hurst.
|
||||
Further extensions by Takashi Iwai.
|
||||
|
|
|
|||
Loading…
Reference in a new issue