Matanya has uploaded a new change for review. https://gerrit.wikimedia.org/r/274576
Change subject: add sulwatcher doc ...................................................................... add sulwatcher doc Change-Id: I86e6f713a72a1a3bc155d7929ed676c72f74d67f --- A SULWatcher/SULWatcher.html 1 file changed, 167 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/labs/tools/stewardbots refs/changes/76/274576/1 diff --git a/SULWatcher/SULWatcher.html b/SULWatcher/SULWatcher.html new file mode 100644 index 0000000..f19e310 --- /dev/null +++ b/SULWatcher/SULWatcher.html @@ -0,0 +1,167 @@ +SULWatcher +========== + +**SULWatcher** notifies +[`#cvn-unifications`](irc://irc.freenode.net/cvn-unifications) of +[account unifications](http://meta.wikimedia.org/wiki/Help:Unified_login). + +Commands +-------- + +You need to be voiced in IRC to be able to use these commands. Note that +the commands start with the bot's nickname, whatever it is, plus a +colon. Normally the bot runs using two nicks (SULWatcher and WatcherSUL) +- issuing a command to either one has the same effect. `SULWatcher:` is +used for these examples. + +<table class="wikitable" style="font-size:85%"> +<tr> +<th> Command </th><th> Description </th><th> Example +</th></tr> +<tr> +<td> SULWatcher: test </td><td> Test if the bot is alive </td><td> +SULWatcher: test + +</td></tr> +<tr> +<td> +SULWatcher: test <i>[string]</i> regex <i>[regex]</i></td><td> +Test the regex against the string </td><td> +SULWatcher: test grawp regex <code>\bpoop\b</code> + +</td></tr> +<tr> +<td> SULWatcher: find regex <i>[regex]</i> </td><td> Find +information on a given regex </td><td> +SULWatcher: find regex <code>\bpoop\b</code> +</td></tr> + +<tr> +<td> SULWatcher: find match <i>[string]</i> </td><td> Find the +regex which matches the provided string </td><td> +SULWatcher: find match <code>\bpoop\b</code> +</td></tr> +<tr> + +<td> SULWatcher: find adder <i>[cloak]</i> </td><td> Find the +regexes attributed to a given cloak </td><td> +SULWatcher: find adder <i>wikimedia/mikelifeguard</i> +</td></tr> +<tr> +<td> SULWatcher: find number <i>[#]</i> </td><td> Find +information on a given entry </td><td> SULWatcher: find number 3 + +</td></tr> +<tr> +<td> SULWatcher: add reason <i>[#]</i> <i>[reason]</i> +</td><td> Add a reason for a certain entry if it is attributed to you</td><td> +SULWatcher: add reason 1 suspicious - matches pattern vandalism + +</td></tr> +<tr> +<td> +SULWatcher: add reason <i>[#]</i> <b>!</b> <i>[reason]</i> +</td><td> Re-attribute the entry to you with a given reason </td><td> +SULWatcher: add reason 1 ! I want to take credit for someone else's work + +</td></tr> +<tr> +<td> +SULWatcher: (add|remove|list) badword <i>[regex]</i> +</td><td> Add/remove/list regexes to match against unifications </td><td> +SULWatcher: add badword <code>\bpoop\b</code><br +/>SULWatcher: list badword + +</td></tr> +<tr> +<td> +SULWatcher: (add|remove|list) whitelist <i>[username]</i> +</td><td> Add/remove/list users who are whitelisted </td><td> +SULWatcher: add whitelist Mike.lifeguard<br +/>SULWatcher: list whitelist + +</td></tr> +<tr> +<td> SULWatcher: edit <i>[#]</i> enable  </td><td> Re-enable +an existing regex </td><td> SULWatcher: edit 2 enable</code> + +</td></tr> +<tr> +<td> +SULWatcher: edit <i>[#]</i> (regex|reason) <i>[whatever]</i> +</td><td> Change the regex/reason for an entry, if it is attributed to you +</td><td> SULWatcher: edit 2 regex <code>\bpoop\b</code> + +</td></tr> +<tr> +<td> +SULWatcher: edit <i>[#]</i> (regex|reason) <b>!</b> <i>[whatever]</i> +</td><td> Change the regex/reason for an entry, re-attributing it to +you</td><td> +SULWatcher: edit 2 reason ! Added word boundaries for fewer false positives + +</td></tr> +<tr> +<td> +SULWatcher: edit <i>[#]</i> case <i>(true|false)</i> +</td><td> Make an entry either case sensitive or insensitive</td><td> +SULWatcher: edit 2 case true + +</td></tr> +<tr> +<td align="center" colspan="3"> <b>For <i>list</i> commands, don't provide a +(regex|cloak|nick|username).</b> +</td></tr> +<tr> +<td align="center" colspan="3"> The following commands are restricted to opped +users. +</td></tr> +<tr> + +<th> Restricted command </th><th> Description </th><th> Example +</th></tr> +<tr> +<td> SULWatcher: restart </td><td> Restart the bots +</td><td>SULWatcher: restart +</td></tr> +<tr> + +<td> SULWatcher: restart rc </td><td> Restart the <a +href="http://meta.wikimedia.org/wiki/Help:Recent_changes";>RC</a> reader +</td><td> SULWatcher: restart rc +</td></tr> +<tr> +<td> SULWatcher: die </td><td> Kill all the bots </td><td> +SULWatcher: die<span style="color:grey;">*</span> + +</td></tr> +<tr> +<td align="center" colspan="3"> <span style="color:grey;">*Note that the bot +uses <a href="https://wiki.toolserver.org/view/Cron";>cron</a> and <a +href="https://wiki.toolserver.org/view/Phoenix";>phoenix</a> to stay up - if you +kill it, it will come back in <a href="/~stewardbots/docs/crontab-linux">about +10 minutes</a>. Use this for a hard restart in case the soft restart above +fails.</span> +</td></tr> +</table> + +Reports +------- + +[Reports](/~stewardbots/SULWatcher/index.php) of SULWatcher's regexes +and matches are available for privileged users. + +Regex help +---------- + +If you don't know [regex](http://en.wikipedia.org/wiki/Regex), you can +simply enter strings with nothing fancy, and that will work pretty well. +Although the bot isn't a wiki, people can still edit - ask for help, or +someone will come along behind you and make your rule better by using +fancier regex. If you're inclined to learn, here are some starting +points: + +* <http://etext.lib.virginia.edu/services/helpsheets/unix/regex.html> +* <http://codeproject.com/dotnet/RegexTutorial.asp> +* <http://docs.python.org/howto/regex.html> + -- To view, visit https://gerrit.wikimedia.org/r/274576 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I86e6f713a72a1a3bc155d7929ed676c72f74d67f Gerrit-PatchSet: 1 Gerrit-Project: labs/tools/stewardbots Gerrit-Branch: master Gerrit-Owner: Matanya <mata...@foss.co.il> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
