src/mod-helpserv.help

   1 "<index>" (
   2         " Hello there!",
   3         " I'm $b$S$b, your helper service.",
   4         "$b$b",
   5         " With this service you can request help. Your",
   6         " request will be picked up by a helper and you",
   7         " will be assisted.",
   8         "=---------------------------------------=",
   9         "  $bQUEUE$b   - Managing the request queue.",
  10         "  $bUSERS$b   - Managing $S helpers",
  11         "  $bOPER$b    - IRC operator administration commands",
  12         "$b$b",
  13         " See $b/msg $S help <command>$b for syntax",
  14         " and usage for a command.");
  15
  16 "<userindex>" (
  17         " Hello there!",
  18         " I'm $b$S$b, your helper service.",
  19         "$b$b",
  20         " With this service you can request help. Your",
  21         " request will be picked up by a helper and you",
  22         " will be assisted.",
  23         "=---------------------------------------=",
  24         "  $bCLOSEREQ$b - Close your current request.",
  25         "  $bHELPER$b   - Find out who is currently helping you.",
  26         "  $bSHOWREQ$b  - Detailed information on your current request.",
  27         "  $bWAIT$b     - Find out where you are in the queue.",
  28         "$b$b",
  29         " See $b/msg $S help <command>$b for syntax",
  30         " and usage for a command. To open a help request,",
  31         " just type $b/msg $S <what you need help with>$b.",
  32         " A request will be opened and picked up as soon as",
  33         " possible by a helper");
  34
  35 "QUEUE" ("Managing the request queue in $S",
  36         "  LIST        List open requests",
  37         "  NEXT        Pick up the next unassigned request",
  38         "  PICKUP      Pick up a particular unassigned request",
  39         "  REASSIGN    Assign a request to another helper",
  40         "  CLOSE       Close out a request",
  41         "  SHOW        Show detailed information on a request",
  42         "  ADDNOTE     Add a note to a request",
  43         "  PAGE        Try to wake up other helpers",
  44         "  STATS       Get statistics on time and requests handled",
  45         "  STATSREPORT Shows statistics for all users");
  46
  47 "USERS" ("Managing helpers in $S",
  48         "  USER ACCESS Description of the user access levels",
  49         "  HELPERS     List current helpers and their access levels",
  50         "  GIVEOWNERSHIP Transfer ownership to another user",
  51         "  ADDMANAGER  Add a new manager to the service",
  52         "  ADDHELPER   Add a helper to the service",
  53         "  ADDTRIAL    Add a trial helper to the service",
  54         "  DELUSER     Remove a person from the service",
  55         "  CLVL        Change a user's access",
  56         "  SET         Change $S settings");
  57
  58 "USER ACCESS" ("User access levels",
  59         "There are four levels of user access to $S: $btrial$b helper, $bhelper$b, $bmanager$b, and $bowner$b.",
  60         "Helpers can use the normal help queue management functions.",
  61         "Trial helpers have the same access as helpers, but they do not stop the \"empty alert\" from occurring",
  62         "Managers also have the ability to use the $ureassign$u command, add and remove helpers, and see stats for any helper.",
  63         "Owners have those abilities, can add and remove managers, and change queue settings.");
  64 "OPER" ("IRC operator administration commands",
  65         "  REGISTER    Register a new HelpServ bot",
  66         "  SUSPEND     Suspend a HelpServ bot",
  67         "  UNSUSPEND   Unsuspend a HelpServ bot",
  68         "  ADDOWNER    Add an owner to an existing HelpServ",
  69         "  DELOWNER    Remove an owner from an existing HelpServ",
  70         "  MOVE        Change the channel or nick the service helps on",
  71         "  UNREGISTER  Unregister a HelpServ bot",
  72         "  BOTS        List registered HelpServ instances",
  73         "  EXPIRE      Expire inactive channels",
  74         "  READHELP    Re-read help file");
  75 "COMMANDS" "${index}";
  76
  77 "WAIT" (
  78         "/msg $S WAIT",
  79         "Tells you where you are sitting in the request queue and how long the first person has been sitting in the queue.");
  80
  81 "ADDTRIAL" (
  82         "/msg $S ADDTRIAL <nick|*account>",
  83         "Add the specified user to the bot as a trial helper.",
  84         "$uSee also:$u helpers, addhelper, addmanager, clvl, deluser");
  85 "ADDHELPER" (
  86         "/msg $S ADDHELPER <nick|*account>",
  87         "Add the specified user to the bot as a helper.",
  88         "$uSee also:$u helpers, addtrial, addmanager, clvl, deluser");
  89 "ADDMANAGER" (
  90         "/msg $S ADDMANAGER <nick|*account>",
  91         "Add the specified user to the bot as a manager.",
  92         "$uSee also:$u helpers, addtrial, addhelper, clvl, deluser");
  93 "ADDOWNER" (
  94         "/msg $O HELPSERV ADDOWNER <bot-nick> <nick|*account>",
  95         "Add the specified user to the bot as a owner.",
  96         "$uSee also:$u clvl, delowner, helpers");
  97 "ADDNOTE" (
  98         "/msg $S ADDNOTE <reqid|nick|*account> <message>",
  99         "Adds a helper note to a request (useful for requests that last a long period of time).",
 100         "$uSee also:$u show");
 101 "BOTS" (
 102         "/msg $O HELPSERV BOTS",
 103         "Lists the currently defined HelpServ bots (along with their channels and owners' accounts).",
 104         "$uSee also:$u EXPIRE");
 105 "EXPIRE" (
 106         "/msg $O HELPSERV EXPIRE",
 107         "Expires any HelpServ bots that have been inactive for too long.",
 108         "$uSee also:$u BOTS");
 109 "GIVEOWNERSHIP" (
 110         "/msg $S GIVEOWNERSHIP <nick|*account> CONFIRM",
 111         "Gives ownership of the bot to another user on the userlist.");
 112 "CLOSE" (
 113         "/msg $S CLOSE <reqid|nick|*account> [reason]",
 114         "Closes out the specified request. The optional [reason] is included in the request log file.");
 115 "CLVL" (
 116         "/msg $S CLVL <user|*nick> <new-level>",
 117         "Allows an owner or manager to change a user's access with $S.",
 118         "$uSee also:$u addtrial, addhelper, addmanager, deluser, helpers");
 119 "DELOWNER" (
 120         "/msg $O HELPSERV DELOWNER <bot-nick> <nick|*account>",
 121         "Delete an owner from the channel user list.  (Secretly, this is just an alias for deluser.)",
 122         "$uSee also:$u clvl, deluser, helpers");
 123 "DELUSER" (
 124         "/msg $S DELUSER <nick|*account>",
 125         "Delete a user from the channel user list.",
 126         "$uSee also:$u addhelper, addmanager, clvl, helpers");
 127 "HELP" (
 128         "/msg $S HELP [command|topic]",
 129         "HELP will show you usage or other information for the command you give.",
 130         "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).",
 131         "If you do not give a command or topic for HELP, an index is shown.");
 132 "HELPERS" (
 133         "/msg $S HELPERS",
 134         "Displays the trials, helpers, managers and owner(s) registered with $S.",
 135         "$uSee also:$u addtrial, addhelper, addmanager, deluser, tlist, hlist, mlist, wlist");
 136 "WLIST" (
 137         "/msg $S WLIST",
 138         "Displays the owner(s) registered with $S.",
 139         "$uSee also:$u helpers");
 140 "MLIST" (
 141         "/msg $S MLIST",
 142         "Displays the managers registered with $S.",
 143         "$uSee also:$u helpers");
 144 "HLIST" (
 145         "/msg $S HLIST",
 146         "Displays the helpers registered with $S.",
 147         "$uSee also:$u helpers");
 148 "TLIST" (
 149         "/msg $S TLIST",
 150         "Displays the trials registered with $S.",
 151         "$uSee also:$u helpers");
 152 "LIST" (
 153         "/msg $S LIST [unassigned|assigned|me|all]",
 154         "Lists open help requests of the specified type (if not specified, defaults to \"unassigned\").",
 155         "\"assigned\" means that a helper has picked up the request or been assigned to handle it.",
 156         "\"me\" means to only show requests assigned to you.",
 157         "$uSee also:$u next, pickup");
 158 "MOVE" (
 159         "/msg $O HELPSERV MOVE <bot-nick> <new-nick|#new-channel>",
 160         "Makes the HelpServ bot use a different nick or channel.");
 161 "NEXT" (
 162         "/msg $S NEXT",
 163         "Assigns the next unhandled help request to you.",
 164         "$uSee also:$u list, pickup, reassign, close");
 165 "PAGE" (
 166         "/msg $S PAGE <reason for page>",
 167         "Pages the current page target, requesting attention.",
 168         "$uSee also:$u set");
 169 "PICKUP" (
 170         "/msg $S PICKUP <reqid|nick|*account>",
 171         "Assigns the request with $breqid$b to you.",
 172         "$uSee also:$u list, next, reassign, close");
 173 "READHELP" (
 174         "/msg $O HELPSERV READHELP",
 175         "Re-reads the HelpServ help file.");
 176 "REASSIGN" (
 177         "/msg $S REASSIGN <reqid|nick|*account> <new-helper-nick>",
 178         "Reassigns (or assigns) the specified request to $bnew_helper_nick$b.",
 179         "$uSee also:$u next, pickup, close");
 180 "REGISTER" (
 181         "/msg $O HELPSERV REGISTER <bot-nick> <#channel> <owner-nick|*account>",
 182         "Registers a new HelpServ bot to the specified channel, and adds the given user as owner.",
 183         "$uSee also:$u unregister, helpers");
 184 "SET" (
 185         "/msg $S SET [<option> [new-value]]",
 186         "Change service options.  If no option is specified, show all options.  If no value is specified, show current value of option.",
 187         "PageTarget       Send command pages to this channel",
 188         "PageType         Delivery type for command pages (sent by the PAGE command)",
 189         "AlertPageTarget  Send alert pages to this channel",
 190         "AlertPageType    Delivery type for alert pages (to gain helpers' attention)",
 191         "StatusPageTarget Send status pages to this channel",
 192         "StatusPageType   Delivery type for status pages (less urgent information, such as requests being opened/assigned/closed)",
 193         "Greeting         Message sent to users joining channel",
 194         "ReqOpened        Message sent to user opening a new request",
 195         "ReqAssigned      Message sent to user when their request is assigned to a helper",
 196         "ReqClosed        Message sent to user when their request is closed",
 197         "IdleDelay        Time user may idle in channel before bot complains to StatusPageTarget",
 198         "WhineInterval    Time between complaints about unhandled requests and idle users",
 199         "WhineDelay       Time before an unhandled request makes bot complain to AlertPageTarget",
 200         "EmptyInterval    Time between complaints (to AlertPageTarget) that the help channel is unstaffed",
 201         "StaleDelay       Time after which updating an old request causes it to send an activity alert",
 202         "ReqPersist       Persistence for new requests",
 203         "HelperPersist    Persistence for assignation of requests to helpers",
 204         "Notification     Notification to helpers of events concerning their requests",
 205         "IdWrap           Maximum request ID plus one (IDs wrap to 0 when they reach this)",
 206         "ReqMaxLen        Maximum number of lines of text allowed in a request",
 207         "PrivmsgOnly      Messages to users are sent as privmsg (overriding account preference)",
 208         "ReqOnJoin        Automatically opens a request for a user who joins the channel",
 209         "AutoVoice        Automatically voices users when their request is assigned to a helper",
 210         "AutoDeVoice      Automatically devoices users when their request is closed or their helper is unassigned",
 211         "$uSee also:$u set <option-name>");
 212 "SET PAGETARGET" (
 213         "/msg $S SET PAGETARGET [#channel-name]",
 214         "This sets the destination for pages and other alerts.  The target may be set to * to disable pages entirely.",
 215         "Just like $C registration requires an oper or helper, this option can only be set by an oper.",
 216         "$uSee also:$u set, set pagetype, set statuspagetype");
 217 "PAGE TYPES" (
 218         "The following types of pages may be used:",
 219         "None            Disable this particular page type",
 220         "Notice          Send as a notice to PageTarget",
 221         "Privmsg         Send as a normal message to PageTarget",
 222         "Onotice         Send as a notice to channel operators in PageTarget",
 223         "$uSee also:$u set, set pagetarget, set pagetype, set statuspagetype");
 224 "SET PAGETYPE" (
 225         "/msg $S SET PAGETYPE <page-type>",
 226         "This sets the type of page for pages sent using the $bpage$b command.",
 227         "$uSee also:$u set, set pagetarget, page types, page");
 228 "SET STATUSPAGETYPE" (
 229         "/msg $S SET STATUSPAGETYPE <page-type>",
 230         "This sets the type of page sent when a new request is opened.",
 231         "$uSee also:$u set, set pagetarget, page types, page");
 232 "SET GREETING" (
 233         "/msg $S SET GREETING <greeting-text>",
 234         "This sets the message sent to users when they join the channel -- for example, the URL for a FAQ or \"How to get help\" page.",
 235         "You may disable this message by using * as the text.",
 236         "$uSee also:$u set");
 237 "SET OPENREQ" (
 238         "/msg $S SET OPENREQ <openreq-text>",
 239         "This sets a message sent to users when they open a new request with the bot.  It is sent just before more mechanical information about the request ID, current wait time, and request persistence.",
 240         "You may disable this message by using * as the text.",
 241         "$uSee also:$u set");
 242 "SET ASSIGNREQ" (
 243         "/msg $S SET ASSIGNREQ <assignreq-text>",
 244         "This sets a message sent to users when their request is assigned to a helper (or re-assigned to another helper).",
 245         "You may disable this message by using * as the text.",
 246         "$uSee also:$u set");
 247 "SET CLOSEREQ" (
 248         "/msg $S SET CLOSEREQ <closereq-text>",
 249         "This sets a message sent to users when their request is closed.",
 250         "You may disable this message by using * as the text.",
 251         "$uSee also:$u set");
 252 "SET IDLEDELAY" (
 253         "/msg $S SET IDLEDELAY <interval>",
 254         "If a user idles in the help channel longer than the IdleDelay, then the bot will complain every WhineInterval reminding helpers of all the users that are waiting and idle at least IdleDelay. As a user without voice is forced to be idle, this makes sense primarily if the help channel is moderated (+m) and the helpers voice users (+v) to ask them what they need.",
 255         "You may disable this by using 0 as the interval.",
 256         "$uSee also:$u set, set whineinterval");
 257 "SET WHINEDELAY" (
 258         "/msg $S SET WHINEDELAY <interval>",
 259         "If any unhandled requests in the queue are at least this old, the bot will send a page requesting someone to handle it.",
 260         "If the request remains unhandled, another complaint will be sent every WhineInterval.",
 261         "You may disable this by using 0 as the interval.",
 262         "$uSee also:$u set, set whineinterval");
 263 "SET WHINEINTERVAL" (
 264         "/msg $S SET WHINEINTERVAL <interval>",
 265         "If any unhandled requests in the queue are at least WhineDelay old, then every WhineInterval, the bot will send a complaint about each unhandled request at least WhineDelay old, reminding helpers that the request is still unhandled.",
 266         "IdleDelay messages are also sent every WhineInterval.",
 267         "If you use 0 as the interval, only the initial request will be sent.",
 268         "$uSee also:$u set, set whinedelay, set idledelay");
 269 "SET EMPTYINTERVAL" (
 270         "/msg $S SET EMPTYINTERVAL <interval>",
 271         "If the help channel is unstaffed (there are no helpers in the channel) the bot will send a complaint to PageTarget every EmptyInterval.",
 272         "You may disable this by using 0 as the interval.",
 273         "$uSee also:$u set");
 274 "SET STALEDELAY" (
 275         "/msg $S SET STALEDELAY <interval>",
 276         "If a user adds additional information to a request that has been otherwise inactive for at least this amount of time, the PageTarget is sent a message set by StatusPageType mentioning the update.",
 277         "You may disable this by using 0 as the interval.",
 278         "$uSee also:$u set, set pagetarget, set statuspagetype");
 279 "SET REQPERSIST" (
 280         "/msg $S SET REQPERSIST <persistence-type>",
 281         "This sets the \"request persistence\" for all requests.",
 282         "The following types of persistence may be used:",
 283         "Part            Request is closed when the user parts the channel",
 284         "Quit            Request is closed when the user disconnects from IRC",
 285         "Close           Request is only closed when a helper closes it",
 286         "$uPart$u and $uQuit$u type requests, and $uClose$u type requests with no associated account, will be automatically closed when the services restart.",
 287         "$uSee also:$u set, set helperpersist");
 288 "SET HELPERPERSIST" (
 289         "/msg $S SET REQPERSIST <persistence-type>",
 290         "This sets the \"helper persistence\" for all requests.",
 291         "The following types of persistence may be used:",
 292         "Part            Request is marked unassigned when the helper parts the channel",
 293         "Quit            Request is marked unassigned when the helper disconnects from IRC",
 294         "Close           Request is never marked unassigned",
 295         "$uPart$u and $uQuit$u type requests will be marked unassigned when the services restart.",
 296         "$uSee also:$u set, set reqpersist");
 297 "SET NOTIFICATION" (
 298         "/msg $S SET NOTIFICATION <notification-type>",
 299         "This sets the \"notification level\" for all requests. It determines which messages are sent to helpers when something happens with their request, or the user/account the request is associated with.",
 300         "The following notification levels may be used:",
 301         "None             No notifications are sent",
 302         "ReqDrop          Send a notification if a request is dropped",
 303         "UserChanges      Above, and also notify of the user changing nick, disconnecting, or coming online",
 304         "AccountChanges   Above, and also notify when the user authenticates to an account or unregisters an account ($bcan only be set by an IRCOP$b)",
 305         "$uSee also:$u set");
 306 "SET PRIVMSGONLY" (
 307         "/msg $S SET PRIVMSGONLY <Yes|No>",
 308         "This sets if messages to users communicating with $S will have their responses in privmsg format (overriding their account's preference for privmsg or notice).",
 309         "Helpers are not affected by this setting.",
 310         "$uSee also:$u set");
 311 "SET REQONJOIN" (
 312         "/msg $S SET REQONJOIN <Yes|No>",
 313         "This sets if requests are automatically opened whenever someone joins the help channel. They contain no text by default.",
 314         "Helpers are not affected by this setting.",
 315         "$uSee also:$u set");
 316 "SHOW" (
 317         "/msg $S SHOW <reqid|nick|*account>",
 318         "Shows the details of the specified request.",
 319         "$uSee also:$u list");
 320 "STATS" (
 321         "/msg $S STATS <nick|*account>",
 322         "Shows time and request statistics for the specified helper.  (If no one is specified, shows your own stats.)",
 323         "Only managers and owners may look at stats for other users.");
 324 "STATSREPORT" (
 325         "/msg $S STATSREPORT [NOTICE]",
 326         "Sends a list of how long each helper has been in the help channel for the past 4 weeks (separated by week)",
 327         "If you give the \"NOTICE\" argument, it will send the report as NOTICEs instead of PRIVMSGs.",
 328         "$uSee also:$u stats");
 329 "UNREGISTER" (
 330         "/msg $S UNREGISTER CONFIRM",
 331         "Unregisters the channel and removes the service from the channel.");
 332 "SUSPEND" ("/msg $S SUSPEND <HelpBot> <duration> <reason>",
 333         "This command will temporarily remove $b$S$b from a channel and suspend its registration.",
 334         "The duration may be \"0\" to make it never expire; otherwise, $S will automatically unsuspend the channel after $uduration$u.",
 335         "$uSee Also:$u unregister, unsuspend, durations");
 336 "UNSUSPEND" ("/msg $S UNSUSPEND <#channel>",
 337         "Restores a channel's $b$S$b registration.",
 338         "$uSee Also:$u suspend,");
 339 "DURATIONS" (
 340         "This is the syntax used for commands that require time durations. A time duration is made up of numbers and units. Multiple units may be used in a row.",
 341         "The valid unit letters are:",
 342         "$by$b - years (365 days)",
 343         "$bM$b - months (30 days)",
 344         "$bw$b - weeks (7 days)",
 345         "$bd$b - days (24 hours)",
 346         "$bh$b - hours (60 minutes)",
 347         "$bm$b - minutes (60 seconds)",
 348         "$bs$b - seconds",
 349         "If the unit letter is not given, seconds are assumed.",
 350         "$b$b",
 351         "$uExamples$u:",
 352         "$b5d$b is 5 days.",
 353         "$b1y2M$b is 1 year and 2 months (425 days.)",
 354         "$b1d1h$b is 1 day and 1 hour (25 hours.)",
 355         "$b1h25m30s$b is 1 hour, 25 minutes and 30 seconds."
 356         );