[Pkg-alsa-devel] Bug#971931: speaker-test.1: fix some formatting issues
Bjarni Ingi Gislason
bjarniig at rhi.hi.is
Sat Oct 10 00:39:54 BST 2020
Package: alsa-utils
Version: 1.2.3-1
Severity: minor
Tags: patch
Dear Maintainer,
Summary:
Fix warnings from "mandoc -T lint".
Fix warnings from test-groff.
Change <number>[\]-<number> to <number>\(en<number> if it is
a numeric range (use an en-dash for ranges).
Begin a sentence on a new line.
Split long lines (> 80).
Separate a unit from its number with a no-break space (\ ).
Change " - " to an en-dash, " \(en "; see style guides.
###
Input file is speaker-test.1
Output from "mandoc -T lint speaker-test.1"
mandoc: speaker-test.1:14:21: WARNING: cannot parse date, using it verbatim: April 2nd, 2011
mandoc: speaker-test.1:30:2: ERROR: skipping all arguments: PP \fBaplay\fR's ...
mandoc: speaker-test.1:31:1: WARNING: skipping paragraph macro: sp after PP
mandoc: speaker-test.1:48:2: ERROR: skipping all arguments: PP Each ...
#######
chk_man: Next line: execute doclifter -w -v speaker-test.1
speaker-test.1 uses man macros...
"speaker-test.1": warning - portability warning: nonportable requests 'end' seen.
#######
Input file is speaker-test.1, case 1
Test nr. 2:
Enable and fix warnings from 'test-groff'.
[ "test-groff" is a developmental version of "groff" ]
Input file is ./speaker-test.1
Output from test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -rIN=4m -t -w w -z :
<speaker-test.1>:177 (macro BR): only 1 argument, but more are expected
####
#####
Input file is speaker-test.1, case 1
Test nr. 5:
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
speaker-test.1:142:Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
#####
Input file is speaker-test.1, case 1
Test nr. 36:
Wrong distance between sentences.
a) Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) and "info groff".
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
23:\fBspeaker\-test\fP by default will test the \fIdefault\fP device. If you
26:those cards. Notice that there might be for example, one device for
50:and surround40. So, if you want to test the last device you can
51:run \fBspeaker\-test \-Dsurround40:ICH5 \-c 6\fR. The \fB\-c\fR option will
142:Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
#####
Input file is speaker-test.1, case 1
Test nr. 37:
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
speaker-test.1: line 21 length 89
\fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
speaker-test.1: line 100 length 177
Pink noise is perceptually uniform noise -- that is, it sounds like every frequency at once. If you can hear any tone it may indicate resonances in your speaker system or room.
speaker-test.1: line 104 length 94
\fB\-t wav\fP means to play WAV files, either pre-defined files or given via \fB\-w\fP option.
speaker-test.1: line 113 length 91
When \fB\-s\fP option below with a valid channel is given, \fBspeaker\-test\fP will perform
speaker-test.1: line 118 length 87
Do a single-shot speaker test for the given channel. The channel number starts from 1.
speaker-test.1: line 119 length 82
The channel number corresponds to left, right, rear-left, rear-right, center, LFE,
speaker-test.1: line 122 length 92
For example, when 1 is passed, it tests the left channel only once rather than both channels
speaker-test.1: line 142 length 107
Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
speaker-test.1: line 161 length 93
To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
#####
Input file is speaker-test.1, case 1
Test nr. 54:
Use the name of units in text, symbols in tables and calculations
142:Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
161:To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
#####
Input file is speaker-test.1, case 1
Test nr. 63:
Name of a manual is set in bold, the section in roman.
177:.BR aplay(1)
#####
Patch:
--- speaker-test.1 2020-08-20 19:03:08.000000000 +0000
+++ speaker-test.1.new 2020-10-09 23:31:21.000000000 +0000
@@ -18,17 +18,23 @@ speaker\-test \- command\-line speaker t
.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
-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.
+\fBspeaker\-test\fP generates a tone that can be used to test the
+speakers of a computer.
-.P \fBaplay\fR's output will be similar to this one:
+\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
+.BR "aplay \-L" .
+.P
+\fBaplay\fR's output will be similar to this one:
.nf
$ aplay \-L
null
@@ -45,15 +51,15 @@ surround40:CARD=ICH5,DEV=0
(...)
.fi
-.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
-indicate that the six audio channels in the device have to be tested.
-
-
-
-
+.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 indicate
+that the six audio channels in the device have to be tested.
.SH OPTIONS
@@ -97,11 +103,16 @@ stream of \fIRATE\fP Hz
\fB\-t\fP | \fB\-\-test\fP \fBpink\fP|\fBsine\fP|\fBwav\fP
\fB\-t pink\fP means use pink noise (default).
-Pink noise is perceptually uniform noise -- that is, it sounds like every frequency at once. If you can hear any tone it may indicate resonances in your speaker system or room.
+Pink noise is perceptually uniform noise \(en that is,
+it sounds like every frequency at once.
+If you can hear any tone it may indicate resonances in your speaker
+system or room.
\fB\-t sine\fP means to use sine wave.
-\fB\-t wav\fP means to play WAV files, either pre-defined files or given via \fB\-w\fP option.
+\fB\-t wav\fP means to play WAV files,
+either pre-defined files or
+given via \fB\-w\fP option.
You can pass the number from 1 to 3 as a backward compatibility.
@@ -110,17 +121,26 @@ You can pass the number from 1 to 3 as a
Specifies the number of loops. Zero means to run infinitely.
-When \fB\-s\fP option below with a valid channel is given, \fBspeaker\-test\fP will perform
-always a single-shot without looping.
+When \fB\-s\fP option below with a valid channel is given,
+\fBspeaker\-test\fP will perform always a single-shot without looping.
.TP
\fB\-s\fP | \fB\-\-speaker\fP \fICHANNEL\fP
-Do a single-shot speaker test for the given channel. The channel number starts from 1.
-The channel number corresponds to left, right, rear-left, rear-right, center, LFE,
-side-left, side-right, and so on.
+Do a single-shot speaker test for the given channel.
+The channel number starts from 1.
+The channel number corresponds to left,
+right,
+rear-left,
+rear-right,
+center,
+LFE,
+side-left,
+side-right,
+and so on.
-For example, when 1 is passed, it tests the left channel only once rather than both channels
-with looping.
+For example, when 1 is passed,
+it tests the left channel only once rather than both channels with
+looping.
.TP
\fB\-w\fP | \fB\-\-wavfile\fP \fIFILE\fP
@@ -139,7 +159,8 @@ required, pass the channel position stri
.TP
\fB\-X\fP | \fB\-\-force-frequency\fP
-Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
+Allow supplied \fIFREQ\fP to be outside the default range of 30\(en8000\ Hz.
+A minimum of 1\ Hz is still enforced.
.SH USAGE EXAMPLES
@@ -158,7 +179,8 @@ Produce 5.1 speaker sound from three ste
speaker\-test \-Dplug:surround51 \-c6
.EE
-To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
+To send a nice low 75\ Hz tone to the Woofer and
+then exit without touching any other speakers:
.EX
speaker\-test \-Dplug:surround51 \-c6 \-s1 \-f75
.EE
@@ -174,7 +196,7 @@ Play in the order of front\-right and fr
.EE
.SH SEE ALSO
-.BR aplay(1)
+.BR aplay (1)
.SH AUTHOR
The speaker\-test program was written by James Courtier-Dutton.
-- System Information:
Debian Release: bullseye/sid
APT prefers testing
APT policy: (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 5.8.10-1 (SMP w/2 CPU threads)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages alsa-utils depends on:
ii kmod 27+20200310-2
ii libasound2 1.2.3.2-1
ii libatopology2 1.2.3.2-1
ii libc6 2.31-3
ii libfftw3-single3 3.3.8-2
ii libncursesw6 6.2+20200918-1
ii libsamplerate0 0.1.9-2
ii libtinfo6 6.2+20200918-1
ii lsb-base 11.1.0
alsa-utils recommends no packages.
Versions of packages alsa-utils suggests:
pn dialog <none>
-- no debconf information
--
Bjarni I. Gislason
More information about the Pkg-alsa-devel
mailing list