Document meaning/usage of flag masks in binds

eggheads / eggdrop

The Eggdrop IRC Bot

GNU General Public License v2.0

500 stars 84 forks source link

Document meaning/usage of flag masks in binds #618

Open vanosg opened 6 years ago

vanosg commented 6 years ago

Maybe it is already somewhere, but when trying to help a user I couldn't point him to any documentation that defines what the flag mask does or how to use it. Open to suggestions on where this info belongs; I'm thinking the BIND section of tcl-commands.doc and maybe FIRST-SCRIPT ? Any better place? Or is it already defined somewhere that I missed?

Specifically, need to include what the format is (global|channel) and what special characters mean (* versus - )

Cizzle commented 5 years ago

As reference, portions are located at:

doc/tcl-commands.doc: at userlist https://github.com/eggheads/eggdrop/blob/develop/doc/tcl-commands.doc#L167
help/cmds2.help: at match https://github.com/eggheads/eggdrop/blob/develop/help/cmds2.help#L56

Location would be at the bottom of tcl-commands.doc after or before the MATCH explanation.