Add "unreviewed" flag for channels.
[srvx.git] / src / chanserv.help
index b8d59f91d4a7cdd7176df6f947e1ee5c2a214ec1..6d4191f0fa5383688e2ada289c5e4de25b626ea6 100644 (file)
@@ -56,7 +56,7 @@
         "  CLIST                coowners of a channel.",
         "  MLIST                masters of a channel.",
         "  OLIST                ops of a channel.",
-        "  PLIST                peons of a channel.",    
+        "  PLIST                peons of a channel.",
         "  BANS        List all the bans for a channel.",
         "  TOPIC       Set the current topic, or reset it to the default topic.",
         "  MODE        Change a channel mode.",
@@ -92,6 +92,7 @@
         "  REGISTER    Register a new channel with $C.",
         "  NOREGISTER  Add a channel to the do-not-register list.",
         "  ALLOWREGISTER Remove a channel from the do-not-register list.",
+        "  DNRSEARCH   Search the do-not-register list.",
         "  UNREGISTER  Remove $C from a registered channel.",
         "  SEARCH      Find registered channel matching criteria.",
         "  ADDOWNER    Add a new owner to a channel.",
 "MYACCESS" ("/msg $S MYACCESS [<nick|*account>]",
         "Lists channels where you have access and infolines in each.",
         "Network staff may specify a nickname or *account to view the list for another user.",
+        "Your access level in the channel may be followed by a comma and one of the following characters:",
+        "  s     Your access in the channel has been suspended.",
+        "  o     AutoOp is active.",
+        "  v     AutoVoice is active.",
+        "  i     AutoInvite is active.",
         "$uSee Also:$u access, users");
 "ACCESS" ("/msg $S ACCESS <#channel> [<nick|*account>]",
         "Reports various pieces of information about a channel user, including channel and network access level, and the user's info line. If no nick or account is provided, $S returns your own information.",
         "$uSee Also:$u addban, bans, delban, durations");
 "ALLOWREGISTER" ("/msg $C ALLOWREGISTER <#channel|*Account>",
         "Removes the named channel (or channel mask) from the do-not-register list.",
-        "$uSee Also:$u register, noregister, unregister");
+        "$uSee Also:$u register, noregister, dnrsearch, unregister");
 "BAN" ("/msg $C BAN <#channel> <mask|nick>",
         "This command will temporarily add a ban for the user specified as the parameter. Masks are to be supplied in the format <Nick>!<Ident>@<Host> and usually contain wildcards. If a nick is specified, a mask is automatically generated (though not completely foolproof). This ban is removed either by removing it from the channel ban list using any irc client, or sending the UNBAN or UNBANALL commands. If you are banned with this method, the UNBANME command can be used.",
         "$uFor assistance, please join to #support$u",
         "Example: *!*serv@*.gamesurge.net would ban anyone with ident 'serv' and a gamesurge.net hostname from joining the channel.",
         "$uSee Also:$u unban, unbanall, unbanme");
