X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Finspircd.helpop-full.example;h=3a8b67c22f8d76cd46a496332a1dd89129d38010;hb=27c1548bcab1fe40922ead9bffbf3753deb32abd;hp=b4db906088428de5beded294db1ccadd0385235b;hpb=677eda6ffac89af794c263127b14d1e08ab90ceb;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/conf/inspircd.helpop-full.example b/conf/inspircd.helpop-full.example
index b4db90608..3a8b67c22 100644
--- a/conf/inspircd.helpop-full.example
+++ b/conf/inspircd.helpop-full.example
@@ -6,10 +6,9 @@
 -
 This system provides help for commands and modes.
 Specify your question or a command name as the
-parameter for this command. If you are an oper
-you must prefix your query with a ? symbol.
+parameter for this command.
 -
-/HELPOP COMMANDS      -      To see a list of user commands
+/HELPOP CUSER         -      To see a list of user commands
 /HELPOP COPER         -      To see a list of oper commands
 /HELPOP UMODES        -      To see a list of user modes
 /HELPOP CHMODES       -      To see a list of channel modes">
@@ -21,7 +20,7 @@ you searched for. Please try again.">
 #   User Commands   #
 #####################
 
-<helpop key="commands" value="User Commands
+<helpop key="cuser" value="User Commands
 -------------
 USER      NICK     QUIT     VERSION    PING
 PONG      ADMIN    PRIVMSG  INFO       TIME
@@ -31,7 +30,38 @@ RULES     OPER     LIST     LUSERS     STATS
 USERHOST  AWAY     ISON     SUMMON     USERS
 INVITE    PASS     WHOWAS   LINKS      MAP
 COMMANDS  MODULES  KNOCK    SILENCE    DEVOICE
-REMOVE    UNINVITE VHOST    WATCH      USERIP">
+REMOVE    UNINVITE VHOST    WATCH      TBAN
+TITLE     CYCLE    DCCALLOW FPART      FINGERPRINT
+SSLINFO">
+
+<helpop key="sslinfo" value="/SSLINFO [nick]
+Shows the SSL key fingerprint for the user if they have an SSL
+client key.">
+
+<helpop key="fingerprint" value="/FINGERPRINT [nick]
+Shows the SSL fingerprint of a user.">
+
+<helpop key="uninvite" value="/UNINVITE [nick] [channel]
+Uninvite a user from a channel, same syntax as INVITE.">
+
+<helpop key="tban" value="/TBAN [channel] [duration] [banmask]
+Sets a timed ban. The duration of the ban can be specified in the
+following format: 1w2d3h4m6s which indicates a ban of one week, two
+days, three hours, four minutes and six seconds. Alternatively the
+ban may just be specified as a number of seconds. All timed bans
+appear in the banlist as normal bans and may be safely removed
+before their time is up.">
+
+<helpop key="dccallow" value="/DCCALLOW [+|-] [nick] [duration]
+Add a nickname to or delete a nickname from your DCCALLOW list.">
+
+<helpop key="cycle" value="/CYCLE [channel]
+Cycles a channel (Leaving and Rejoining), overrides restrictions that
+would stop a new user joining, such as User Limits and Channel Keys.">
+
+<helpop key="title" value="/TITLE [name] [password]
+Adds a WHOIS title line and optionally sets a VHOST depending
+on username and password.">
 
 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
 Adds or deletes a user from the watch list. C clears the list
@@ -40,20 +70,30 @@ and S queries the status.">
 <helpop key="vhost" value="/VHOST [username] [password]
 Authenticate for a vhost.">
 
-<helpop key="kick" value="/REMOVE [channel] [nick] {[reason]}
-Removes a user from a channel you specify. You must be
-At least a channel halfoperator to remove a user.
-A removed user will part with a message stating they
-were removed from the channel and by whom.">
+<helpop key="remove" value="/REMOVE [channel] [nick] {[reason]}
+Removes a user from a channel you specify. You must be at least a
+channel halfoperator to remove a user. A removed user will part with
+a message stating they were removed from the channel and by whom.">
+
+<helpop key="fpart" value="/FPART [nick] [channel] {[reason]}
+This behaves identically to /REMOVE, the only difference is that that
+[channel] and [nick] parameters are switched around to match /KICK's
+syntax. Also, /REMOVE is a builtin mIRC command which caused trouble
+for some users. This feature was added in the 1.1 branch.">
 
 <helpop key="devoice" value="/DEVOICE [channel]
 Devoices yourself from the specified channel.">
 
