From 11fc655bb7ad8ee856c5af21047f9e411e1a7f90 Mon Sep 17 00:00:00 2001 From: hkc Date: Tue, 30 Apr 2024 13:00:08 +0300 Subject: [PATCH] Added documentation for `list` command --- sfxd.5 | 8 +++++++- sfxd.5.scd | 7 ++++++- src/sfxd.c | 1 + 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/sfxd.5 b/sfxd.5 index 094d024..683a93e 100644 --- a/sfxd.5 +++ b/sfxd.5 @@ -61,7 +61,13 @@ Configuration file is \fBnot\fR loaded automatically, unless specified with `-C .PP \fBfind QUERY\fR Search for loaded sounds by a substring.\& .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 .SH DEBUG COMMANDS .PP diff --git a/sfxd.5.scd b/sfxd.5.scd index c7e44c9..8c74a4d 100644 --- a/sfxd.5.scd +++ b/sfxd.5.scd @@ -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. *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 diff --git a/src/sfxd.c b/src/sfxd.c index 085fb09..1a6780d 100644 --- a/src/sfxd.c +++ b/src/sfxd.c @@ -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, "source PATH load instructions from PATH\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];