Explorar el Código

* Fix misc help text

svn: 3954
Bryan Drewery hace 17 años
padre
commit
94b7db3c5b
Se han modificado 1 ficheros con 53 adiciones y 48 borrados
  1. 53 48
      doc/help.txt

+ 53 - 48
doc/help.txt

@@ -158,7 +158,7 @@ See also: whois
    bot remembers).
  
    If you want to add a user using a static hostmask, prefix their nick
-   with a '!'. i.e. .adduser !Lamer
+   with a '!'. i.e. '%dadduser !Lamer'
  
    The user being added is sent a NOTICE with their initial password.
  
@@ -254,7 +254,7 @@ See also: -ban, +ban, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
    Just using '?' for 'bot' will choose a random leaf bot.
    Just using '&' for 'bot' will do the cmd on all localhub bots. (first bot in config).
  
-   This cmd cannot be chained over the botnet, ie, no: .botcmd [bot] botcmd [bot2] ...
+   This cmd cannot be chained over the botnet, ie, no: '%dbotcmd [bot] botcmd [bot2] ...'
  
    There are two default aliases added for this cmd:
      bc -> botcmd
@@ -265,6 +265,9 @@ See also: cmdpass
 ###  $bbotjoin$b <bot> <channel> [options]
    Adds a channel to the bot's channel list. If options are specified, the 
    channel will be configured with the options.
+
+   $bTHIS CMD IS CURRENTLY EXPERIMENTAL AND WILL NOT ACTUALLY SAVE STATE$b
+   $bMEANING, ALL BOTS WILL JOIN EVENTUALLY AFTER DOING BOTJOIN$b
  
 See also: botpart, +chan, -chan, chanset, chaninfo
 :hub:botjump:
@@ -417,7 +420,7 @@ See also: link
       $bmdop$b                   Users who mass deop.
       $bmop$b                    Users who mass op in a -mop chan.
  