-<helpop key="silence" value="/SILENCE +/-[nick]
-A serverside /ignore of the given nick. It does not follow
-the users nick so if they change their nick you will recieve
-their messages. /SILENCE without a parameter will list the nicks
-that you have silenced.">
+<helpop key="silence" value="/SILENCE [+/-][hostmask] [p|c|i|n|t|a|x]
+ p        Block private messages
+ c        Block channel messages
+ i        Block invites
+ n        Block private notices
+ t        Block channel notices
+ a        Block all of the above
+ x        Exception
+A serverside /ignore of the given hostmask.
+/SILENCE without a parameter will list the hostmasks that you have silenced.">
 
 <helpop key="knock" value="/KNOCK [channel]
 Sends a notice to a channel indicating you wish to join.">
@@ -65,7 +105,7 @@ You should not use it during an established connection.">
 <helpop key="nick" value="/NICK [new nick]
 Change your nickname to [new nick].">
 
-<helpop key="quit" value="/QUIT [reason]
+<helpop key="quit" value="/QUIT {[reason]}
 Quit from IRC and end your current session.">
 
 <helpop key="version" value="/VERSION
@@ -108,15 +148,47 @@ channels where they are at least a halfoperator.">
 
 <helpop key="topic" value="/TOPIC [channel] {topic}
 Sets or retrieves the channel topic. If a channel topic is
-given in teh command and the channel is either not +t, or
+given in the command and the channel is either not +t, or
 You are at least a halfoperator, the channel topic will be
 changed to the new one you provide.">
 
-<helpop key="who" value="/WHO [channel|nick|servermask|o 0]
-Looks up the information of users matching the range you
-provide. You may only /WHO nicknames in channels or on servers
-where you share a common channel with them.
-The syntax '/WHO o 0' shows a list of online IRC operators.">
+<helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
+Looks up the information of users matching the range you provide.
+You may only /WHO nicknames in channels or on servers where you
+share a common channel with them, or ones which are not +i (unless
+you are an IRC operator). The search-pattern may be a special
+sequence of characters determined by the flags given below, or
+it may be one of a nickname, a channel, a hostmask, an ip address
+mask or a server mask.
+-
+Valid WHO flags
+--------------- 
+The following flags after the mask have the following affects:
+-
+ o      Show online IRC operators matching the mask
+ u      Unlimit the results past the maximum /who results value
+        (IRC operators only)
+ r      Show all users whose realnames match the mask. When this
+        flag is set it overrides the meaning of the search-pattern,
+        which must contain a glob pattern intended to match GECOS
+        (realname) fields.
+ h      Show real hostnames rather than masked hostnames (IRC
+        operators only)
+ m      Search for all users with a given set of user modes. When
+        this flag is set it overrides the meaning of the
+        search-pattern, which must contain the mode sequence to
+        search for, for example to find all users with +i and
+        without +s, issue the command WHO +i-s m.
+ a      Show all users who have an away message matching the given mask
+ p      Show all users who are connected on the given port number
+ i      Show all users who have an ident (username) matching the given mask
+ M      Show all users who have metadata attached to them with
+        the given key name
+ l      Show only local users
+ f      Show only remote (far) users
+ t      Show users connected within this time limit
+-
+You may combine multiple flags in one WHO command except where stated in the table above.">
 
 <helpop key="motd" value="/MOTD [server]
 Show the message of the day for [server]. Messages of the
@@ -130,8 +202,8 @@ sent the MOTD when they connect without having to request it.">
 
 <helpop key="oper" value="/OPER [login] [password]
 Attempts to authenticate a user as an IRC operator.
