chiark / gitweb /
New trout from rjk
[irc.git] / servus.html
index 43ed887..efd8fa3 100644 (file)
@@ -23,9 +23,10 @@ span.code {font-family: courier, monospace}
 <h2>Introduction</h2>
 <p>Servus is one of the IRC bots on <span
 class="code">#chiark</span>. This page documents the available
-commands. You can get a copy of the source code by running <span
+commands.<br /> You can get a copy of the source code by running <span
 class="code">git-clone <a
-href="http://www.chiark.greenend.org.uk/~matthewv/irc/.git">http://www.chiark.greenend.org.uk/~matthewv/irc/.git</a></span></p>
+href="http://www.chiark.greenend.org.uk/~matthewv/irc/.git">http://www.chiark.greenend.org.uk/~matthewv/irc/.git</a></span>,
+or via <span class="code">gitweb</span> at <a href="http://www.chiark.greenend.org.uk/ucgi/~matthewv/git/irc.git/">http://www.chiark.greenend.org.uk/ucgi/~matthewv/git/irc.git/</a>.</p>
 
 <h2>Invocation</h2>
 <p>Servus may be invoked in-channel using either <span
@@ -37,6 +38,8 @@ class="code">~command</span>. Alternatively, you may pass commands by
 <h2>Commands</h2>
 
 <ul>
+<li><a href="#blame">blame</a></li>
+<li><a href="#currency">currency</a></li>
 <li><a href="#define">define</a></li>
 <li><a href="#die">die</a></li>
 <li><a href="#do">do</a></li>
@@ -49,6 +52,8 @@ class="code">~command</span>. Alternatively, you may pass commands by
 <li><a href="#karmadel">karmadel</a></li>
 <li><a href="#karmalist">karmalist</a></li>
 <li><a href="#list">list</a></li>
+<li><a href="#nsfw">nsfw</a></li>
+<li><a href="nws">nws</a></li>
 <li><a href="#quiet">quiet</a></li>
 <li><a href="#quit">quit</a></li>
 <li><a href="#reload">reload</a></li>
@@ -63,11 +68,32 @@ class="code">~command</span>. Alternatively, you may pass commands by
 
 <hr />
 
+<h3><a name="blame">blame</a></h3>
+<p>The syntax is:<br />
+<span class="code">blame text</span><br />or:<br />
+<span class="code">blame #trouts text</span><br />or:<br />
+<span class="code">blame #flirts text</span><br />or:<br />
+<span class="code">blame #slashes text</span><br />or:<br />
+<span class="code">blame #last</span><br />
+The first form will search for <span class="code">text</span> in the
+      trouts, flirts, and slashes lists, and return information on
+      when the relevant item was added, and by whom. The next three
+      forms restrict the search to the specified list. The last form
+      is a special case that searches for the last trout, flirt, or
+      slash that Servus emitted.</p>
+
+<h3><a name="currency">currency</a></h3>
+<p>The syntax is:<br />
+<span class="code">currency curr1 as curr2</span><br />
+This will give the first currency in terms of the second
+      currency. Currencies must be specified using their standard <a
+       href="http://en.wikipedia.org/wiki/ISO_4217">currency
+       code</a>. The currency conversion is performed using xe.com's
+      currency converter.</p>
+
 <h3><a name="define">define</a></h3>
-<p>This command returns (either on-channel or by <span
-class="code">/msg</span>) a definition of the argument(s) of the
-"define" command. This is done by using a "define:" query on
-google, so the results may be a little unusual at times...</p>
+<p>This command no longer works, as google have broken 'define'-style
+      searches; it will return an error message if invoked.</p> 
 
 <h3><a name="die">die</a></h3>
 <p>This command must be invoked by <span class="code">/msg</span> only,