-   The following can be set + or - (e.g. .chanset #channel -enforcebans)
+   The following can be set + or - (e.g. '%dchanset #channel -enforcebans')
         $bautoop$b         Bots that are +y will auto-op all users with 
                        op access to the channel.
         $bbackup$b         Make backup-bots (+B) join when set.
@@ -483,7 +486,7 @@ See also: link
         $bdynamicexempts$b Only activate exempts on the channel when
                        necessary? This keeps the channel's exempt list from
                        getting excessively long. The bot still remembers every
-                       exempt, but it only activates a exempt on the channel
+                       exempt, but it only activates an exempt on the channel
                        when it sees a ban set that matches the exempt. The
                        exempt remains active on the channel for as long as the
                        ban is still active.
@@ -500,8 +503,8 @@ See also: link
         $buserinvites$b    Allow invites to be made by users directly? If turned
                        off, the bot will require all invites to be made through
                        the bot's console.
-   The following are flood settings, they are set via "%dchanset <channel>
-   flood-type number:seconds", where number and second are integers
+   The following are flood settings, they are set via '%dchanset <channel>
+   flood-type number:seconds', where number and second are integers
    indicating the number of times in how many seconds the flood will be
    triggered. Setting one of these to 0:0, 0:1, or 1:0 will deactivate the
    respective flood setting.
@@ -592,17 +595,17 @@ See also: console
 ###  $bchattr$b <handle> [flags] [channel]
    This lets you view and change the flags for a user.
    For example, to give Lamer the p and f flags:
-      .chattr Lamer +pf
+      '%dchattr Lamer +pf'
    To remove Denali from the global op list:
-      .chattr Denali -o
+      '%dchattr Denali -o'
    You may also do any combination of the above:
-      .chattr Fred1 -m+xj-o
+      '%dchattr Fred1 -m+xj-o'
    You can also change the flags for Usagi on a specific channel by supplying
    the channel after the attributes:
-      .chattr Usagi -m+dk-o #blah
+      '%dchattr Usagi -m+dk-o #blah'
    Changing global and channel specific flags within the same command line is
    also possible (global +o #lamer):
-      .chattr Bill f|o #lamer
+      '%dchattr Bill f|o #lamer'
    Whether or not you change any flags, it will show you the user's attributes
    afterwards. To get a list of all possible flags, see $b'%dhelp whois'$b.
    $bNOTES:$b Only the owner may add or remove the 'a' (admin) or 'n' (owner) flags.
@@ -671,13 +674,13 @@ See also: +host, -host
 ###  $bcmdpass$b <command> <pass> [newpassword]
    Places the specified pass on the cmd so that the cmd will need to be 
    followed by the specified pass whenever it is called. For example:
-    %dcmdpass whoami BLAH
+    '%dcmdpass whoami BLAH'
      [19:32] #bryan# cmdpass whoami ...
      Set command password for whoami to 'BLAH'
-    %dwhoami
+    '%dwhoami'
      Invalid command password. Use !command password arguments
      [19:33] bryan attempted !whoami with missing or incorrect command password
-    %dwhoami BLAH
+    '%dwhoami BLAH'
      You are bryan@hub.
      [19:33] #bryan# whoami
  
@@ -956,7 +959,7 @@ See also: decrypt, randstring, md5, sha1
  
    Here's a sample entry;
       ! [ 3] *!test@test.com (perm)
-             Wcc: requested
+             bryan: requested
              Created 01:15
  
    The number (3) can be used to reference the exempt if you wish to remove it
@@ -965,7 +968,7 @@ See also: decrypt, randstring, md5, sha1
    expire. If there is an elapsed time showing instead, the time displayed is
    how long the exempt has been active. These types of exempts expire after one
    hour. The second line of the exempt entry is the comment ("requested"), and
-   who set the exempt (Wcc). The last line shows when the exempt was added, and
+   who set the exempt (bryan). The last line shows when the exempt was added, and
    possibly the last time the exempt was activated on the channel (if it's
    different from the creation time).
  
@@ -992,7 +995,7 @@ See also: decrypt, randstring, md5, sha1
 See also: -exempt, +exempt, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
 :leaf:find:
 ###  $bfind$b  <nick!ident@host.com>|<user>
-   The bot will search through all of it's channel records and look
+   The bot will search through all of its channel records and look
    for the specified hostmask.  Wildcards are accepted; '*' for 1 or more
    characters, or '?' for exactly 1 character.
    If a username is specified, then the user is searched for in all the channel
@@ -1045,17 +1048,17 @@ See also: uplink, chaddr
    to remove them.
    Here is a sample permanent ignore:
       [  1] *!*@217.156.44.184 (perm)
-            Wcc: go away
+            bryan: go away
             Started 523 days ago
    The number (1) can be used to reference the ignore if you wish to remove it
    (see $b'%dhelp -ignore'$b). Next is the actual hostmask being ignored. The
    "(perm)" means that the ignore is "permanent": that is, it doesn't
    automatically expire. The second line of the ignore entry is the comment
-   ("go away"), and who set the ban (Wcc). The last line shows when the ignore
+   ("go away"), and who set the ban (bryan). The last line shows when the ignore
    was added.
    Here is a sample temporary ignore:
       [ 10] blah!blah@blah.cc (expires in 1 day)
-            Wcc: requested
+            bryan: requested
             Started 18:02
    Here, you see the "perm" in the parentheses next to the hostmask is instead
    an expire time. This means that the ignore will expire automatically in one
@@ -1087,7 +1090,7 @@ See also: console, iop
  
    Here's a sample entry;
       ! [ 3] *!test@test.com (perm)
-             Wcc: requested
+             bryan: requested
              Created 01:15
  
    The number (3) can be used to reference the invite if you wish to remove it
@@ -1096,7 +1099,7 @@ See also: console, iop
    expire. If there is an elapsed time showing instead, the time displayed is
    how long the invite has been active. These types of invites expire after one
    hour. The second line of the invite entry is the comment ("requested"), and
-   who set the invite (Wcc). The last line shows when the invite was added, and
+   who set the invite (bryan). The last line shows when the invite was added, and
    possibly the last time the invite was activated on the channel (if it's
    different from the creation time).
  
@@ -1159,15 +1162,15 @@ See also: kickban, console
         e.g. with a host of nick!ident@host.name.domain
  
         command        banmask
-        .kickban nick  *!*dent@*.name.domain
-        .kickban -nick *!*dent@host.name.domain
-        .kickban @nick *!*@host.name.domain
+        '%dkickban nick  *!*dent@*.name.domain'
+        '%dkickban -nick *!*dent@host.name.domain'
+        '%dkickban @nick *!*@host.name.domain'
  
         with a host of nick!~ident@host.name.domain (strict-host set to 1)
  
         command        banmask
-        .kickban nick  *!*ident@*.name.domain
-        .kickban -nick *!*ident@host.name.domain
+        '%dkickban nick  *!*ident@*.name.domain'
+        '%dkickban -nick *!*ident@host.name.domain'
  
 See also: +ban, bans, stick
 :hub:lagged:
@@ -1202,27 +1205,27 @@ See also: echo, color, console, page, strip, whois
    "attr" is of the form:  <+/-><global>[&/|<channel>[&/|<bot>]]
    Specifying "&" as the separator will cause AND style matching.
    For example:
-      %dmatch p&o
+      '%dmatch p&o'
    This will match all users with both the "p" global flag and the "o" channel
    flag on your current console channel.
    Specifying "|" as the separator will cause OR style matching.
    For example:
-     %dmatch p|o
+     '%dmatch p|o'
    This will match all users with either the "p" global flag or the "o" channel
    flag on your current console channel. If you specify a channel, it will be
    used instead of the current console channel.
    For example:
-     %dmatch p|o #eggdrop
+     '%dmatch p|o #eggdrop'
    This will match all users with either the "p" global flag or the "o" channel
    flag on the channel #eggdrop. You can also match bot flags.
    For example:
-     %dmatch o|o|h
+     '%dmatch o|o|h'
    This will match all bots with either the "o" global flag, the "o" channel
    flag on the current console channel, or the "h" botflag. You can also limit
    the number of total results returned by specifying a limit at the end of the
    command. A starting point can also be specified.
    For example:
-     %dmatch p&o #eggdrop 16 25
+     '%dmatch p&o #eggdrop 16 25'
    This would show results 16 through 25 matching any users with the "p" global
    flag or the "o" channel flag on #eggdrop.
 ###  $bmatch$b <wildcard-string> [[start] limit]
@@ -1231,9 +1234,11 @@ See also: echo, color, console, page, strip, whois
    of total results returned by specifying a limit at the end of the command. A
    starting point can also be specified.
    For example:
-     %dmatch *.edu 16 25
+     '%dmatch *.edu 16 25'
    This would show results 16 through 25 matching any users with a hostmask
    that ends with ".edu".
+
+   $bThis command will not match on bots. You must use 'matchbot' for that.$b
 See also: matchbot
 ::matchbot
 ###  $bmatchbot$b 
@@ -1247,7 +1252,7 @@ See also: match
 See also: randstring, sha1, encrypt, decrypt
 ::me
 ###  $bme$b <text>
-   Performs an action on the party line. This appears as "* Wcc is leaving",
+   Performs an action on the party line. This appears as "* bryan is leaving",
    etc.
 :leaf:mmode:
 ###  $bmmode$b <(+|-)MODE> <#channel> <a|o|v|d|r> [bots=n] [alines=n] [slines=n] [overlap=n] [bitch] [simul] [local]
@@ -1437,7 +1442,7 @@ See also: restart
 ###  $brelay$b <bot>
    Relays you via telnet to another bot, whether or not it is currently linked.
    The local bot must, however, have a bot record for the bot you wish to
-   relay to. Typing .quit or "*bye*" on a line by itself will end the relay.
+   relay to. Typing '%dquit' or "*bye*" on a line by itself will end the relay.
  
 See also: bots%{+n}, newleaf%{-}%{+a}, -bot%{-}
 ::reload
@@ -1450,9 +1455,9 @@ See also: save
 ###  $breset$b [channel]
    Clears out the bot's channel information and makes it gather the
    information from the server all over again, as if it had just
-   joined that channel.  it's not really useful much, but could be
+   joined that channel. It's not really useful much, but could be
    if an odd bug causes the channel information to get scrambled.
-   unfortunately this command used to get a lot of use.  you can omit
+   unfortunately this command used to get a lot of use. You can omit
    the channel name to make it reset ALL channels.
  
 See also: resetbans, resetexempts, resetinvites
@@ -1517,7 +1522,7 @@ See also: reload, backup
  
    The '+' may be used to add 1 element to a comma separated list. (ie, servers)
    The '-' may be used to remove 1 element from a comma separated list. (ie, servers)
-   The 'list' may be used to list a comma separated variable as a vertical listing. (like %dservers)
+   The 'list' may be used to list a comma separated variable as a vertical listing. (like '%dservers')
  
  
    Current variables:
@@ -1563,7 +1568,7 @@ See also: reload, backup
  
 [D]  $blogin$b           How to handle someone logging in to the shell.
 [D]  $btrace$b           How to handle someone tracing/debugging the bot.
-[D]  $bpromisc$b         How to handle when a interface is set to promiscuous mode.
+[D]  $bpromisc$b         How to handle when an interface is set to promiscuous mode.
 [D]  $bhijack$b          How to handle when a commonly used hijack method attempt is detected. 
  
 [SL] $bservers$b         Comma-separated list of servers the bot will use.
@@ -1591,8 +1596,8 @@ See also: reload, backup
                          unless upgrading or letting an older bot link in to upgrade.
 
 [B]  $bdccauth$b         Boolean (0 or 1). Set to use auth checking on dcc/telnet login.
-[N]  $bop-bots$b         Number of bots to ask every time a oprequest is to be made.
-[N]  $bin-bots$b         Number of bots to ask every time a inrequest is to be made.
+[N]  $bop-bots$b         Number of bots to ask every time an oprequest is to be made.
+[N]  $bin-bots$b         Number of bots to ask every time an inrequest is to be made.
  
 [R]  $bop-requests$b     (requests:seconds) limits how often the bot will ask for ops.
 [R]  $bclose-threshold$b (H:L) When at least H hubs but L or less leafs are linked, close 
@@ -1629,8 +1634,8 @@ See also: randstring, md5, encrypt, decrypt
 ###  $bsimul$b <handle> <text>
    This allows you to simulate the specified handle typing the given text.
    For example:
-      %dsimul dweeb%d.quit
-   This would appear just as if "dweeb" typed "%dquit". This command will not
+      '%dsimul dweeb%d.quit'
+   This would appear just as if "dweeb" typed '%dquit'. This command will not
    work unless eggdrop has simul enabled in the config file. 
  
 See also: su
@@ -1826,10 +1831,10 @@ See also: devoice
    Displays a list of users on the local bot.
  
    For example:
-      [23:21] #Wcc# who
+      [23:21] #bryan# who
       Party line members:  (* = owner, + = master, @ = op)
-      *Wcc       telnet@xxx.atlaga.adelphia.net (idle 17m)
-      *Wcc       telnet@xxx.atlaga.adelphia.net
+      *bryan       telnet@xxx.atlaga.adelphia.net (idle 17m)
+      *bryan       telnet@xxx.atlaga.adelphia.net
       Bots connected:
       -> wortel (05 Dec 16:32) eggdrop v1.6.15 <efnet>
  
@@ -1928,10 +1933,10 @@ See also: match, who, whom%{+m|m}, chattr, chaninfo%{-}
    '*' is assumed if no parameters are given.
  
    For example:
-      [23:12] #Wcc# whom
+      [23:12] #bryan# whom
        Nick        Bot        Host
       ----------   ---------  --------------------
-      *Wcc         Anakha     telnet@xxx.atlaga.adelphia.net [idle 8m]
+      *bryan         Anakha     telnet@xxx.atlaga.adelphia.net [idle 8m]
       *BitchSmack  Anakha     telnet@xxx.atlaga.adelphia.net
       Total users: 2