src/mod-memoserv.help

   1 "<INDEX>" (
   2         " Hello there!",
   3         " Im $b$S$b, your handy message relay service.",
   4         "$b$b",
   5         " With this service you can relay long distance",
   6         " messages to other users, wether they be on",
   7         " or offline.",
   8         "=---------------------------------------=",
   9         "  $bSEND$b    - Sends a message.",
  10         "  $bREAD$b    - Reads a message.",
  11         "  $bDELETE$b  - Deletes a message.",
  12         "  $bLIST$b    - Lists your messages.",
  13         "  $bSET$b     - Sets certain options in relation with $S.",
  14         "  $bEXPIRY$b  - Displays when old unread messages will be deleted.",
  15         "  $bSTATUS$b  - Displays a few details about $S's status.",
  16         "$b$b",
  17         " $bPrivileged Commands:$b",
  18         "  $bEXPIRE$b  - Expires messages.",
  19         "  $bOSET$b    - Modify account options in relation with $S.",
  20         "$b$b",
  21         " See $b/msg $S help <command>$b for syntax",
  22         " and usage for a command. Before you can",
  23         " start using $S you must get an $N",
  24         " account, see $b/MSG $N HELP$b for getting",
  25         " and maintaining your user account.");
  26
  27 "COMMANDS" "${index}";
  28
  29 "SET" ("/msg $S SET [<setting> <value>]",
  30        "Changes your $S settings. Settings are:",
  31         "$bAUTHNOTIFY$b - Indicates wether $S should notify you of any new messages when you authenticate with $N.",
  32         "$bNOTIFY$b     - Indicates wether $S should notify you of the messages in your inbox, on authentication with $N AND when someone sends you a new message.",
  33         "$bPRIVATE$b    - Indicates wether $S will allow people to send messages to you.");
  34
  35 "OSET" ("/msg $S OSET <nick|*account> [<setting> <value>]",
  36         "Allows opers/helpers to change a user $S settings. You may set:",
  37         "$bAUTHNOTIFY$b - Indicates wether $S should notify the user of any new messages when they authenticate with $N.",
  38         "$bNOTIFY$b     - Indicates wether $S should notify the user of the messages in your inbox, on authentication with $N AND when someone sends the user a new message.",
  39         "$bPRIVATE$b    - Indicates wether $S will allow people to send messages to the user.",
  40         "You may use *Account instead of Nick as the name argument; the * makes $S use the name of an account directly (useful if the user is not online).",
  41         "$uSee Also:$u set");
  42
  43 "EXPIRY" ("/msg $S EXPIRY ",
  44          "Sends you the current time set in which any old unread messages will be deleted.");
  45
  46 "EXPIRE" ("/msg $S EXPIRE ",
  47          "Runs an expire process through $S's messages, deleting any messages that are over date.",
  48          "$uSee Also:$u expiry");
  49
  50 "SEND" ("/msg $S SEND <nick|*account> <-flags> <message>",
  51         "Sends a message to an user. Flags can be $br$b to request a read recipient.",
  52         "You may use *Account instead of Nick as the name argument; the * makes $S use the name of an account directly (useful if the user is not online).",
  53         "$uSee also:$u read, list");
  54
  55 "READ" ("/msg $S READ <memo id> <-flags>",
  56         "Shows you the message behind <memo id>. Flags can be $bi$b to ignore a read recipient request.",
  57         "$uSee also:$u send, list");
  58
  59 "DELETE" ("/msg $S DELETE <memo id/*>",
  60           "Deletes <memo id> from your inbox.",
  61           "NOTE: You may supply $b*$b or $ball$b as the memo id, which will result in $S deleting all your messages.");
  62
  63 "LIST" ("/msg $S LIST",
  64         "This will list all the messages in your inbox. Messages marked with (r) have a read recipient reqiested",
  65         "$uSee also:$u read, send");
  66
  67 "STATUS" ("/msg $S STATUS",
  68         "This will list some details about $S's status, i.e the total amount of memo's sent and expired.");
  69
  70 "INDEX" "${index}";