1.0.27: man pages

man/beepalsa.1

@@ -0,0 +1,71 @@
+.TH "BEEPALSA" "1" "2020-01-14" "1.0.27" "User Manual"
+
+.SH NAME
+beepalsa \- ALSA implementation beep
+
+.SH SYNOPSIS
+
+\fBbeepalsa\fR [OPTION]...
+
+.SH DESCRIPTION
+.PP
+ALSA implementation beep speaker player.
+
+.SH OPTIONS
+.TP
+\fB-e\fR,\fB--device\fR
+playback device
+.TP
+\fB-r\fR,\fB--rate\fR
+stream rate in Hz
+.TP
+\fB-c\fR,\fB--channels\fR
+count of channels in stream
+.TP
+\fB-F\fR,\fB--format\fR
+sample format. Recognized sample formats are: S8 S16_LE S16_BE FLOAT_LE S32_LE S32_BE
+.TP
+\fB-b\fR,\fB--buffer\fR
+ring buffer size in us
+.TP
+\fB-p\fR,\fB--period\fR
+period size in us
+.TP
+\fB-P\fR,\fB--nperiods\fR
+number of periods
+.TP
+\fB-f\fR,\fB--frequency\fR
+sine wave frequency in Hz
+.TP
+\fB-l\fR,\fB--length\fR
+beep for N milliseconds
+.TP
+\fB-n\fR,\fB--new\fR
+multiple beeps
+.TP
+\fB-d\fR,\fB-D\fR,\fB--delay\fR
+delay N milliseconds
+.TP
+\fB-s\fR,\fB--speaker\fR
+single speaker test. Values 1=Left, 2=right, etc
+.TP
+\fB-v\fR,\fB--verbose\fR
+enable debug mode
+.TP
+\fB-h\fR,\fB--help\fR
+help
+
+.SH EXAMPLE
+.PP
+\fBbeepalsa\fR -f 659 -l 460 -n -f 784 -l 340 -n -f 659 -l 230 -n -f 659 -l 110 -n -f 880 -l 230 -n -f 659 -l 230 -n -f 587 -l 230 -n -f 659 -l 460 -n -f 988 -l 340 -n -f 659 -l 230 -n -f 659 -l 110 -n -f 1047 -l 230 -n -f 988 -l 230 -n -f 784 -l 230 -n -f 659 -l 230 -n -f 988 -l 230 -n -f 1318 -l 230 -n -f 659 -l 110 -n -f 587 -l 230 -n -f 587 -l 110 -n -f 494 -l 230 -n -f 740 -l 230 -n -f 659 -l 460
+
+.SH AUTHORS
+ Yukimasa Sugizaki
+ James Courtier-Dutton
+ Nathan Hurst
+
+.SH SEE ALSO
+\fBbeep\fR(1), \fBaplay\fR(1)
+
+.SH HOMEPAGE
+https://github.com/Terminus-IMRC/beepALSA

src/beepalsa.c

@@ -450,21 +450,21 @@ static void help(void)
     const int *fmt;
 
     printf(
-        _("Usage: speaker-test [OPTION]... \n"
-          "-h,--help      help\n"
+        _("Usage: beepalsa [OPTION]... \n"
           "-e,--device    playback device\n"
           "-r,--rate      stream rate in Hz\n"
           "-c,--channels  count of channels in stream\n"
-          "-f,--frequency sine wave frequency in Hz\n"
-          "-n,--new       multiple beeps\n"
-          "-d,-D,--delay  delay N milliseconds\n"
           "-F,--format    sample format\n"
           "-b,--buffer    ring buffer size in us\n"
           "-p,--period    period size in us\n"
           "-P,--nperiods  number of periods\n"
+          "-f,--frequency sine wave frequency in Hz\n"
           "-l,--length    beep for N milliseconds\n"
+          "-n,--new       multiple beeps\n"
+          "-d,-D,--delay  delay N milliseconds\n"
           "-s,--speaker   single speaker test. Values 1=Left, 2=right, etc\n"
           "-v,--verbose   enable debug mode\n"
+          "-h,--help      help\n"
           "\n"));
     printf(_("Recognized sample formats are:"));
     for (fmt = supported_formats; *fmt >= 0; fmt++)