-Please be aware that both successful and unsucessful oper attempts
-Are logged, and sent to online IRC operators.">
+Please be aware that both successful and unsuccessful oper attempts
+are logged, and sent to online IRC operators.">
 
 <helpop key="list" value="/LIST [pattern]
 Creates a list of all existing channels matching the glob pattern
@@ -142,10 +214,7 @@ Shows a count of local and remote users, servers and channels.">
 
 <helpop key="userhost" value="/USERHOST [nickname]
 Returns the hostname and nickname of a user, and some other
-miscellanious information.">
-
-<helpop key="userip" value="/USERIP [nickname]
-Returns the ip and nickname of a user.">
+miscellaneous information.">
 
 <helpop key="away" value="/AWAY {message}
 If a message is given, marks you as being away, otherwise
@@ -195,20 +264,82 @@ implementation as a tree based network is not in place.">
 
 <helpop key="coper" value="Oper Commands
 -------------
-DIE        RESTART     KILL         REHASH         TRACE
+DIE        RESTART     KILL         REHASH         TLINE
 CONNECT    SQUIT       MODULES      MKPASSWD       SHUN
-KLINE      QLINE       GLINE        ELINE          ZLINE"  
+KLINE      QLINE       GLINE        ELINE          ZLINE
 SAJOIN     SAPART      SAMODE       SAQUIT         SANICK
 SETIDLE    SETHOST     SETNAME      SETIDENT       SWHOIS
 OPERMOTD   CHGHOST     CHGNAME      CHGIDENT       CBAN
-NICKLOCK   NICKUNLOCK  LOADMODULE   UNLOADMODULE   GLOBOPS
-SPYLIST    SPYNAMES    GLOADMODULE  GUNLOADMODULE  MKSHA256
-PARKSTATS  FREEZE      UNFREEZE     OPERPERMS      RCONNECT">
+NICKLOCK   NICKUNLOCK  LOADMODULE   UNLOADMODULE   RELOADMODULE
+SPYLIST    SPYNAMES    GLOADMODULE  GUNLOADMODULE  GRELOADMODULE
+FREEZE     UNFREEZE    OPERPERMS    RCONNECT       RSQUIT
+CHECK      CLONES      FILTER       GLOBOPS        USERIP
+JUMPSERVER LOCKSERV    UNLOCKSERV   ALLTIME        TAXONOMY">
+
+<helpop key="userip" value="/USERIP [nickname]
+Returns the ip and nickname of a user.">
+
+<helpop key="tline" value="/TLINE [host or ip mask]
+This command returns the number of local and global clients matched,
+and the percentage of clients matched, plus how they were matched
+(by IP address or by hostname).">
+
+<helpop key="taxonomy" value="/TAXONOMY [nick]
+Lists all metadata attached to the user.">
+
+<helpop key="lockserv" value="/LOCKSERV
+Locks out all new connections notifying connecting users that the
+service is temporarily closed and to try again later.">
+
+<helpop key="unlockserv" value="/UNLOCKSERV
+Opens the server up again for new connections.">
+
+<helpop key="jumpserver" value="/JUMPSERVER {[newserver] [newport] [+/-flags] {:[reason]}}
+Sets or cancels jumpserver mode. If no parameters are given,
+jumpserver mode is cancelled, if it is currently set. If parameters
+are given, a server address must be given for [newserver] and a
+server port must be given for [newport]. Zero or more status flags
+should be given for 'flags', from the list below (if you do not
+wish to specify any flags just place a '+' in this field):
+1. +a: Redirect all users immediately (except for opers) and cause
+them to quit with the given reason
+2. +n: Redirect any new users who connect and cause them to quit
+during registration
+You may use + and - to set or unset these flags in the command, the
+default flags are -a+n, which will just redirect new users. The
+reason parameter is optional, and if not provided defaults to
+'Please use this server/port instead' (the default given in various
+numeric lists)">
+
+<helpop key="filter" value="/FILTER [filter-definition] {[action] [flags] {[gline-duration]} :[reason]}
+This command will add a filter when more than one parameter is
+given, using the specified filter definition, action, gline
+duration (when the type is 'gline') and reason. When only one
+parameter is provided (the filter pattern) the provided filter will
+be removed. Note that if you remove a configuration-defined filter,
+it will re-appear at next rehash unless it is also removed from the
+config file.">
+
+<helpop key="clones" value="/CLONES [limit]
+Retrieves a list of users with more clones than the specified
+limit.">
+
+<helpop key="check" value="/CHECK [nick|ip|hostmask|channel]
+Allows opers to look up advanced information on channels, hostmasks
+or IP addresses, in a similar way to WHO but in more detail.">
+
+<helpop key="alltime" value="/ALLTIME
+Shows the time (with any delta, if applied) on all servers on
+the network.">
 
 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
 All servers matching [source mask] will try to connect to
 the first server in the config file matching [target mask].">
 
