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 2013-05-15 19:12:55 +02:00 committed by Takashi Iwai
parent 48554fc28b
commit 093a371a27
5 changed files with 63 additions and 63 deletions

View file

@ -1,6 +1,6 @@
.TH ALSALOOP 1 "5 Aug 2010" .TH ALSALOOP 1 "5 Aug 2010"
.SH NAME .SH NAME
alsaloop \- command-line PCM loopback alsaloop \- command\-line PCM loopback
.SH SYNOPSIS .SH SYNOPSIS
\fBalsaloop\fP [\fI\-option\fP] [\fIcmd\fP] \fBalsaloop\fP [\fI\-option\fP] [\fIcmd\fP]
.SH DESCRIPTION .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 contains the command line options for one job. The '#' means comment and
rest of line is ignored. Example: rest of line is ignored. Example:
# First line - comment, second line - first job # First line \- comment, second line \- first job
-C hw:1,0 -P hw:0,0 -t 50000 -T 1 \-C hw:1,0 \-P hw:0,0 \-t 50000 \-T 1
# Third line - comment, fourth line - second job # Third line \- comment, fourth line \- second job
-C hw:1,1 -P hw:0,1 -t 40000 -T 2 \-C hw:1,1 \-P hw:0,1 \-t 40000 \-T 2
.TP .TP
\fI\-d\fP | \fI\-\-daemonize\fP \fI\-d\fP | \fI\-\-daemonize\fP
@ -70,7 +70,7 @@ Requested latency in usec (1/1000000sec).
.TP .TP
\fI\-f <format>\fP | \fI\-\-format=<format>\fP \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. Default format is S16_LE.
.TP .TP
@ -86,19 +86,19 @@ Rate specification. Default value is 48000 (Hz).
.TP .TP
\fI\-n\fP | \fI\-\-resample\fP \fI\-n\fP | \fI\-\-resample\fP
Allow rate resampling using alsa-lib. Allow rate resampling using alsa\-lib.
.TP .TP
\fI\-A <converter>\fP | \fI\-\-samplerate=<converter>\fP \fI\-A <converter>\fP | \fI\-\-samplerate=<converter>\fP
Use libsamplerate and choose a converter: Use libsamplerate and choose a converter:
0 or sincbest - best quality 0 or sincbest \- best quality
1 or sincmedium - medium quality 1 or sincmedium \- medium quality
2 or sincfastest - lowest quality 2 or sincfastest \- lowest quality
3 or zerohold - hold zero samples 3 or zerohold \- hold zero samples
4 or linear - worst quality - linear resampling 4 or linear \- worst quality - linear resampling
5 or auto - choose best method 5 or auto \- choose best method
.TP .TP
\fI\-B <size>\fP | \fI\-\-buffer=<size>\fP \fI\-B <size>\fP | \fI\-\-buffer=<size>\fP
@ -118,30 +118,30 @@ Duration of loop in seconds.
.TP .TP
\fI\-b\fP | \fI\-\-nblock\fP \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 .TP
\fI\-S <mode>\fP | \fI\-\-sync=<mode>\fP \fI\-S <mode>\fP | \fI\-\-sync=<mode>\fP
Sync mode specification for capture to playback stream: Sync mode specification for capture to playback stream:
0 or none - do not touch the stream 0 or none \- do not touch the stream
1 or simple - add or remove samples to keep 1 or simple \- add or remove samples to keep
both streams synchronized 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 (if supported) to compensate
the rate shift 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 (if supported) to compensate
the rate shift the rate shift
4 or samplerate - use samplerate library to do rate resampling 4 or samplerate \- use samplerate library to do rate resampling
5 or auto - automatically selects the best method 5 or auto \- automatically selects the best method
in this order: captshift, playshift, in this order: captshift, playshift,
samplerate, simple samplerate, simple
.TP .TP
\fI\-T <num>\fP | \fI\-\-thread=<num>\fP \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. thread numbers are run within one thread.
.TP .TP
@ -155,12 +155,12 @@ Redirect mixer control from the playback card to the capture card. Format of
Known attributes: Known attributes:
name - control ID name name \- control ID name
index - control ID index index \- control ID index
device - control ID device device \- control ID device
subdevice - control ID subdevice subdevice \- control ID subdevice
iface - control ID interface iface \- control ID interface
numid - control ID numid numid \- control ID numid
.TP .TP
\fI\-O <ossmixid>\fP | \fI\-\-ossmixer=<midid>\fP \fI\-O <ossmixid>\fP | \fI\-\-ossmixer=<midid>\fP

