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         "  $bCANCEL$b  - Cancels a message you have sent.",
  14         "  $bHISTORY$b - Lists any existing memos that you have sent.",
  15         "  $bSET$b     - Sets certain options in relation with $S.",
  16         "  $bEXPIRY$b  - Displays when old unread messages will be deleted.",
  17         "  $bSTATUS$b  - Displays a few details about $S's status.",
  18         "$b$b",
  19         " $bPrivileged Commands:$b",
  20         "  $bEXPIRE$b  - Expires messages.",
  21         "  $bOSET$b    - Modify account options in relation with $S.",
  22         "$b$b",
  23         " See $b/msg $S help <command>$b for syntax",
  24         " and usage for a command. Before you can",
  25         " start using $S you must get an $N",
  26         " account, see $b/MSG $N HELP$b for getting",
  27         " and maintaining your user account.");
  28
  29 "COMMANDS" "${index}";
  30
  31 "SET" ("/msg $S SET [<setting> <value>]",
  32        "Changes your $S settings. Settings are:",
  33         "$bAUTHNOTIFY$b     - Indicates if $S should notify you of any new messages when you authenticate with $N. Default is yes.",
  34         "$bNEWNOTIFY$b      - Indicates if $S should notify you instantly when someone sends you a new message. Default is yes.",
  35         "$bPRIVMSG$b        - If yes, $S will notify you of new messages via message, instead of notice. Default is yes.",
  36         "$bPRIVATE$b        - If yes, $S will not allow people to send messages to you (do-not-disturb mode). Default is off.",
  37         "$bIGNORERECIEPTS$b - Indicates if $S will always ignore read reciept requests. Default is no.",
  38         "$bSENDRECIEPTS$b   - Indicates if $S will always send read receipts with your messages. Default is no.",
  39         "$bLIMIT$b          - Indicates how many messages $S will accept before denying them. Set to 0 to recieve no messages. Defaults to 50.");
  40
  41 "OSET" ("/msg $S OSET <nick|*account> [<setting> <value>]",
  42         "Allows opers/helpers to change a user $S settings. You may set:",
  43         "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).",
  44         "$uSee Also:$u set");
  45
  46 "EXPIRY" ("/msg $S EXPIRY ",
  47          "Sends you the current time set in which any old unread messages will be deleted.");
  48
  49 "EXPIRE" ("/msg $S EXPIRE ",
  50          "Runs an expire process through $S's messages, deleting any messages and history that are over date.",
  51          "$uSee Also:$u expiry");
  52
  53 "CANCEL" ("/msg $S CANCEL <id>",
  54          "Cancels the messaged marked with <id> as long as you have sent the message.");
  55
  56 "HISTORY" ("/msg $S HISTORY",
  57          "Shows you any messages that you have sent, provided that the recipient has not deleted them yet..",
  58          "$uSee Also:$u expiry");
  59
  60 "SEND" ("/msg $S SEND <nick|*account> <-flags> <message>",
  61         "Sends a message to an user. Flags can be $br$b to request a read reciept. Take note of the ID number if you wish to cancel the message in the future. The ID number is required in the CANCEL command.",
  62         "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).",
  63         "$uSee also:$u read, list");
  64
  65 "READ" ("/msg $S READ <memo id> <-flags>",
  66         "Shows you the message behind <memo id>. Flags can be $bi$b to ignore a read reciept request.",
  67         "$uSee also:$u send, list");
  68
  69 "DELETE" ("/msg $S DELETE <memo id/*>",
  70           "Deletes <memo id> from your inbox.",
  71           "NOTE: You may supply $b*$b or $ball$b as the memo id, which will result in $S deleting all your messages.");
  72
  73 "LIST" ("/msg $S LIST",
  74         "This will list all the messages in your inbox. Messages marked with (r) have a read reciept reqiested",
  75         "$uSee also:$u read, send");
  76
  77 "STATUS" ("/msg $S STATUS",
  78         "This will list some details about $S's status, i.e the total amount of memo's sent and expired.");
  79
  80 "INDEX" "${index}";