From 7cad1230e6610a0a943627f6a3180dbfe336c2f2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= <flashcode@flashtux.org>
Date: Fri, 12 Nov 2021 21:19:34 +0100
Subject: trigger: add comments with list of all commands in default triggers

---
 src/plugins/trigger/trigger-config.c | 35 ++++++++++++++++++++++++++---------
 1 file changed, 26 insertions(+), 9 deletions(-)

(limited to 'src/plugins/trigger')

diff --git a/src/plugins/trigger/trigger-config.c b/src/plugins/trigger/trigger-config.c
index 7201a0065..ddc9b9843 100644
--- a/src/plugins/trigger/trigger-config.c
+++ b/src/plugins/trigger/trigger-config.c
@@ -71,10 +71,17 @@ char *trigger_config_default_list[][1 + TRIGGER_NUM_OPTIONS] =
       "" },
     /*
      * hide passwords in commands:
-     *   - /msg nickserv id|identify|ghost|release|regain|recover
-     *   - /oper
-     *   - /quote pass
-     *   - /secure passphrase|decrypt|set
+     *   - /msg [-server <name>] nickserv id <password>
+     *   - /msg [-server <name>] nickserv identify <password>
+     *   - /msg [-server <name>] nickserv ghost <nick> <password>
+     *   - /msg [-server <name>] nickserv release <nick> <password>
+     *   - /msg [-server <name>] nickserv regain <nick> <password>
+     *   - /msg [-server <name>] nickserv recover <nick> <password>
+     *   - /oper <nick> <password>
+     *   - /quote pass <password>
+     *   - /secure passphrase <passphrase>
+     *   - /secure decrypt <passphrase>
+     *   - /secure set <name> <value>
      */
     { "cmd_pass", "on",
       "modifier",
@@ -101,7 +108,7 @@ char *trigger_config_default_list[][1 + TRIGGER_NUM_OPTIONS] =
       "" },
     /*
      * hide passwords in commands:
-     *   - /msg nickserv register
+     *   - /msg [-server <name>] nickserv register <password> <email>
      */
     { "cmd_pass_register", "on",
       "modifier",
@@ -113,8 +120,16 @@ char *trigger_config_default_list[][1 + TRIGGER_NUM_OPTIONS] =
       "",
       "" },
     /*
-     * hide password in IRC auth message displayed
-     * (message received from server after the user issued the command)
+     * hide password in IRC auth message displayed (message received from
+     * server after the user issued the command):
+     *   - id <password>
+     *   - identify <password>
+     *   - set password <password>
+     *   - register <password>
+     *   - ghost <nick> <password>
+     *   - release <nick> <password>
+     *   - regain <nick> <password>
+     *   - recover <nick> <password>
      */
     { "msg_auth", "on",
       "modifier",
@@ -136,8 +151,10 @@ char *trigger_config_default_list[][1 + TRIGGER_NUM_OPTIONS] =
       "" },
     /*
      * hide server password in commands:
-     *   - /server
-     *   - /connect
+     *   - /server add <name> <address> -password=<password>
+     *   - /server add <name> <address> -sasl_password=<password>
+     *   - /connect <address> -password=<password>
+     *   - /connect <address> -sasl_password=<password>
      */
     { "server_pass", "on",
       "modifier",
-- 
cgit v1.2.3