View file

@ -9,7 +9,7 @@ amidi \- read from and write to ALSA RawMIDI ports
.SH DESCRIPTION .SH DESCRIPTION
.B amidi .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. SysEx (system exclusive) data from/to external MIDI devices.
It can also send any other MIDI commands. 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 default rawmidi definitions
.br .br
.I /etc/asound.conf .I /etc/asound.conf
system-wide rawmidi definitions system\-wide rawmidi definitions
.br .br
.I ~/.asoundrc .I ~/.asoundrc
user specific rawmidi definitions user specific rawmidi definitions

View file

@ -4,7 +4,7 @@ amixer \- command-line mixer for ALSA soundcard driver
.SH SYNOPSIS .SH SYNOPSIS
\fBamixer\fP [\fI\-option\fP] [\fIcmd\fP] \fBamixer\fP [\fI\-option\fP] [\fIcmd\fP]
.SH DESCRIPTION .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. soundcard driver.
\fBamixer\fP supports multiple soundcards. \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> ... \fIset\fP or \fIsset\fP <\fISCONTROL\fP> <\fIPARAMETER\fP> ...
Sets the simple mixer control contents. The parameter can be the volume Sets the simple mixer control contents. The parameter can be the volume
either as a percentage from 0% to 100% with \fI%\fP suffix, 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 The dB gain can be used only for the mixer elements with available
dB information. dB information.
When plus(+) or minus(\-) letter is appended after 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 \fI\-s\fP | \fI\-\-stdin\fP
Read from stdin and execute the command on each line sequentially. 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. Only sset and cset are accepted. Other commands are ignored.
The commands to unmatched ids are ignored without errors too. 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 capture (recording).\fR
.TP .TP
\fBamixer \-c 1 \-\- sset Master playback -20dB\fR \fBamixer \-c 1 \-\- sset Master playback \-20dB\fR
will set the master volume of the second card to -20dB. If the master 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. has multiple channels, all channels are set to the same value.
.TP .TP

View file