@@ -93,7 +119,7 @@ class="code">slash</span>).</p>
 <p>The syntax is:<br /> <span
 class="code">flirt target</span><br /> Servus picks a flirt at random
 from the flirts list (<span
-class="code">/home/matthew/programming/irc/bot/flirts</span> on rapun),
+class="code">/u2/matthewv/programming/irc/flirts</span> on chiark),
 and substitutes "target" for "%s" in the flirt line. If this command
 is invoked by <span class="code">/msg</span>, there is a 10% chance
 of Servus stating who invoked it by adding "(but nick is their secret
@@ -147,6 +173,14 @@ removed from channel for excess flooding).</p>
 class="code">/msg</span>) a list of the commands Servus
 understands</p> 
 
+<h3><a name="nsfw">nsfw</a></h3>
+<p>This command is the same as <a href="#url">url</a>, only you should
+use it for URLs that are not work-safe. Servus will replace the "http"
+in your URL with "nsfw", before passing it to <a href="#url">url</a>.</p>
+
+<h3><a name="nws">nws</a></h3>
+<p>This is an alias for <a href="nsfw">nsfw</a>.</p>
+
 <h3><a name="quiet">quiet</a></h3>
 <p>This command prevents the use of <span
 class="code">trout</span>, <span class="code">flirt</span>, and <span
@@ -180,7 +214,7 @@ in output to the channel of the form:<br />
 <p>The syntax is:<br /> <span
 class="code">slash target1 / target2 </span><br /> Servus picks a slash at random
 from the slashes list (<span
-class="code">/home/matthew/programming/irc/bot/slashes</span> on rapun),
+class="code">/u2/matthewv/programming/irc/slashes</span> on chiark),
 and substitutes "target1" for the first "%s" and "target2" for the
 second "%s" in the slash line. If this command
 is invoked by <span class="code">/msg</span>, there is a 10% chance
@@ -193,7 +227,7 @@ href="slashes">http://www.chiark.greenend.org.uk/~matthewv/irc/slashes</a>.</p>
 <p>The syntax is:<br /> <span
 class="code">trout target</span><br /> Servus picks a trout at random
 from the trouts list (<span
-class="code">/home/matthew/programming/irc/bot/trouts</span> on rapun),
+class="code">/u2/matthewv/programming/irc/trouts</span> on chiark),
 and substitutes "target" for "%s" in the trout line. If this command
 is invoked by <span class="code">/msg</span>, there is a 10% chance
 of Servus stating who invoked it by adding "(at the instigation of
@@ -222,17 +256,24 @@ command is implemented by calling <span class="code">units(1)</span>.</p>
 class="code">#chiark</span>, and will comment if you post a duplicate
 URL. The <span class="code">url</span> command provides a way for you
 to check if a URL has been posted before (if not, Servus posts it on
-your behalf). The syntax is:<br /> 
-<span class="code">/msg Servus url http://some.url</span><br />
-Servus will either paste the URL into channel, or <span
-class="code">/msg</span> you to tell you it was a duplicate. Although
-you can use this command in-channel (and get a response by <span
-class="code">/msg </span>), this is discouraged.</p>
+your behalf). The syntax is:<br /> <span class="code">/msg Servus url
+http://some.url</span><br /> Servus will either paste the URL into
+channel, or <span class="code">/msg</span> you to tell you it was a
+duplicate; in the latter case, the URL will be sent to <span
+class="code">#urls</span>. Although you can use this command
+in-channel (and get a response by <span class="code">/msg </span>),
+this is discouraged. Servus also understands <span
+class="code">nsfw://</span> and <span class="code">nsfws://</span>
+URLs, and knows they are an obfuscation of the relevant <span
+class="code">http://</span> or <span class="code">https://</span> URL
+for URLs that are not work-safe. You can make your firefox understand
+<span class="code">nsfw://</span> URLS by visiting <a
+href="http://www.chiark.greenend.org.uk/~owend/free/nsfw/">http://www.chiark.greenend.org.uk/~owend/free/nsfw/</a>.</p>
 
 <hr />
 <address>
   <a href="mailto:matthewv@chiark.greenend.org.uk">Matthew Vernon</a><br />
-  Coventry, England
+  Cambridge, England
 </address>
  <p>
 <a href="http://validator.w3.org/check/referer"><img