ngBBSd - System Operator's Guide
--------------------------------

I. Command reference

command		usage			description
-------		-----			------------
bc		bc [message]		broadcast message to everyone online
sd		sd [message]		broadcast message to everyone online
					and wait 1 minute before shutting
					down.
					NOTE: this is not implemented yet
down		down			shutdown immediatly, no message, no
					wait
					NOTE: this is not implemented yet
pass		pass			change your password
					TODO: allow sysops to change user
					passwords
nu		nu [user] [pass] [CC]	create a new user with given
					password and country code
du		du [user]		delete user
lo		lo <user> <why>		(un)lockout user. if why is ommited,
					informs user to contact the sysop.
					why can be up to 128 characters.
					if user is already locked out, then
					the user becomes unlocked. If user
					is ommited, shows a list of all
					locked out users.
kick		kick [user] <why>	kick user off BBS. if why is
					ommitted, user is told to contact
					the sysop. why can be up to 128
					characters
mu		mu [user]		mute user. does not let the user
					send and private messages, if user
					is already muted, un-mutes them
kill		kill [user]		delete users account, kick off BBS,
					blacklist the email address
					NOTE: this is not yet implemented
mask		mask [user] <hostname>	masks the user's hostname in the who
					listing. if hostname is omitted,
					unsets mask or shows current
					hostname if no mask is currently set
priv		priv [user] <level>	get or set users privilige level. if
					level is ommited, it will return the
					current level of the user

II. Overview

	Most priviliged commands require expert mode to be on. You can
toggle this on and off by logging in and just type expert and hit enter. A
lot of the time, the system wont even acknowledge it was a valid command
unless you are in expert mode. This is for security reasons.

	To send a broadcast message, your privilige level must be more than
85. To send a private message, the sender must have a privilige level of at
least 10. This is to avoid having new users spam all of your users with
crap. In general practice, it is wise to keep your users on a
limited privilige for a trial period, and then upgrade them so they can get
the full benefits of your BBS. This behavior is recommended, but you can change
this with the web administration tool. You can escalate a privilige level
(to a level no greater than your own minus 5) any time using the priv command,
described above.

	The mask command requires a privilige level of at least 60 (for
self-masking) or 90 (to mask other users).

	The pass command can be used at any privilige level (to change your
own password), but in order to change another users password, you must have a
privilige level of 95 or more.

	The kick command allows a sysop to kick a user offline. It is the
sysop's option to provide a reason or not. If a reason is not given, the
system will use the default "You have been kicked". This is only a one-time
thing, i.e. a user can be kicked and then, if they wish, reconnect immediatly.
This command requires a privilige level of 90.

	The kill command, while probably the most desired, is a highly
priviliged command, in fact it requires your privilige level to be 99.
Once the command is used, the user is immidiatly kicked off the BBS, and then
their account is terminated. Not only that, but their email address is added
to a list in the database that will not let them signup for an account with
that email address ever again. This is one of the most dangerous commands,
use it with caution! Try a kick first ;)

	The nu command will create a user with the given handle and
password. All of the extra data fields will remain blank in the database
(first name, last name, URL, etc). They are immidiatly able to login after
the command has successfully completed. Per default, the new user has a
privilige level of 10. This allows them to be a standard user that is able
to do standard things, including send and recieve private messages. This
command requires a privilige level of 95 or more.

	The lo command is probably one of the funnest commands in ngbbs. It
allows sysops to temporarily ban a user from connecting to the BBS, while
not permenantly deleting their account. When they try to login, it will tell
them they cant because they were locked out, and then it will give them the
smart ass comment you gave along with the command. Fun times when someone
gets a little irritating. This command requires a privilige level of 90 or
more.

	The mu command is pretty amusing itself. It allows you to mute a
user where they can not send any messages. Messages are still recieved, but
not shown until the mute lifts. So they dont know someone is talking to them
until a sysop unmutes them, at which time they could possibly be flooded
with messages. This command also requires a privilige level of 90 or more.

