From 6ca32e8d49083768383599806dac453cc00a6ad4 Mon Sep 17 00:00:00 2001 From: hkc Date: Tue, 30 Apr 2024 12:18:40 +0300 Subject: [PATCH] Added documentation for "find" command --- sfxd.5 | 6 +++++- sfxd.5.scd | 3 +++ src/sfxd.c | 1 + 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/sfxd.5 b/sfxd.5 index 4dd4da2..094d024 100644 --- a/sfxd.5 +++ b/sfxd.5 @@ -5,7 +5,7 @@ .nh .ad l .\" Begin generated content: -.TH "sfxd" "5" "2024-02-25" +.TH "sfxd" "5" "2024-04-30" .PP .SH NAME .PP @@ -59,6 +59,10 @@ Configuration file is \fBnot\fR loaded automatically, unless specified with `-C .br NOTE: there is a limit on how deep inclusion can go.\& By default it'\&s set to 32.\& .PP +\fBfind QUERY\fR Search for loaded sounds by a substring.\& +.br + \fB\fRQUERY\fB\fR substring to search for.\& +.PP .SH DEBUG COMMANDS .PP \fBdbg:dump\fR Dumps contents of the hashmap.\& diff --git a/sfxd.5.scd b/sfxd.5.scd index efa0e11..c7e44c9 100644 --- a/sfxd.5.scd +++ b/sfxd.5.scd @@ -38,6 +38,9 @@ Configuration file is *not* loaded automatically, unless specified with `-C [pat **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. +*find QUERY* Search for loaded sounds by a substring. ++ + **QUERY** substring to search for. + # DEBUG COMMANDS *dbg:dump* Dumps contents of the hashmap. ++ diff --git a/src/sfxd.c b/src/sfxd.c index a55e561..3589869 100644 --- a/src/sfxd.c +++ b/src/sfxd.c @@ -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: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"); } static char buffer_exec_file[BUFFER_SIZE];