search

eggheads / eggdrop

The Eggdrop IRC Bot
GNU General Public License v2.0
509 stars 84 forks source link

".help set" is not showing all "modifyable" settings as indicated #744

Closed michaelortmann closed 4 years ago

michaelortmann commented 6 years ago 
.help set
[05:07:30] tcl: builtin dcc call: *dcc:help -HQ 1 set
[05:07:30] #-HQ# help set
###  set <variable> [value]
   Changes the values of config-file settings of the bot, or, if used without
   a value parameter, shows the current value of a setting. Any config file
   setting changed with this command will be reset when the config file is
   reloaded. Here are the variables that can be modified with this command
   (note that other modules can add variables):
     botnet-nick     userfile        motd            paranoid-telnet-flood
     vhost4          vhost6          prefer-ipv6     listen-addr
     telnet-banner   admin           userfile-perm   use-telnet-banner
     notify-newusers owner           nat-ip          cidr-support
     dcc-sanitycheck network         whois-fields    username
     version         firewall        telnet-flood    ignore-time
     dcc-flood-thr   hourly-updates  connect-timeout resolve-timeout
     dupwait-timeout require-p       keep-all-logs   open-telnets
     stealth-telnets stealth-prompt  handlen         reserved-portrange
     console         default-flags   log-time        timestamp-format
     max-logsize     quick-logs      logfile-suffix  quiet-save
     remote-boots    max-socks       ident-timeout   allow-dk-cmds
     max-logs        protect-telnet  switch-logfiles-atshare-unlinks
     ssl-privatekey  ssl-certificate ssl-privatekey  ssl-certificate
     ssl-capath      ssl-cafile      ssl-verify-depthssl-cert-auth
     ssl-verify-bots ssl-verify-dcc  ssl-verify-clients
   Use '.help set <variable>' for more info on each variable.

The interesting line is: note that other modules can add variables

As far as i understand, all "on the fly modifyable" settings (all without STR_PROTECT?) should be listet here?

If so, i miss for example: ssl-verify-server

So, either the list above is wrong/missing settings or the note that other modules can add variables is wrong?

Cizzle commented 6 years ago

The help text should be altered so it is clear there are read-only settings. Those read-only settings are probably best marked with a * or the likes.

The note about other modules' settings is IMO there for the user to be aware that more settings can exist (which can be viewed via .help <modulename> module).

vanosg commented 4 years ago

Agree- I understand the text to mean "other variables may be available in other modules". For example, src/mod/server.mod/help/set/server.help holds the variables it adds (to include ssl-verify-server), manually formatted.