From 2b0ae8fd82f1defb0b30362fcd6854f61f55f907 Mon Sep 17 00:00:00 2001 From: unknown_lamer Date: Mon, 12 Sep 2005 21:46:07 +0000 Subject: [PATCH] [project @ 2005-09-12 21:46:06 by unknown_lamer] Documentation updates --- ChangeLog | 14 ++++ TODO | 2 +- bobot++.info | 209 +++++++++++++++++++++++++++++------------------- bobot++.texinfo | 186 +++++++++++++++++++++++------------------- 4 files changed, 245 insertions(+), 166 deletions(-) diff --git a/ChangeLog b/ChangeLog index 5b97903..6f3fbbb 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,17 @@ +2005-09-12 Clinton Ebadi + + * bobot++.texinfo (High Level Message Functions): Removed + duplicate bot:say entry + (Channel Control): Converted section to new format, and documented + more commands + +2005-08-07 Clinton Ebadi + + * bobot++.texinfo (Bot Control Commands): Convert to @deffn and + documented commands + (Built-In Commands): Clarified when the channel argument must be + provided + 2005-07-21 Clinton Ebadi * bobot++.texinfo: Removed all multitables and replaced them with diff --git a/TODO b/TODO index 49085ef..3dc0e1c 100644 --- a/TODO +++ b/TODO @@ -14,7 +14,7 @@ Done (2.2): 2.2: * Finish Texinfo manual -* Implement ctcp-unquote +* Implement ctcp-dequote * Finish adding commands to Scheme for sending messages * Finish adding hooks/send hooks diff --git a/bobot++.info b/bobot++.info index 46d030e..2998222 100644 --- a/bobot++.info +++ b/bobot++.info @@ -609,11 +609,8 @@ to use whatever you defined the command char to be in `bot.conf'. If a command needs the channel name then you must specify the channel as the first argument to the command when private messaging the bot a -command. - - The following sub sections are internally organized with commands -that need a channel in one list, and commands that do not need a -channel in another list. +command. If, however, you are using the command in a channel you may +omit the channel argument, and the bot will use the current channel. * Menu: @@ -635,20 +632,28 @@ File: bobot++.info, Node: Bot Control Commands, Next: Message Commands, Prev: 3.3.1 Bot Control Commands -------------------------- - * `cycle' Yes Makes the bot leave and join CHANNEL. - - * `die' Makes the bot stop immediately. +These commands are used to control the behaviour of the bot. - * `join' Makes the bot join CHANNEL. + -- Command: cycle channel + Makes the bot leave and join CHANNEL. - * `nick' Makes the bot use nickname NICK. + -- Command: die + Makes the bot stop immediately. - * `save' Saves the userlist. + -- Command: join channel + Makes the bot join CHANNEL. - * `setfloodrate' + -- Command: nick newnick + Makes the bot use nickname NEW-NICK. - * `setversion' + -- Command: setfloodrate messages-per-second + Sets the flood rate to MESSAGES-PER-SECOND. The bot will consider + users sending more than MESSAGES-PER-SECOND messges in a second to + be flooding and will ignore them. + -- Command: setversion version-info + Sets the string returned when someone requestions the version info + of the bot.  File: bobot++.info, Node: Message Commands, Next: Channel Control, Prev: Bot Control Commands, Up: Built-In Commands @@ -656,15 +661,20 @@ File: bobot++.info, Node: Message Commands, Next: Channel Control, Prev: Bot 3.3.2 Message Commands ---------------------- - * `action' `do' Yes USER Causes the bot to perform the action `do' - in the current channel. +These commands cause the bot to send messages (e.g. sending a message +to a channel or performing an action). For all commands TARGET may be +either a user or a channel. - * `do' + -- Command: action target do + Makes the bot to perform the action DO in a message sent to TARGET. - * `msg' - - * `say' Yes Makes the bot say MESSAGE on CHANNEL. + -- Command: do command + Sends a raw irc command. COMMAND is the IRC command you wish to + send (e.g. `PRIVMSG #foo Hello!'). + -- Command: msg target message + -- Command: say target message + Makes the bot say MESSAGE to TARGET.  File: bobot++.info, Node: Channel Control, Next: Spylist Commands, Prev: Message Commands, Up: Built-In Commands @@ -672,36 +682,44 @@ File: bobot++.info, Node: Channel Control, Next: Spylist Commands, Prev: Mess 3.3.3 Channel Control --------------------- - * `ban' Bans MASK or NICK from CHANNEL. You need to be a trusted - user to ban with a MASK. - - * `deban' Yes Debans MASK or NICK from CHANNEL. You need to be a - trusted user to deban with a MASK. + -- Command: ban channel mask + Bans MASK from CHANNEL. You must be a trusted user to ban using a + host mask, but a normal user may ban individual nicks. - * `deop' Yes Deops MASK or NICK on CHANNEL. + -- Command: deban channel mask + Debans MASK from CHANNEL. You need to be a trusted user to deban + with a MASK. - * `invite' Yes Invites NICK on CHANNEL. + -- Command: deop channel mask + Deops MASK on CHANNEL. - * `keep' Yes Sets the MODES that the bot will keep for CHANNEL. + -- Command: invite nick channel + Invites NICK to CHANNEL. - * `kick' Yes Kicks MASK or NICK out of CHANNEL, because of - REASON. You need to be a trusted user to use a MASK. + -- Command: keep channel modes + Sets the MODES that the bot will keep for CHANNEL. - * `kickban' Yes Bans then kicks MASK or NICK out of CHANNEL, - because of REASON. You need to be a trusted user to use a MASK. + -- Command: kick channel mask reason + -- Command: kickban channel mask reason + Kicks MASK out of CHANNEL, because of REASON. `kickban' also bans + MASK.You need to be a trusted user to use a mask. - * `lock' Locks topic on CHANNEL. + -- Command: lock channel + Locks topic on CHANNEL - * `mode' Yes Sends MODE STRING as mode for CHANNEL. + -- Command: mode channel modes + Sets mode of CHANNEL to the mode string MODES. - * `op' Yes Ops NICK on CHANNEL. + -- Command: op channel nick + Ops NICK on CHANNEL - * `part' Yes Makes the bot leave CHANNEL. - - * `tban' Yes Bans NICK or MASK from CHANNEL for TIME seconds. + -- Command: part channel + Makes the bot leave CHANNEL. - * `tkban' Yes Bans NICK or MASK from CHANNEL for TIME seconds, - then kicks him/them because of REASON. + -- Command: tban channel mask time + -- Command: tkban channel mask time + Bans MASK from CHANNEL for TIME seconds. `tkban' also kicks the + user. You must be a trusted user to use a mask. * `topic' Yes If no TOPICis given, prints CHANNEL's topic. Otherwise, the bot will change CHANNEL's topic to TOPIC. @@ -728,11 +746,15 @@ File: bobot++.info, Node: User List Commands, Next: Server List Commands, Pre 3.3.5 User List Commands ------------------------ - * `adduser' + -- Command: adduser mask + Adds the user - * `deluser' Removes NICK or MASK from the userlist. + `deluser' Removes NICK or MASK from the userlist. - * `userlist' Shows the bot's userlist + -- Command: save + Saves the userlist. + + `userlist' Shows the bot's userlist  File: bobot++.info, Node: Server List Commands, Next: Shit List Commands, Prev: User List Commands, Up: Built-In Commands @@ -1260,12 +1282,6 @@ File: bobot++.info, Node: High Level Message Functions, Next: Low Level Messag 4.3.1 "High Level" Message Functions ------------------------------------ - -- Function: bot:say channel message - Send a public or private MESSAGE to CHANNEL. - - Sends a normal text message, as if a user had typed it in. The - DEST can be a nickname or a channel. - -- Function: bot:action channel message Send an "action" type MESSAGE to CHANNEL @@ -1566,8 +1582,11 @@ Function Index * Menu: * %bot:load-extensions: Query Functions. (line 75) +* action: Message Commands. (line 11) +* adduser: User List Commands. (line 7) +* ban: Channel Control. (line 7) * bot:action: High Level Message Functions. - (line 13) + (line 7) * bot:addcommand: Adding New Commands. (line 11) * bot:addhook: Creating a Hook. (line 9) * bot:addserver: Scheme Commands. (line 22) @@ -1611,17 +1630,17 @@ Function Index * bot:match-to-me: Query Functions. (line 63) * bot:mode: Scheme Commands. (line 93) * bot:msg: High Level Message Functions. - (line 16) + (line 10) * bot:nextserver: Scheme Commands. (line 96) * bot:nick: Scheme Commands. (line 99) * bot:notice: High Level Message Functions. - (line 27) + (line 21) * bot:op: Scheme Commands. (line 102) * bot:part: Scheme Commands. (line 105) * bot:random: Query Functions. (line 33) * bot:reconnect: Scheme Commands. (line 108) * bot:say: High Level Message Functions. - (line 7) + (line 11) * bot:sent-to-me?: Query Functions. (line 67) * bot:server: Scheme Commands. (line 111) * bot:setfloodrate: Scheme Commands. (line 115) @@ -1633,6 +1652,13 @@ Function Index * bot:use-module: Query Functions. (line 57) * bot:who: Scheme Commands. (line 133) * bot:whois: Scheme Commands. (line 137) +* cycle: Bot Control Commands. + (line 9) +* deban: Channel Control. (line 11) +* deop: Channel Control. (line 15) +* die: Bot Control Commands. + (line 12) +* do: Message Commands. (line 14) * hooks/action: Received Message Hooks. (line 9) * hooks/ctcp: Received Message Hooks. @@ -1678,6 +1704,27 @@ Function Index * hooks/timer: Miscellaneous Hooks. (line 12) * hooks/topic: Received Message Hooks. (line 153) +* invite: Channel Control. (line 18) +* join: Bot Control Commands. + (line 15) +* keep: Channel Control. (line 21) +* kick: Channel Control. (line 24) +* kickban: Channel Control. (line 25) +* lock: Channel Control. (line 29) +* mode: Channel Control. (line 32) +* msg: Message Commands. (line 18) +* nick: Bot Control Commands. + (line 18) +* op: Channel Control. (line 35) +* part: Channel Control. (line 38) +* save: User List Commands. (line 12) +* say: Message Commands. (line 19) +* setfloodrate: Bot Control Commands. + (line 21) +* setversion: Bot Control Commands. + (line 26) +* tban: Channel Control. (line 41) +* tkban: Channel Control. (line 42)  File: bobot++.info, Node: Variable Index, Prev: Function Index, Up: Top @@ -1718,34 +1765,34 @@ Node: Protection15866 Node: Automatic Op16585 Node: Shit Levels16999 Node: Built-In Commands17725 -Node: Bot Control Commands18632 -Node: Message Commands19089 -Node: Channel Control19443 -Node: Spylist Commands20811 -Node: User List Commands21125 -Node: Server List Commands21423 -Node: Shit List Commands22138 -Node: Channel Info22433 -Node: Scripting Commands22801 -Node: Authentication Commands23166 -Node: Miscellaneous Commands23618 -Node: Scripting24179 -Node: Adding New Commands25268 -Node: Hooks26579 -Node: Creating a Hook27417 -Node: Hook Types28623 -Node: Received Message Hooks29187 -Node: Sent Message Hooks34414 -Node: DCC CHAT Hooks36298 -Node: Miscellaneous Hooks37338 -Node: Sending Messages37787 -Node: High Level Message Functions38319 -Node: Low Level Message Functions39383 -Node: Misc Scripting Stuff40436 -Node: Scheme Commands40934 -Node: Query Functions45590 -Node: Concept Index47816 -Node: Function Index48035 -Node: Variable Index56287 +Node: Bot Control Commands18601 +Node: Message Commands19456 +Node: Channel Control20141 +Node: Spylist Commands21649 +Node: User List Commands21963 +Node: Server List Commands22331 +Node: Shit List Commands23046 +Node: Channel Info23341 +Node: Scripting Commands23709 +Node: Authentication Commands24074 +Node: Miscellaneous Commands24526 +Node: Scripting25087 +Node: Adding New Commands26176 +Node: Hooks27487 +Node: Creating a Hook28325 +Node: Hook Types29531 +Node: Received Message Hooks30095 +Node: Sent Message Hooks35322 +Node: DCC CHAT Hooks37206 +Node: Miscellaneous Hooks38246 +Node: Sending Messages38695 +Node: High Level Message Functions39227 +Node: Low Level Message Functions40090 +Node: Misc Scripting Stuff41143 +Node: Scheme Commands41641 +Node: Query Functions46297 +Node: Concept Index48523 +Node: Function Index48742 +Node: Variable Index59197  End Tag Table diff --git a/bobot++.texinfo b/bobot++.texinfo index 597709c..4394ca3 100644 --- a/bobot++.texinfo +++ b/bobot++.texinfo @@ -576,11 +576,8 @@ to use whatever you defined the command char to be in If a command needs the channel name then you must specify the channel as the first argument to the command when private messaging the bot a -command. - -The following sub sections are internally organized with commands that -need a channel in one list, and commands that do not need a channel in -another list. +command. If, however, you are using the command in a channel you may +omit the channel argument, and the bot will use the current channel. @menu * Bot Control Commands:: @@ -599,97 +596,122 @@ another list. @node Bot Control Commands, Message Commands, Built-In Commands, Built-In Commands @subsection Bot Control Commands -@itemize - -@item @command{cycle} Yes Makes the bot leave and join -@var{channel}. +These commands are used to control the behaviour of the bot. -@item @command{die} Makes the bot stop immediately. +@deffn Command cycle channel +Makes the bot leave and join @var{channel}. +@end deffn -@item @command{join} Makes the bot join @var{channel}. +@deffn Command die +Makes the bot stop immediately. +@end deffn -@item @command{nick} Makes the bot use nickname @var{nick}. +@deffn Command join channel +Makes the bot join @var{channel}. +@end deffn -@item @command{save} Saves the userlist. +@deffn Command nick newnick +Makes the bot use nickname @var{new-nick}. +@end deffn -@item @command{setfloodrate} +@deffn Command setfloodrate messages-per-second +Sets the flood rate to @var{messages-per-second}. The bot will +consider users sending more than @var{messages-per-second} messges in +a second to be flooding and will ignore them. +@end deffn -@item @command{setversion} +@deffn Command setversion version-info +Sets the string returned when someone requestions the version info of +the bot. +@end deffn -@end itemize @node Message Commands, Channel Control, Bot Control Commands, Built-In Commands @subsection Message Commands -@itemize - -@item @command{action} @option{do} Yes @var{USER} -Causes the bot to perform the action @option{do} in the current -channel. +These commands cause the bot to send messages (e.g. sending a message +to a channel or performing an action). For all commands @var{target} +may be either a user or a channel. -@item @command{do} +@deffn Command action target do +Makes the bot to perform the action @var{do} in a message sent to +@var{target}. +@end deffn -@item @command{msg} +@deffn Command do command +Sends a raw irc command. @var{command} is the IRC command you wish to +send (e.g. @samp{PRIVMSG #foo Hello!}). +@end deffn -@item @command{say} Yes Makes the bot say @var{message} -on @var{channel}. - -@end itemize +@deffn Command msg target message +@deffnx Command say target message +Makes the bot say @var{message} to @var{target}. +@end deffn @node Channel Control, Spylist Commands, Message Commands, Built-In Commands @subsection Channel Control -@itemize - -@item @command{ban} Bans @var{mask} or @var{nick} from -@var{channel}. You need to be a trusted user to ban with a -@var{mask}. +@deffn Command ban channel mask +Bans @var{mask} from @var{channel}. You must be a trusted user to ban +using a host mask, but a normal user may ban individual nicks. +@end deffn -@item @command{deban} Yes Debans @var{mask} or -@var{nick} from @var{channel}. You need to be a trusted user to deban -with a @var{mask}. +@deffn Command deban channel mask +Debans @var{mask} from @var{channel}. You must be a trusted user to +deban with a @var{mask}. +@end deffn -@item @command{deop} Yes Deops @var{mask} or @var{nick} -on @var{channel}. +@deffn Command deop channel mask +Deops @var{mask} on @var{channel}. +@end deffn -@item @command{invite} Yes Invites @var{nick} on -@var{channel}. +@deffn Command invite nick channel +Invites @var{nick} to @var{channel}. +@end deffn -@item @command{keep} Yes Sets the @var{modes} that the -bot will keep for @var{channel}. - -@item @command{kick} Yes Kicks @var{mask} or @var{nick} -out of @var{channel}, because of @var{reason}. You need to be a -trusted user to use a @var{mask}. - -@item @command{kickban} Yes Bans then kicks @var{mask} -or @var{nick} out of @var{channel}, because of @var{reason}. You need -to be a trusted user to use a @var{mask}. - -@item @command{lock} Locks topic on @var{channel}. - -@item @command{mode} Yes Sends @var{mode string} as -mode for @var{channel}. - -@item @command{op} Yes Ops @var{nick} on @var{channel}. +@deffn Command keep channel modes +Sets the @var{modes} that the bot will keep for @var{channel}. +@end deffn -@item @command{part} Yes Makes the bot leave @var{channel}. +@deffn Command kick channel mask reason +@deffnx Command kickban channel mask reason +Kicks @var{mask} out of @var{channel}, because of +@var{reason}. @command{kickban} also bans @var{mask}.You must be a +trusted user to use a mask. +@end deffn -@item @command{tban} Yes Bans @var{nick} or @var{mask} -from @var{channel} for @var{time} seconds. +@deffn Command lock channel +Locks topic on @var{channel} +@end deffn -@item @command{tkban} Yes Bans @var{nick} or @var{mask} -from @var{channel} for @var{time} seconds, then kicks him/them because -of @var{reason}. +@deffn Command mode channel modes +Sets mode of @var{channel} to the mode string @var{modes}. +@end deffn -@item @command{topic} Yes If no @var{topic}is given, -prints @var{channel}'s topic. Otherwise, the bot will change -@var{channel}'s topic to @var{topic}. +@deffn Command op channel nick +Ops @var{nick} on @var{channel} +@end deffn -@item @command{unlock} Yes Makes the bot unlock topic -on @var{channel} +@deffn Command part channel +Makes the bot leave @var{channel}. +@end deffn + +@deffn Command tban channel mask time +@deffnx Command tkban channel mask time +Bans @var{mask} from @var{channel} for @var{time} +seconds. @command{tkban} also kicks the user. You must be a trusted +user to use a mask. +@end deffn + +@deffn Command topic channel [topic] +Sets the topic in @var{channel} to @var{topic}. If @var{topic} is not +supplied the current topic is sent as a notice to the user calling the +command. +@end deffn -@end itemize +@deffn Command unlock channel +Unlocks the topic on @var{channel} +@end deffn @node Spylist Commands, User List Commands, Channel Control, Built-In Commands @subsection Spylist Commands @@ -709,15 +731,18 @@ list. @node User List Commands, Server List Commands, Spylist Commands, Built-In Commands @subsection User List Commands -@itemize -@item @command{adduser} +@deffn Command adduser mask +Adds the user +@end deffn -@item @command{deluser} Removes @var{nick} or +@command{deluser} Removes @var{nick} or @var{mask} from the userlist. +@deffn Command save +Saves the userlist. +@end deffn -@item @command{userlist} Shows the bot's userlist -@end itemize +@command{userlist} Shows the bot's userlist @node Server List Commands, Shit List Commands, User List Commands, Built-In Commands @subsection Server List Commands @@ -1259,13 +1284,6 @@ send raw IRC messages or CTCP commands. @node High Level Message Functions, Low Level Message Functions, Sending Messages, Sending Messages @subsection ``High Level'' Message Functions -@defun bot:say channel message -Send a public or private @var{message} to @var{channel}. - -Sends a normal text message, as if a user had typed it in. The -@var{dest} can be a nickname or a channel. -@end defun - @defun bot:action channel message Send an ``action'' type @var{message} to @var{channel} @end defun @@ -1375,7 +1393,7 @@ The @var{level} can be: @c (2, 0, 0) @defun bot:ban channel mask-or-nick -Bans @var{mask} or @var{nick} from @var{channel}. You need to be a trusted +Bans @var{mask} or @var{nick} from @var{channel}. You must be a trusted user to ban with a @var{mask}. @end defun @@ -1394,7 +1412,7 @@ Makes the bot leave and join @var{channel}. @c (2, 0, 0) @defun bot:deban channel mask-or-nick -Debans @var{mask} or @var{nick} from @var{channel}. You need to be a trusted +Debans @var{mask} or @var{nick} from @var{channel}. You must be a trusted user to deban with a @var{mask}. @end defun @@ -1447,14 +1465,14 @@ See also STATS. @c (2, 1, 0) @defun bot:kick channel mask-or-nick [reason] Kicks @var{mask} or @var{nick} out of @var{channel}, because of @var{reason}. -You need to be a trusted user to use a @var{mask}. +You must be a trusted user to use a @var{mask}. @end defun @c (2, 1, 0) @defun bot:kickban channel mask-or-nick [reason] Bans then kicks @var{mask} or @var{nick} out of @var{channel}, because of @var{reason}. -You need to be a trusted user to use a @var{mask}. +You must be a trusted user to use a @var{mask}. @end defun @c (1, 0, 0) -- 2.20.1