-"BANS" ("/msg $C BANS <#channel>",
+"BANS" ("/msg $C BANS <#channel> [mask|nick]",
         "This command lists all permanent and timed bans in the channel.",
+        "If a nickname is specified, lists any bans that visibly match that user.",
+        "If a hostmask with no wildcards is specified, lists any bans that match that hostmask.",
+        "If a hostmask with wildcards is specified, lists any bans included in that mask.",
         "$uSee Also:$u addban, delban, mdelban");
 "CLIST" ("/msg $C CLIST <#channel> [mask]",
         "This command lists all users of level $bCoowner$b on a channel's userlist. If a mask is supplied, only coowners matching the mask will be shown.",
         "If the note type already exists, it is modified with the new values you specify.",
         "$uSee Also:$u removenote");
 "GIVEOWNERSHIP" ("/msg $C GIVEOWNERSHIP <#channel> <nick|*account>",
-        "Transfer ownership of the channel from you to another user on the channel's userlist.  You are demoted to co-owner, and they are promoted to owner.",
+        "Transfer ownership of the channel from you to another user on the channel's userlist.  You are demoted to co-owner, and he or she is promoted to owner.",
        "You may use *Account instead of Nick as the name argument; the * makes $C use the name of a account directly (useful if the user is not online).",
         "$uSee Also:$u clvl, access, users");
 "CSUSPEND" ("/msg $C CSUSPEND <#channel> [!]<duration> <reason>",
         "$uSee Also:$u unregister, cunsuspend, durations");
 "CUNSUSPEND" ("/msg $C CUNSUSPEND <#channel>",
         "Restores a channel's $b$C$b registration.",
-        "$bSee Also:$b csuspend, unregister");
+        "$uSee Also:$u csuspend, unregister");
 "DELBAN" ("/msg $C DELBAN <#channel> <mask|nick>",
         "Deletes a ban from the channel ban list. This command works for both permanent and timed bans alike.",
         "$uSee Also:$u addban, addtimedban, bans");
 "DEVOICE" ("/msg $C DEVOICE <#channel> <nick> [nick]...",
         "This command will make $C devoice the selected user[s].",
         "$uSee Also:$u addpeon, delpeon, deop, voice");
