vftdan
/
sfxd
forked from hkc/sfxd
1
0
Fork 0
Code Pull Requests Activity

Added documentation for `list` command

This commit is contained in:
Casey 2024-04-30 13:00:08 +03:00
parent 26fb7bc8a5
commit 11fc655bb7
Signed by: hkc
GPG Key ID: F0F6CFE11CDB0960
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sfxd.5
View File

@ -61,7 +61,13 @@ Configuration file is \fBnot\fR loaded automatically, unless specified with `-C
.PP .PP
\fBfind QUERY\fR Search for loaded sounds by a substring.\& \fBfind QUERY\fR Search for loaded sounds by a substring.\&
.br .br
\fB\fRQUERY\fB\fR substring to search for.\& \fB\fRQUERY\fB\fR is a substring to search for.\&
.PP
\fBlist [QUERY]\fR Prints out all loaded sounds that match an optional query.\&
.br
\fB\fRQUERY\fB\fR is a fnmatch-compatible pattern.\&
.PP
\fBls [QUERY]\fR - an alias for \fB\fRlist\fB\fR
.PP .PP
.SH DEBUG COMMANDS .SH DEBUG COMMANDS
.PP .PP

7
sfxd.5.scd
View File

@ -39,7 +39,12 @@ Configuration file is *not* loaded automatically, unless specified with `-C [pat
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. ++ *find QUERY* Search for loaded sounds by a substring. ++
**QUERY** substring to search for. **QUERY** is a substring to search for.
*list [QUERY]* Prints out all loaded sounds that match an optional query. ++
**QUERY** is a fnmatch-compatible pattern.
*ls [QUERY]* - an alias for **list**
# DEBUG COMMANDS # DEBUG COMMANDS

1
src/sfxd.c
View File

@ -426,6 +426,7 @@ void send_help(struct msg_target tgt) {
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"); send_txt(tgt, "find QUERY search for keys by QUERY\n");
send_txt(tgt, "list [QUERY] basically ls\n");
} }
static char buffer_exec_file[BUFFER_SIZE]; static char buffer_exec_file[BUFFER_SIZE];