#1038855 speaker-test.1: Some remarks and editing fixes for the manual

Package:
alsa-utils
Source:
alsa-utils
Description:
Utilities for configuring and using ALSA
Submitter:
Bjarni Ingi Gislason
Date:
2023-06-22 00:00:05 UTC
Severity:
normal
Tags:
#1038855#5
Date:
2023-06-21 23:28:52 UTC
From:
To:
Dear Maintainer,

here are some notes and fixes for the manual.

Input file is speaker-test.1

Output from "mandoc -T lint speaker-test.1":

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 ...
mandoc: speaker-test.1:100:177: STYLE: input text line longer than 80 bytes: Pink noise is percep...
mandoc: speaker-test.1:113:91: STYLE: input text line longer than 80 bytes: When \fB\-s\fP optio...
mandoc: speaker-test.1:118:87: STYLE: input text line longer than 80 bytes: Do a single-shot spe...
mandoc: speaker-test.1:119:82: STYLE: input text line longer than 80 bytes: The channel number c...
mandoc: speaker-test.1:122:92: STYLE: input text line longer than 80 bytes: For example, when 1 ...
mandoc: speaker-test.1:142:107: STYLE: input text line longer than 80 bytes: Allow supplied \fIFR...
mandoc: speaker-test.1:161:93: STYLE: input text line longer than 80 bytes: To send a nice low 7...

#######

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.

#####

Change two HYPHEN-MINUSES (code 0x055, 2D) to an em-dash (\(em), if one
is intended.  An en-dash is usually surrounded by a space, while an em-dash
is used without spaces. "man" (1 byte characters) transforms an en-dash
(\(en ) to one HYPHEN-MINUS, and an em-dash to two HYPHEN-MINUSES without
considering the space around it.
If "--" are two single "-" (end of options) then use "\-\-".

speaker-test.1:100: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.

#####

Wrong distance between sentences.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  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.

#####

Split lines longer than 100 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 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 142	length 107
Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.


#####

Name of a manual is set in bold, the section in roman.
See man-pages(7).

177:.BR aplay(1)

#####
--- speaker-test.1	2023-06-21 22:53:24.000000000 +0000
+++ speaker-test.1.new	2023-06-21 23:12:51.000000000 +0000
@@ -20,14 +20,17 @@ speaker\-test \- command\-line speaker t
 .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.
+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.

-.P \fBaplay\fR's output will be similar to this one:
+.P
+\fBaplay\fR's output will be similar to this one:

 .nf
 $ aplay \-L
@@ -47,14 +50,12 @@ 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
+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

 .TP
@@ -97,29 +98,38 @@ 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).