X-Git-Url: https://jfr.im/git/irc/evilnet/x3.git/blobdiff_plain/d76ed9a966ee3d955c8ef00ecc02e643c2005e2e..63c0b8ad3980b46f5c9052c1966a36ce15f6e440:/src/mod-helpserv.help diff --git a/src/mod-helpserv.help b/src/mod-helpserv.help index a695da1..66e752a 100644 --- a/src/mod-helpserv.help +++ b/src/mod-helpserv.help @@ -1,9 +1,37 @@ -"" ("Help Queue Manager commands", - "The following topics are available:", - " HELP How to use this service", - " QUEUE Managing the request queue", - " USERS Managing $S helpers", - " OPER IRC operator administration commands"); +"" ( + " Hello there!", + " Im $b$S$b, your helper service.", + "$b$b", + " With this service you can request help. Your", + " request will be picked up by a helper and you", + " will be assisted.", + "=---------------------------------------=", + " $bQUEUE$b - Managing the request queue.", + " $bUSERS$b - Managing $S helpers", + " $bOPER$b - IRC operator administration commands", + "$b$b", + " See $b/msg $S help $b for syntax", + " and usage for a command."); + +"" ( + " Hello there!", + " Im $b$S$b, your helper service.", + "$b$b", + " With this service you can request help. Your", + " request will be picked up by a helper and you", + " will be assisted.", + "=---------------------------------------=", + " $bCLOSEREQ$b - Close your current request.", + " $bHELPER$b - Find out whos currently helping you.", + " $bSHOWREQ$b - Detailed information on your current request.", + " $bWAIT$b - Find out where you are in the queue.", + "$b$b", + " See $b/msg $S help $b for syntax", + " and usage for a command. To open a help request,", + " just type $b/msg $S $b.", + " A request will be opened and picked up as soon as", + " possible by a helper"); + "QUEUE" ("Managing the request queue in $S", " LIST List open requests", " NEXT Pick up the next unassigned request", @@ -15,6 +43,7 @@ " PAGE Try to wake up other helpers", " STATS Get statistics on time and requests handled", " STATSREPORT Shows statistics for all users"); + "USERS" ("Managing helpers in $S", " USER ACCESS Description of the user access levels", " HELPERS List current helpers and their access levels", @@ -25,6 +54,7 @@ " DELUSER Remove a person from the service", " CLVL Change a user's access", " SET Change $S settings"); + "USER ACCESS" ("User access levels", "There are four levels of user access to $S: $btrial$b helper, $bhelper$b, $bmanager$b, and $bowner$b.", "Helpers can use the normal help queue management functions.", @@ -33,6 +63,8 @@ "Owners have those abilities, can add and remove managers, and change queue settings."); "OPER" ("IRC operator administration commands", " REGISTER Register a new HelpServ bot", + " SUSPEND Suspend a HelpServ bot", + " UNSUSPEND Unsuspend a HelpServ bot", " ADDOWNER Add an owner to an existing HelpServ", " DELOWNER Remove an owner from an existing HelpServ", " MOVE Change the channel or nick the service helps on", @@ -42,110 +74,114 @@ " READHELP Re-read help file"); "COMMANDS" "${index}"; -"ADDTRIAL" ("$bADDTRIAL$b", +"WAIT" ( + "/msg $S WAIT", + "Tells you where you are sitting in the request queue and how long the first person has been sitting in the queue."); + +"ADDTRIAL" ( "/msg $S ADDTRIAL ", "Add the specified user to the bot as a trial helper.", "$uSee also:$u helpers, addhelper, addmanager, clvl, deluser"); -"ADDHELPER" ("$bADDHELPER$b", +"ADDHELPER" ( "/msg $S ADDHELPER ", "Add the specified user to the bot as a helper.", "$uSee also:$u helpers, addtrial, addmanager, clvl, deluser"); -"ADDMANAGER" ("$bADDMANAGER$b", +"ADDMANAGER" ( "/msg $S ADDMANAGER ", "Add the specified user to the bot as a manager.", "$uSee also:$u helpers, addtrial, addhelper, clvl, deluser"); -"ADDOWNER" ("$bADDOWNER$b", +"ADDOWNER" ( "/msg $O HELPSERV ADDOWNER ", "Add the specified user to the bot as a owner.", "$uSee also:$u clvl, delowner, helpers"); -"ADDNOTE" ("$bADDNOTE$b", +"ADDNOTE" ( "/msg $S ADDNOTE ", "Adds a helper note to a request (useful for requests that last a long period of time).", "$uSee also:$u show"); -"BOTS" ("$bBOTS$b", +"BOTS" ( "/msg $O HELPSERV BOTS", "Lists the currently defined HelpServ bots (along with their channels and owners' accounts).", "$uSee also:$u EXPIRE"); -"EXPIRE" ("$bEXPIRE$b", +"EXPIRE" ( "/msg $O HELPSERV EXPIRE", "Expires any HelpServ bots that have been inactive for too long.", "$uSee also:$u BOTS"); -"GIVEOWNERSHIP" ("$bGIVEOWNERSHIP$b", +"GIVEOWNERSHIP" ( "/msg $S GIVEOWNERSHIP CONFIRM", "Gives ownership of the bot to another user on the userlist."); -"CLOSE" ("$bCLOSE$b", +"CLOSE" ( "/msg $S CLOSE [reason]", "Closes out the specified request. The optional [reason] is included in the request log file."); -"CLVL" ("$bCLVL$b", +"CLVL" ( "/msg $S CLVL ", "Allows an owner or manager to change a user's access with $S.", "$uSee also:$u addtrial, addhelper, addmanager, deluser, helpers"); -"DELOWNER" ("$bDELOWNER$b", +"DELOWNER" ( "/msg $O HELPSERV DELOWNER ", "Delete an owner from the channel user list. (Secretly, this is just an alias for deluser.)", "$uSee also:$u clvl, deluser, helpers"); -"DELUSER" ("$bDELUSER$b", +"DELUSER" ( "/msg $S DELUSER ", "Delete a user from the channel user list.", "$uSee also:$u addhelper, addmanager, clvl, helpers"); -"HELP" ("$bHELP$b", +"HELP" ( "/msg $S HELP [command|topic]", "HELP will show you usage or other information for the command you give.", "All help entries will use the same syntax for usage, with optional parameters listed in [] and meta-parameters listed in <> (a meta-parameter is one that you must provide a value for).", "If you do not give a command or topic for HELP, an index is shown."); -"HELPERS" ("$bHELPERS$b", +"HELPERS" ( "/msg $S HELPERS", "Displays the trials, helpers, managers and owner(s) registered with $S.", "$uSee also:$u addtrial, addhelper, addmanager, deluser, tlist, hlist, mlist, wlist"); -"WLIST" ("$bWLIST$b", +"WLIST" ( "/msg $S WLIST", "Displays the owner(s) registered with $S.", "$uSee also:$u helpers"); -"MLIST" ("$bMLIST$b", +"MLIST" ( "/msg $S MLIST", "Displays the managers registered with $S.", "$uSee also:$u helpers"); -"HLIST" ("$bHLIST$b", +"HLIST" ( "/msg $S HLIST", "Displays the helpers registered with $S.", "$uSee also:$u helpers"); -"TLIST" ("$bTLIST$b", +"TLIST" ( "/msg $S TLIST", "Displays the trials registered with $S.", "$uSee also:$u helpers"); -"LIST" ("$bLIST$b", +"LIST" ( "/msg $S LIST [unassigned|assigned|me|all]", "Lists open help requests of the specified type (if not specified, defaults to \"unassigned\").", "\"assigned\" means that a helper has picked up the request or been assigned to handle it.", "\"me\" means to only show requests assigned to you.", "$uSee also:$u next, pickup"); -"MOVE" ("$bMOVE$b", +"MOVE" ( "/msg $O HELPSERV MOVE ", "Makes the HelpServ bot use a different nick or channel."); -"NEXT" ("$bNEXT$b", +"NEXT" ( "/msg $S NEXT", "Assigns the next unhandled help request to you.", "$uSee also:$u list, pickup, reassign, close"); -"PAGE" ("$bPAGE$b", +"PAGE" ( "/msg $S PAGE ", "Pages the current page target, requesting attention.", "$uSee also:$u set"); -"PICKUP" ("$bPICKUP$b", +"PICKUP" ( "/msg $S PICKUP ", "Assigns the request with $breqid$b to you.", "$uSee also:$u list, next, reassign, close"); -"READHELP" ("$bREADHELP$b", +"READHELP" ( "/msg $O HELPSERV READHELP", "Re-reads the HelpServ help file."); -"REASSIGN" ("$bREASSIGN$b", +"REASSIGN" ( "/msg $S REASSIGN ", "Reassigns (or assigns) the specified request to $bnew_helper_nick$b.", "$uSee also:$u next, pickup, close"); -"REGISTER" ("$bREGISTER$b", +"REGISTER" ( "/msg $O HELPSERV REGISTER <#channel> ", "Registers a new HelpServ bot to the specified channel, and adds the given user as owner.", "$uSee also:$u unregister, helpers"); -"SET" ("$bSET$b", +"SET" ( "/msg $S SET [