home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / tinymush.zip / TinyMush / wizhelp.txt < prev    next >
Text File  |  1997-11-19  |  113KB  |  2,602 lines
  1. & help
  2.   This is the MUSH online help facility for wizard commands and topics.
  3.   The information provided by this command is generally not useful for
  4.   anyone other than wizards and game maintainers, as the features described
  5.   here are only accessible to characters whose WIZARD bit is set, or to those
  6.   who have access to the directory where the MUSH data files reside.
  7.  
  8.   Syntax of help command:
  9.      wizhelp [<command/topic>]
  10.  
  11.   To get a list of MUSH wizard topics:
  12.      wizhelp topics
  13.  
  14.   To get a list of MUSH wizard commands:
  15.      wizhelp commands
  16.  
  17.   If there are any errors in the help text, please notify a Wizard.
  18.   See also: help.
  19.  
  20. & commands
  21.   Help is available for the following MUSH commands:
  22.  
  23.   DOING          examine        give           SESSION        slay
  24.   WHO            wizhelp
  25.  
  26.   @admin         @apply_marked  @attribute     @boot          @chown
  27.   @chownall      @clone         @cut           @dbck          @destroy
  28.   @disable       @doing         @dump          @enable        @fixdb
  29.   @function      @halt          @kick          @list          @list_file
  30.   @listmotd      @lock          @mark          @mark_all      @motd
  31.   @newpassword   @pcreate       @poor          @ps            @purge
  32.   @quota         @readcache     @restart       @rwho          @shutdown
  33.   @timewarp      @toad          @wall
  34.  
  35.   @allowance     @comment       @timeout
  36.  
  37. & topics
  38.   Help available on the following Topics:
  39.  
  40.   CAUTIONS         CONFIG PARAMETERS  DEBUG FEATURES     FILES
  41.   FLAGS            INHERITANCE        LOGGING            MASTER ROOM
  42.   PERMISSIONS      SEARCH CRITERIA    SITE LISTS
  43.  
  44. & flags
  45.   Information is available on the following flags:
  46.  
  47.   INHERIT(i)         MARKED(m)          STARTUP(z)         SUSPECT(u)
  48.   WIZARD(W)
  49.  
  50. & examine
  51.   Command: examine[/<switches>] [<object>]
  52.  
  53.   Wizards may use the /debug switch to see additional information about the
  54.   object.  The Owner, Exits, Next, and Contents fields of the object are
  55.   shown in numeric form only, and an attribute list is included.
  56.  
  57. & give
  58.   Command: give[/<switches>] <who> = <what>
  59.  
  60.   Wizards may use the /quiet switch to suppress the 'You give X to P' and
  61.   'P gave you X' messages.  Other messages related to giving objects
  62.   (such as the xDROP and xSUCC attributes on the object being given, or
  63.   error messages) are not suppressed.
  64.  
  65. & SESSION
  66.   Command: SESSION <prefix>
  67.   The SESSION command displays character input and output information for
  68.   all connected players, or just those who match <prefix>.
  69.  
  70.   This command can be used to help identify network problems as follows:
  71.     - A nonzero Input Pending count can indicate indicate typeahead or a
  72.       client program dumping commands faster than the command scheduling
  73.       parameters let them be executed.  Telnet sessions in character mode also
  74.       show up with positive Input Pending counts when the player is in the
  75.       middle of typing a command.
  76.     - A nonzero Input Lost count means that the player has typed a line longer
  77.       than what the mush can handle.  This usually indicates a problem with
  78.       the player's client or terminal (a stuck key).
  79.     - A persistently large Output Pending count can indicate netlag between
  80.       the host site and the player's site, or merely that the player has
  81.       performed a command that generated a lot of output which hasn't been
  82.       sent yet.
  83.     - A nonzero Output Lost count usually means that the player performed
  84.       a command that produced more output than the output buffer could hold.
  85.       It may also indicate network problems or that the player is generating
  86.       output faster than the network or his client can process it.
  87.      
  88. & slay
  89.   Command: slay <player/object>
  90.   Kills the indicated player or object without paying any insurance to the
  91.   victim.  It should be used in places where suicide should not be rewarded.
  92.   See also: kill, IMMORTAL.
  93.  
  94. & WHO
  95.   Command: WHO <prefix>
  96.  
  97.   The WHO command returns miscellaneous information about connected players.
  98.   It returns the player name, connect time, idle time, and player flags just
  99.   like the player WHO command (which is available as the DOING command), but
  100.   returns the following information in place of the player's Doing string:
  101.  
  102.      Room         - The room that the player is in.
  103.      Commands     - The number of commands that the player has entered during
  104.                     this session (not counting machine commands).
  105.      Host flags   - located between the Commands and Host fields:
  106.                     F(forbidden), R(registration), +(suspect).
  107.      Host         - The Internet host name or address from where the player has
  108.                     connected.
  109.  
  110.   See also: SESSION, DOING.
  111.  
  112. & DOING
  113.   Command: DOING <prefix>
  114.  
  115.   This command is very similar to the mortal WHO command (the wizard WHO
  116.   command returns different information).  When run by a wizard, the DOING
  117.   command reports additional information about the player in the form of flag
  118.   letters between the idle time and the players' Doing string.  The following
  119.   letters may be present:
  120.  
  121.   D - Player is set DARK.
  122.   d - Player is not shown on the WHO list because they have been idle for
  123.       longer than the default inactivity timeout and the idle_dark_wiz
  124.       configuration parameter has been turned on. (only if not D)
  125.   U - Player is set UNFINDABLE.
  126.   u - Player is in an UNFINDABLE location (only if not U).
  127.   + - Player is set SUSPECT.
  128.  
  129.   See also: SESSION, WHO, DARK, UNFINDABLE, SUSPECT, idle_dark_wiz.
  130.  
  131. & wizhelp
  132.   Command: wizhelp <topic>
  133.   Displays information from the wizard help file.  The information is
  134.   typically of use only to wizards and/or the game maintainer.
  135.   See also: the source code.
  136.  
  137. & @admin
  138.   Command: @admin <param>=<value>
  139.   Sets a TinyMUSH configuration parameter to the indicated value.
  140.   Type 'wizhelp config parameters' for a list of the config parameters that
  141.   may be set.
  142.  
  143. & @apply_marked
  144.   Command: @apply_marked <command>
  145.   Performs <command> once for each object in the database that has its MARK
  146.   flag set, substituting the characters ## for the object number of the
  147.   marked object.  The command is performed by the player invoking the
  148.   @apply_marked command, not by the marked object.  This command may only
  149.   be used when database cleaning is disabled (via @disable cleaning),
  150.   as cleaning uses the MARKED flag to check connectivity.
  151.   See also: @mark, @mark_all, MARKED.
  152.  
  153. & @attribute
  154.   Command: @attribute[/<switch>] <attrib>[=<value>]
  155.   Performs operations on user-named attributes depending on the switch used.
  156.   The following switches are available:
  157.      /access   - Changes the access to the named attribute.  <value> is a
  158.                  space-separated list of permissions to add or remove from
  159.                  the attribute's access permissions.  For a list of
  160.                  possible permissions, see 'wizhelp attribute permissions'.
  161.      /delete   - Removes the named attribute from the attribute table.
  162.                  This switch does not remove instances of the attribute from
  163.                  objects, and any that remain will be renamed to the 
  164.                  user-named attribute that re-uses the attribute number
  165.                  of the deleted attribute.
  166.      /rename   - Changes the name of the named attribute to <value>.
  167.   Note that changes to user-named attributes performed by this command
  168.   are permanent and do not need to be performed each time the MUSH is
  169.   restarted.
  170.  
  171. & attribute permissions
  172.  
  173.   Possible values are: dark  deleted  god  hidden  ignore  is_lock
  174.   locked  no_command  no_inherit  private  visual  wizard.
  175.  
  176. & @boot
  177.   Command: @boot[/<switches>] <player>
  178.   Severs the named player's connection to the game.  The player is given a
  179.   notice that they have been booted.  If the player is connected to the game
  180.   more than once, then all connections to that player are severed.
  181.  
  182.   The following switches are available:
  183.     /quiet - Don't give the booted player any special notice.
  184.     /port  - Disconnects only a specific port (port numbers may be obtained
  185.              from the SESSION command).  In this case <player> must be a
  186.              number.
  187.   See also: @destroy, @toad, SESSION.
  188.  
  189. & @chown
  190.   Command: @chown <object>=<player>
  191.  
  192.   Wizards may @chown objects, rooms, and exits to other players.
  193.   @Chowned objects are set HALT.
  194.  
  195.   See also: @chownall.
  196.  
  197. & @clone
  198.   Command: @clone[/<switches>] <object>
  199.   Wizards may also specify the /preserve switch, which preserves the original
  200.   owner of the object in the new copy, instead of creating the copy as being
  201.   owned by the wizard.
  202.  
  203. & @chownall
  204.   Command: @chownall <victim>[=<recipient>]
  205.   Changes the ownership of all of the victim's objects, rooms, and exits to
  206.   the indicated recipient (or to the wizard performing the @chownall if
  207.   no recipient is specified).  All objects, rooms, and exits are set HALTED.
  208.   See also: @chown.
  209.  
  210. & @cut
  211.   Command: @cut <object/exit>
  212.   Cuts off the object or exit list for the current location at the indicated
  213.   object or exit by setting [next(thing)] to NOTHING.  Objects or exits that
  214.   follow in the chain are not moved or otherwise changed, and are only
  215.   accessible by object number.  This command is intended for performing
  216.   database repair, and should be used only with extreme caution.
  217.  
  218. & @dbck
  219.   Command: @dbck
  220.   Performs a scan of the database looking for inconsistencies in the object
  221.   chains, disconnected rooms, rooms waiting to be destroyed, and problems in
  222.   the object free list.  Problems that are found are reported to the log
  223.   file, disconnected rooms are reported to their owners, and players are
  224.   credited for rooms destroyed.  Database checks are automatically run
  225.   periodically, so there is usually no need to use this command.
  226.   See also: @admin, @disable, @enable, @list, @purge.
  227.  
  228. & @destroy
  229.   Command: @destroy[/<switches>] <object>
  230.  
  231.   Players are always considered SAFE. Depending on the way the configuration
  232.   is set up, objects owned by other players may be automatically considered
  233.   SAFE.
  234.  
  235. & @disable
  236.   Command: @disable <option>
  237.   Turns off the indicated MUSH runtime parameter.  The following parameters
  238.   may be turned off:
  239.     building      - Allows players to use the building commands.
  240.     checkpointing - Enables periodic database checkpoint dumping.
  241.     cleaning      - Enables periodic scanning of the database for rooms
  242.                     to be destroyed.
  243.     dequeueing    - Allows commands to be removed from the queue and
  244.                     executed.
  245.     idlechecking  - Enables periodic checking for and booting of idle
  246.                     players.
  247.     interpret     - Enables execution of commands that place commands
  248.                     on the queue.
  249.     local_rwho    - Enables the RWHO command for querying a remote RWHO
  250.                     server.
  251.     logins        - Allows nonwizard players to connect to their characters.
  252.     transmit_rwho - Enables transmission of player data to a remote RWHO
  253.                     server.
  254.   These parameters are all enabled by default.
  255.   See also: @enable, @list.
  256.  
  257. & @doing
  258.   Command: @doing[/<switch>] <text>
  259.   Wizards may use the /header switch to set the Doing header in the WHO report.
  260.   If no header is specified, the header is reset to "Doing".
  261.  
  262. & @dump
  263.   Command: @dump[/<switches>]
  264.   Writes a checkpoint dump of the database to disk.  Checkpoint dumps are
  265.   automatically performed periodically, so there is usually no need to use
  266.   this command.  Switches may be used to either dump just the structure
  267.   portion of the database to a flat file, or to ensure that all changes to
  268.   the text database are written out to disk.  The default is to write out
  269.   both files.
  270.   The following options are available:
  271.      structure  - Dump the structure portion of the database to a flat file.
  272.      text       - Ensure that all changes to the text portion of the
  273.                   database are written out to disk.
  274.   See also: @admin, @disable, @enable, @list, @shutdown.
  275.  
  276. & @enable
  277.   Command: @enable <option>
  278.   Turns on the indicated MUSH runtime parameter.  The following parameters
  279.   may be turned on:
  280.     building      - Allows players to use the building commands.
  281.     checkpointing - Enables periodic database checkpoint dumping.
  282.     cleaning      - Enables periodic scanning of the database for rooms
  283.                     to be destroyed.
  284.     dequeueing    - Allows commands to be removed from the queue and
  285.                     executed.
  286.     idlechecking  - Enables periodic checking for and booting of idle
  287.                     players.
  288.     interpret     - Enables execution of commands that place commands
  289.                     on the queue.
  290.     local_rwho    - Enables the RWHO command for querying a remote RWHO
  291.                     server.
  292.     logins        - Allows nonwizard players to connect to their characters.
  293.     transmit_rwho - Enables transmission of player data to a remote RWHO
  294.                     server.
  295.   These parameters are all enabled by default.
  296.   See also: @disable, @list.
  297.  
  298. & @fixdb
  299.   Command: @fixdb[/<switch>] <object>=<value>
  300.   This command directly edits the database structure according to the
  301.   switch specified.  As such, it is possible to produce database
  302.   inconsistencies that can hang or crash the server.  This command should
  303.   be used with extreme caution.
  304.  
  305.   The following switches are available:
  306.      contents     - Sets the contents pointer of <object> to <value>
  307.      exits        - Sets the exits pointer of <object> to <value>
  308.      location     - Sets the location pointer of <object> to <value>
  309.      next         - Sets the next pointer of <object> to <value>
  310.      owner        - Sets the owner of <object> to <value>
  311.      pennies      - Sets the value or wealth of <object> to <value>
  312.      rename       - Renames <object> to <value>
  313.  
  314. & @function
  315.   Command: @function[/<switches>] <function>=<object>/<attr>
  316.  
  317.   This command creates a global function named <function>.  When invoked,
  318.   the arguments to the function are loaded into %0-%9, the <attr> attribute
  319.   from <object> is fetched, and substitution is performed on the resulting
  320.   text.  The result of that substitution is returned as the function result.
  321.  
  322.   If the /privileged switch is given, then the function is evaluated as if
  323.   the evaluation were being performed by the object on which it is stored,
  324.   instead of as if it were being performed by the invoker of the function.
  325.   This may be used to allow access to information normally available only
  326.   to wizards.
  327.  
  328.   The function definitions created by @function are not stored in the database
  329.   so they need to be re-created each time the MUSH is started.  It is
  330.   recommended that the Startup attribute for player #1 include code to
  331.   set up all global functions.
  332.  
  333.   Function definitions may not be removed (aside from shutting down and
  334.   restarting the MUSH, but they may be redefined so that they point to an
  335.   unused attribute.  This command may normally only be invoked by player #1.
  336.  
  337. & @halt
  338.   Command: @halt[/<switches>] [<object>]
  339.   This command can be used to halt commands being run by a specific object,
  340.   all commands being run by objects owned by a specific player, or all
  341.   commands in the game.  If <object> is not specified, the object running
  342.   the command is halted.  If the object being halted is a player, then
  343.   all commands being run by objects owned by that player are halted.
  344.   Halting an object does not affect commands waiting on it as a semaphore,
  345.   use the @drain command to reset a semaphore.
  346.  
  347.   The /all switch may be used to halt all commands globally.
  348.   See also: @drain, @notify, kill, HALTED, SEMAPHORES.
  349.  
  350. & @kick
  351.   Command: @kick <count>
  352.   Immediately executes the first <count> commands from the top of the queue.
  353.   See also: @disable, @enable, @timewarp.
  354.  
  355. & @list
  356.   Command: @list [<option>]
  357.   Lists information from internal databases.  Information is available
  358.   about the following options:
  359.  
  360.     allocations         attr_permissions    attributes          bad_names
  361.     buffers             commands            costs               db_stats
  362.     default_flags       flags               functions           globals
  363.     hashstats           logging             options             permissions
  364.     powers              process             site_info           switches
  365.     user_attributes
  366.  
  367.   Type wizhelp @list <option> for help with a particular option.
  368.  
  369. & @list allocations
  370.   Command: @list allocations
  371.   This command lists the usage statistics for the internal buffer pools.
  372.   For each buffer pool, the following information is listed:
  373.     Size   - The size of a buffer, in characters.
  374.     InUse  - The number of buffers presently allocated from the pool.
  375.     Total  - The total number of buffers currently in the pool.
  376.     Allocs - The total number of buffers ever allocated from the pool.
  377.     Lost   - The number of buffers lost due to buffer header corruption.
  378.  
  379.   Information is reported for the following pools:
  380.     Lbufs    - Large buffers, used when handling data input by the user,
  381.                object attributes, the results of interpreting commands, and
  382.                many other places.
  383.     Mbufs    - Medium-sized buffers, for when an sbuf is too small but an lbuf
  384.                is too large.
  385.     Sbufs    - Small buffers, for when you need only a little space.
  386.     Bools    - Boolean expressions, used when evaluating locks.
  387.     Descs    - Network descriptors, one is used for each connected player.
  388.     Qentries - Queue entries, one is used for each command placed on the
  389.                queue. (@wait, @trigger, @switch, @dolist, etc).
  390.  
  391.   See also: @list buffers.
  392.  
  393. & @list attr_permissions
  394.   Command: @list attr_permissions
  395.   Lists the attributes and the access restrictions that have been placed on
  396.   them. The attributes are listed one per line.  Refer to the attr_access
  397.   config parameter for the meanings of the restrictions.
  398.  
  399.   Note that being allowed to write to an attribute does not imply the right
  400.   to use the @<attr-name> shorthand command to set it, just the @set command.
  401.   See also: @list permissions, attr_access.
  402.  
  403. & @list attributes
  404.   Command: @list attributes
  405.   Lists the attributes that are visible or settable by you.
  406.   See also: @list attr_access, @list permissions.
  407.  
  408. & @list bad_names
  409.   Command: @list bad_names
  410.   This command lists the player names that are not allowed to be created.
  411.   Any create request (whether via the login screen or @pcreate) that matches
  412.   (after wildcard expansion) one of the names in the list will be rejected.
  413.  
  414. & @list buffers
  415.   Command: @list buffers
  416.   For each buffer in a buffer pool that is currently allocated, lists where
  417.   within TinyMUSH the buffer was allocated.
  418.  
  419. & @list commands
  420.   Command: @list commands
  421.   Lists the internal commands that you may execute.  This command does not
  422.   list the attribute-setting commands that you may use (like @va or @ahear),
  423.   and does not list exits in your current room or $-commands on objects.
  424.   See also: @list attr_access, @list attributes, @list permissions.
  425.  
  426. & @list costs
  427.   Command: @list costs
  428.   Lists the costs that are associated with some commands, particularly those
  429.   that expand the database.
  430.  
  431. & @list db_stats
  432.   Command: @list db_stats
  433.   Lists statistics for the database cache.
  434.  
  435. & @list default_flags
  436.   Command: @list default_flags
  437.   Lists the flags that are automatically given to players, things, rooms,
  438.   exits, and robots when they are created.
  439.   See also: player_flags, thing_flags, room_flags, exit_flags, robot_flags.
  440.  
  441. & @list flags
  442.   Command: @list flags
  443.   For each object type, lists the name and key letter for all flags that may
  444.   be set on that object type that are visible to you.
  445.  
  446. & @list functions
  447.   Command: @list functions
  448.   Lists the functions that may be used to obtain information when evaluating
  449.   command lines.
  450.  
  451. & @list globals
  452.   Command: @list globals
  453.   Lists the global parameters that may be set or cleared by the @enable and
  454.   @disable commands.  The following parameters are displayed.
  455.  
  456.     building       - Indicates whether or not commands that alter the
  457.                      stricture of the database are allowed.
  458.     checkpointing  - Indicates whether or not the database is to be
  459.                      periodically written to disk.
  460.     cleaning       - Indicates whether or not the database is to be
  461.                      periodically checked for deleted or disconnected rooms,
  462.                     and other connectivity problems.
  463.     dequeueing     - Indicates whether or not commands on the queue may be
  464.                      automatically executed.
  465.     god_monitoring - Indicates whether or not monitoring of commands is
  466.                      on (interactive debugging mode).
  467.     idlechecking   - Indicates whether or not the inactivity limits are
  468.                      enforced.
  469. { 'wizhelp @list globals2' for more }
  470. & @list globals2
  471.     interpret      - Indicates whether or not new commands may be added to
  472.                      the queue.
  473.     local_rwho     - Indicates whether or not the RWHO command may be used
  474.                      to read data from the configured remote RWHO server.
  475.     logins         - Indicates whether or not nonwizard players are allowed
  476.                      to connect.
  477.     transmit_rwho  - Indicates whether or not user information is to be
  478.                      periodically sent to the configured remote RWHO server.
  479.  
  480.   See also: RWHO, @dbck, @disable, @enable, @kick, @list permissions, @purge,
  481.             @timewarp, checkpoint, conn_timeout, dump_interval, dump_offset,
  482.             idle_interval, idle_timeout, rwho_data_port, rwho_dump_interval,
  483.             rwho_host, rwho_info_port, rwho_password, rwho_transmit.
  484.  
  485. & @list hashstats
  486.   Command: @list hashstats
  487.   Lists the hashing statistics for each of the internal hash tables.
  488.   For each hash table, the following information is displayed:
  489.     Size    - The number of hash buckets in the hash table.
  490.     Entries - The number of entries currently in the hash table.
  491.     Deleted - The number of entries that have been deleted from the hash
  492.               table.
  493.     Empty   - The number of hash buckets with no entries.
  494.     Lookups - The number of times the hash table has been searched.
  495.     Hits    - The number of times that an item that was searched for was
  496.               found.
  497.     Checks  - The total number of comparisons made against hash table entries
  498.               to see if they were the desired entry.
  499.     Longest - The maximum number of entries in one hash bucket.
  500.  
  501. { 'wizhelp @list hashstats2' for more }
  502. & @list hashstats2
  503.   Information is displayed for the following hash tables:
  504.     Commands            - Internal MUSH commands
  505.     Logged-out commands - Commands valid whether or not you are connected
  506.                           (such as WHO and QUIT).
  507.     Functions           - MUSH functions, such as rand() and lexits().
  508.     Player flags        - Names of flags valid for players.
  509.     Thing flags         - Names of flags valid for things.
  510.     Room flags          - Names of flags valid for rooms.
  511.     Exit flags          - Names of flags valid for exits.
  512.     Attribute names     - Object attribute names.
  513.     Attribute numbers   - Object attribute numbers (only used internally).
  514.     Net descriptors     - Mapping of player DB numbers to net descriptors.
  515.     News topics         - Topics for the news command.
  516.     Help topics         - Topics for the help command.
  517.     Wizhelp topics      - Topics for the wizhelp command.
  518.  
  519.   See also: alias, attr_alias, flag_alias.
  520.  
  521. & @list logging
  522.   Command: @list logging
  523.  
  524.   Lists the type of information that is written to the log file and how it is
  525.   displayed. See 'wizhelp log' for a list of the kinds of information which
  526.   can be logged.
  527.  
  528.   The following formatting information is listed:
  529.  
  530.     flags          - Include flags for players/objects/rooms listed.
  531.     location       - Include location if player/object when requested.
  532.     owner          - Include owner of objects/rooms listed.
  533.     timestamp      - Prefix log entries by a timestamp.
  534.  
  535.   See also: log, log_options.
  536.  
  537. & @list options
  538.   Command: @list options
  539.   Lists the value of many of the configuration parameters.
  540.   See also: @admin.
  541.  
  542. & @list permissions
  543.   Command: @list permissions
  544.   For each command that you are allowed to use, lists the permissions that are
  545.   needed to execute it.
  546.   See also: access, attr_cmd_access.
  547.  
  548. & @list powers
  549.   Command: @list powers
  550.   Lists the access restrictions on the various powers
  551.     change_quotas   - Player may change the building quotas of others.
  552.     chown_mine      - Player may @chown objects to yourself even if not
  553.                       CHOWN_OK.
  554.     chown_others    - Player may @chown objects you control to others.
  555.     expanded_who    - WHO report includes additional information about the 
  556.                       players listed.
  557.     free_money      - All commands are free.
  558.     free_quota      - Quotas are ignored for this player.
  559.     grab_player     - Player may @tel any other player to themselves.
  560.     join_player     - Player may @tel to the loc of any other player.
  561.     long_fingers    - Player may operate on objects that normally must be
  562.                       near the player even if they are not.
  563.     priv_attributes - Player may modify read-only attributes and see invisible
  564.                       attributes.
  565.     priv_flags      - Player sees and may modify privileged flags.
  566.     rename_myself   - Player may change his name and password.
  567.     see_all_queue   - Player sees entire contents of queue.
  568.     see_hidden      - Player sees hidden players in the WHO report.
  569.     stat_any        - Player may get @stats on any player.
  570. { 'wizhelp @list powers2' for more }
  571. & @list powers2
  572.     steal_money     - Player may give negative money.
  573.     unkillable      - Player may not be killed.
  574.  
  575. & @list process
  576.   Command: @list process
  577.  
  578.   Lists information about the running MUSH process and its resource usage.
  579.   The following information is returned:
  580.      Process number.
  581.      Pagesize of the system running the mush, in bytes.
  582.      CPU time used, both user and system.
  583.      Maximum resident size, in both pages and bytes.
  584.      Integral resident size of the shared, private, and stack segments.
  585.         This number is not terribly useful.
  586.      Page faults, counting separately those that cause I/O and those that do
  587.         not.
  588.      Number of times the process has been swapped out.
  589.      Number of real disk reads and writes done (possibly via NFS).
  590.      Number of network packets read and written.
  591.      Context switches, counting separately voluntary switches (as the result
  592.         of calling a blocking I/O routine) and involuntarily switches (as the
  593.         result of a timeslice end or a higher-priority process becoming
  594.         runnable).
  595.      Signals received.
  596.  
  597. & @list site_information
  598.   Command: @list site_information
  599.  
  600.   Lists the contents of the site access and suspect lists.
  601.  
  602.     IP Prefix - The CIDR IP prefix (address and number of bits in mask)
  603.                 that specifies the address range.
  604.  
  605.     Status    - Indicates what type of access or restriction is to be
  606.                 applied. The following statuses may occur in the site
  607.                 access list:
  608.  
  609.                 Forbidden    - Connections from this site are rejected.
  610.                 Registration - Connections from this site are accepted,
  611.                                new characters may not be created with the
  612.                                'create' command, players wanting a character
  613.                                must get a wizard to create one for them.
  614.                 Unrestricted - Connections from this site are accepted,
  615.                                new characters may be created with the 'create'
  616.                                command.
  617.  
  618. { 'wizhelp @list site_information2' for more }
  619. & @list site_information2
  620.               The following statuses may occur in the site suspect list:
  621.  
  622.                 Suspected    - Notify logged-in wizards of any connects or
  623.                                disconnects from this site.
  624.                 Trusted      - Don't notify wizards of connects or disconnects
  625.                                from this site.
  626.  
  627.   See also: forbid_site, permit_site, register_site, guest_site,
  628.   suspect_site, trust_site, SITE LISTS.
  629.  
  630. & @list switches
  631.   Command: @list switches
  632.   Lists the commands that support switches as well as the switches that may
  633.   be used.
  634.  
  635. & @list user_attributes
  636.   Command: @list user_attributes
  637.   Lists the defined user-named attributes, along with their internal
  638.   attribute numbers and access restrictions.
  639.  
  640. & @list_file
  641.   Command: @list_file <file>
  642.   Lists the contents of one of the message files that are shown during the
  643.   connect/create/disconnect process as conditions warrant.  The following
  644.   files may be listed:
  645.      badsite_connect - shown when a connection is opened from a forbidden
  646.                        site.
  647.      connect          - shown when a connection is opened from a site for
  648.                         which registration is not enforced.
  649.      create_register  - shown when the 'create' command is used from a site 
  650.                         for which registration is enforced.
  651.      down             - shown when a non-wizard attempts to connect to or
  652.                         create a character when logins are disabled.
  653.      full             - shown when a non-wizard attempts to connect to or
  654.                         create a character when the maximum number of connected
  655.                         players are connected.  Note that this is different
  656.                         from what happens when someone tries to connect but
  657.                         there are no free descriptors, which is
  658.                         machine-dependent (usually the connect attempt hangs
  659.                         or is rejected).
  660.      guest_motd       - shown to guest characters immediately after they
  661.                         connect.
  662. { 'wizhelp @list_file2' for more }
  663. & @list_file2
  664.      motd             - shown to all players immediately after they connect.
  665.                         (except guests and players connecting for the first
  666.                         time)
  667.      newuser          - shown to players the first time they connect in place
  668.                         of the motd file.
  669.      quit             - shown to players when they disconnect from the game.
  670.      register_connect - shown when a connection is opened from a site for
  671.                         which registration is enforced.
  672.      wizard_motd      - shown to wizards when they connect in addition to
  673.                         the motd file.
  674.   See also: @readcache, badsite_file, connect_file, connect_reg_file,
  675.             down_file, guest_file, motd_file, newuser_file, quit_file,
  676.             register_create_file, wizard_motd_file.
  677.  
  678. & @listmotd
  679.   Command: @listmotd
  680.   Lists the current MOTD messages as set by the @motd command.
  681.   See also: @motd.
  682.  
  683. & @lock
  684.   Command: @lock <object>=<key>
  685.   Note that with attribute locking, a WIZARD object can read any attribute of
  686.   any object, including attributes invisible to players.
  687.  
  688.   Player #1 may also make attribute locks of the form <attr-num>:<value>
  689.   Note that if <attr-num> is not a valid attribute number, the lock will
  690.   never succeed.
  691.  
  692. & @mark
  693.   Command: @mark[/<switches>] [<player>] [<class>=<restriction>]
  694.   Sets or clears the MARKED flags for objects that match the search criteria.
  695.   This command may only be used when database cleaning is disabled (via
  696.   @disable cleaning), as cleaning uses the MARKED flag to check
  697.   connectivity.
  698.  
  699.   The following switches are available:
  700.      /set    - (default) Set the MARKED flag on the selected objects.
  701.      /clear  - Clear the MARKED flag on the selected objects.
  702.  
  703.   See also: @apply_marked, @@mark_all, MARKED, SEARCH CRITERIA.
  704.  
  705. & @mark_all
  706.   Command: @mark_all[/<switches>]
  707.  
  708.   Sets or clears the MARKED flag for all objects in the database.  This command
  709.   may only be used when database cleaning is disabled (via @disable cleaning),
  710.   as cleaning uses the MARKED flag to check connectivity.
  711.  
  712.   The following switches are available:
  713.      /set    - (default) Set the MARKED flag on all objects.
  714.      /clear  - Clear the MARKED flag on all objects.
  715.  
  716.   See also: @apply_marked, @mark_all, MARKED.
  717.  
  718. & @motd
  719.   Command: @motd[/<switches>] <message>
  720.  
  721.   This command sets or lists short messages that are displayed to players
  722.   after they successfully log in to the game (or after they fail because
  723.   logins are not allowed).  These messages are displayed in addition to
  724.   the contents of the motd.txt and wizmotd.txt files.
  725.  
  726.   The following switches are available:
  727.      (No switches)   - Sets the message that all players see when they connect.
  728.      /wizard         - Sets the message that wizards see when they connect.
  729.      /down           - Sets the message the players see when they try to
  730.                        connect, but fail because logins are disabled.
  731.      /full           - Sets the message that players see when they try to
  732.                        connect, but fail because there are too many players
  733.                        already connected.
  734.      /list           - Lists the current messages.
  735.   See also: @listmotd.
  736.  
  737. & @newpassword
  738.   Command: @newpassword <player>[=<newpassword>]
  739.   Gives <player> the new password <newpassword>.  If <newpassword> is not
  740.   specified, the player is given a null password.  If logged in, the player
  741.   is notified that his password has been changed.
  742.   See also: @password.
  743.  
  744. & @pcreate
  745.   Command: @pcreate <player>=<password>
  746.   Creates a new player with the indicated password.  This command is
  747.   equivalent to typing 'create <player> <password>' from the connection
  748.   screen, and is normally only used when registration is enabled.
  749.   See also: REGISTRATION.
  750.  
  751. & @poor
  752.   Command: @poor <amount>
  753.   Sets the wealth of all players to <amount>.
  754.  
  755. & @ps
  756.   Command: @ps[/<switches>] [<object>]
  757.   Wizards may also use the /all switch to view the entire queue.
  758.   See also: @ps (player version).
  759.  
  760. & @purge
  761.   Command: @purge
  762.   Immediately destroys any rooms that are waiting to be destroyed, crediting
  763.   their owners for the cost of creating the room.  The freelist is also 
  764.   repaired if it is damaged.  These operations are performed periodically,
  765.   so there is usually no need to use this command.
  766.   See also: @dbck.
  767.  
  768. & @quota
  769.   Command: @quota[/<switches>] [<player>[=<quota>]]
  770.            @quota/all[/<switches>] [<quota>]]
  771.  
  772.   Lists or sets the player's (or everyone's) remaining or total quota
  773.   according to the switches used.
  774.   The following switches are available:
  775.      /all       - Display or set the quota for all players.
  776.      /fix       - Repair the remaining or total quota, assuming that the other
  777.                   is correct.
  778.      /remaining - Set or repair the remaining quota.
  779.      /set       - Set the remaining or total quota to the specified value.
  780.      /total     - Set or repair the total quota.
  781.      /room      - Set or repair the room quota.
  782.      /exit      - Set or repair the exit quota.
  783.      /thing     - Set or repair the thing quota.
  784.      /player    - Set or repair the player quota.
  785.  
  786.   See also: QUOTAS.
  787.  
  788. & @readcache
  789.   Command: @readcache
  790.   Reads the commonly-used text files and help indexes on the game directory
  791.   into an internal cache, destroying the prior contents of the cache.
  792.   Use this command whenever you change one of the text of index files in
  793.   the game directory.
  794.  
  795. & @restart
  796.   Command: @restart
  797.   
  798.   This command restarts the game, in a fashion which is largely transparent
  799.   to the players. It maintains all connections and much of the information
  800.   related to them (such as @doing text). It saves and loads the database,
  801.   so it cannot be used to change databases. It does, however, reload the
  802.   server binary (so it can be used to switch between versions of the
  803.   server), as well as re-read the configuration file (so it can be
  804.   used to switch between configurations); note that because configuration 
  805.   information is reset, so anything modified with @admin and the like
  806.   will be lost across the restart.
  807.  
  808.   Note that overwriting the server binary while the game is running may
  809.   be dangerous; it is possible, under some operating systems, for the
  810.   game to crash. Generally, the safest thing to do is to delete the
  811.   old binary, then copy the new one into place.
  812.  
  813. & @rwho
  814.   Command: @rwho[/<switches>]
  815.   Sets up or breaks the connection to the remote RWHO server over which
  816.   WHO data is transmitted.  Note that changes to many of the RWHO
  817.   configuration parameters only take effect when RWHO transmission is next
  818.   started.
  819.  
  820.   The following switches are supported:
  821.      /start - Opens the connection and transmits an 'I am alive' message.
  822.      /stop  - Transmits an 'I am going down' message and closes the
  823.               connection.
  824.  
  825.   See also: rwho_data_port, rwho_dump_interval, rwho_host, rwho_password,
  826.             rwho_transmit.
  827.  
  828. & @shutdown
  829.   Command: @shutdown[/abort] <text>
  830.   Disconnects all connected players, saves the database to disk, and shuts
  831.   down the game.  The game is unavailable until it is restarted.  If an
  832.   argument is specified, it is written to the file named by the status_file
  833.   config directive.
  834.  
  835.   If the /abort switch is specified, the game simply prints a message to
  836.   the logfile, and coredumps (dying immediately, without saving the
  837.   database or doing the usual "panic" things).
  838.  
  839.   See also: status_file
  840.  
  841. & @timewarp
  842.   Command: @timewarp[/<switches>] <secs>
  843.   Subtracts (or adds if negative) <secs> to one or more internal timers,
  844.   depending on the switches specified from the following list:
  845.      /check    - The time left until the next consistency check and database
  846.                  cleaning.
  847.      /dump     - The time left until the next automatic checkpoint dump.
  848.      /idle     - The time left until the next check for idle users.
  849.      /queue    - (default) Adjusts the time-to-execute for all entries in the
  850.                  wait and semaphore queues.  Entries whose time-to-execute
  851.                  becomes less than the current time are then ready for
  852.                  execution. The contents of the object queue are also
  853.                  appended to the player queue.
  854.      /rwho     - The time left until the WHO list is transmitted to the
  855.                  connected RWHO server (if any)
  856.  
  857.   Note: these flags may be specified together if desired.
  858.   See also: @list options.
  859.  
  860. & @toad
  861.   Command: @toad[/<switches>] <victim>[=<recipient>]
  862.   Turns the victim into an object (a slimy toad) and disconnects them from
  863.   the game.  The named recipient (or the @toading wizard) get ownership of
  864.   all the victim's things, rooms, and exits, as well as of the toad object
  865.   itself.
  866.  
  867.   The following switches are available:
  868.     /no_chown - Don't change the ownership of the victim or his objects.
  869.   See also: @boot, @chownall, @destroy.
  870.  
  871. & @wall
  872.   Command: @wall[/<switches>] <message>
  873.   With no switches, shouts <message> to every connected player or to every
  874.   connected wizard, prefixed by either 'Announcement:' (if for everyone) or
  875.   'Broadcast:' (if for wizards).  The following switches can be used to get the
  876.   described effects:
  877.      /emit      - Format the message as an emit (ie send just <message>).
  878.      /pose      - Format the message as a pose (ie <yourname> <message>).
  879.      /wizard    - Only send the message to connected wizards.
  880.      /no_prefix - Don't prepend 'Announcement:' or 'Broadcast:' to the message.
  881.   If neither /emit or /pose are used, you can format the message one of several
  882.   ways by specifying ':', ';', or '"' as the first character of the message.
  883.   ':' and ';' format the message as if /pose were specified, except that ';'
  884.   does not insert a space between your name and the message.  '"' formats the
  885.   message in normal @wall format (this is the default).
  886.   The message is also written to the log file.
  887.  
  888. & INHERIT
  889.   Flag: INHERIT(I) (all types)
  890.   When set on an object, gives the object access to the WIZARD and IMMORTAL
  891.   powers that its owner has, and also allows that object to control the player
  892.   and other INHERIT objects owned by that player.
  893.   When set on a player, gives all of that player's objects access to the
  894.   WIZARD and IMMORTAL powers of their owner, and allows them to control the
  895.   player or any object owned by the player.
  896.  
  897. & MARKED
  898.   Flag: MARKED(m) (all types)
  899.   This flag is used by the database cleaning routines to check the
  900.   connectivity of the database, and also by the @mark commands to select
  901.   objects for special attention.  Since database cleaning is performed
  902.   automatically from time to time, automatic cleaning must be disabled
  903.   before using the @mark commands, and the command @mark_all/clear should
  904.   be run immediately before turning automatic cleaning back on.
  905.   See also: @apply_marked, @dbck, @disable, @enable, @list, @mark,
  906.             @mark_all.
  907.  
  908. & STARTUP
  909.   Flag: STARTUP(z) (all types)
  910.   This flag is managed internally by the server and it is not directly
  911.   settable.  It indicates whether or not the object has a STARTUP attribute
  912.   that is to be run when the MUSH is booted.  This saves a considerable amount
  913.   of time considering that very few objects have a STARTUP attribute.
  914.   This flag is set automatically when the STARTUP attribute is set to a
  915.   non-empty string, and cleared when the STARTUP attribute is removed or
  916.   set to a null string.
  917.   See also: @startup.
  918.  
  919. & SUSPECT
  920.   Flag: SUSPECT(u) (players)
  921.   When set on a player, causes connects, disconnects, name changes, kills,
  922.   and attempted kills to be reported to all connected wizards.
  923.   This flag is only visible and settable by wizards.
  924.  
  925. & WIZARD
  926.   Flag: WIZARD(W) (all types)
  927.   A player or object that is set WIZARD controls all of the objects in the
  928.   database (except for player #1), regardless of their ownership or flags.
  929.   In general, WIZARDs can do anything using #<number> or *<player>.
  930.   Wizards can also use many additional commands that are useful for game
  931.   administration and maintenance.
  932.   Only player #1 can set or clear this flag.  An object owned by a Wizard has
  933.   wizard privileges only if its WIZARD or INHERIT flag is set, or if the
  934.   owning Wizard has his INHERIT flag set.
  935.   See also: CONTROL, INHERIT.
  936.  
  937. & @allowance
  938.   Attribute: Allowance
  939.   Command: @allowance <object>[=<amount>]
  940.   Sets the amount of money that the player receives each day he/she connects
  941.   to the MUSH.  The Allowance attribute overrides the default allowance
  942.   specified by the paycheck config parameter.
  943.   This attribute is only visible and settable by wizards.  It is only
  944.   meaningful for players, and has no effect on other object types.
  945.  
  946. & @comment
  947.   Attribute: Comment
  948.   Command: @comment <object>[=<text>]
  949.   Sets a wizard-visible comment on the indicated object.
  950.   This attribute is only visible and settable by wizards.
  951.  
  952. & @timeout
  953.   Attribute: Timeout
  954.   Command: @timeout <object>[=<seconds>]
  955.   Sets an idle timeout value on <object> that is different from the default
  956.   value.  If the value is non-numeric or less than or equal to zero, then
  957.   the default value is used.
  958.   This attribute is only visible and settable by wizards.  It is only
  959.   meaningful for players, and has no effect on other object types.
  960.   See also: idle_timeout.
  961.  
  962. & MASTER ROOM
  963.   The master room contains the default exits and $-commands for the MUSH.
  964.   The order in which commands are searched for is: local exits, master room
  965.   exits, built-in commands, local $-commands and aliases, and finally master
  966.   room $-commands.
  967.  
  968.   Caution: Do not allow players into the master room, as they can leave
  969.   objects that will be searched for $-commands.  Make sure that the room is
  970.   not JUMP_OK or LINK_OK, and that any exits leading to the room are locked so
  971.   that only wizards may use them.
  972.  
  973.   To make global commands, simply leave an object in the master room
  974.   with the appropriate $-commands on it.  You can make global exits by having
  975.   an unlocked exit from the master room (or an exit locked to a desired key
  976.   object) lead to the desired destination.  When a player goes through one of
  977.   these exits, any KEY objects are returned home, as is done with @teleport.
  978.  
  979.   Do not put too many objects in the room, because each object is searched
  980.   for $-commands every time anyone (or anything) anywhere on the MUSH enters
  981.   an unrecognized command.
  982.   See also: @link, @lock, @open, master_room, use_global_aconn
  983.  
  984. & CONFIG PARAMETERS
  985.   Topic: CONFIG PARAMETERS
  986.  
  987.   A number of configuration parameters may be specified in the configuration
  988.   file, or given to the @admin command. The parameters are listed by type.
  989.   Type 'wizhelp param <category>' for a list of parameters relevant to
  990.   that category. Type 'wizhelp <param>' for help on a particular parameter.
  991.  
  992.     Aliases        Costs        Database        Files
  993.     Limits        Messages    Miscellaneous        Objects
  994.     Options        Permissions    Sites            Timers
  995.  
  996. & PARAM ALIASES
  997.     alias            attr_alias        flag_alias
  998.     logout_cmd_alias
  999.  
  1000. & PARAM COSTS
  1001.     create_max_cost        create_min_cost        dig_cost
  1002.     exit_quota        find_money_chance    kill_guarantee_cost
  1003.     kill_max_cost        kill_min_cost        link_cost
  1004.     machine_command_cost    open_cost        page_cost
  1005.     paycheck        player_quota        robot_cost
  1006.     room_quota        sacrifice_adjust    sacrifice_factor
  1007.     search_cost        starting_money        starting_quota
  1008.     starting_room_quota    starting_exit_quota    starting_thing_quota
  1009.     starting_player_quota    thing_quota        wait_cost
  1010.  
  1011. & PARAM DATABASE
  1012.     cache_depth        cache_steal_dirty    cache_width
  1013.     fork_dump        fork_vfork        garbage_chunk
  1014.     gdbm_cache_size        initial_size
  1015.  
  1016. & PARAM FILES
  1017.     badsite_file        connect_file        connect_reg_file
  1018.     crash_database        down_file        full_file
  1019.     gdbm_database        guest_file        help_file
  1020.     help_index        html_connect_file    include
  1021.     input_database        motd_file        news_file
  1022.     news_index        newuser_file        output_database
  1023.     quit_file        register_create_file    wizard_help_file
  1024.     wizard_help_index    wizard_motd_file
  1025.  
  1026. & PARAM LIMITS
  1027.     building_limit            earn_limit
  1028.     function_invocation_limit    function_recursion_limit
  1029.     conn_timeout            idle_timeout
  1030.     lag_maximum            lock_recursion_limit
  1031.     max_players            notify_recursion_limit
  1032.     output_limit            player_queue_limit
  1033.     retry_limit            trace_output_limit
  1034.  
  1035. & PARAM MESSAGES
  1036.     down_motd_message    dump_message        full_motd_message
  1037.     motd_message        postdump_message    pueblo_message
  1038.     wizard_motd_message
  1039.  
  1040. & PARAM MISCELLANEOUS
  1041.     log            log_options        money_name_plural
  1042.     money_name_singular    mud_name        port
  1043.     queue_active_chunk    queue_idle_chunk    rwho_data_port
  1044.     rwho_host        rwho_info_port        rwho_password
  1045.  
  1046. & PARAM OBJECTS
  1047.     default_home        exit_flags        exit_parent
  1048.     guests            player_flags        player_parent
  1049.     player_starting_home    player_starting_room    robot_flags
  1050.     room_flags        room_parent        thing_flags
  1051.     thing_parent        user_attr_flags
  1052.  
  1053. & PARAM PERMISSIONS
  1054.     access            attr_access        attr_cmd_access
  1055.     bad_name        config_access        function_access
  1056.     good_name        list_access        logout_cmd_access
  1057.     power_access
  1058.  
  1059. & PARAM SITES
  1060.     forbid_site        guest_site        permit_site
  1061.     register_site        suspect_site        trust_site
  1062.  
  1063. & PARAM TIMERS
  1064.     check_interval        check_offset        command_quota_increment
  1065.     command_quota_max    dump_interval        dump_offset
  1066.     idle_interval        rwho_dump_interval    timeslice
  1067.  
  1068. & PARAM OPTIONS
  1069. abort_on_bug        ansi_colors        clone_copies_cost
  1070. dark_sleepers        examine_flags        examine_public_attrs
  1071. fascist_teleport    format_contents        format_exits
  1072. hostnames        idle_wiz_dark        local_master_rooms
  1073. look_obey_terse        match_own_commands    paranoid_allocate
  1074. parentable_control_lock    parent_zones        pemit_any_object
  1075. pemit_far_players    player_listen        player_match_own_commands
  1076. player_name_spaces    public_flags        quiet_look
  1077. quiet_whisper        quotas            read_remote_desc
  1078. read_remote_name    recycling        require_cmds_flag
  1079. robot_speech        rwho_transmit        safer_passwords
  1080. see_owned_dark        signal_action        space_compress
  1081. sweep_dark        switch_default_all    terse_shows_contents
  1082. terse_shows_exits    terse_shows_move_messages
  1083. trace_topdown        typed_quotas        unowned_safe
  1084. use_global_aconn    wizard_obeys_linklock
  1085.  
  1086. & abort_on_bug
  1087.   Config parameter: abort_on_bug <yes/no>.  Default: no
  1088.   Indicates whether or not the server is to abort when it logs a bug.
  1089.   See also: log.
  1090.  
  1091. & access
  1092.   Config parameter: access <command> <permlist>
  1093.   Modifies the permissions needed to execute the indicated command.
  1094.   Specifying a permission adds it to the list of permissions required; to
  1095.   remove a permission prefix it with a ! character.
  1096.   See also: PERMISSIONS, @list.
  1097.  
  1098. & alias
  1099.   Config parameter: alias <new> <old>.
  1100.   Defines the command <new> to be an alias of the command <old>.
  1101.   See also:
  1102.  
  1103. & ansi_colors
  1104.   Config parameter: ansi_colors <yes/no>.  Default: NO
  1105.  
  1106.   Specifies whether or not players are permitted to use ANSI colors
  1107.   in their text.
  1108.  
  1109. & attr_access
  1110.   Config parameter: attr_access <attr> [!]<privilege> [[!]<privilege>]...
  1111.   Changes the access rights to the named attribute.
  1112.  
  1113.   The following privileges may be used:
  1114.   private     - The attribute is visible only to those who can examine the
  1115.                 object.
  1116.   internal    - The attribute is not visible to anyone.
  1117.   wizard      - Only wizards may change the attribute.
  1118.   hidden      - The attribute is visible only to wizards.
  1119.  
  1120. & attr_alias
  1121.   Config parameter: attr_alias <alias> <attr>.
  1122.   Makes <alias> an alias for the attribute <attr>.
  1123.  
  1124. & attr_cmd_access
  1125.   Config parameter: attr_cmd_access [!]<privilege> [[!]<privilege>]...
  1126.   Changes the access rights on all attribute-setting commands in parallel.
  1127.   Use this parameter to allow or deny access to the attribute-setting commands
  1128.   as a group.  This directive should normally be followed by access directives
  1129.   to properly set access to restricted attributes.
  1130.   See also: access, PERMISSIONS.
  1131.  
  1132. & bad_name
  1133.   Config parameter: bad_name <wildcarded-name>.
  1134.   Specifies that any name that matches <wildcarded-name> may not be used as a
  1135.   player name.  Attempts to create a player with a disallowed name (or to
  1136.   rename to a disallowed name) will be rejected.  Normally, words that
  1137.   lead off messages from MUSH are disallowed, some sites may wish to disallow
  1138.   some obscene names as well.
  1139.  
  1140. & badsite_file
  1141.   Config parameter: badsite_file <path>.  Default: badsite.txt
  1142.   Specifies the name of the file that is sent to new net connections from
  1143.   sites that have been blocked from accessing the server.  The connection
  1144.   is closed immediately after the file is sent.
  1145.   See also: forbid_site, permit_site.
  1146.  
  1147. & building_limit
  1148.   Config parameter: building_limit <number>.  Default: 50000.
  1149.  
  1150.   Specifies the maximum number of objects that the database can contain.
  1151.   When this number is reached, no new objects can be created. This is
  1152.   useful for preventing people from programming runaway dustbunny monsters
  1153.   that create thousands of objects.
  1154.  
  1155. & cache_depth
  1156.   Config parameter: cache_depth <depth>.  Default: 10.
  1157.  
  1158.   Specifies the depth of the database cache.  Each bucket in the cache is
  1159.   allowed to have this many entries before it will try to remove old entries.
  1160.   See also: cache_width.
  1161.  
  1162. & cache_width
  1163.   Config parameter: cache_width <depth>.  Default: ??
  1164.  
  1165.   Specifies the number of buckets in the database cache.  A hashing function
  1166.   is used to assign objects or attributes to a particular bucket, where a 
  1167.   linear search is performed.
  1168.  
  1169. & check_interval
  1170.   Config parameter: check_interval <secs>.  Default: 600.
  1171.   Specifies how often (in seconds) the database is to be automatically
  1172.   scanned for inconsistencies and purged of references to destroyed objects.
  1173.   Any inconsistencies found are either fixed or recorded in the log file.
  1174.   See also: check_offset, @dbck.
  1175.  
  1176. & check_offset
  1177.   Config parameter: check_offset <secs>.  Default: 300.
  1178.   Specifies how long after startup the first automatic database check is
  1179.   to be performed.  Subsequent checks are performed every check_interval
  1180.   seconds.
  1181.   See also: check_interval, @dbck.
  1182.  
  1183. & cache_steal_dirty
  1184.   Config parameter: cache_steal_dirty <yes/no>.  Default: NO
  1185.   Specifies whether or not the cache manager may take a modified attribute
  1186.   and write it out when trying to insert a new attribute into the cache.
  1187.  
  1188. & clone_copies_cost
  1189.   Config parameter: clone_copies_cost <yes/no>.  Default: NO
  1190.   Indicates whether or not @cloned objects inherit the cost of the original.
  1191.   If disabled, @cloned objects cost the same as a @create that doesn't specify
  1192.   the object cost.  The new owner is charged the correct amount in either
  1193.   case.
  1194.   See also: @clone.
  1195.  
  1196. & command_quota_increment
  1197.   Config parameter: command_quota_increment <amount>. Default: 1
  1198.   Specifies the number of commands by which the command quota for connected
  1199.   users each timeslice.  Each command a user types in (commands executed by
  1200.   machines do not count) decreases the quota by 1, and the user's commands are
  1201.   only executed if the quota is greater than zero.
  1202.   See also: command_quota_max, timeslice.
  1203.  
  1204. & command_quota_max
  1205.   Config parameter: command_quota_max <amount>. Default: 100
  1206.   Specifies the maximum value for the command quota for connected users.
  1207.   A user's command quota is only increased if it is below this value.
  1208.   Each command a user types in (commands executed by machines do not count)
  1209.   decreases the quota by 1, and the user's commands are only executed if the
  1210.   quota is greater than zero.
  1211.   See also: command_quota_increment, timeslice.
  1212.  
  1213. & config_access
  1214.   Config parameter: config_access <param> [!]<privilege> [[!]<privilege>]...
  1215.   Changes the privileges needed to change the specified configuration
  1216.   parameter.  The value 'disabled' indicates that the parameter may only
  1217.   be specified in the configuration file at startup.  Setting privileges
  1218.   to anything other than disabled or god is meaningless unless the 
  1219.   restriction on the @admin command is weakened.
  1220.   See also: @admin, @list config_permissions, PERMISSIONS.
  1221.  
  1222. & conn_timeout
  1223.   Config parameter: conn_timeout <num>.  Default: 60
  1224.   Specifies how many seconds a new network connection may remain open before
  1225.   connecting to a character before being automatically disconnected.
  1226.  
  1227. & connect_file
  1228.   Config parameter: connect_file <path>.  Default: connect.txt
  1229.   Specifies the name of the file that a user sees immediately after connecting
  1230.   to the MUSH if registration is not enabled.  This file normally contains
  1231.   help on how to connect to or create a character, as well as the WHO and QUIT
  1232.   commands.
  1233.   See also: connect_reg_file
  1234.  
  1235. & connect_reg_file
  1236.   Config parameter: connect_reg_file <path>.  Default: connect_reg.txt
  1237.   Specifies the name of the file that a user sees immediately after connecting
  1238.   to the MUSH if registration is enabled.  This file normally contains
  1239.   help on how to get a character (usually by sending e-mail to one of the
  1240.   wizards), how to connect to an existing character, as well as the WHO and
  1241.   QUIT commands.
  1242.   See also: connect_file
  1243.  
  1244. & html_connect_file
  1245.   Config parameter: html_connect_file <path>.  Default: htmlconn.txt
  1246.   Specifies the name of the file that a user sees when a PUEBLOCLIENT
  1247.   command is issued. Typically this is a file similar to connect_file,
  1248.   with HTML formatting.
  1249.   See also: connect_file
  1250.  
  1251. & crash_database
  1252.   Config parameter: crash_database <path>.  Default: none
  1253.   Specifies the name of the database file that should be written when mush
  1254.   detects an internal error and is about to crash.  Note that the database
  1255.   may contain corrupted links of the error occurs in the middle of moving
  1256.   links about.
  1257.   Dumping a crash database is currently not implemented.
  1258.  
  1259. & create_max_cost
  1260.   Config directive: create_max_cost <amount>.  Default: 505
  1261.   Specifies the maximum amount of money that is used in calculating the value
  1262.   of a created object.  Specifying more than this amount of money in a @create
  1263.   command will cause the excess to be wasted.
  1264.   See also: create_min_cost, sacrifice_adjust, sacrifice_factor.
  1265.  
  1266. & create_min_cost
  1267.   Config directive: create_min_cost <amount>.  Default: 10
  1268.   Specifies the minimum (and default) cost for creating an object.
  1269.   See also: create_max_cost, sacrifice_adjust, sacrifice_factor.
  1270.  
  1271. & dark_sleepers
  1272.   Config directive: dark_sleepers <yes/no>.  Default: yes
  1273.   Indicates whether or not disconnected players are to be considered 'dark',
  1274.   so that they do not show up when a player looks in the room that they are
  1275.   in.  Disconnected players can still be found by examining the room or by
  1276.   using [next()] to follow the contents chain for the room.
  1277.  
  1278. & default_home
  1279.   Config directive: default_home <location>.  Default (player_starting_home)
  1280.   Sets the home location for objects which have an invalid home (whether
  1281.   because the home location was deleted, or is owned by another player and
  1282.   is not set ABODE) and the home of their owner is also invalid.  If this
  1283.   parameter is not set, the value of player_starting_home is used instead.
  1284.   See also: player_starting_home.
  1285.  
  1286. & dig_cost
  1287.   Config parameter: dig_cost <amount>.  Default: 1
  1288.   Specifies how much the @dig command costs.
  1289.  
  1290. & down_file
  1291.   Config parameter: down_file <pathname>.  Default: down.txt
  1292.   Specifies the name of the file that is displayed when players attempt to
  1293.   connect to a non-wizard character when logins are disabled.
  1294.   See also: @disable, down_motd_message.
  1295.  
  1296. & down_motd_message
  1297.   Config parameter: down_motd_message <message>.  Default: blank
  1298.   Sets the message that is displayed when a player attempts to connect to a
  1299.   non-wizard character when logins are disabled.  This message is displayed
  1300.   in addition to the contents of the down.txt file.
  1301.   See also: @disable, down_motd_file.
  1302.  
  1303. & dump_interval
  1304.   Config parameter: dump_interval <amount>.  Default: 3600
  1305.   Specifies the time in seconds between automatic database dumps.
  1306.   See also: dump_offset, output_database.
  1307.  
  1308. & dump_message
  1309.   Config parameter: dump_message <message>.  Default: blank
  1310.   Sets the message that is sent to everyone before the database is being
  1311.   dumped to disk, whether automatically or via the @dump command.
  1312.   See also: @dump, postdump_message.
  1313.  
  1314. & dump_offset
  1315.   Config parameter: dump_offset <amount>.  Default: 0
  1316.   Specifies the time in seconds between startup and the first database dump.
  1317.   If zero, the value of the dump_interval parameter is used.
  1318.   See also: dump_interval.
  1319.  
  1320. & earn_limit
  1321.   Config parameter: earn_limit <amount>.  Default: 10000
  1322.   Specifies the threshold at which earning additional money becomes difficult.
  1323.   Specifically, players with more than this much money no longer receive a
  1324.   paycheck for each day they connect, only receive one penny for sacrificing
  1325.   objects at temples, don't receive insurance payments for being killed, and
  1326.   don't find money lying in the streets.
  1327.   See also: find_money_chance, paycheck.
  1328.  
  1329. & examine_flags
  1330.   Config parameter: examine_flags <yes/no>.  Default: yes
  1331.   Indicates whether or not the examine command should include an expanded
  1332.   flags list in the description of the object.
  1333.   See also: examine.
  1334.  
  1335. & examine_public_attrs
  1336.   Config parameter: examine_public_attrs <yes/no>.  Default: yes
  1337.   Indicate whether or not the examine command should display the public
  1338.   attributes of the object by default when used by a player who does not
  1339.   control the object.  Regardless of the setting of this parameter, the
  1340.   short form is available with examine/brief and the long form with
  1341.   examine/long.
  1342.   See also: examine.
  1343.  
  1344. & exit_flags
  1345.   Config parameter: exit_flags <flags>.  Default: blank
  1346.   Modifies the set of flags that an exit receives when it is created via the
  1347.   @open command or via the optional exit creation parameters of the @dig or
  1348.   @link commands.  Flags prefixed by a ! remove the indicated flag from the
  1349.   set.
  1350.   See also: @list, player_flags, robot_flags, room_flags, thing_flags.
  1351.  
  1352. & exit_parent
  1353.   Config parameter: exit_parent <dbref>.  Default: nothing
  1354.  
  1355.   If this parameter is set, every object of type EXIT will have the
  1356.   specified object as a parent.
  1357.  
  1358.   See also: player_parent, room_parent, thing_parent.
  1359.  
  1360. & exit_quota
  1361.   Config parameter: exit_quota <amount>.  Default: 1
  1362.   Sets how much quota it costs to create an exit (and also how much the
  1363.   remaining quota is increased when an exit is @destroyed.
  1364.   See also: @quota, player_quota, room_quota, thing_quota, QUOTAS.
  1365.  
  1366. & fascist_teleport
  1367.   Config parameter: fascist_teleport <yes/no>.  Default: no
  1368.   If this parameter is set to yes, then players (and objects) may not
  1369.   teleport out of locations that they do not control or which are not set
  1370.   JUMP_OK.  If the teleporting player is inside an object, the room that
  1371.   ultimately contains the object is checked.  Going home is unaffected.
  1372.  
  1373. & find_money_chance
  1374.   Config parameter: find_money_chance <amount>.  Default: 0
  1375.   Indicates the chance that players have of finding money when entering a
  1376.   new room.  The chance is 1 / find_money_chance, except that finding money
  1377.   is disabled if this parameter is set to zero.
  1378.   See also: earn_limit, paycheck.
  1379.  
  1380. & flag_alias
  1381.   Config parameter: flag_alias <alias> <flagname>.
  1382.   Defines <alias> as a synonym for the flag <flagname>.
  1383.  
  1384. & forbid_site
  1385.   Config parameter: forbid_site <site notation>
  1386.  
  1387.   Indicates that connections are to be rejected from sites who match
  1388.   that site notation. The contents of the file specified by badsite_file
  1389.   is sent immediately before closing the connection.  This directive
  1390.   may be used to restrict access to just the local network, or to
  1391.   prevent access from troublemaking sites. The default is for all
  1392.   sites to be allowed to connect, none forbidden.
  1393.  
  1394.   See also: badsite_file, permit_site, register_site, SITE LISTS.
  1395.  
  1396. & fork_dump
  1397.   Config parameter: fork_dump <yes/no>.  Default: yes
  1398.   Indicates whether or not database dumps are to be done by fork()ing off a
  1399.   separate process to perform the dump.  While enabling this parameter reduces
  1400.   the amount of time needed to perform the dump, it requires that the system
  1401.   have enough free swap space to hold a second copy of the running game.
  1402.   See also: fork_vfork.
  1403.  
  1404. & fork_vfork
  1405.   Config parameter: fork_vfork <yes/no>.  Default: no
  1406.   Indicates whether or not the vfork() system call should be used in place of
  1407.   fork() when a database dump is to be performed.  This parameter is only
  1408.   checked if the fork_dump parameter is set to yes.
  1409.   See also: fork_dump.
  1410.  
  1411. & format_contents
  1412.   Config parameter: format_contents <yes/no>. Default: yes
  1413.  
  1414.   Indicates whether or not the @conformat attribute is honored.
  1415.   
  1416.   See also: format_exits
  1417.  
  1418. & format_exits
  1419.   Config parameter: format_exits <yes/no>. Default: yes
  1420.   
  1421.   Indicates whether or not the @exitformat attribute is honored.
  1422.  
  1423.   See also: format_contents
  1424.  
  1425. & full_file
  1426.   Config parameter: down_file <pathname>.  Default: full.txt
  1427.  
  1428.   Specifies the name of the file that is displayed when players attempt to
  1429.   connect to a non-wizard character when the number of connected players
  1430.   is not less than the number of players allowed by the max_players directive.
  1431.   See also: full_motd_message, max_players.
  1432.  
  1433. & function_access
  1434.   Config parameter: function_access <function> [!]<priv> [[!]<priv>]...
  1435.  
  1436.   Changes the privileges needed to call the mush function <function>.
  1437.   If you do not have permission to call a function, the function
  1438.   returns the value "#-1 PERMISSION DENIED" instead of the value it
  1439.   would normally return.
  1440.   See also: @list functions, FUNCTION LIST, PERMISSIONS.
  1441.  
  1442. & full_motd_message
  1443.   Config parameter: full_motd_message <message>.  Default: blank
  1444.  
  1445.   Sets the message that is displayed when a player attempts to connect to a
  1446.   non-wizard character when the number of connected players is not less than
  1447.   the number of players allowed by the max_players directive.  This message is
  1448.   displayed in addition to the contents of the full.txt file.
  1449.   See also: down_motd_file, max_players.
  1450.  
  1451. & function_invocation_limit
  1452.   Config directive: function_invocation_limit <num>.  Default: 2500
  1453.  
  1454.   This directive sets the maximum number of times that a command may make
  1455.   function calls.  If the invocation limit is exceeded, the string 
  1456.   '#-1 FUNCTION INVOCATION LIMIT EXCEEDED' is returned.  This limit is
  1457.   intended to prevent long hangs from creative uses of u() and iter().
  1458.   Note: @search is treated specially, each object examined with the
  1459.   eval=<arg> parameter is treated as a separate command for the purposes
  1460.   of the function invocation limit.
  1461.  
  1462. & function_recursion_limit
  1463.   Config directive: function_recursion_limit <num>.  Default: 50
  1464.  
  1465.   This directive sets the maximum number of nested function calls that
  1466.   may be made before the function call is aborted and the string
  1467.   '#-1 FUNCTION RECURSION LIMIT EXCEEDED' is returned.  Normally this is not
  1468.   a problem, but the u() function can be used to cause infinite recursion
  1469.   (unless blocked by a recursion limit)
  1470.  
  1471. & garbage_chunk
  1472.   Config_parameter: garbage_chunk <number>.  Default: 3
  1473.  
  1474. & gdbm_cache_size
  1475.   Config parameter: gdbm_cache_size <number>.  Default: 4096
  1476.   Specifies the size of the cache used by the text database in 1K blocks.
  1477.  
  1478. & gdbm_database
  1479.   Config parameter: gdbm_database <path>.  Default: none.
  1480.   Specifies the name of the file that stores the text portion of the
  1481.   database.  The text strings are stored in a binary format optimized for
  1482.   fast retrieval and storage rather than access with programs such as more.
  1483.  
  1484. & good_name
  1485.   Config parameter: good_name <name>.
  1486.   Removes <name> from the list of names that may not be used as a player
  1487.   name, reversing the effect of a bad_name directive.  The name must match
  1488.   exactly (wildcard matching is not performed).
  1489.  
  1490. & guests
  1491.   Config parameter: guests <number number  ...>.  Default: (none)
  1492.   Indicates the database number(s) of the guest character(s).  If set,
  1493.   the specified guest characters are subject to additional restrictions
  1494.   (such as not being allowed to create or destroy objects).  The actual
  1495.   restrictions can be changed with the access config parameter using the
  1496.   no_guest permission.
  1497.   See also: access.
  1498.  
  1499. & guest_file
  1500.   Config parameter: guest_file <path>.  Default: guest.txt.
  1501.   Specifies the file that is to be shown to people connecting to the
  1502.   guest character in place of the motd file.
  1503.   See also: guest_char_num.
  1504.  
  1505. & guest_site
  1506.   Config parameter: guest_site <site notation>
  1507.  
  1508.   Indicates that connections to Guest are to be rejected from sites whose
  1509.   address matches the specified site notation. The default is for all
  1510.   sites to be allowed to connect, none forbidden.
  1511.  
  1512.   See also: SITE LISTS.
  1513.  
  1514. & help_file
  1515.   Config parameter: help_file <path>.  Default: help.txt
  1516.   Specifies the name of the file containing the text used by the help command.
  1517.   See also: help, help_index
  1518.  
  1519. & help_index
  1520.   Config parameter: help_index <path>.  Default: help.indx
  1521.   Specifies the name of the index file used by the help command.  This file
  1522.   must be generated by mkindx from the wizard help file.  The contents of
  1523.   this file are read in to a hash table when the game is started and whenever
  1524.   a @readcache command is executed.
  1525.   See also: help, @readcache, help_file
  1526.  
  1527. & hostnames
  1528.   Config parameter: hostnames <yes/no>.  Default: yes
  1529.   Indicates whether or not IP addresses should be replaced with host names
  1530.   where possible in the log file and wizard WHO report.
  1531.  
  1532. & idle_interval
  1533.   Config parameter: idle_interval <secs>.  Default: 60
  1534.   Sets the interval between checks for idle users. 
  1535.   See also: conn_timeout, idle_timeout.
  1536.  
  1537. & idle_timeout
  1538.   Config parameter: idle_timeout <secs>.  Default: 3600 (one hour)
  1539.   Sets the amount of time that a player may remain idle before being
  1540.   automatically disconnected.  Players idle longer than this parameter are
  1541.   disconnected when the next check for idle players is done.
  1542.   See also: conn_timeout, idle_interval.
  1543.  
  1544. & idle_wiz_dark
  1545.   Config parameter: idle_wiz_dark <yes/no>.  Default: no
  1546.   Indicates whether or not wizards who are idle for longer than the default
  1547.   timeout value are to automatically be set DARK, and then unDARKed when they
  1548.   type in their next command.  Wizards already set DARK are not automatically
  1549.   unDARKed.
  1550.  
  1551. & include
  1552.   Config parameter: include <path>.  Default: none
  1553.   Reads and processes configuration directives from the named file.
  1554.   This directive is only valid during startup.
  1555.  
  1556. & initial_size
  1557.   XXX
  1558.  
  1559. & input_database
  1560.   Config parameter: input_database.  Default: tinymush.db
  1561.   Specifies the name of the database file that is read in at startup.
  1562.   This file is used only as an input file, the parameter output_database
  1563.   controls where updated copies of the database are written.
  1564.   See also: crash_database, gdbm_database, output_database.
  1565.  
  1566. & kill_guarantee_cost
  1567.   Config parameter: kill_guarantee_cost <amount>.  Default: 100
  1568.   Specifies the amount of money you have to spend (ie. kill target = <amount>)
  1569.   to have a 100% chance of killing them (assuming there are no other factors,
  1570.   such as the victim being immortal or in a HAVEN room, etc).  The chance of
  1571.   a successful kill is <amount spent> / <kill_guarantee_cost>.
  1572.   See also: kill, kill_max_cost, kill_min_cost, HAVEN, IMMORTAL, KILLING.
  1573.  
  1574. & kill_max_cost
  1575.   Config parameter: kill_max_cost <amount>.  Default: 100
  1576.   Specifies the maximum amount of money that may be usefully spent on a kill
  1577.   attempt.  Spending more than this amount does not improve the chance of
  1578.   success.  Setting this parameter to less than the kill_guarantee_cost
  1579.   parameter prevents 'automatic kills', as the kill will always have a chance
  1580.   of failing.
  1581.   See also: kill, kill_guarantee_cost, kill_min_cost, HAVEN, IMMORTAL,
  1582.             KILLING.
  1583.  
  1584. & kill_min_cost
  1585.   Config parameter: kill_min_cost <amount>.  Default: 10
  1586.   Specifies the minimum (and default) cost for attempting to kill someone or
  1587.   something.
  1588.   See also: kill, kill_guarantee_cost, kill_max_cost, HAVEN, IMMORTAL,
  1589.             KILLING.
  1590.  
  1591. & lag_maximum
  1592.   Config parameter: lag_maximum <number of seconds>.  Default: 120
  1593.   If the amount of real time used by a command exceeds the given number
  1594.   of seconds, a warning message will be printed to the log file.
  1595.  
  1596. & list_access
  1597.   Config parameter: list_access <param> [!]<privilege> [[!]<privilege>]...
  1598.   Changes the access needed to the <param> option of the @list command.
  1599.   See also: @list, PERMISSIONS.
  1600.  
  1601. & link_cost
  1602.   Config parameter: link_cost <amount>.  Default: 1.
  1603.   Specifies the cost of using the @link command to establish or change the
  1604.   link of an exit to its destination, the home of a player or an object, or
  1605.   the drop-to of a room.
  1606.   See also: @link.
  1607.  
  1608. & local_master_rooms
  1609.   Config parameter: local_master_rooms <yes/no>.  Default: Yes.
  1610.  
  1611.   If this config parameter is turned on, parent objects set ZONE will be
  1612.   treated like local master rooms, for the purposes of $command checks.
  1613.   See "help ZONE" for details.
  1614. & lock_recursion_limit
  1615.   Config directive: lock_recursion_limit <num>.  Default: 20
  1616.  
  1617.   Sets the maximum number of levels of indirection that may be used when
  1618.   using indirect locks.  If more than this many levels are used, the lock
  1619.   fails and the user gets an error message.
  1620.  
  1621. & log
  1622.   Config parameter: log [!]<logoption> [[!]<logoption>]...
  1623.   Specifies what types of events are to be logged to the logfile.
  1624.   
  1625.     accounting        - Write an accounting record to the log for each player
  1626.                         who disconnects.
  1627.     all_commands      - Record all commands executed.
  1628.     bad_commands      - Record commands entered that did not match anything.
  1629.     buffer_alloc      - Record buffer allocates and frees.
  1630.     bugs              - Record internal inconsistencies found.
  1631.     checkpoints       - Record automatic database dumps.
  1632.     config_changes    - Record uses of the @admin command.
  1633.     create            - Record creation of new players.
  1634.     keyboard_commands - Record commands entered interactively by players.
  1635.     killing           - Record uses of the kill and slay commands.
  1636.     logins            - Record connects to characters.
  1637.     network           - Record new and broken net connections.
  1638.     problems          - Record problems found with the database.
  1639.     security          - Record security-related events.
  1640.     shouts            - Record uses of the @wall command.
  1641.     startup           - Record information about game startup.
  1642.     suspect_commands  - Record commands entered by Suspect players.
  1643.     wizard            - Record uses of dangerous commands like @toad.
  1644.   See also: log_options.
  1645.  
  1646. & log_options
  1647.   Config parameter: log_options [!]<option> [[!]<option>]...
  1648.  
  1649.   Specifies the type of information to be included in each log entry.
  1650.   The possible values are:
  1651.  
  1652.     flags       - Include the flags set on a player or object.
  1653.     location    - Include the location of referenced players and objects.
  1654.     owner       - Include the owner of referenced players and objects.
  1655.     timestamp   - Include a timestamp in each log entry.
  1656.  
  1657.   See also: log.
  1658.  
  1659. & logout_cmd_access
  1660.   XXX
  1661.  
  1662. & logout_cmd_alias
  1663.   XXX
  1664.  
  1665. & look_obey_terse
  1666.   Config parameter: look_obey_terse <yes/no>.  Default: YES
  1667.   Indicates whether or not the 'look' command obeys the TERSE flag when
  1668.   deciding how much information to display.  If set to yes, the
  1669.   terse_shows_contents, terse_shows_exits, and terse_shows_move_messages
  1670.   config options control the amount of information displayed for TERSE
  1671.   players.
  1672.  
  1673.   See also: terse_shows_contents, terse_shows_exits, terse_shows_move_messages.
  1674.  
  1675. & machine_command_cost
  1676.   Config parameter: machine_command_cost <number>.  Default: 64
  1677.   Sets the cost for running a command from a machine, as opposed to running
  1678.   it interactively.  Each command run has a one in <number> chance of being
  1679.   charged one coin for machine overhead.
  1680.  
  1681. & match_own_commands
  1682.   Config parameter: match_own_commands <yes/no>.  Default: NO
  1683.   Specifies whether or not objects search themselves for $-commands when a
  1684.   command does not match an exit or an internal command.  In order for
  1685.   players to search themselves for commands, both match_own_commands and
  1686.   player_match_own_commands must be set to yes.
  1687.   See also: player_match_own_commands.
  1688.  
  1689. & master_room
  1690.   Config parameter: master_room <roomnum>.  Default: (none)
  1691.   Specifies the room that is searched for exits if a command does not match
  1692.   an exit in the current room, and for $-command if a command does not match
  1693.   any $-commands that are available to the player in his current location.
  1694.  
  1695. & max_players
  1696.   Config directive: max_players <num>.  Default: -1 (unlimited)
  1697.  
  1698.   Sets the maximum number of players that may be connected at any one time
  1699.   Note that wizards are allowed to login even if they would exceed the limit,
  1700.   and that this limit does not override any limits imposed by the system
  1701.   running the MUSH (such as the maximum number of net connections a process
  1702.   may have).  Players connecting when there are max_players players connected
  1703.   receive the contents of the file named by the full_file directive, and the
  1704.   full_motd_message (also settable via @motd/full), and are disconnected.
  1705.   See also: @motd, full_file, full_motd_message.
  1706.  
  1707. & money_name_plural
  1708.   Config parameter: money_name_plural <string>.  Default: pennies
  1709.   Specifies the string to use to describe the coin of the realm when they
  1710.   are being referred to plurally (such as: 'You have <number> pennies.', where
  1711.   <number>  is not 1).
  1712.   See also: money_name_singular.
  1713.  
  1714. & money_name_singular
  1715.   Config parameter: money_name_singular <string>.  Default: penny
  1716.   Specifies the string to use to describe the coin of the realm when they
  1717.   are being referred to singularly (such as: 'You found a penny!').
  1718.   See also: money_name_plural.
  1719.  
  1720. & motd_file
  1721.   Config parameter: motd_file <pathname>.  Default: motd.txt
  1722.   Specifies the name of the file to be shown to players immediately after they
  1723.   connect to their characters.
  1724.   See also: @readcache, newuser_file, motd_message.
  1725.  
  1726. & motd_message
  1727.   Config parameter: motd_message <message>.  Default: blank
  1728.   Sets the MOTD message that is displayed to all characters when they log in.
  1729.   This message is displayed in addition to the contents of the motd.txt
  1730.   file.  It can be changed with the @motd command and examined by the
  1731.   @listmotd command.
  1732.   See also: @listmotd, @motd, motd_file.
  1733.  
  1734. & mud_name
  1735.   Config parameter: mud_name <string>.  Default: TinyMUSH
  1736.   Specifies the mud name that is transmitted to a remote RWHO server when
  1737.   reporting information.
  1738.   See also: rwho_dump_interval, rwho_host, rwho_info_port, rwho_password,
  1739.             rwho_transmit.
  1740.  
  1741. & news_file
  1742.   Config parameter: news_file <path>.  Default: news.txt
  1743.   Specifies the name of the file containing the text used by the news
  1744.   command.
  1745.   See also: news, news_index
  1746.  
  1747. & news_index
  1748.   Config parameter: news_index <path>.  Default: news.indx
  1749.   Specifies the name of the index file used by the news command.  This file
  1750.   must be generated by mkindx from the news file.  The contents of this
  1751.   file are read in to a hash table when the game is started and whenever a
  1752.   @readcache command is executed.
  1753.   See also: news, @readcache, news_file
  1754.  
  1755. & newuser_file
  1756.   Config parameter: newuser_file <filename>.  Default: newuser.txt
  1757.   Specifies the file to be shown to new players immediately after they
  1758.   create their characters, in place of the MOTD file.  This file should
  1759.   contain information about the basic commands and how to get help.
  1760.   See also: @readcache, motd_file.
  1761.  
  1762. & notify_recursion_limit
  1763.   Config directive: notify_recursion_limit <num>.  Default: 20
  1764.  
  1765.   Sets the maximum number of times that the notify() routine may be called
  1766.   recursively.  A recursive call is made whenever a message heard by an
  1767.   object is to be forwarded to its contents.
  1768.  
  1769. & open_cost
  1770.   Config parameter: open_cost <amount>.  Default: 1
  1771.   Indicates the cost of using the @open command to open a new exit.
  1772.   If a destination for the new exit is specified and the link is successful,
  1773.   then the link_cost is also charged.
  1774.   See also: @open, link_cost.
  1775.  
  1776. & output_database
  1777.   Config parameter: output_database <pathname>.  Default: none
  1778.   Specifies the file to which the database is to be written when writing
  1779.   checkpoint dumps or writing the final dump after receiving a @shutdown
  1780.   command.
  1781.   See also: @dump, @shutdown, checkpoint_database, input_database.
  1782.  
  1783. & output_limit
  1784.   Config parameter: output_limit <amount>.  Default: 16384
  1785.   Indicates the maximum number of characters that a connected player may have
  1786.   queued for output.  As queued output is normally transmitted once each
  1787.   second, this parameter limits the amount of output that can be generated by
  1788.   a single command or a set of commands executed in rapid succession.  It also
  1789.   prevents the output queues from growing without limit when the network does
  1790.   not accept new output on a particular connection or connections.  If new
  1791.   output would cause the amount of queued output to exceed this parameter,
  1792.   the oldest pending output is discarded until the amount of pending output
  1793.   is less than this parameter.
  1794.  
  1795. & page_cost
  1796.   Config parameter: page_cost <amount>.  Default: 10
  1797.   Specifies the cost of using the page command.
  1798.   See also: page.
  1799.  
  1800. & paranoid_allocate
  1801.   Config parameter: paranoid_allocate <yes/no>.  Default: no
  1802.  
  1803.   Controls whether or not the game performs a consistency check on the entire
  1804.   set of xbuf buffers each time one is allocated or freed.  This check
  1805.   involves making sure that nobody has written to the memory immediately before
  1806.   and after each buffer.  Normally, only the buffer being allocated or freed
  1807.   is checked.
  1808.  
  1809. & parentable_control_lock
  1810.   Config parameter: parentable_control_lock <yes/no>.  Default: no
  1811.  
  1812.   Specifies whether or not objects without a ControlLock inherit the
  1813.   ControlLock of their parent.  Note that the ControlLock is only obeyed
  1814.   for objects whose ZONE flag is set.
  1815.  
  1816. & parent_zones
  1817.   Config parameter: parent_zones <yes/no>.  Default: no
  1818.  
  1819.   Specifies whether or not the @parent/zone command works, and whether
  1820.   rooms that have that secondary parent have that parent chain checked
  1821.   for ZONE local masters.
  1822.  
  1823. & paycheck
  1824.   Config parameter: paycheck <amount>.  Default: 0
  1825.   Specifies the default amount of money that players receive each day they
  1826.   connect.  This parameter may be overridden by setting the ALLOWANCE
  1827.   attribute on the player to a different value.
  1828.   See also: @allowance, earn_limit, starting_money.
  1829.  
  1830. & pemit_any_object
  1831.   Config parameter: pemit_any_object <yes/no>.  Default: no
  1832.   Indicates whether or not players may @pemit to faraway objects they do not
  1833.   control.  It does not affect @pemits to faraway players, the
  1834.   pemit_far_players directive is used for that purpose.
  1835.   See also: pemit_far_players.
  1836.  
  1837. & pemit_far_players
  1838.   Config parameter: pemit_far_players <yes/no>.  Default: no
  1839.   Controls whether or not players may use the @pemit command to send messages
  1840.   to other connected players that are not in the same room.  The rules and
  1841.   costs for this form of @pemit are the same as for page.
  1842.   See also: pemit_any_object.
  1843.  
  1844. & permit_site
  1845.   Config parameter: permit_site <site notation>
  1846.  
  1847.   Indicates that connections are to be accepted and registration is not to be
  1848.   enforced from sites whose addresses match the specified notation. This
  1849.   directive is typically used to enable connections from a few selected
  1850.   hosts or subnets that would otherwise be disallowed by a forbid_site
  1851.   directive.  The default is all sites permitted, none forbidden.
  1852.  
  1853.   See also: badsite_file, forbid_site, register_site, SITE LISTS.
  1854.  
  1855. & player_flags
  1856.   Config parameter: player_flags <flags>.  Default: blank
  1857.   Modifies the set of flags that a player receives when it is created via the
  1858.   @pcreate command or via the connection screen.  Flags prefixed by a ! remove
  1859.   the indicated flag from the set.
  1860.   See also: @list, exit_flags, robot_flags, room_flags, thing_flags.
  1861.  
  1862. & player_listen
  1863.   Config parameter: player_listen.  Default: no
  1864.   Indicates whether the Listen, Aahear, Ahear, and Amhear attributes on
  1865.   player objects are to be obeyed.
  1866.  
  1867. & player_match_own_commands
  1868.   Config parameter: player_match_own_commands <yes/no>.  Default: no
  1869.   Specifies whether or not players should check themselves for $-commands.
  1870.   This parameter is only checked if the match_own_commands parameter is
  1871.   set to yes.
  1872.   See also: match_own_commands.
  1873.  
  1874. & player_name_spaces
  1875.   Config parameter: player_name_spaces <yes/no>.  Default: yes
  1876.   Specifies whether or not player names are permitted to contain
  1877.   spaces.
  1878.  
  1879. & player_queue_limit
  1880.   Config parameter: player_queue_limit.  Default: 100
  1881.   Sets the maximum number of commands that non-wizard players may have on the
  1882.   queue at one time.  An attempt to queue more commands than allowed will
  1883.   halt the object performing the command.
  1884.  
  1885. & player_parent
  1886.   Config parameter: player_parent <dbref>.  Default: nothing
  1887.  
  1888.   If this parameter is set, every object of type PLAYER will have the
  1889.   specified object as a parent.
  1890.  
  1891.   See also: room_parent, exit_parent, thing_parent.
  1892.  
  1893. & player_quota
  1894.   Config parameter: player_quota <amount>.  Default: 1
  1895.   Sets how much quota it costs to create a robot player (and also how much the
  1896.   remaining quota is increased when a robot is @destroyed.
  1897.   See also: @quota, exit_quota, room_quota, thing_quota, QUOTAS.
  1898.  
  1899. & player_starting_home
  1900.   Config parameter: player_starting_home.  Default: <player_starting_room>
  1901.   Specifies the room to which the home of new players is set.  If this
  1902.   parameter has not been set, then the value of the player_starting_room
  1903.   parameter is used instead.
  1904.   See also: default_home, player_starting_room, @pcreate, player_flags.
  1905.  
  1906. & player_starting_room
  1907.   Config parameter: player_starting_room.  Default: 0
  1908.   Specifies the room that new players start out in.  If the
  1909.   player_starting_home parameter has not been set, then player_starting_room
  1910.   is used for both.
  1911.   See also: player_starting_home, @pcreate, player_flags.
  1912.  
  1913. & port
  1914.   Config parameter: port <port>.  Default: 6250
  1915.   Specifies the IP port on which the game listens for new connections.
  1916.  
  1917. & postdump_message
  1918.   Config parameter: postdump_message <message>.  Default: blank
  1919.   Sets the message that is sent to everyone after a database dump
  1920.   whether automatically or via the @dump command.
  1921.   See also: @dump, dump_message.
  1922.  
  1923. & power_access
  1924.   Config parameter: power_access <power> [!]<privilege> [[!]<privilege>]...
  1925.   Changes the access rights to the named power.
  1926.   See also: @list powers, PERMISSIONS.
  1927.  
  1928. & public_flags
  1929.   Config parameter: public_flags <yes/no>.  Default: yes
  1930.   If enabled, indicates that players may get the flags of any object with the
  1931.   flags() function call.  Otherwise, they may only get the flags for objects
  1932.   that are examinable by them.
  1933.   See also: flags().
  1934.  
  1935. & pueblo_message
  1936.   Config parameter: pueblo_message <string>.
  1937.  
  1938.   The default for this is:  </xch_mudtext><img xch_mode=html><tt>
  1939.  
  1940.   This is the message which is sent to Pueblo client users when they
  1941.   first send a PUEBLOCLIENT command.
  1942.  
  1943. & queue_active_chunk
  1944.   Config parameter: queue_idle_chunk <num>.  Default: 0
  1945.   Specifies the number of commands to be run from the player queue when the
  1946.   check for network traffic indicates that there is data needing to be
  1947.   read from or written to the network.
  1948.   See also: queue_idle_chunk.
  1949.  
  1950. & queue_idle_chunk
  1951.   Config parameter: queue_idle_chunk <num>.  Default: 3
  1952.   Specifies the number of commands to be run from the player queue when the
  1953.   check for network traffic indicates that there is no data needing to be
  1954.   read from or written to the network.
  1955.   See also: queue_active_chunk.
  1956.  
  1957. & quiet_look
  1958.   Config parameter: quiet_look <yes/no>.  Default: no
  1959.   Indicates whether or not players are shown the attributes set on an object
  1960.   when they look at it.  Not recommended.
  1961.  
  1962. & quiet_whisper
  1963.   Config parameter: quiet_whisper <yes/no>.  Default: yes
  1964.   Indicates whether or not whispers are completely invisible except to the
  1965.   whispered-to player, or if a '<whisperer> whispers something to
  1966.   <recipient>.' message is displayed to everyone else in the same room.
  1967.   See also: whisper.
  1968.  
  1969. & quit_file
  1970.   Config parameter: quit_file <filename>.  Default: quit.txt
  1971.   Specifies the name of the file that is displayed to users after they QUIT
  1972.   but before the network connection is closed.
  1973.   See also: QUIT, @readcache.
  1974.  
  1975. & quota_cost
  1976.   Config parameter: quota_cost <amount>.  Default: 1
  1977.   Indicates how much adding one object to the database charges against the
  1978.   player's quota.
  1979.   See also: @create, @destroy, @dig, @open, @quota, QUOTAS.
  1980.  
  1981. & quotas
  1982.   Config parameter: quotas <yes/no>.  Default: no
  1983.  
  1984.   Indicates whether or not building quotas are enforced and maintained.
  1985.   Quotas are stored as a relative number, ie. number of objects that the
  1986.   player may create, not the total number that the player may create.
  1987.   If quotas are turned off and turned back on later, any building or
  1988.   @destroying that occurs in the interim does not affect the quotas.
  1989.  
  1990.   Players have a total quota (the number of objects total they may own
  1991.   on the database), as well as quotas for each individual type, which
  1992.   restrict the number of objects of each type that a player may own.
  1993.  
  1994.   See also: @allquota, @create, @destroy, @dig, @open, @quota, QUOTAS,
  1995.             quota_cost.
  1996.  
  1997. & read_remote_desc
  1998.   Config parameter: read_remote_desc <yes/no>.  Default: no
  1999.   Indicates whether or not the descriptions of faraway objects are available
  2000.   to players that don't control them via the examine command and get()
  2001.   function.
  2002.   See also: examine, get().
  2003.  
  2004. & read_remote_name
  2005.   Config parameter: read_remote_name <yes/no>.  Default: no
  2006.   Indicates whether or not the names of faraway objects are available
  2007.   to players that don't control them via the examine command and get()
  2008.   function.
  2009.   See also: examine, get().
  2010.  
  2011. & recycling
  2012.   Config parameter: recycling <yes/no>.  Default: yes
  2013.   Indicates whether or not object destruction, recycling, reuse is enabled.
  2014.   Don't change it.
  2015.  
  2016. & register_create_file
  2017.   Config parameter: register_create_file <filename>.  Default: create_reg.txt
  2018.   Specifies the name of the file that is shown to players who attempt to
  2019.   create a new character when registration is in force from their site.
  2020.   See also: @list_file, @readcache, register_site.
  2021.  
  2022. & register_site
  2023.   Config parameter: register_site <site notation>
  2024.  
  2025.   Indicates that registration is to be enforced for sites whose address
  2026.   falls within the specified address range.
  2027.  
  2028.   See also: forbid_site, permit_site, REGISTRATION, SITE LISTS.
  2029.  
  2030. & require_cmds_flag
  2031.   Config parameter: require_cmds_flag <yes/no>.  Default: yes
  2032.   Indicates whether or not the COMMANDS flag has to be set in order
  2033.   for $-commands to be checked on an object. Older versions of MUSH
  2034.   don't require it to be set. However, it can be considerably more
  2035.   efficient to require it.
  2036.  
  2037. & retry_limit
  2038.   Config parameter: retry_limit <count>.  Default: 3
  2039.   Specifies the number of times that a user is allowed to try to connect to
  2040.   an existing player before being disconnected.
  2041.   See also: conn_timeout.
  2042.  
  2043. & robot_cost
  2044.   Config parameter: robot_cost <amount>.  Default: 1000
  2045.   Specifies the cost of using the @robot command to create a robot.
  2046.   See also: @robot, ROBOT.
  2047.  
  2048. & robot_flags
  2049.   Config parameter: robot_flags <flags>.  Default: ROBOT
  2050.   Modifies the set of flags that a robot receives when it is created via
  2051.   the @robot command.  Flags prefixed by a ! remove the indicated flag from
  2052.   the set.
  2053.   See also: @list, exit_flags, player_flags, room_flags, thing_flags.
  2054.  
  2055. & robot_speech
  2056.   Config parameter: robot_speech: <yes/no>.  Default: yes
  2057.   Indicates whether or not robot characters are allowed to use the speech,
  2058.   pose, and emit commands in areas not controlled by their owner.
  2059.   See also: @robot, ROBOT.
  2060.  
  2061. & room_flags
  2062.   Config parameter: room_flags <flags>.  Default: blank
  2063.   Modifies the set of flags that a room receives when it is @dug.
  2064.   Flags prefixed by a ! remove the indicated flag from the set.
  2065.   See also: @list, exit_flags, player_flags, robot_flags, thing_flags.
  2066.  
  2067. & room_parent
  2068.   Config parameter: room_parent <dbref>.  Default: nothing
  2069.  
  2070.   If this parameter is set, every object of type ROOM will have the
  2071.   specified object as a parent.
  2072.  
  2073.   See also: player_parent, exit_parent, thing_parent.
  2074.  
  2075. & room_quota
  2076.   Config parameter: room_quota <amount>.  Default: 1
  2077.   Sets how much quota it costs to dig a room (and also how much the
  2078.   remaining quota is increased when a room is @destroyed.
  2079.   See also: @quota, exit_quota, player_quota, thing_quota, QUOTAS.
  2080.  
  2081. & rwho_data_port
  2082.   Config parameter: rwho_data_port <number>.  Default: 0
  2083.   Sets the port number that is used to retrieve RWHO information from the
  2084.   remote RWHO server in response to a user entering the RWHO command.
  2085.   If zero, the RWHO command is disabled.  Use of this parameter is *STRONGLY*
  2086.   discouraged unless you are on the same local network as the RWHO server,
  2087.   as network problems and delays will hang the MUSH, affecting all connected
  2088.   users.  Support for the RWHO command is a compile-time option.
  2089.   See also: RWHO, rwho_host.
  2090.  
  2091. & rwho_dump_interval
  2092.   Config parameter: rwho_dump_interval <secs>.  Default: 241
  2093.   Sets the number of seconds between RWHO dumps, during which the MUSH sends
  2094.   an 'I am alive' message and a list of all connected users to the remote RWHO
  2095.   server.
  2096.   See also: mud_name, rwho_host, rwho_info_port, rwho_password, rwho_transmit.
  2097.  
  2098. & rwho_host
  2099.   Config parameter: rwho_host <hostname/ip_address>.  Default: 36.21.0.69
  2100.   Sets the host name or IP address of the remote RWHO server.
  2101.   See also: mud_name, rwho_data_port, rwho_info_port, rwho_password,
  2102.             rwho_transmit.
  2103.  
  2104. & rwho_info_port
  2105.   Config parameter: rwho_info_port <number>.  Default: 6888
  2106.   Sets the port number to be used when sending data to the remote RWHO
  2107.   server.
  2108.   See also: mud_name, rwho_host, rwho_password, rwho_transmit.
  2109.  
  2110. & rwho_password
  2111.   Config parameter: rwho_password <string>.  Default: something wrong.
  2112.   Sets the password that is used when sending data to a remote RWHO server.
  2113.   You must receive the value for this parameter from the administrator
  2114.   of the RWHO server that you are using.
  2115.   See also: mud_name, rwho_host, rwho_info_port, rwho_transmit.
  2116.  
  2117. & rwho_transmit
  2118.   Config parameter: rwho_transmit <yes/no>.  Default: no
  2119.   Indicates whether or not to transmit data to a remote RWHO server.
  2120.   See also: @list, mud_name, rwho_host, rwho_info_port, rwho_password.
  2121.  
  2122. & sacrifice_adjust
  2123.   Config parameter: sacrifice_adjust <amount>.  Default -1.
  2124.   This parameter is part of the formula that is used to determine an object's
  2125.   value given the amount spent on its creation.  The formula is:
  2126.  
  2127.      value = (cost / sacrifice_factor) + sacrifice_adjust.
  2128.  
  2129.   The inverse formula is used to determine how much the owner receives when
  2130.   @destroying an object.
  2131.   See also: @create, @destroy, SACRIFICING, sacrifice_factor.
  2132.  
  2133. & sacrifice_factor
  2134.   Config parameter: sacrifice_factor <amount>.  Default 5.
  2135.   This parameter is part of the formula that is used to determine an object's
  2136.   value given the amount spent on its creation.  The formula is:
  2137.  
  2138.      value = (cost / sacrifice_factor) + sacrifice_adjust.
  2139.  
  2140.   The inverse formula is used to determine how much the owner receives when
  2141.   @destroying an object.
  2142.   See also: @create, @destroy, SACRIFICING, sacrifice_adjust.
  2143.  
  2144. & safer_passwords
  2145.   Config parameter: safer_passwords <yes/no>.  Default: no
  2146.  
  2147.   If this configuration parameter is enabled, player passwords are 
  2148.   required to have at least one uppercase letter, at least one lowercase
  2149.   letter, and at least one number or symbol that is not the apostrophe (')
  2150.   or dash (-). Passwords of this type are less easily compromised using a
  2151.   brute-force password-cracker.
  2152.  
  2153. & search_cost
  2154.   Config parameter: search_cost <amount>.  Default: 100
  2155.   Specifies how much commands that scan the entire database (such as @find,
  2156.   @search, and stats with a playername) cost.
  2157.   See also: stats, @find, @search.
  2158.  
  2159. & see_owned_dark
  2160.   Config parameters: see_owned_dark <yes/no>.  Default: yes
  2161.   Specifies whether or not players see their own DARK objects when they
  2162.   look at a room.  It does not affect the inventory or examine commands,
  2163.   both of which show all objects.
  2164.  
  2165. & signal_action
  2166.   Config parameter: signal_action <default|resignal|retry>.  Default: default
  2167.   Specifies what action to take when a fatal signal is received.  The
  2168.   possibilities are:
  2169.      default  - Don't catch fatal signals.  Nothing will be cleaned up and a
  2170.                 coredump will be produced.
  2171.      resignal - Log the error, produce a panic dump, close all files and
  2172.                 network connections, and resignal the signal from the signal
  2173.                 handler.  The second instance of the signal will produce a
  2174.                 coredump, although the portion of the stack before the signal
  2175.                 may be unreadable.
  2176.      retry    - Log the error, produce a panic dump, close all files and
  2177.                 network connections, and return to the point where the signal
  2178.                 originated.  Retrying the failed operation should produce
  2179.                 a coredump, although the stack may or may not be readable.
  2180.  
  2181. & space_compress
  2182.   Config parameter: space_compress <yes/no>.  Default: yes
  2183.   Specifies whether or not extra spaces are to be removed from user input
  2184.   as it is processed.  If enabled, multiple spaces are compressed to a single
  2185.   space, and spaces at the ends of strings are removed.
  2186.  
  2187. & starting_money
  2188.   Config parameter: starting_money <amount>.  Default: 0
  2189.   Sets the amount of money that new players start out with.
  2190.   See also: paycheck.
  2191.  
  2192. & starting_quota
  2193.   Config parameter: starting_quota <amount>.  Default: 20
  2194.   Sets the building quota that players receive when they are created, whether
  2195.   by @pcreate or the connection screen.
  2196.   See also: @quota, quotas.
  2197.  
  2198. & starting_room_quota
  2199.   Config parameter: starting_room_quota <amount>.  Default: 20
  2200.   Sets the room quota that players receive when they are created, whether by 
  2201.   @pcreate or the connection screen.
  2202.  
  2203. & starting_exit_quota
  2204.   Config parameter: starting_exit_quota <amount>.  Default: 20
  2205.   Sets the exit quota that players receive when they are created, whether by 
  2206.   @pcreate or the connection screen.
  2207.  
  2208. & starting_thing_quota
  2209.   Config parameter: starting_thing_quota <amount>.  Default: 20
  2210.   Sets the thing quota that players receive when they are created, whether by 
  2211.   @pcreate or the connection screen.
  2212.  
  2213. & starting_player_quota
  2214.   Config parameter: starting_player_quota <amount>.  Default: 20
  2215.   Sets the player quota that players receive when they are created, whether by 
  2216.   @pcreate or the connection screen.
  2217.  
  2218. & status_file
  2219.   Config parameter: status_file <filename>.  Default: shutdown.status
  2220.  
  2221.   If you give an argument to the @shutdown command, that argument is written
  2222.   out to the file named by this directive.  The file can be used by an
  2223.   auto-restart script to decide whether or not to bring the mush back up,
  2224.   for instance.
  2225.  
  2226. & suspect_site
  2227.   Config parameter: suspect_site <site notation>
  2228.  
  2229.   Indicates that sites whose address falls within the specified address range
  2230.   are to be considered suspect, and any player creates, connects and
  2231.   disconnects are to be reported to all logged-in wizards.
  2232.  
  2233.   See also: trust_site, SITE LISTS.
  2234.  
  2235. & sweep_dark
  2236.   Config parameter: sweep_dark <yes/no>.  Default: no
  2237.   Indicates whether or not players are allowed to @sweep dark places they do not
  2238.   control.
  2239.   See also: @sweep.
  2240.  
  2241. & switch_default_all
  2242.   Config parameter: switch_default_all <yes/no>.  Default: yes
  2243.   Indicates whether the @switch command should perform the commands for all
  2244.   targets that match or just the first one that matches if you don't specify
  2245.   either /all or /first as a command switch.
  2246.  
  2247. & terse_shows_contents
  2248.   Config parameter: terse_shows_contents <yes/no>.  Default yes
  2249.  
  2250.   Indicates whether or not to suppress the listing of a location's contents
  2251.   when producing TERSE output (whether from an automatic look or a 'real'
  2252.   look if look_obey_terse is turned on.
  2253.  
  2254.   See also: look_obey_terse, terse_shows_exits, terse_shows_move_messages.
  2255.  
  2256. & terse_shows_contents
  2257.   Config parameter: terse_shows_contents <yes/no>.  Default yes
  2258.  
  2259.   Indicates whether or not to suppress the listing of a location's contents
  2260.   when producing TERSE output (whether from an automatic look or a 'real'
  2261.   look if look_obey_terse is turned on.
  2262.  
  2263.   See also: look_obey_terse, terse_shows_exits, terse_shows_move_messages.
  2264.  
  2265. & terse_shows_exits
  2266.   Config parameter: terse_shows_exits <yes/no>.  Default yes
  2267.  
  2268.   Indicates whether or not to suppress the listing of a location's obvious
  2269.   exits when producing TERSE output (whether from an automatic look or a
  2270.   'real' look if look_obey_terse is turned on.
  2271.  
  2272.   See also: look_obey_terse, terse_shows_contents, terse_shows_move_messages.
  2273.  
  2274. & terse_shows_move_messages
  2275.   Config parameter: terse_shows_move_messages <yes/no>.  Default yes
  2276.  
  2277.   Indicates whether or not to suppress messages related to moving about
  2278.   produced by locations and exits.  These messages are the ENTER and LEAVE
  2279.   messages on locations, and the SUCC and DROP messages on exits.
  2280.   The messages seen by others (Oxxx attributes) and the actions to be
  2281.   performed (Axxx attributes) are unaffected.
  2282.  
  2283.   See also: look_obey_terse, terse_shows_contents, terse_shows_exits.
  2284.  
  2285. & thing_flags
  2286.   Config parameter: thing_flags <flags>.  Default: blank
  2287.   Modifies the set of flags that a thing receives when it is @created.
  2288.   Flags prefixed by a ! remove the indicated flag from the set.
  2289.   See also: @list, exit_flags, player_flags, robot_flags, room_flags.
  2290.  
  2291. & thing_parent
  2292.   Config parameter: thing_parent <dbref>.  Default: nothing
  2293.  
  2294.   If this parameter is set, every object of type THING will have the
  2295.   specified object as a parent.
  2296.  
  2297.   See also: player_parent, room_parent, exit_parent.
  2298.  
  2299. & thing_quota
  2300.   Config parameter: thing_quota <amount>.  Default: 1
  2301.   Sets how much quota it costs to create a thing (and also how much the
  2302.   remaining quota is increased when a thing is @destroyed.
  2303.   See also: @quota, exit_quota, player_quota, room_quota, QUOTAS.
  2304.  
  2305. & timeslice
  2306.   Config parameter: timeslice <amount>.  Default: 1000
  2307.   Specifies the interval at which connected users' command quotas are
  2308.   increased.  Each command a user types in (commands executed by machines do
  2309.   not count) decreases that user's quota by 1, and the user's commands are
  2310.   only executed if the quota is greater than zero.
  2311.   See also: command_quota_incr, command_quota_max.
  2312.  
  2313. & trace_output_limit
  2314.   Config parameter: trace_output_limit <amount>.  Default: 200
  2315.   Specifies the maximum number of lines of trace output that will be displayed
  2316.   when using top-down format.  Bottom-up format output is not affected by this
  2317.   parameter.
  2318.   Note that this parameter is intended as a limit on the amount of memory used
  2319.   to store intermediate data and not on the quantity of trace output, top-down
  2320.   format needs to keep all intermediate results in memory before displaying
  2321.   them, while bottom-up format displays them immediately after generating them.
  2322.   When trace output lines are discarded, only the last (trace_output_limit)
  2323.   lines are kept.  These lines contain information about the evaluations done
  2324.   earliest in the process of evaluating the expression (usually the innermost
  2325.   evaluations and earlier arguments of outer functions).
  2326.  
  2327. & trace_topdown
  2328.   Config parameter: trace_topdown <yes/no>.  Default: yes
  2329.   Specifies whether TRACE output is displayed top-down (complete evaluation
  2330.   shown first, followed by sub-evaluations), or bottom-up (sub-evaluations
  2331.   shown first, followed by the larger evaluation of which they are a part).
  2332.  
  2333. & trust_site
  2334.   Config parameter: trust_site <site notation>
  2335.  
  2336.   Indicates that sites whose addresses fall within the specified address
  2337.   range are not to be considered suspect.
  2338.  
  2339.   See also: suspect_site, SITE LISTS.
  2340.  
  2341. & typed_quotas
  2342.   Config parameter: typed_quotas <yes/no>.  Default: no
  2343.   Indicates whether or not quotas are managed by type. If this is not on,
  2344.   then only total quota will be checked; otherwise, players must have both
  2345.   enough total quota and quota for that specific object type, in order to
  2346.   build more of that object type. If this is 'yes', then the config
  2347.   parameter "quotas" should also be 'yes'.
  2348.  
  2349. & unowned_safe
  2350.   Config parameter: unowned_safe <yes/no>.  Default: no
  2351.   Indicates whether or not objects not owned by you are automatically
  2352.   considered SAFE.  (This parameter only affects wizards)  Note that players
  2353.   are always considered SAFE, and DESTROY_OK things are never considered SAFE.
  2354.   See also: @destroy, DESTROY_OK, SAFE.
  2355.  
  2356. & use_global_aconn
  2357.   Config parameter: use_global_aconn <yes/no>.  Default: yes
  2358.   Indicates whether or not objects in the master room should be searched
  2359.   for @aconnect and @adisconnect attributes whenever a player logs in or
  2360.   out.  If enabled, each object in the master room is searched for the
  2361.   appropriate attribute at login/logout time. Attributes found are
  2362.   triggered by the player, just as their local @aconnect/@disconnect
  2363.   attributes would be. 
  2364.  
  2365. & user_attr_access
  2366.   Config parameter: user_attr_access [!]<privilege> [[!]<privilege>]...
  2367.   Changes the access flags that new user-named attributes receive when
  2368.   they are created.  By default, user attributes are invisible to others.
  2369.  
  2370. & wait_cost
  2371.   Config parameter: wait_cost <amount>.  Default: 10
  2372.   Sets the amount of money that it costs to run the @wait command and other
  2373.   actions that add commands to the queue.  The money is refunded when the
  2374.   command is removed from the queue (either when it is executed or by @halt).
  2375.   See also: @wait.
  2376.  
  2377. & wizard_obeys_linklock
  2378.   Config parameter: wizard_obeys_linklock <yes/no>.  Default: no
  2379.   Controls whether or not wizards can link to anything, regardless of
  2380.   whether or not it has a linklock.
  2381.  
  2382. & wizard_help_file
  2383.   Config parameter: wizard_help_file <path>.  Default: wizhelp.txt
  2384.   Specifies the name of the file containing the text used by the wizhelp
  2385.   command.
  2386.   See also: wizhelp, wizard_help_index
  2387.  
  2388. & wizard_help_index
  2389.   Config parameter: wizard_help_index <path>.  Default: wizhelp.indx
  2390.   Specifies the name of the index file used by the wizhelp command.  This file
  2391.   must be generated by mkindx from the wizard help file.  The contents of
  2392.   this file are read in to a hash table when the game is started and whenever
  2393.   a @readcache command is executed.
  2394.   See also: wizhelp, @readcache, wizard_help_file
  2395.  
  2396. & wizard_motd_file
  2397.   Config parameter: wizard_motd_file <path>.  Default: wizmotd.txt
  2398.   Specifies the name of the file that contains the wizard MOTD message that
  2399.   is displayed to wizards when they log in.  This message is displayed in
  2400.   addition to the wizard MOTD message that is set by the @motd/wiz command or
  2401.   the wizard_motd_message config parameter.  The contents of the file are
  2402.   read in to a cache when the game is started and whenever a @readcache
  2403.   command is executed.
  2404.   See also: @readcache, wizard_motd_message.
  2405.  
  2406. & wizard_motd_message
  2407.   Config parameter: wizard_motd_message <message>.  Default: blank
  2408.   Sets the wizard MOTD message that is displayed to wizards when they log in.
  2409.   This message is displayed in addition to the contents of the wizmotd.txt
  2410.   file.  It can be changed with the @motd/wiz command and examined by the
  2411.   @listmotd command.
  2412.   See also: @listmotd, @motd, motd_message, wizard_motd_file.
  2413.  
  2414. & CAUTIONS
  2415.   Topic: CAUTIONS
  2416.  
  2417.   The @force command evaluates its argument before putting it on the queue.
  2418.   Therefore, any ';' characters resulting from the evaluation that are
  2419.   outside of any nested delimiters will cause what follows to be treated
  2420.   as a separate command.
  2421.  
  2422. & CONTACT INFO
  2423.   Topic: CONTACT INFO
  2424.  
  2425.   Put information about how to contact the wizards and game maintainer
  2426.   in here so they can contact one another when the game is down.
  2427.  
  2428. & DEBUG FEATURES
  2429.  
  2430. & FILES
  2431.   Topic: FILES
  2432.  
  2433.   TinyMUSH uses these files (normally kept in the same directory as the
  2434.   database files and the netmush program) to display information under
  2435.   certain circumstances.  The names of the files used can be changed with
  2436.   configuration directives (or on the netmush command line, in the case of
  2437.   netmush.conf).
  2438.  
  2439.   badsite.txt:    Displayed when someone connects from a site that is not
  2440.                   allowed to connect.  The connection is then closed.
  2441.   connect.txt:    Displayed when someone connects from a site for which
  2442.                   registration is not enabled.
  2443.   create_reg.txt: Displayed when someone tries to 'create' a character from
  2444.                   a site for which registration is enforced.
  2445.   down.txt:       Displayed when someone tries to connect to a non-wizard
  2446.                   character when logins are disabled.
  2447.   help.indx:      Index for the help.txt file, produced by the mkindx program.
  2448.   help.txt:       File containing information displayed by the help command.
  2449. { 'wizhelp files2' for more }
  2450. & files2
  2451.   guest.txt:      Displayed to whoever connects to the guest character(s)
  2452.                   specified by the guests config parameter.
  2453.   motd.txt:       Displayed after someone connects to an existing character.
  2454.   netmush.conf:   Configuration directives read at startup.
  2455.   news.indx:      Index for the news.txt file, produced by the mkindx program.
  2456.   news.txt:       File containing information displayed by the news command.
  2457.   newuser.txt:    Displayed after someone creates a new character or connects
  2458.                   to their character for the first time.
  2459.   quit.txt:       Displayed after someone QUITs but before the net connection
  2460.                   is closed.
  2461.   register.txt:   Displayed when someone connects from a site for which
  2462.                   registration is enabled.
  2463.   wizhelp.indx:   Index for the wizhelp.txt file, produced by the mkindx
  2464.                   program.
  2465.   wizhelp.txt:    File containing information displayed by the wizhelp
  2466.                   command.
  2467.   wizmotd.txt:    Displayed to wizards when they connect to their characters.
  2468.  
  2469.   See also: badsite_file, connect_file, connect_reg_file, down_file,
  2470.             guest_file, help_file, help_index, motd_file, news_file,
  2471.             news_index, newuser_file, quit_file, register_create_file,
  2472.             wizard_help_file, wizard_help_index, wizard_motd_file.
  2473.  
  2474. & INHERITANCE
  2475.   XXXX
  2476. & LOGGING
  2477.   XXXX
  2478. & PERMISSIONS
  2479.   Topic: PERMISSIONS
  2480.  
  2481.   Access to many MUSH features is controlled by a set of permissions, which
  2482.   can usually be changed via the configuration file or the @admin command.
  2483.   This is a list of the valid permissions and their meanings.
  2484.     god           - Only player #1 may use this feature.
  2485.    +wizard        - Only wizards (players with their WIZARD bit set) may use
  2486.                     this feature.
  2487.    +builder       - Only builders (BUILDER bit) may use this feature.
  2488.    +immortals     - Only immortals (IMMORTAL bit) may use this feature.
  2489.    +robot         - Only robots (ROBOT bit) may use this feature
  2490.     no_haven      - Only players who are not set HAVEN may use this feature.
  2491.     no_robot      - Robots may not use this feature.
  2492.     no_gagged     - Gagged players (GAGGED bit) may not use this feature.
  2493.     no_slave      - Slave players (SLAVE bit) may not use this feature.
  2494.     no_suspect    - Suspect players (SUSPECT bit) may not use this feature.
  2495.     no_guest      - Guest players (guest_character config directive) may not
  2496.                     use this feature.
  2497. { 'wizhelp permissions2' for more }
  2498. & permissions2
  2499.     global_build  - This feature may only be used when the global building
  2500.                     flag is turned on.
  2501.     global_interp - This feature may only be used when the global
  2502.                     interpretation flag is turned on.
  2503.     disabled      - Nobody may use this feature.
  2504.     need_location - Only players and things may use this feature.
  2505.     need_contents - Only players, things, and rooms may use this feature.
  2506.     need_player   - Only players may use this feature.
  2507.  
  2508.   Restrictions are normally additive (meaning that you must be a member of all
  2509.   required groups and not be a member of any excluded group).  The permissions
  2510.   marked with a + are different, in that if more than one is required, then
  2511.   being a member of any + group will grant access to the feature and skip
  2512.   the remaining checks.
  2513.  
  2514. & SEARCH CRITERIA
  2515.   Topic: SEARCH CRITERIA
  2516.  
  2517.   The following criteria may be used when searching the database with the
  2518.   @search and @mark commands:
  2519.  
  2520.   Syntax: {@mark|@search} [<player>] [<class>=<restriction>]
  2521.  
  2522.   <player>  - Restricts to objects owned by the named player.
  2523.               By default, the search is limited to objects owned by the
  2524.               invoking player, except when searching for players or if
  2525.               the invoking player is a wizard.
  2526. { 'wizhelp search criteria2' for more }
  2527. & search criteria2
  2528.   The following classes may be used when searching:
  2529.  
  2530.   TYPE      - Restricts to objects of the indicated type (OBJECTS, ROOMS,
  2531.               EXITS, PLAYERS).
  2532.   NAME      - Restricts to objects whose names start with <restriction>.
  2533.   OBJECTS   - A combination of TYPE=OBJECT and NAME=<restriction>
  2534.   ROOMS     - A combination of TYPE=ROOM and NAME=<restriction>
  2535.   EXITS     - A combination of TYPE=EXIT and NAME=<restriction>
  2536.   PLAYERS   - A combination of TYPE=PLAYER and NAME=<restriction>
  2537.   FLAGS     - Restricts to objects which have the flags listed in
  2538.               <restriction> set.
  2539.   See also: @mark, @search.
  2540.  
  2541. & SITE LISTS
  2542.   Topic: SITE LISTS
  2543.  
  2544.   There are two site lists, one for controlling access and registration, and
  2545.   one for suspect warning.  The first list is controlled by the forbid_site,
  2546.   permit_site, and register_site parameters, the second by the suspect_site
  2547.   and trust_site parameters. The syntax of these parameters is:
  2548.   <param-name> <address> <mask>, or <param-name> <IP prefix> where:
  2549.  
  2550.   Address   - Four-part decimal Internet address, specified as a.b.c.d,
  2551.               of the host or network to which this parameter applies.
  2552.   Mask      - Four-part decimal Internet address, specified as a.b.c.d
  2553.               The mask is used to determine which parts of the address are
  2554.               to be used for comparison, it is ANDed with both the address
  2555.               of the host and the address in the directive.
  2556.   OR
  2557.   IP Prefix - CIDR IP prefix notation ("slash notation"), specified as
  2558.               a.b.c.d/maskbits. See RFCs 1517-1520 for more information.
  2559.  
  2560.   Continued in 'wizhelp site lists2'.
  2561.  
  2562. & site lists2
  2563.  
  2564.   Conversion can be made between old-style classful addresses and modern
  2565.   CIDR IP prefix notation by looking at RFC 1878, Variable Length Subnet
  2566.   Table for IPv4. For easy reference, a single address is a /32, a
  2567.   Class C network is /24, a Class B network is /16, and a Class A
  2568.   network is /8.
  2569.  
  2570.   The parameters are applied in the order specified in the configuration file,
  2571.   and the first one that matches is used.  Therefore, you should put
  2572.   the more-specific parameters before the more general ones.
  2573.   Additions made to the lists after startup with the @admin command are put
  2574.   at the front of the list, and are checked before entries from the config
  2575.   file and previous entries made by the @admin command.
  2576.  
  2577.   Continued in 'wizhelp site lists3'.
  2578.  
  2579. & site lists3
  2580.  
  2581.   Example:  Restricting Access
  2582.  
  2583.   register_site  135.246.4.40 255.255.255.255  <- Allow this site w/reg
  2584.   forbid_site    135.246.4.0  255.255.255.0    <- Disallow a class C subnet
  2585.   permit_site    135.246.0.0  255.255.0.0      <- Permit a class B network
  2586.   register_site  195.3.17.1   255.255.255.255  <- Permit this site w/reg.
  2587.   forbid_site    0.0.0.0      0.0.0.0          <- DIsallow everyone else
  2588.  
  2589.   These directives only allow access from 135.346.*.* and 195.3.17.1, except
  2590.   that all hosts in the 135.246.4 subnet except for 135.246.4.40 are also
  2591.   not allowed access.  People connecting from 135.246.4.40 and 195.3.17.1
  2592.   are not allowed to create their own characters (registration is enabled
  2593.   for those sites), while people connecting from elsewhere on the 135.246
  2594.   net are allowed to create their own characters.
  2595.  
  2596.   The addresses above may be written, in CIDR IP prefix notation, as
  2597.   135.246.4.40/32, 135.246.4.0/24, 135.246.0.0/16, and 195.3.17.1/32,
  2598.   and 0.0.0.0/0, respectively.
  2599.  
  2600.   See also: @admin, @list site_information, forbid_site, permit_site,
  2601.             register_site, suspect_site, trust_site.
  2602.