SATYR DISK ACCESS MODULE GUIDE

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

INSTALLATION

	Before installing this module, change the #8 shown in the first three lines to the result of:
	
		;toobj(toint(max_object()) + 1)

	To install, paste the full text of mod_disk.v to the server while logged in as an administrator.
	
	The current working directory is stored as "/satyr". This may need to be changed before using.
	
ABOUT THIS GUIDE

	Disk Access Module - This module adds disk access functionality to the database for use by administrators.

	Required arguments are enclosed in arrow brackets <>.
	Optional arguments are enclosed in square brackets [].
	[path] does not require / as the first character, but can be used in the middle of a string.
	File and directory names are case-sensitive.
	A space must be placed between a path and a file name.
	Wildcard characters such as * and ? cannot be used.
	
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.

ADMINISTRATOR COMMANDS

	@mkfile [path] <filename>

		Create a blank file.

	@read [path] <filename>

		Display the contents of a file.

	@nread [path] <filename>

		Display the contents of a file and include line numbers.

	@write [path] <filename>

		Prompt user for a block of text to write to a file. If it does not exist, create it first.
		Warning: This overwrites the contents of a file if it already exists.

	@append [path] <filename>

		Prompt user for a block of text to add to the end of a file. If it does not exist, create it first.
		This command will not overwrite the contents of a file if it already exists.

	@insert [path] <filename> <before-line-number>

		Prompt user for a block of text to insert into a file before the line number given.

	@rmline [path] <filename> <line-number>

		Delete a given line number from a file.

	@ls [path]

		List all files and directories in the current working directory, unless [path] is provided.
		File sizes are listed for each file.

	@cd [path]

		Change current working directory to [path].
		Change current working directory to / if [path] is not provided.

	@pwd

		Display the current working directory.

	@cp [path] <filename> [path] <new-filename>

		Create a copy of a file in the same directory if the second [path] is not provided.
		To copy a file to another directory, all path and file arguments must be provided.

	@rename [path] <filename> <new-filename>

		Rename a file or directory.

	@mkdir [path] <dir-name>

		Create a directory.

	@rmdir [path] <dir-name>

		Delete a directory, only if it is empty.
		If $server_options.confirm_delete is TRUE (1), prompts for confirmation first.

	@rm [path] <filename>

		Delete a file.
		If $server_options.confirm_delete is TRUE (1), prompts for confirmation first.

	@chmod [path] <file> [new-mode-number]

		Change file permissions to the new mode number provided.
		Note: A string expression cannot be entered for the mode number.

	@sh <shell-command-string>

		Run a shell command as root and display the output, if any.
		Does not work on Windows systems by default.
		Warning: Do not run full-screen programs or programs that require keyboard input.

FUNCTIONS

	$fsize(str [path], str <file>)
	
		Returns the size of <file> in human-readable format.