Sat Jul 4 23:09:43 2020 UTC ()

Add more markup.  Edit for clarity.


(uwe)

diff -r1.24 -r1.25 src/share/man/man4/speaker.4

--- src/share/man/man4/speaker.4 2020/07/04 19:25:24	1.24
+++ src/share/man/man4/speaker.4 2020/07/04 23:09:43	1.25

 @@ -1,14 +1,14 @@
-.\" $NetBSD: speaker.4,v 1.24 2020/07/04 19:25:24 uwe Exp $
+.\" $NetBSD: speaker.4,v 1.25 2020/07/04 23:09:43 uwe Exp $
 .\"
 .\" Copyright (c) 2016 Nathanial Sloss <nathanialsloss@yahoo.com.au>
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1993 Christopher G. Demetriou
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
 .\" 1. Redistributions of source code must retain the above copyright
 .\"    notice, this list of conditions and the following disclaimer.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 @@ -52,167 +52,241 @@ The speaker device driver allows applica
 speaker on machines with a PC-like 8253 timer implementation or a synthesized
 speaker from an audio device/soundcard.
 .Pp
 Only one process may have this device open at any given time;
 .Xr open 2
 and
 .Xr close 2
 are used to lock and relinquish it.
 An attempt to
 .Xr open 2
 when another process has the device locked will return \-1 with an
 .Er EBUSY
 error indication.
-Writes to the device are interpreted as 'play strings' in a
+Writes to the device are interpreted as
-simple ASCII melody notation.
+.Dq play strings
 in a simple
 .Tn ASCII
 melody notation.
 An
 .Fn ioctl
 for tone generation at arbitrary frequencies is also supported.
 .Pp
-For the pcppi device sound-generation does
+For the
 .Xr pcppi 4
 device sound-generation does
 .Em not
 monopolize the processor; in fact, the driver
 spends most of its time sleeping while the PC hardware is emitting
 tones.
 Other processes may emit beeps while the driver is running.
 .Pp
 For the audio device speaker, the speaker uses one of the virtual audio
 channels.
 Enabling this device will also provide a
 .Xr wsbell 4
 keyboard bell.
 .Pp
 Applications may call
 .Fn ioctl
 on a speaker file descriptor to control the speaker driver directly;
 definitions for the
 .Fn ioctl
 interface are in
 .In dev/spkrio.h .
 .Pp
-The tone_t structure is as follows:
+The
-.Bd -literal
+.Vt tone_t
 structure is as follows:
 .Bd -literal -offset indent
 typedef struct {
 	int	frequency;	/* in hertz */
 	int	duration;	/* in 1/100ths of a second */
 } tone_t;
 .Ed
 .Pp
 A frequency of zero is interpreted as a rest.
 .Pp
 At present there are four ioctls:
 .Bl -tag -width Dv
 .It Dv SPKRGETVOL