+<helpop key="rsquit" value="/RSQUIT {[source mask]} [target mask]
+Causes the remote server [target mask] to be disconnected from
+the network, by [source mask] if specified.">
+
 <helpop key="operperms" value="/OPERPERMS [nick]
 List all commands an oper has access to use.">
 
@@ -219,19 +350,10 @@ User is also notified they have been frozen.">
 <helpop key="unfreeze" value="/UNFREEZE [nick]
 Unfreezes a user frozen by the /FREEZE command.">
 
-<helpop key="parkstats" value="/PARKSTATS
-Displays the park module's statistics">
-
-<helpop key="spylist" value="/SPYLIST
-Operates the same as /LIST but includes +s and +p channels.">
-
-<helpop key="spynames" value="/SPYNAMES [channel]
-Operates the same as /name but works on +s and +p channels.">
-
 <helpop key="globops" value="/GLOBOPS [message]
-Sends a message to all +g users.">
+Sends a message to all users with the +g snomask.">
 
-<helpop key="cban  " value="/CBAN [channel] {[duration] :[reason]}
+<helpop key="cban" value="/CBAN [channel] {[duration] :[reason]}
 Sets or removes a channel ban. You must specify at least
 3 parameters to add a ban, and one parameter to remove a ban.
 The duration may be specified in seconds, or in the following format
@@ -244,7 +366,7 @@ Forces the user to join the channel.">
 <helpop key="sapart" value="/SAPART [nick] [channel]
 Forces the user to part the channel.">
 
-<helpop key="samode" value="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}
+<helpop key="samode" value="/SAMODE [#chan] +/-[modes] {[parameters for modes]}
 Gives the channel or nick the modes specified.">
 
 <helpop key="sanick" value="/SANICK [nick] [new nick]
@@ -265,14 +387,12 @@ Sets your ident to the specified ident.">
 <helpop key="setname" value="/SETNAME [name]
 Sets your name to the specified name.">
 
-<helpop key="swhois line="/SWHOIS [nick] [swhois]
+<helpop key="swhois" line="/SWHOIS [nick] [swhois]
 Sets the users swhois field to the given swhois.">
 
-<helpop key="mkpasswd" value="/MKPASSWD [plaintext]
-Encodes the plaintext to an MD5 hash and displays the result.">
-
-<helpop key="mksha256" value="/MKSHA256 [plaintext]
-Encodes the plaintext to an SHA-256 hash and displays the result.">
+<helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
+Encodes the plaintext to a hash of the given type and displays
+the result.">
 
 <helpop key="opermotd" value="/OPERMOTD
 Re-displays the Oper MOTD.">
@@ -317,18 +437,14 @@ This command will disconnect a user from IRC with the given reason.">
 
 <helpop key="rehash" value="/REHASH
 This command will cause the server configuration file to be
-re-read and values re-initialised.">
-
-<helpop key="trace" value="/TRACE [nick|user@host|servermask]
-This command will provide a list of all users and servers which
-must be passed through or over to reach a given object (server or user).">
+re-read and values re-initialized.">
 
 <helpop key="connect" value="/CONNECT [servermask]
 Create a mesh connection to the given servermask. You must have
 configured the server for linking in your configuration file,
 and provided a password.">
 
-<helpop key="squit" value="/SQUIT
+<helpop key="squit" value="/SQUIT [servermask]
 Disconnects the local server from the mesh network, causing every
 other server in the network to drop it.">
 
