diff options
| author | Tom Rini | 2022-12-19 09:29:55 -0500 |
|---|---|---|
| committer | Tom Rini | 2022-12-21 13:09:01 -0500 |
| commit | 14f43797d0a696248c09d298e2f2809dded345ba (patch) | |
| tree | 23fc5bc462689f07f389cc0b8e7f7bedd35253ff /doc/usage | |
| parent | 9c955393f7a27ded250fef7688e0065b44a3343f (diff) | |
| parent | 2243922edca9f56a9d5519b9d6e36f5d7a18434d (diff) | |
Merge tag 'v2023.01-rc4' into next
Prepare v2023.01-rc4
Signed-off-by: Tom Rini <trini@konsulko.com>
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 |