src/global.help

   1 "<INDEX>" (
   2         "The $b$G$b service allows network administrators to manage and send important notices to users. It also allows users to retrieve, at once, all messages addressed to them.",
   3         "$bUser Commands:$b",
   4         "  MESSAGES   Sends you all messages addressed to your user class.",
   5         "  VERSION    Prints the X3 and $G version information.",
   6         "$bPrivileged Commands:$b",
   7         "  NOTICE     Immediately sends a message.",
   8         "  MESSAGE    Adds a message to $G's database.",
   9         "  LIST       Displays active messages.",
  10         "  REMOVE     Removes a message.");
  11 "LIST" ("/msg $G LIST",
  12         "Displays all active messages and information pertaining to them, such as the target, message ID, expiration time, and who the message is from.",
  13         "$uSee Also:$u message, messages, remove");
  14 "MESSAGE" ("/msg $G MESSAGE [<options> <value>] text <message>",
  15         "Adds a notice to the $b$G$b database. Messages are sent to users as they enter the network or the target class. $bMessage$b takes several options, which must be preceded by the name of the option being used. Options include:",
  16         "$bFROM$b:     Sets the message's stated source.",
  17         "$bTARGET$b:   Controls the recipients of the message. This option may be used multiple times. See the $bTARGET$b help entry for details.",
  18         "$bDURATION$b: This option sets the length of time for which the message is valid. After this time, the message will be deleted from the $b$G$b database.",
  19         "$uSee Also:$u list, messages, remove, target");
  20 "MESSAGES" ("/msg $G MESSAGES",
  21         "Sends you all messages addressed to your user class.");
  22 "NOTICE" ("/msg $G NOTICE <target> [from <source>] <message>",
  23         "Immediately sends a notice to a specific target. See $btarget$b for a list of targets.",
  24         "$uSee Also:$u target");
  25 "REMOVE" ("/msg $G REMOVE <message id>",
  26         "Remove a message before it expires. The message ID can be found in the message you received when using $bsend$b to first add the message, or by using $blist$b.",
  27         "$uSee Also:$u list, message");
  28 "TARGET" ("$bTARGET$b",
  29         "$bTarget$b is used as a sub-command in many commands. It's values are:",
  30         "$bUSERS$b:      The message will be sent to all users on the network including opers and helpers, but not channels.",
  31         "$bANNOUNCEMENT$b: The message will be sent to all users who are configured to receive community announcements.",
  32         "$bAUTHED$b:     The message will be sent to authenticated users only",
  33         "$bHELPERS$b:    The message will be sent to helpers only.",
  34         "$bOPERS$b:      The message will be sent to opers only.",
  35         "$bSTAFF$b:      The message will be sent to helpers and opers.",
  36         "$bCHANNELS$b:   The message will be sent to all channels.",
  37         "$bRCHANNELS$b:  The message will be sent to all registered channels.",
  38         "$bALL$b:        A combination of USERS and CHANNELS.");