File: beep-usage.txt

package info (click to toggle)
beep 1.4.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 524 kB
  • sloc: ansic: 863; sh: 228; python: 26; makefile: 10
file content (43 lines) | stat: -rw-r--r-- 1,484 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
Usage:
  beep [--verbose|--debug] [-e DEVICE]
       [-f FREQ_Hz] [-l LEN_ms] [-r REPS] [<-d|-D> DELAY_ms] [-s] [-c]
  beep [OPTIONS] <TONE_OPTS> [-n|--new TONE_OPTS...]
  beep [-h|--help]
  beep [-v|-V|--version]

Beep the PC speaker in a number of ways.

Options:
  Information options:
    -h, --help
                  print this usage information and exit
    -V, -v, --version
                  print program version information and exit

  Global options:
    -e, --device=DEVICE
                  set the device to output the beeps to (see beep(1) man page)
    --debug, --verbose
                  make program output more verbose

  Tone options:
    -f FREQ_Hz    frequency of the tone in Hertz (Hz)
    -l LENGTH_ms  length of the tone in milliseconds (ms)
    -d DELAY_ms   delay between repetitions of the tone
                  *without* delay after last repetition of the tone
    -D DELAY_ms   delay between repetitions of the tone
                  *with* delay after last repetition of the tone
    -r REPS       number of repetitions of the last tone

    -n, --new     start a new tone

    -s            read text from stdin and write it through to stdout,
                  beeping the last defined tone for every newline in the text,
		  until EOF in stdin
    -c            like -s, but beep for every character in the text

Exit status:
  0      if OK
  non-0  if any problems occured

More documentation is available in the beep(1) man page via:  man 1 beep