Added documentation for "find" command

This commit is contained in:
Casey 2024-04-30 12:18:40 +03:00
parent 58010c8a07
commit 6ca32e8d49
Signed by: hkc
GPG Key ID: F0F6CFE11CDB0960
3 changed files with 9 additions and 1 deletions

6
sfxd.5
View File

@ -5,7 +5,7 @@
.nh .nh
.ad l .ad l
.\" Begin generated content: .\" Begin generated content:
.TH "sfxd" "5" "2024-02-25" .TH "sfxd" "5" "2024-04-30"
.PP .PP
.SH NAME .SH NAME
.PP .PP
@ -59,6 +59,10 @@ Configuration file is \fBnot\fR loaded automatically, unless specified with `-C
.br .br
NOTE: there is a limit on how deep inclusion can go.\& By default it'\&s set to 32.\& NOTE: there is a limit on how deep inclusion can go.\& By default it'\&s set to 32.\&
.PP .PP
\fBfind QUERY\fR Search for loaded sounds by a substring.\&
.br
\fB\fRQUERY\fB\fR substring to search for.\&
.PP
.SH DEBUG COMMANDS .SH DEBUG COMMANDS
.PP .PP
\fBdbg:dump\fR Dumps contents of the hashmap.\& \fBdbg:dump\fR Dumps contents of the hashmap.\&

View File

@ -38,6 +38,9 @@ Configuration file is *not* loaded automatically, unless specified with `-C [pat
**PATH** is the file path for the configuration file. ++ **PATH** is the file path for the configuration file. ++
NOTE: there is a limit on how deep inclusion can go. By default it's set to 32. NOTE: there is a limit on how deep inclusion can go. By default it's set to 32.
*find QUERY* Search for loaded sounds by a substring. ++
**QUERY** substring to search for.
# DEBUG COMMANDS # DEBUG COMMANDS
*dbg:dump* Dumps contents of the hashmap. ++ *dbg:dump* Dumps contents of the hashmap. ++

View File

@ -388,6 +388,7 @@ void send_help(struct msg_target tgt) {
send_txt(tgt, "set:pitch NAME MIN MAX set pitch range for NAME\n"); send_txt(tgt, "set:pitch NAME MIN MAX set pitch range for NAME\n");
send_txt(tgt, "set:volume NAME VOLUME set loudness for NAME\n"); send_txt(tgt, "set:volume NAME VOLUME set loudness for NAME\n");
send_txt(tgt, "source PATH load instructions from PATH\n"); send_txt(tgt, "source PATH load instructions from PATH\n");
send_txt(tgt, "find QUERY search for keys by QUERY\n");
} }
static char buffer_exec_file[BUFFER_SIZE]; static char buffer_exec_file[BUFFER_SIZE];