Commits

jjacky committed 99b1912

Add info about the options of weenick in README.md and an example weereact.conf

Comments (0)

Files changed (2)

 # weeplugins - Plugins for WeeChat
 
-weeplugins are plugins for the IRC client [WeeChat](http://www.weechat.org/ "WeeChat, the extensible chat client.").
+weeplugins are plugins for the IRC client [WeeChat](http://www.weechat.org/
+"WeeChat, the extensible chat client.").
 
 ## weenick: Provides support for common NickServ operations
 
-weenick allows you to define global and/or server-specific options to get automatically identified with services (NickServ).
+weenick allows you to define global and/or server-specific options to get
+automatically identified with services (NickServ).
 
-Upon connection, if the nick is already in use the GHOST command will be sent, and once it has been killed you'll change nick. The IDENTIFY command is then sent.
+Upon connection, if the nick is already in use the GHOST command will be sent,
+and once it has been killed you'll change nick. The IDENTIFY command is then
+sent.
 
 You can also have command(s) executed once identified.
 
- 
+### Configuration
+
+All settings can be defined either under `var.plugins.weenick.server_default.SETTING`
+for global/default values, and `var.plugins.weenick.server.SERVER.SETTING` for
+settings to server SERVER only.
+
+The options are:
+
+* `nick` : your (registered) nickname
+
+* `password` : your password, to identify/kill ghosts with services
+
+* `command` : command(s) to get processed upon identification
+
+* `nickserv_nick` : nickname to send messages to.
+Default: _NickServ_
+
+* `nickserv_registered` : string to identify notice that nick is registered
+Default: _nickname is registered_
+
+* `nickserv_ghost_killed` : string to identify notice that ghost was killed
+Default: _ghost with your nick has been killed_
+
+* `nickserv_identified` : string to identify notice that nick was identified
+Default: _password accepted_
+
+* `nickserv_failed` : string to identify notice that password is wrong
+Default: _access denied_
+
+
 ## weereact: Triggers commands in reaction to messages
 
-weereact allows you to have commands be executed by reacting on messages you receive (or send). They can be filtered by server, channel, user, and content (through perl-compatible regex).
+weereact allows you to have commands be executed by reacting on messages you
+receive (or send). They can be filtered by server, channel, user, and content
+(through perl-compatible regex).
+
+Triggers can be defined in file `weereact.conf` in the WeeChat's directory
+(usually `~/.weechat`)
+See weereact.conf for the list of options and example. There is no way to
+set things from WeeChat, you need to manually edit the file, then use /reload
+for the plugin to reload its config from the file.
 
-It also introduces a new command - `/tobuffer` - to send text (or commands) to a specific buffer.
+It also introduces a new command - `/tobuffer` - to send text (or commands) to
+a specific buffer.
+
+# Empty lines and lines starting with # are ignored
+
+# To start a new trigger definition, use the following on a new line: []
+
+# Options can be used to filter on which messages should the actions be triggered,
+# as well as define said actions.
+
+# on=name of the server the message must be sent on
+
+# to=name of the channel (with #) or nick for PMs
+# For PMs send to yourself/you're receiving, use: to=-
+
+# by=name of the sender
+# For PMs you're sending, use: by=-
+
+# is=perl-compatible regular expression to filter the message
+# More info: http://developer.gnome.org/glib/2.30/glib-regex-syntax.html
+
+# do=command to be executed when a message matches. You can specify this
+# option as many as times as you need.
+# In addition to the back-references from the regex in is, you can also use
+# the following variables:
+# $on : name of the server
+# $to : name of the #channel/nick the message is sent to
+# $by : name of the sender (only available if you're not sending the message)
+
+
+# Example:
+
+#[]
+#on=freenode
+#to=#foobar
+#is=^(?<hi>h(i|ey|ello))[^[:alpha:]]
+#do=\g<hi> $by!