@@ -344,6 +460,10 @@ Loads a module into the IRCd.">
 Unloads a module from the IRCd. The module cannot have the static
 flag set (see the output of /MODULES).">
 
+<helpop key="reloadmodule" value="/RELOADMODULE [filename.so]
+Unloads and reloads a module in the IRCd. This module cannot have
+the static flag set (see the output of /MODULES).">
+
 <helpop key="gloadmodule" value="/GLOADMODULE [filename.so]
 Globally loads a module into the network.">
 
@@ -351,8 +471,12 @@ Globally loads a module into the network.">
 Globally unloads a module from the network. The module cannot 
 have the static flag set (see the output of /MODULES).">
 
+<helpop key="greloadmodule" value="/GRELOADMODULE [filename.so]
+Globally unloads and reloads a module in the network. This module
+cannot have the static flag set (see the output of /MODULES).">
+
 <helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
-Sets or removes a k-line (host based ban) on a host and ident mask.
+Sets or removes a k-line (local host based ban) on a host and ident mask.
 You must specify at least 3 parameters to add a ban, and one
 parameter to remove a ban (just the user@host section).
 The duration may be specified in seconds, or in the following format
@@ -376,7 +500,7 @@ The duration may be specified in seconds, or in the following format
 5 minutes and 6 seconds. All fields in this format are optional.">
 
 <helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
-Sets or removes a g-line (global host based ban) on host mask.
+Sets or removes a g-line (host based ban) on host mask.
 You must specify at least 3 parameters to add a ban, and one
 parameter to remove a ban (just the user@host section).
 The duration may be specified in seconds, or in the following format
@@ -400,18 +524,20 @@ The duration may be specified in seconds, or in the following format
 o                Is an IRC operator
 i                Is invisible to /WHO
 w                Can receive wallops messages
-s                Can receive server notices
-n [mask]         Can recieve server notices specified by [mask]
+s [mask]         Can receive server notices specified by [mask]
 x                Cloaked hostname (requires cloaking module)
-g                Can receive globops (requires globops module)
-h                Will receive helpops notification (requires helpop module)
+h                Is available for help (requires helpop module)
 r                Nickname is registered
-R                Only registered users can PRIVMSG this nickname
+d                Hides all non-private messages and notices
 B                Is a bot
 G                Messages are censored to user
 W                Can see when a user uses WHOIS on them
 S                mIRC colour codes are stripped to the user
-D                User can not recieve PRIVMSGs">
+D                User can not receive PRIVMSGs
+H                Hides an oper's WHOIS line
+I                Hides a user's channel list from non-opers
+Q                Hides an oper completely
+R                Only registered users can message you">
 
 <helpop key="chmodes" value="Channel Modes
 -------------
@@ -438,7 +564,7 @@ S                  mIRC colour codes are stripped from the channel
 e [hostmask]       Ban exception on [hostmask]
 K                  No /KNOCK allowed to channel
 L [channel]        If the channel is full, redirect users to [channel]
-N                  No nickchanges while on the channel
+N                  No nick changes while on the channel
 G                  Censors channel based on network censor config
 g [word]           All messages containing the word are blocked
 I [hostmask]       Invite exception allows user to join a channel with +i
@@ -472,18 +598,21 @@ z  Show memory usage statistics
 o  Show a list of all valid oper usernames and hostmasks
 l  Show all inbound and outbound server and client connections
 u  Show server uptime
-k  Show k-lines (local bans)
-g  Show g-lines (global bans)
+k  Show k-lines (local host bans)
+g  Show g-lines (host bans)
 q  Show q-lines (nick mask bans)
 Z  Show z-lines (ip mask bans)
 Y  Show connection classes
-C  Show link blocks
+c  Show link blocks
 U  Show u-lined servers
 P  Show online opers and their idle times
 I  Show connect class permissions
 e  Show e-lines (local ban exemptions)
 C  Show channel bans
 s  Show filters
+L  Show all client connections with information and IP address
+T  Show bandwidth/socket statistics
+p  Show open client ports, and the port type (ssl, plaintext, etc) plus number of users on each port
 -
 Note that all /STATS use is broadcast to online IRC operators.">