-Returns an integer, which is the current bell volume as a percentage (0-100).
+Returns an integer, which is the current bell volume as a percentage (0\(en100).
 .It Dv SPKRSETVOL
 Accepts an integer, which is the desired volume as a percentage.
 .It Dv SPKRTONE
 Accepts a pointer to a single tone structure as third argument and plays it.
 .It Dv SPKRTUNE
 Accepts a pointer to the first of an array of tone structures and plays
 them in continuous sequence; this array must be terminated by a final member
 with a zero duration.
 .El
-.Pp
+.\"
-The play-string language is modelled on the PLAY statement conventions of
+.Ss Play string language
-IBM BASIC 2.0.
+.\"
-The MB, MF and X primitives of PLAY are not useful in a UNIX
+The play string language is modelled on the
 .Ic PLAY
 statement conventions of
 .Tn IBM BASIC No 2.0 .
 The
 .Ic MB ,
 .Ic MF
 and
 .Ic X
 primitives of
 .Ic PLAY
 are not useful in a
 .Tn UNIX
 environment and are omitted.
-The `octave-tracking' feature is also new.
+The
 .Dq octave-tracking
 feature is also new.
 .Pp
-There are 84 accessible notes numbered 1-84 in 7 octaves, each running from
+There are 84 accessible notes numbered 1\(en84 in 7 octaves, each running from
-C to B, numbered 0-6; the scale is equal-tempered A440 and octave 3 starts
+C to B, numbered 0\(en6; the scale is equal-tempered A440 and octave\~3 starts
 with middle C.
 By default, the play function emits half-second notes with the
-last 1/16th second being `rest time'.
+last 1/16th second being
 .Dq rest time .
 .Pp
-Play strings are interpreted left to right as a series of play command groups;
+Play strings are interpreted left to right as a series of play command groups.
-letter case is ignored.
+Letter case is ignored.
 Whitespace is ignored and may be used to separate melody sections.
 Play command groups are as follows:
-.Pp
+.Bl -tag -width Ic
-CDEFGAB -- letters A through G cause the corresponding note to be played in the
+.It Ic C , D , E , F , G , A , B
-current octave.
+Letters
 .Sq Ic A
 through
 .Sq Ic G
 cause the corresponding note to be played in the current octave.
 A note letter may optionally be followed by an
 .Em accidental sign ,
-one of # + or -; the first two of these cause it to be sharped one
+one of
 .Sq Ic \&# ,
 .Sq Ic \&+ ,
 or
 .Sq Ic \&- ;
 the first two of these cause it to be sharped one
 half-tone, the last causes it to be flatted one half-tone.
 It may also be
 followed by a time value number and by sustain dots (see below).
-Time values
+Time values are interpreted as for the
-are interpreted as for the L command below;.
+.Sq Ic L
-.Pp
+command below;.
-O <n> -- if <n> is numeric, this sets the current octave.
+.\"
-<n> may also be one
+.It Ic O Ns Ar n , Ic OL , Ic ON
-of 'L' or 'N' to enable or disable octave-tracking (it is disabled by default).
+If
 .Ar n
 is numeric, this sets the current octave.
 .Sq Ic OL
 enables, and
 .Sq Ic ON
 disables
 .Em octave-tracking
 (it is disabled by default).
 When octave-tracking is on, interpretation of a pair of letter notes will
 change octaves if necessary in order to make the smallest possible jump between
 notes.
-Thus "olbc" will be played as "olb>c", and "olcb" as "olc<b".
+Thus
-Octave
+.Dq Li olbc
-locking is disabled for one letter note following by >, < and O[0123456].
+will be played as
-.Pp
+.Dq Li olb>c ,
-> -- bump the current octave up one.
+and
-.Pp
+.Dq Li olcb
-< -- drop the current octave down one.
+as
-.Pp
+.Dq Li olc<b .
-N <n> -- play note n, n being 1 to 84 or 0 for a rest of current time value.
+Octave tracking is temporarily disabled for one letter note that follows
 .Sq Ic \&> ,
 .Sq Ic \&<
 or
 .Sq Ic O Ns Ar n .
 .\"
 .It Ic \&>
 Bump the current octave up one.
 .\"
 .It Ic \&<
 Drop the current octave down one.
 .\"
 .It Ic N Ns Ar n
 Play note
 .Ar n ,
 .Ar n
 being 1 to 84 or 0 for a rest of current time value.
 May be followed by sustain dots.
-.Pp
+.\"
-L <n> -- sets the current time value for notes.
+.It Ic L Ns Ar n
-The default is L4, quarter notes.
+Sets the current time value for notes.
 The default is
 .Dq Li L4 ,
 quarter notes.
 The lowest possible value is 1; values up to 64 are accepted.
-L1 sets whole notes, L2 sets half notes, L4 sets quarter notes, etc..
+.Dq Li L1
-.Pp
+sets whole notes,
-P <n> -- pause (rest), with <n> interpreted as for L.
+.Dq Li L2
-May be followed by
+sets half notes,
-sustain dots.
+.Dq Li L4
-May also be written '~'.
+sets quarter notes, etc...
-.Pp
+.\"
-T <n> -- Sets the number of quarter notes per minute; default is 120.
+.It Ic P Ns Ar n , Ic \&~ Ns Ar n
 Pause (rest), with
 .Ar n
 interpreted as for
 .Sq Ic L .
 May be followed by sustain dots.
 .\"
 .It Ic T Ns Ar n
 Sets the number of quarter notes per minute; default is 120.
 Musical names for common tempi are:
-.Bl -column Description Prestissimo "Beats per Minute" -offset indent
+.Bl -column "very slow" "Larghissimo" "999\(en999" -offset indent
-.It Ta Sy Tempo Ta Sy "Beats per Minute"
+.It           Ta Sy "Tempo"  Ta Sy "BPM"
 .It very slow Ta Larghissimo Ta ""
-.It           Ta Largo Ta 40-60
+.It           Ta Largo       Ta 40\(en60
-.It           Ta Larghetto Ta 60-66
+.It           Ta Larghetto   Ta 60\(en66
-.It           Ta Grave Ta ""
+.It           Ta Grave       Ta ""
-.It           Ta Lento Ta ""
+.It           Ta Lento       Ta ""
-.It           Ta Adagio Ta 66-76
+.It           Ta Adagio      Ta 66\(en76
-.It slow Ta Adagietto Ta ""
+.It slow      Ta Adagietto   Ta ""
-.It      Ta Andante Ta 76-108
+.It           Ta Andante     Ta 76\(en108
-.It medium Ta Andantino Ta ""
+.It medium    Ta Andantino   Ta ""
-.It        Ta Moderato Ta 108-120
+.It           Ta Moderato    Ta 108\(en120
-.It fast Ta Allegretto Ta ""
+.It fast      Ta Allegretto  Ta ""
-.It      Ta Allegro Ta 120-168
+.It           Ta Allegro     Ta 120\(en168
-.It      Ta Vivace Ta ""
+.It           Ta Vivace      Ta ""
-.It      Ta Veloce Ta ""
+.It           Ta Veloce      Ta ""
-.It      Ta Presto Ta 168-208
+.It           Ta Presto      Ta 168\(en208
 .It very fast Ta Prestissimo Ta ""
 .El
-.Pp
+.\"
-M[LNS] -- set articulation.
+.It Ic ML , Ic MN , Ic MS
-MN (N for normal) is the default; the last 1/8th of
+Set articulation.
 .Sq Ic MN
 (for normal) is the default; the last 1/8th of
 the note's value is rest time.
-You can set ML for legato (no rest space) or
+You can set
-MS (staccato) 1/4 rest space.
+.Sq Ic ML
 for legato (no rest time) or
 .Sq Ic MS
 for staccato (1/4 rest time).
 .El
 .Pp
-Notes (that is, CDEFGAB or N command character groups) may be followed by
+Notes, that is,
-sustain dots.
+.Ic C , D , E , F , G , A , B ,
 or
 .Ic N
 command character groups, may be followed by sustain dots.
 Each dot causes the note's value to be lengthened by one-half
 for each one.
 Thus, a note dotted once is held for 3/2 of its undotted value;
 dotted twice, it is held 9/4, and three times would give 27/8.
 .Pp
 Whitespace in play strings is simply skipped and may be used to separate
 melody sections.
 .Sh FILES
 .Bl -tag -width Pa -compact
 .It Pa /dev/speaker
 .El
 .Sh SEE ALSO
 .Xr audio 4 ,
 .Xr pcppi 4 ,
 .Xr wsbell 4 ,
 .Xr sysctl 8
 .Sh HISTORY
 This
 .Nm
 device was originally for the pcppi PC timer interface.