+"DNRSEARCH" ("/msg $C DNRSEARCH <action> <criteria> <value> [<criteria> <value> ...]",
+        "Searches through the current do-not-register list for those matching the specified criteria, and applies the specified action to them.  A list of actions can be found in $bhelp dnrsearch action$b and a list of criteria in $bhelp dnrsearch criteria$b.",
+        "$uSee Also:$u allowregister, dnrsearch action, dnrsearch criteria, noregister");
+"DNRSEARCH ACTION" ("$bDNRSEARCH ACTION$b",
+       "Options for the action in $bdnrsearch$b are:",
+        "$bPRINT: $b      Display the do-not-register entry.",
+        "$bREMOVE:$b      Remove the do-not-register entry.",
+        "$uSee Also:$u dnrsearch, dnrsearch criteria");
+"DNRSEARCH CRITERIA" ("$bDNRSEARCH CRITERIA$b",
+        "Options for the criteria in $bdnrsearch$b are:",
+        "$bCHANNEL:$b     Channel name, channel mask, or \*account (note the backslash).",
+        "$bSETTER: $b     Staff member who issued the do-not-register.",
+        "$bREASON: $b     Mask for the do-not-register reason or note.",
+        "$bLIMIT:  $b     Maximum entries to operate upon (default 50).",
+        "$bSET:    $b     Age limit for entry (defaults to minimum age).",
+        "$bEXPIRES:$b     Expiration limit for entry (defaults to minimum time).",
+        "Note: If you use the $blimit$b criteria, the full count of matching do-not-register entries will be shown at the end of the $bdnrsearch$b output, but only the first $blimit$b entries will be affected by the action.",
+        "$uSee Also:$u dnrsearch, dnrsearch action");
 "DOWN" ("/msg $C DOWN <#channel>",
         "This command will devoice/deop you in the selected channel.",
         "$uSee Also:$u downall, up, upall");
         "$uSee Also:$u staff");
 "KICK" ("/msg $C KICK <#channel> <mask|nick> [reason]",
         "Kicks the users matching the given nick or mask with the specified reason. If no reason is provided, a default will be used.",
-        "$bSee Also:$b kickban");
+        "$uSee Also:$u kickban");
 "KICKBAN" ("/msg $C KICKBAN <#channel> <mask|nick> [reason]",
         "Kicks and bans with the specified reason any users with a matching nick or hostmask. If no reason is provided, a default one will be used.",
-        "$bSee Also:$b addban, kick");
+        "$uSee Also:$u addban, kick");
 "MDELCOOWNER" ("/msg $C MDELCOOWNER <#channel> <pattern>",
         "Deletes all coowners with accounts matching the given pattern from the channel user list.",
-        "$bSee Also:$b clist, delcoowner");
+        "$uSee Also:$u clist, delcoowner");
 "MDELMASTER" ("/msg $C MDELMASTER <#channel> <pattern>",
         "Deletes all masters with accounts matching the given pattern from the channel user list.",
-        "$bSee Also:$b mdelban, mdelcoowner, mdelop, mdelowner, mdelpeon");
+        "$uSee Also:$u mdelban, mdelcoowner, mdelop, mdelowner, mdelpeon");
 "MDELOP" ("/msg $C MDELOP <#channel> <pattern>",
         "Deletes all ops with accounts matching the given pattern from the channel user list.");
 "MDELOWNER" ("/msg $C MDELOWNER <#channel> <pattern>",
 "NETINFO" ("/msg $C NETINFO",
         "Displays some assorted pieces of information about network-wide $b$C$b statistics.",
         "$uSee Also:$u info, staff");
-"NOREGISTER" ("/msg $C NOREGISTER <#channel|*Account> <reason>",
+"NOREGISTER" ("/msg $C NOREGISTER <#channel|*Account> <duration> <reason>",
         "With no arguments, lists the current do-not-register channels.",
         "With arguments, adds a do-not-register channel (or account) with the specified reason.  In this case, the channel name may include * or ? wildcards.",
-        "$uSee Also:$u allowregister, register, unregister");
+        "The duration may be \"0\" to make it never expire; otherwise, the do-not-register entry will be automatically removed after $uduration$u.",
+        "$uSee Also:$u allowregister, dnrsearch, register, unregister");
 "NOTE" ("/msg $C NOTE <#channel> [<type> [new-note-text]]",
         "With no arguments, lists all visible notes on the specified channel.",
         "With one argument, lists the note type you name (if it is visible to you).",
         "  REGISTERED  Channels that have been registered for less than the given duration",
         "  FLAGS       Matches channels with the specified flag set",
         "  LIMIT       Limit the number of channels returned by the search",
-        "Flags that can be matched against are: nodelete and suspended.",
+        "Flags that can be matched against are: nodelete, suspended and unreviewed.",
         "$uSee Also:$u search, search actions");
 "SEARCH ACTIONS" ("$bSEARCH ACTIONS$b",
        "The following are valid $bsearch$b actions:",
         "TOPICREFRESH: Controls if (and how often) $b$C$b will reset the topic.",
         "DYNLIMIT:     Adjusts user limit (+l channel mode) to prevent join floods.",
         "$bIRCOP ONLY$b:",
-        "NODELETE:  Prevents channel deletion.",
+        "NODELETE:     Prevents channel deletion.",
+        "UNREVIEWED:   Indicates channels that have not been manually reviewed.",
         "If you wish to reset your channel to the default settings, you can use the $bSET DEFAULTS$b command.",
         "$uSee Also:$u set pubcmd, set giveops, set enfops, set enfmodes, set enftopic, set protect, set toys, set setters, set topicrefresh, set ctcpusers, set ctcpreaction, set defaults");
 "SET DEFAULTTOPIC" ("/msg $C SET <#channel> DEFAULTTOPIC <New default topic>",
         "$b3$b  No users will be protected.",
         "$uSee Also:$u set");
 "SET SETTERS" ("/msg $C SET <#channel> SETTERS <value>",
-        "This setting restricts the protection that $C enforces.  It is a numeric user level.",
+        "Users with at least this user level can use the $bset$b command for $C.",
         "$uSee Also:$u set");
 "SET TOPICREFRESH" ("/msg $C SET <#channel> TOPICREFRESH <value>",
         "This setting controls if (and how often) $C refreshes the topic to the default value.  Valid settings are:",
         "$uSee Also:$u unsuspend, deluser");
 "TOPIC" ("/msg $C TOPIC <#channel> [topic]",
         "Sets the current topic for the specified channel.  If no topic is specified, then set the current topic to the default topic.");
-"TRIM" ("/msg $C TRIM <#channel> <target> <duration>",
+"TRIM" ("/msg $C TRIM <#channel> <target> <duration> [vacation]",
        "The trim command removes target objects inactive for more than a certain duration from a channel. The target must be a channel access level, a range of access levels (for example, \"300-399\"), \"users\" or \"bans\". The duration argument specifies the amount of time the target has been inactive for to be removed.",
+        "If the vacation argument is given for the users target, users who are on vacation will be trimmed.  By default they are skipped.",
         "$uSee Also:$u durations");
 "UNBAN" ("/msg $C UNBAN <#channel> <mask|nick>",
         "Unbans the specified nick or hostmask. If a nick is given, $b$C$b determines what hostmask(s) to unban.",
-        "$bSee Also:$b ban, kick, kickban");
+        "$uSee Also:$u ban, kick, kickban");
 "UNBANALL" ("/msg $C UNBANALL <#channel>",
         "Clears the specified channel's banlist. If the channel is omitted, then $bunbanall$b will be done in the channel where the command was given.",
-        "$bSee Also:$b ban, unban, unbanme");
+        "$uSee Also:$u ban, unban, unbanme");
 "UNBANME" ("/msg $C UNBANME <#channel>",
         "Unbans your hostmask from the specified channel.",
-        "$bSee Also:$b ban, unban");
+        "$uSee Also:$u ban, unban");
 "UNREGISTER" ("/msg $C UNREGISTER <#channel> [<confirmation>]",
         "Unregisters a channel that is registered with $b$C$b. $bIMPORTANT$b: Once the channel is unregistered, the userlist $bcannot$b be recovered.",
         "If you are not network staff, you must add a confimation string to the end of your line to confirm the unregistration.  If you leave it out, $C will show the proper confirmation string.",
-        "$bSee Also:$b register");
+        "$uSee Also:$u register");
 "UNSUSPEND" ("/msg $C UNSUSPEND <#channel> <nick|*account>",
         "This restores the target's access to the channel (after it has been suspended).",
         "$uSee Also:$u suspend, deluser");
 "UNVISITED" ("/msg $C UNVISITED [duration] [limit]",
         "Displays up to a certain limit, all channels registered with $b$C$b that have not been visited within a certain duration. If a duration is not provided, a default will be used.",
-        "$bSee Also:$b expire, search, durations");
+        "$uSee Also:$u expire, search, durations");
 "UP" ("/msg $C UP <#channel>",
         "Grants you your normal channel privileges.  If your access in the channel is less than the GiveVoice setting, this does nothing.  Otherwise, if your access is less than the GiveOps setting, $b$C$b will give you voice.  If your access is at least GiveOps, $b$C$b will give you ops.");
 "UPALL" ("/msg $C UPALL",
          "$bOptions:$b",
          "INFO:       Sets the infoline that $C sends when you join the channel.",
          "NOAUTOOP:   Enable or disable $C automatically opping you upon joining or authenticating.",
-         "AUTOINVITE: $C will invite you to +i/+k channels which you have access to and are not in when you authenticate if this setting is on.",
+        "AUTOINVITE: $C will invite you to this channel if you have access to and are not in when you authenticate if this setting is on.",
          "NOTE: The NoAutoOp setting is equivalent to the !togop command in previous versions of srvx.",
          "$uSee Also:$u set");
 "USET INFO" ("/msg $C USET <#channel> INFO <info>",
 "USERS" ("/msg $C USERS <#channel> [mask]",
         "Displays the userlist for the specified channel. If a mask is supplied, only users matching the mask will be shown.",
         "$uSee Also:$u clist, mlist, olist, plist, wlist");
-"VERSION" ("/msg $C VERSION",
-        "Sends you the srvx version and some additional version information that is specific to $b$C$b.");
 "VOICE" ("/msg $C VOICE <#channel> <nick> [nick]...",
         "Voices the specified nick in the specified channel. If the channel is omitted, then $bvoice$b will be done in the channel where the command was given.",
         "$uSee Also:$u devoice");