@ -1,6 +1,6 @@
.TH APLAY 1 "1 January 2010" .TH APLAY 1 "1 January 2010"
.SH NAME .SH NAME
arecord, aplay \- command-line sound recorder and player for ALSA arecord, aplay \- command\-line sound recorder and player for ALSA
soundcard driver soundcard driver
.SH SYNOPSIS .SH SYNOPSIS
\fBarecord\fP [\fIflags\fP] [filename] \fBarecord\fP [\fIflags\fP] [filename]
@ -8,7 +8,7 @@ soundcard driver
\fBaplay\fP [\fIflags\fP] [filename [filename]] ... \fBaplay\fP [\fIflags\fP] [filename [filename]] ...
.SH DESCRIPTION .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 driver. It supports several file formats and multiple soundcards with
multiple devices. If recording with interleaved mode samples the file is multiple devices. If recording with interleaved mode samples the file is
automatically split before the 2GB filesize. 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. Min ticks to sleep. The default is not to sleep.
.TP .TP
\fI\-M, \-\-mmap\fP \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. If this option is not set, the read/write I/O mode will be used.
.TP .TP
\fI\-N, \-\-nonblock\fP \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. If this option is not set the program will block until the audio device is available again.
.TP .TP
\fI\-F, \-\-period\-time=#\fP \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. is given twice or three times.
.TP .TP
\fI\-V, \-\-vumeter=TYPE\fP \fI\-V, \-\-vumeter=TYPE\fP
Specifies the VU-meter type, either \fIstereo\fP or \fImono\fP. Specifies the VU\-meter type, either \fIstereo\fP or \fImono\fP.
The stereo VU-meter is available only for 2-channel stereo samples The stereo VU\-meter is available only for 2\-channel stereo samples
with interleaved format. with interleaved format.
.TP .TP
\fI\-I, \-\-separate\-channels\fP \fI\-I, \-\-separate\-channels\fP
@ -173,7 +173,7 @@ Expression for validation is: coef * (buffer_size / 2).
Minimum value is 1. Minimum value is 1.
.TP .TP
\fI\-\-test\-nowait\fP \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 .TP
\fI\-\-max\-file\-time\fP \fI\-\-max\-file\-time\fP
While recording, when the output file has been accumulating 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. send signals to it.
.TP .TP
\fI\-\-use\-strftime\fP \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 the strftime facility whenever the output file is opened. The
important strftime codes are: %Y is the year, %m month, %d day of 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 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 .TP
\fBaplay \-c 1 \-t raw \-r 22050 \-f mu_law foobar\fR \fBaplay \-c 1 \-t raw \-r 22050 \-f mu_law foobar\fR
will play the raw file "foobar" as a 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 .TP
\fBarecord \-d 10 \-f cd \-t wav \-D copy foobar.wav\fP \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: PCM "copy" (which might be defined in the user's .asoundrc file as:
.nf .nf
pcm.copy { pcm.copy {
@ -235,14 +235,14 @@ pcm.copy {
.fi .fi
.TP .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 Record from the default audio source in monaural, 8,000 samples
per second, 8 bits per sample. Start a new file every per second, 8 bits per sample. Start a new file every
30 seconds. File names are mon-nn.wav, where nn increases 30 seconds. File names are mon\-nn.wav, where nn increases
from 01. The file after mon-99.wav is mon-100.wav. from 01. The file after mon\-99.wav is mon\-100.wav.
.TP .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 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 every hour. The files are placed in directories based on their start dates
and have names which include their start times and file numbers. and have names which include their start times and file numbers.

View file

@ -11,26 +11,26 @@
. fi . fi
. PP . PP
.. ..
.TH SPEAKER\-TEST 1 "April 2nd, 2011" speaker-test .TH SPEAKER\-TEST 1 "April 2nd, 2011" speaker\-test
.SH NAME .SH NAME
speaker\-test \- command-line speaker test tone generator for ALSA speaker\-test \- command\-line speaker test tone generator for ALSA
.SH SYNOPSIS .SH SYNOPSIS
.B speaker\-test [\-options] .B speaker\-test [\-options]
.SH DESCRIPTION .SH DESCRIPTION
\fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer. \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 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 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 those cards. Notice that there might be for example, one device for
analog sound, one for digital sound and one for HDMI sound. 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: .P \fBaplay\fR's output will be similar to this one:
.nf .nf
$ aplay -L $ aplay \-L
null null
Discard all samples (playback) or generate zero samples (capture) Discard all samples (playback) or generate zero samples (capture)
default:CARD=ICH5 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, .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 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 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. 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: Produce stereo sound from one stereo jack:
.EX .EX
speaker-test -Dplug:front -c2 speaker\-test \-Dplug:front \-c2
.EE .EE
Produce 4 speaker sound from two stereo jacks: Produce 4 speaker sound from two stereo jacks:
.EX .EX
speaker-test -Dplug:surround40 -c4 speaker\-test \-Dplug:surround40 \-c4
.EE .EE
Produce 5.1 speaker sound from three stereo jacks: Produce 5.1 speaker sound from three stereo jacks:
.EX .EX
speaker-test -Dplug:surround51 -c6 speaker\-test \-Dplug:surround51 \-c6
.EE .EE
To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers: To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
.EX .EX
speaker-test -Dplug:surround51 -c6 -s1 -f75 speaker\-test \-Dplug:surround51 \-c6 \-s1 \-f75
.EE .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 .EX
speaker-test -Dplug:spdif -c2 speaker\-test \-Dplug:spdif \-c2
.EE .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 .EX
speaker-test -Dplug:front -c2 -mFR,FL speaker\-test \-Dplug:front \-c2 \-mFR,FL
.EE .EE
.SH SEE ALSO .SH SEE ALSO
.BR aplay(1) .BR aplay(1)
.SH AUTHOR .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. Pink noise support was added by Nathan Hurst.
Further extensions by Takashi Iwai. Further extensions by Takashi Iwai.