Limnoria/plugins/Alias/README.txt
James Vega 4e8dde4994 Alias: Add a useful README
Signed-off-by: James Vega <jamessan@users.sourceforge.net>
2009-03-15 22:13:42 -04:00

24 lines
933 B
Plaintext

This plugin allows the user to create various aliases to other commands
or combinations of other commands (via nested commands). It is a good
idea to always quote the commands that are being aliased so that any
nested commands are not immediately run.
Basic usage
-----------
Add an alias, trout, which expects a word as an argument
<jamessan> @alias add trout "action slaps $1 with a large trout"
<bot> jamessan: The operation succeeded.
<jamessan> @trout me
* bot slaps me with a large trout
Add an alias, lastfm, which expects a last.fm user and replies with
their recently played items.
@alias add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [urlquote $1] /recenttracks.rss]]"
Note that if the nested commands being aliased hadn't been quoted, then
those commands would have been run immediately, and @lastfm would always
reply with the same information, the result of those commands.