[Bug 291092] beep(1) options in wrong order, min/max not stated

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=291092

            Bug ID: 291092
           Summary: beep(1) options in wrong order, min/max not stated
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Manual Pages
          Assignee: bugs@FreeBSD.org
          Reporter: bigsneaky@duck.com
                CC: doc@FreeBSD.org

Compare beep(1) to the usage message `beep -h`:

> Usage: beep [parameters]
>	-F <frequency in HZ, default 440 Hz>
>	-D <duration in ms, from 50 ms to 2000 ms, default 150 ms>
>	-r <sample rate in HZ, from 8000 Hz to 48000 Hz, default 48000 Hz>
>	-d <OSS device (default /dev/dsp)>
>	-g <gain from 0 to 100, default 75>
>	-B Run in background
>	-h Show usage

Source: https://github.com/freebsd/freebsd-src/blob/main/usr.bin/beep/beep.c

This output is generated from DEFAULT_HZ, DURATION_MIN, DURATION_MAX,
DURATION_DEF, SAMPLE_RATE_MIN, SAMPLE_RATE_MAX, SAMPLE_RATE_DEF,
DEFAULT_DEVICE, GAIN_MIN, GAIN_MAX, and GAIN_DEF so stated figures match the
code's behavior. A supplied value for duration, sample rate, or gain that is
below min or above max results in exit status 1. No min or max is applied for
frequency.

The beep(1) "Description" section states correct defaults for -F, -D, -d, -r,
and -g but not the min and max permissible values for -D, -r, and -g.

The order with -d followed by -r is swapped both in comparison to the usage
message and the "Synopsis", where -r comes before -d.

Also, several sentences have a space before the period, including one in
"Examples" ("Playback default beep sound using /dev/dsp .") which should
probably end in a colon instead.

-- 
You are receiving this mail because:
You are on the CC list for the bug.