SATYR ONLINE HELP MODULE GUIDE

Jon S. <jon@bzap.org>
April 10, 2020
http://www.centaur.pw/ | https://www.bzap.org/

INSTALLATION

	Before installing this module, change the #16 shown in the first two lines to the result of:

		;toobj(toint(max_object()) + 1)

	To install, paste the full text of mod_help.v to the server while logged in as an administrator.

ABOUT THIS GUIDE

	Online Help Module - This module adds help text which can be displayed from within the Satyr database.
	Each topic or index is stored as a list-type property on $mod_help. Only help for commands from the original
	Satyr database come with this module; the commands for other modules are kept separately at:
	
		http://www.centaur.pw/satyr/help/

	Optional arguments are enclosed in square brackets [].
	
ABOUT MODULES

	Module objects may be placed in a list-type property on a user object, $user.modules
	
	New server commands can be added to a module object as opposed to $admin and $user.

	Administrators can set modules for all and/or individual users.

	If the module is not found in a user's .modules property, the verbs on it will not work for that user.

COMMANDS

	@help [topic]

		Without [topic], displays a list of all indexes and topics.
		With [topic], displays the help available for [topic]. This can be one of the entries listed
		in "Indexes" or "Topics" shown by '@help'.