diff options
| author | Heinrich Schuchardt | 2022-12-04 16:16:12 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt | 2022-12-05 17:43:21 +0100 |
| commit | 3f01307ced9af0c20b48217c2c58b63f824451c5 (patch) | |
| tree | 648a6246e2b1043f2fc895fb3d2518d20434c9c8 /doc/usage | |
| parent | ff414fcc44b8b385600df54f5a7dc0719cec106f (diff) | |
doc: man-page for the sound command
Provide a man-page for the sound command.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/usage')
| -rw-r--r-- | doc/usage/cmd/sound.rst | 41 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 42 insertions, 0 deletions
diff --git a/doc/usage/cmd/sound.rst b/doc/usage/cmd/sound.rst new file mode 100644 index 00000000000..d3fac243b13 --- /dev/null +++ b/doc/usage/cmd/sound.rst @@ -0,0 +1,41 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright 2022, Heinrich Schuchardt <xypron.glpk@gmx.de> + +sound command +============= + +Synopsis +-------- + +:: + + sound init + sound play [len [freq]] + +Description +----------- + +The *sound* command is used to play a beep sound. + +sound init + initializes the sound driver. + +sound play + plays a square wave sound. It does not depend on previously calling + *sound init*. + +len + duration of the sound in ms, defaults to 1000 ms + +freq + frequency of the sound in Hz, defaults to 400 Hz + +Configuration +------------- + +The sound command is enabled by CONFIG_CMD_SOUND=y. + +Return value +------------ + +The return value $? is 0 (true) if the command succeeds, 1 (false) otherwise. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 0bc82887e9e..bbd40a6e189 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -73,6 +73,7 @@ Shell commands cmd/scp03 cmd/setexpr cmd/size + cmd/sound cmd/temperature cmd/tftpput cmd/true |