testing version of LuaBIOS and OpenOS

people were having issues getting them to work so now we promote consistency
This commit is contained in:
2025-06-28 20:41:49 +02:00
parent 8210e20939
commit 687cfebd00
182 changed files with 14016 additions and 1 deletions

View File

@@ -0,0 +1,12 @@
NAME
address - display the computer's address
SYNOPSIS
address
DESCRIPTION
`address` allows printing the computer's component address. This can be useful to quickly look up a computer's address without an Analyzer. Knowing a computer's address can be useful if you wish to directly send network messages between two computers.
EXAMPLES
address
Displays the address of the computer the program is run on.

24
data/OpenOS/usr/man/alias Normal file
View File

@@ -0,0 +1,24 @@
NAME
alias - displays and manipulates aliases for programs
SYNOPSIS
alias
alias name
alias name=value
DESCRIPTION
`alias` allows listing and editing aliases for programs. An alias is an alternative name that can be used to start a program. A program can have multiple aliases. Aliases can also contain parameters and options to pass to the actual program. An alias can also, in turn, have aliases.
EXAMPLES
alias
Displays the list of all current aliases.
alias name
Displays the value the specified alias, i.e. what the specified alias stands for.
alias name=value
alias name='value with arguments'
Sets the value of the alias with the specified name. Note that white space separates arguments to a command, thus to have an alias whose value has whitespace, quote the value
alias name1 name2 name3=value
You can also return the value, or set the value, of an arbitrary number of aliases.

15
data/OpenOS/usr/man/cat Normal file
View File

@@ -0,0 +1,15 @@
NAME
cat - concatenate files and print on the standard output
SYNOPSIS
cat [FILE]...
DESCRIPTION
`cat` allows concatenating files or standard input to standard output.
EXAMPLES
cat
Copy standard input to standard output.
cat test.txt
Output contents of file test.txt.

42
data/OpenOS/usr/man/cd Normal file
View File

@@ -0,0 +1,42 @@
NAME
cd - change the current working directory
SYNOPSIS
cd [directory]
cd -
DESCRIPTION
`cd` allows changing the current working directory, i.e the directory based on which relative paths are resolved.
If no operand is given then HOME environment variable is used.
If the operand is - (just a single dash) then OLDPWD environment variable is used.
Relative path components ./ and ../ may be used to denote the working directory and the parent directory, respectively. An operand starting with ./ is equivalent to PWD environment variable. See examples for illustrations.
Lastly, cd will attempt to change the current directory to the path defined by the operand, reporting errors if any.
If cd is successful, OLDPWD environment variable will also be set to the previous value of PWD (that is the current working directory immediately prior to the call to cd).
ENVIRONMENT VARIABLES
PWD
Parent Working Directory, the current working directory
OLDPWD
Old PWD, set each time the PWD is changed by calling the cd utility
HOME
Represents the path of the user's home directory
EXAMPLES
cd a
Changes to directory `a` in the current working directory
cd /bin
Changes to directory `/bin`, using the specified absolute path
cd ../
Changes to the parent directory of the current working directory
cd -
Changes to the previos directory, defined by OLDPWD, and set each time cd changes PWD

12
data/OpenOS/usr/man/clear Normal file
View File

@@ -0,0 +1,12 @@
NAME
clear - clears the terminal
SYNOPSIS
clear
DESCRIPTION
Clears any text from the screen, using the current background and foreground (text) colors and resets the cursor position to (1, 1).
EXAMPLES
clear
Clears the screen/

16
data/OpenOS/usr/man/cp Normal file
View File

@@ -0,0 +1,16 @@
NAME
cp - copy files
SYNOPSIS
cp SOURCE DEST
cp SOURCE DIRECTORY
DESCRIPTION
`cp` allows copying single files on a filesystem and across filesystems.
EXAMPLES
cp a b
Copy file `a` to new file `b` in the same directory.
cp /home/a.txt /home/d/
Copy file `/home/a.txt` to new file `/home/d/a.txt`.

12
data/OpenOS/usr/man/date Normal file
View File

@@ -0,0 +1,12 @@
NAME
date - get the current time and date
SYNOPSIS
date
DESCRIPTION
Writes the current time and date to the standard output. Note that the time is measured in in-game time, with the date starting on the 1st of January 1970 as the time the world was created.
EXAMPLES
date
Displays the current date and time.

15
data/OpenOS/usr/man/df Normal file
View File

@@ -0,0 +1,15 @@
NAME
df - report file system disk space usage
SYNOPSIS
df [FILE]...
DESCRIPTION
`df` outputs disk space information for the file systems containing the specified files. If no file names are given it returns the information for all currently mounted file systems.
EXAMPLES
df
Show global file system disk usage.
df /home /var
Show disk usage of file systems mounted at `/home` and `/var`.

13
data/OpenOS/usr/man/dmesg Normal file
View File

@@ -0,0 +1,13 @@
NAME
dmesg - display messages(events)
SYNOPIS
dmesg [EVENT]...
EXAMPLES
dmesg
Shows all events.
dmesg touch
Shows only "touch" events.

19
data/OpenOS/usr/man/echo Normal file
View File

@@ -0,0 +1,19 @@
NAME
echo - display a line of text
SYNOPSIS
echo [STRING]...
DESCRIPTION
`echo` writes the provided string(s) to the standard output.
-n do not output the trialing newline
--help display this help and exit
EXAMPLES
echo test
Print `test` to the standard output (which is usually the terminal).
echo "a b"
Writes the string `a b`.

19
data/OpenOS/usr/man/edit Normal file
View File

@@ -0,0 +1,19 @@
NAME
edit - primitive file editor
SYNOPSIS
edit FILE
DESCRIPTION
A very simple text file editor. To create new files with `edit`, open a file in a writable file system that doesn't exist and save.
OPTIONS
-r
opens file as read only
EXAMPLES
edit /tmp/test.txt
Opens the file `/tmp/test.txt` for editing. If it doesn't exists, it will be created upon saving.
edit /bin/ls.lua
Opens the file `/bin/ls.lua`, which will be opened in read-only mode, assuming `/bin` is the default as provided by the read-only-memory.

34
data/OpenOS/usr/man/grep Normal file
View File

@@ -0,0 +1,34 @@
NAME
grep - Search for PATTERN in each FILE or standard input. PATTERN is, by default, a Lua regular expression
Example: grep -i 'hello world' menu.lua main.lua
OPTIONS
Regexp selection and interpretation:
-e, --lua-regexp PATTERN is a Lua regexp (default)
-F, --fixed-strings PATTERN is a plain string
--file=FILE use newline separated PATTERNs from FILE
-w, --word-regexp force PATTERN to match only whole words
-x, --line-regexp force PATTERN to match only whole lines
-i, --ignore-case ignore case distinctions
Miscellaneous:
--label=LABEL use LABEL instead of (standard input) for stdin prefix
-s, --no-messages suppress error messages
-v, --invert-match select non-matching lines
--help display help message and exit
Output control:
--max-count=NUM stop after NUM matches
-n, --line-number print line number with output lines
-H, --with-filename print the file name for each match
-h, --no-filename suppress the file name prefix on output
-o, --only-matching show only the part of a line matching PATTERN
-q, --quiet, --silent suppress all normal output
-r, --recursive search directories in FILEs recursively
-L, --files-without-match print only names of FILEs containing no match
-l, --files-with-matches print only names of FILEs containing matches
-c, --count print only a count of matching lines per FILE
--color, --colour user markers to highlight the matching strings
-t, --trim trim whitespace off results
When FILE is -, read stdin. With no FILE, read - or ./ if a command line -r. If fewer than two FILEs are given, assume -h. Exit status is 0 if any line is selected, 1 otherwise. If any error occurs and -q is not given, the exit status is 2.

31
data/OpenOS/usr/man/head Normal file
View File

@@ -0,0 +1,31 @@
NAME
head - Print the first 10 lines of each FILE to stdout.
SYNOPSIS
head [OPTION]... [FILE]...
DESCRIPTION
Print the first 10 lines of each FILE to stdout.
With no FILE, or when FILE is -, read stdin.
--bytes=[-]n print the first n bytes of each file'
with the leading '-', print all but the last
n bytes of each file
--lines=[-]n print the first n lines instead of the first 10;
with the leading '-', print all but the last
n lines of each file
-q, --quiet, --silent never print headers giving file names
-v, --verbose always print headers giving file names
--help print help message
EXAMPLES
head
head -
Read next 10 lines from standard in and print to standard out, then close.
head file.txt
Print first 10 lines of file.txt and print to stdout
head -n 32 file.txt
Print first 32 lines of file.txt and print to stdout

View File

@@ -0,0 +1,15 @@
NAME
hostname - Display and modify hostname
SYNOPIS
hostname [NEW NAME] [--update]
EXAMPLES
hostname
Prints currently set hostname
hostname test
Sets hostname of this computer to test
hostname --update
Updates $HOSTNAME by reading /etc/hostname in case it was set manually. Does not print to stdout

109
data/OpenOS/usr/man/install Normal file
View File

@@ -0,0 +1,109 @@
NAME
install - installs files from a source filesystem to a target filesystem
SYNOPSIS
install [name] [OPTIONS]...
DESCRIPTION
install builds a list of candidate source and target mounted filesystems. If there are multiple candidates, the user is prompted for selections. By default, install copies all files from the source filesystem's root to the target filesystem's root path. The source filesystem can define label, boot, and reboot behavior via .prop and a fully custom install experience via .install which supercedes install running cp from source to target filesystems. Developers creating their own .install files for devices should respect environment variables set by install as per options it is given, such as the root path. This manual page details those environment variables.
OPTIONS
--from=ADDR
Specifies the source filesystem or its root path. ADDR can be the device uuid or a directory path. If this is a directory path, it represents a root path to install from. This option can also be used to specify source paths that would otherwise be ignored, those being devfs, tmpfs, and the rootfs. e.g. --from=/tmp . Note that if both --from and --label are used, install expects the source path to have a .prop defining the same label. See .prop for more details.
--to=ADDR
Same as --from but specifies the target filesystem by uuid or its root path. This option can also be used to specify filesystems that are otherwise ignored including tmpfs. i.e. --to=ADDR where ADDR matches the tmpfs device address or its mount point path. e.g. --to=/tmp
--fromDir=PATH
Install PATH from source. PATH is relative to the root of the source filesystem or path given by --from. The default is .
--root=PATH
Same as --fromDir but for the target filesystem.
--toDir=PATH
Same as --root. Either can be used. It is meaningless to specify both and is not documented which takes precedence in such a case.
-u, --update
Indicates that install should prompt the user before modifying files. This invokes -i and -u for /bin/cp.
The following can override settings defined in .prop in the source filesystem.
--label=LABEL
use LABEL for label instead of any value specified by .prop
--nosetlabel
do not set target label. --nolabelset is deprecated
--nosetboot
do not set target as default boot device when rebooting. --noboot is deprecated
--noreboot
do not reboot after install
.prop
.prop should have valid lua syntax for a table of keys and their values: e.g. "{label='OpenOS'}"
All fields are optional, as is the .prop file
label:string
Declares an identifying name of the installation. This is displayed by install during source selection and also can be used on the commandline: e.g. (where {label="tape"} is given) `install tape`. If setlabel is true, this value is used for the target filesystem label. --label overrides this value. Note that install uses a case insensitive search: e.g. install TAPE works the same as install tape.
setlabel:boolean
Determines whether the install should set the target filesystem's label. If .prop does not define a label and the user does not define a command line --label=LABEL, setlabel has no action. --nosetlabel overrides this value
setboot:boolean
Determines if the target filesystem should be set as the machine's default boot device. Default is false, overriden by --nosetboot
reboot:boolean
Determines if the machine should reboot after the install completes. Overriden by --noreboot
ignore:boolean
If true, the installer will skip the source filesystem and not include it for selection
EXAMPLE:
{label='OpenOS', setlabel=true, setboot=true, reboot=true}
.install ENVIRONMENT
A loot disc can optionally provide a custom installation script at the root of the source filesytem selected for installation. The script must be named ".install"
When provided, the default install action is replaced by executation of this script. The default action is to copy all source files to the destination
A table of configuration options, named `install`, is provided in _ENV
These are the keys and their descriptions of that table
_ENV.install.from:
This is the path of the selected source filesystem to install from. It should be the path to the executing .install
example: /mnt/ABC/.install is executing, thus _ENV.install.from is "/mnt/ABC/"
_ENV.install.to:
This is the path of the selected target filesystem to install to.
example: "/"
_ENV.install.fromDir
This is the relative path to use in the source filesystem as passed by command line to install. If unspecified to install it defaults to "."
example: Perhaps the user executed `install --fromDir="bin"` with the intention that only files under /mnt/ABC/bin would be copied to their rootfs
_ENV.install.root
This is the relative path to use in the target filesystem as passed by command line to install. If unspecified to install it defaults to "."
example: The user prefers to install to usr/ and uses `install --root=usr` and here _ENV.install.root would be "usr"
_ENV.install.update
Assigned value of --update, see OPTIONS
_ENV.install.label
Assigned value of --label or .prop's label, see OPTIONS
_ENV.install.setlabel
Assigned value of .prop's setlabel unless --nosetlabel, see OPTIONS
_ENV.install.setboot
Assigned value of .prop's boot unless --nosetboot, see OPTIONS
_ENV.install.reboot
Assigned value of .prop's reboot unless --noreboot, see OPTIONS
EXAMPLES
install
Searches all non rootfs filesystems to install from, and all non tmpfs filesystems to install to. Prompts the user for a selection, and copies. If .prop is defined in source, sets label and will prompt for reboot when completed.
install openos
Searches candidates source filesystems that have .prop's that define label="OpenOS" and prompts the user to confirm install to candidate target filesystems.

16
data/OpenOS/usr/man/label Normal file
View File

@@ -0,0 +1,16 @@
NAME
label - show or change the label of file systems
SYNOPSIS
label FILE [STRING]
label -a ADDRESS [STRING]
DESCRIPTION
`label` allows reading and writing the label of file systems. The file system can either be specified by a path to or into a mount, or by its address.
EXAMPLES
label /home
Write the label of the file system mounted at `/home` to the standard output.
label -a 93f test
Change the label of the file system of which the address starts with `93f` to `test`.

27
data/OpenOS/usr/man/less Normal file
View File

@@ -0,0 +1,27 @@
NAME
less - file viewer
SYNOPSIS
less [FILE]
DESCRIPTION
'less' is similar to `more`, but with buffering. This allows to you scroll back and forward a single line at a time.
COMMANDS
q quit
up scroll up one line
down scroll down one line
space
pgdown scroll down one page
pgup scroll up one page
home scroll to the start of the buffer
end scroll to the end of the buffer
EXAMPLES
less example.txt
Displays the contents of file `example.txt`
find / | less
filter the output of `file /` through the 'less' pager
SEE ALSO
more

19
data/OpenOS/usr/man/ln Normal file
View File

@@ -0,0 +1,19 @@
NAME
ln - creates symbolic links
SYNOPSIS
ln FILE [TARGET]
DESCRIPTION
`ln` allows creating virtual symbolic links. A symbolic link is a reference in the file system that can be used to point to other nodes in the file system. For example, a symbolic link to a file will behave like that file: it can be opened and changed, where in reality the file the link references is changed. A symbolic link to a directory will behave as such.
Note that symbolic links can lead to cycles (recursion) in the file system structure.
Symbolic links in OpenOS are 'virtual'. They are not stored on any file system, and as such will not persist across a reboot of the computer. This also means that the can be created in virtual folders, and even on read-only file systems.
EXAMPLES
ln /bin/ls.lua
Creates a symbolic link `ls.lua` to the file `/bin/ls.lua` in the current working directory.
ln /home/magic.lua /bin/magic.lua
Creates a symbolic link to file `/home/magic.lua` in the `/bin` directory.

80
data/OpenOS/usr/man/ls Normal file
View File

@@ -0,0 +1,80 @@
NAME
ls - list directory contents
SYNOPSIS
ls [OPTION]... [FILE]...
DESCRIPTION
List information about the specified files, or the current working directory by default.
OPTIONS
-a, --all
do not ignore entries starting with .
--full-time
with -l, print time in full iso format
-h, --human-readable
with -l and/or -s, print human readable sizes
--si
likewise, but use powers of 1000 not 1024
-l
use a long listing format
-r, --reverse
reverse order while sorting
-R, --recursive
list subdirectories recursively
-S
sort by file size
-t
sort by modification time, newest first
-X
sort alphabetically by entry extension
-1
list one file per line
--no-color
Do not colorize the output (default colorized)
--help
display this help and exit
-p
append / indicator to directories
-M
display Microsoft-style file and directory count after listing
ENVIRONMENT VARIABLES
LS_COLORS
A serialized table listing colors to use for listing filesystem elements.
FILE
Coloring to use when listing a regular file
DIR
Coloring to use when listing a directory
LINK
Coloring to use when listing a symbolic link
*.<extension>
Coloring to use for regular files with an extension <extension>
The default LS_COLORS string is "{FILE=0xFFFFFF,DIR=0x66CCFF,LINK=0xFFAA00,["*.lua"]=0x00FF00}"
EXAMPLES
ls
Displays the contents of the current directory.
ls /bin /mnt
Displays the contents of the `/bin`/ and `/mnt` directories, one after the other.

8
data/OpenOS/usr/man/lshw Normal file
View File

@@ -0,0 +1,8 @@
NAME
lshw - hardware viewer
SYNOPSIS
lshw
DESCRIPTION
'lshw' shows you the device information of your PC.

12
data/OpenOS/usr/man/lua Normal file
View File

@@ -0,0 +1,12 @@
NAME
lua - a simple Lua interpreter
SYNOPSIS
lua
DESCRIPTION
Launches a command line that can be used to evaluate Lua statements and expressions. This can be very useful for testing out commands. Note that the interpreter will automatically try to resolve undefined globals using `require`, i.e. it will try to load a package with the specified name.
EXAMPLES
lua
Launches the Lua interpreter.

15
data/OpenOS/usr/man/man Normal file
View File

@@ -0,0 +1,15 @@
NAME
man - help program, providing help on various programs and topics
SYNOPSIS
man topic
DESCRIPTION
`man` is the system's help viewer. Each help topic is normally the name of a program or library. Topics are stored as individual text files in the `/usr/man` folder. Additional help topics can be provided by creating a symbolic link to a file.
EXAMPLES
man man
Display the help for the `man` program.
man ls
Display the help for the `ls` program.

15
data/OpenOS/usr/man/mkdir Normal file
View File

@@ -0,0 +1,15 @@
NAME
mkdir - make directories
SYNOPSIS
mkdir DIRECTORY...
DESCRIPTION
Create the specified directories, if they don't already exist.
EXAMPLES
mkdir a
Create directory `a` in the current directory.
mkdir /a/b c
Create directory `/a` if it doesn't already exists, then create directory `/a/b` and create directory `c` in the current directory.

13
data/OpenOS/usr/man/more Normal file
View File

@@ -0,0 +1,13 @@
NAME
more - primitive file viewer
SYNOPSIS
more FILE
DESCRIPTION
`more` allows viewing the contents of a file one screenful at a time.
There is no buffering which means you cannot scroll back, long lines will jump the view forward, but there is a small and fixed memory footprint even when piping long running programs with significant output
EXAMPLES
more /home/a.txt
Displays the contents of file `/home/a.txt`

32
data/OpenOS/usr/man/mount Normal file
View File

@@ -0,0 +1,32 @@
NAME
mount - mount a file system
SYNOPSIS
mount
mount LABEL PATH
mount ADDRESS PATH
mount --bind PATH PATH
OPTIONS
-r, --readonly mount filesystem readonly
--bind mount a bind point (folder to folder)
-h, --help print help message
DESCRIPTION
All files accessible in OpenOS are arranged in one big tree, starting with the root node, '/'. The files are the leaves of the tree, directories are inner nodes of the tree. Files can be distributed across several devices (file system components, such as hard drives and floppies). The `mount` command is used to attach a file system to this tree. The `umount` command can be used to remove a mounted file system from the tree (note that `rm` works for this, too).
EXAMPLES
mount
Display a list of all currently mounted file systems.
mount test /home
Mounts the file system labeled `test` at `/home`.
mount 56f /var
Mounts the file system of which the address starts with `56f` at `/var`.
mount --readonly tmpfs /tmp_ro
Mounts a readonly access path of tmpfs to /tmp_ro
mount --bind /mnt/fa4/home /home
Mounts /mnt/fa5/home to /home

22
data/OpenOS/usr/man/mv Normal file
View File

@@ -0,0 +1,22 @@
NAME
mv - move (rename) files
SYNOPSIS
mv SOURCE DEST
DESCRIPTION
Renames files - and folders, as long they remain on the same file system. Files that are 'renamed' to another file system will actually be copied, then deleted.
OPTIONS
-f overwrite without prompt
-i prompt before overwriting
unless -f
-v verbose
-h, --help show this help
EXAMPLES
mv a b
Renames file `a` to `b`.
mv /home/a /var/b
Moves file from `/home/a` to `/var/b`.

View File

@@ -0,0 +1,23 @@
NAME
pastebin - download and upload programs from and to pastebin
SYNOPSIS
pastebin get PASTID FILE
pastebin put FILE
pastebin run PASTEID [ARGUMENT]...
DESCRIPTION
The pastebin program allows downloading programs from pastebin, identified by their paste ID. I can also be used to upload programs to pastebin.
The pastebin program requires an internet card and internet access to be enabled in the mod's configuration.
OPTIONS
-f
do not prompt before overwriting
EXAMPLES
pastebin get AbCdEfGh test
Downloads the paste with ID `AbCdEfGh` and writes it to file `test`.
pastebin put prog.lua
Uploads the program `prog.lua` to pastebin.

View File

@@ -0,0 +1,16 @@
NAME
primary - get or set primary components
SYNOPSIS
primary TYPE
primary TYPE ADDRESS
DESCRIPTION
This program allows reading the address of the current primary component of the specified type. It also allows changing the current primary component for a specified type by providing the (abbreviated) address of the new primary component.
EXAMPLES
primary gpu
Writes the address of the current primary GPU to the standard output.
primary gpu 24a
Makes the GPU of which the address starts with `24a` the new primary GPU.

12
data/OpenOS/usr/man/pwd Normal file
View File

@@ -0,0 +1,12 @@
NAME
pwd - print name of current/working directory
SYNOPSIS
pwd
DESCRIPTION
`pwd` writes the name of the current working directory to the standard output.
EXAMPLES
pwd
Write the current directory to the terminal.

35
data/OpenOS/usr/man/rc Normal file
View File

@@ -0,0 +1,35 @@
NAME
rc - Manage services
SYNOPSIS
rc SERVICE COMMAND [ARGS...]
DESCRIPTION
Controls services in /etc/rc.d/
Common commands are start/stop/restart, there are also special commands enable/disable. A command is global function in executable file that is stored in /etc/rc.d/ directory. Services can define their own commands.
COMMANDS
start
This command starts specified service, executed automatically for all enabled services when system boots.
stop
This command stops specified service.
restart
This command restarts specified service. This command doesn't have to be implemented by services when start and stop commands are present.
enable
This command enables specified service. Executing this command won't start the service. It's implemented by the rc library, but can be overridden by service.
disable
This command disables specified service. Executing this command won't stop the service. It's implemented by the rc library, but can be overridden by service.
EXAMPLES
rc example
Lists commands of example service.
rc example start
Starts example service.
rc example enable
Makes example start on system boot.

View File

@@ -0,0 +1,12 @@
NAME
reboot - restarts the computer
SYNOPSIS
reboot
DESCRIPTION
`reboot` will immediately issue a reboot of the computer, shutting it down then starting it back up.
EXAMPLES
reboot
Reboots the computer.

View File

@@ -0,0 +1,22 @@
NAME
redstone - access to redstone input and output
SYNOPSIS
redstone SIDE
redstone SIDE VALUE
redstone SIDE -b COLOR
redstone SIDE -b COLOR VALUE
DESCRIPTION
This program allows manipulating redstone output of the computer via the shell, if it has a built-in redstone card or is connected to a redstone I/O block. It can also be used to just display the current in- and output. If another mod is installed that provides bundled redstone logic, such as RedLogic, MineFactory Reloaded (Rednet Cables) or Project: Red, it can also be used to interact with bundled signals by passing the `-b` flag.
OPTIONS
-b
interact with bundled signals
EXAMPLES
redstone front
Displays the simple in- and output on the front face of a computer with a redstone card.
redstone north -b lime 200
Sets the bundled `lime` output of a redstone I/O block's northern side to 200.

View File

@@ -0,0 +1,16 @@
NAME
resolution - get or set screen resolution
SYNOPSIS
resolution
resolution WIDTH HEIGHT
DESCRIPTION
The `resolution` program is used to write the resolution of the current primary screen to the standard output, or to change the resolution to a new value.
EXAMPLES
resolution
Displays the current screen resolution.
resolution 30 10
Sets the screen's resolution to 30 by 10 characters.

52
data/OpenOS/usr/man/rm Normal file
View File

@@ -0,0 +1,52 @@
NAME
rm - remove files or directories
SYNOPSIS
rm [OPTION]... FILE...
DESCRIPTION
Removes all of the specified files, one by one. By default, it does not remove directories. To remove a mount, please use umount.
If the -I option is given, and there are more than three files or the -r, -R, or --recursive are given, the rm prompts the user for whether to proceed with the entire operation. If the response is not affirmative, the entire command is aborted.
Otherwise, if a file is unwritablle, standard input is a terminal, and the -f or --force option is not given, or the -i option is given, rm prompts the user for whether to remove the file. If the response is not affirmative, the file is skipped.
OPTIONS
Remove (unlink) the FILE(s).
-f, --force
ignore nonexistent files and arguments, never prompt
-i prompt before every removal
-I prompt once before removing more than three files, or when removing recursively; less intrusive than -i, while still giving protection against most mistakes
--one-file-system
when removing a hierarchy recursively, skip any directory that is on a file system different from that of the corresponding command line argument
--no-preserve-root
do not treat '/' specially
--preserve-root
do not remove '/' (default)
-r, -R, --recursive
remove directories and their contents recursively
-d, --dir
remove empty directories
-v, --verbose
explain what is being done
--help
display this help and exit.
By default, rm does not remove directories. Use the --recursive (-r or -R) option to remove each listed directory, too, along with all of its contents.
To remove a file whose name starts with a '-', for example '-foo', use this command:
rm ./-foo
EXAMPLES
rm a
Deletes the file `a`.

View File

@@ -0,0 +1,9 @@
NAME
rmdir - remove empty directories
SYNOPIS
rmdir [DIRECTORY]
EXAMPLES
rmdir doc
Removes doc if and only if doc is an empty directory

19
data/OpenOS/usr/man/set Normal file
View File

@@ -0,0 +1,19 @@
NAME
set - set a environment variable
SYNOPSIS
set [VARIABLE]=[VALUE]
DESCRIPTION
set an environment variable. Quote [VALUE] to include spaces or non alphanumerics.
EXAMPLES
set
Shows all environment variables
set example="Hello World"; echo $example
Prints Hello World without quotes
set LS_COLORS="{FILE=0xFFFFFF,DIR=0x66CCFF,LINK=0xFFAA00,['*.lua']=0xFFFF00}"
Change ls colors, showing lua files in yellow. Note ls color defaults are set in /etc/profile
SEE ALSO
unset

43
data/OpenOS/usr/man/sh Normal file
View File

@@ -0,0 +1,43 @@
NAME
sh - command interpreter (shell)
SYNOPSIS
sh
DESCRIPTION
This is the basic, built-in standard shell of OpenOS. It provides basic functionality and does the job for getting started. To run a command, enter it and press enter. The first token in a command will usually be a program. Any additional parameters will be passed along to the program.
Arguments to programs can be quoted, to provide strings with multiple spaces in them, for example:
echo "a b"
will print the string `a b` to the screen. It is also possible to use single quotes (echo 'a b').
Single quotes also suppress variable expansion. Per default, expressions like `$NAME` and `${NAME}` are expanded using environment variables (also accessible via the `os.getenv` method).
Globbing is supported, i.e. '*' and '?' are expanded approriately. For example:
ls b?n/
will list all files in `/bin/` (and, if it exists `/ban` and so on).
cp /bin/* /usr/bin/
will copy all files from `/bin` to `/usr/bin`.
The shell provides redirects and piping:
cat f > f2
copies the contents of file `f` to `f2`, for example.
echo 'this is a "test"' >> f2
will append the string 'this is a "test"' to the file `f2`.
2>/dev/null ./some_program_with_errors
will redirect all stderr to /dev/null [i.e. supress errors].
This example also demonstrates redirects can go at the front
Redirects can be combined:
cat < f >> f2
will feed the contents of file `f` to cat, which will then output it (in append mode) to file `f2`.
Finally, pipes can be used to pass data between programs:
ls | cat > f
will enumerate the files and directories in the working directory, write them to its output stream, which is cat's input stream, which will in turn write the data to file `f`.
The shell also supports aliases, which can be created using `alias` and removed using `unalias` (or using the `shell` API). For example, `dir` is a standard alias for `ls`.
EXAMPLES
sh
Starts a new shell.

View File

@@ -0,0 +1,12 @@
NAME
shutdown - shut down the computer
SYNOPSIS
shutdown
DESCRIPTION
Immediately shuts down the computer.
EXAMPLES
shutdown
Stops the computer.

View File

@@ -0,0 +1,17 @@
NAME
umount - remove a file system mount
SYNOPSIS
umount PATH
umount -a LABEL
umount -a ADDRESS
DESCRIPTION
Removes either a single mount point if given the path into a mount, or all mount points for a specified file system if given the label or address of the file system.
EXAMPLES
umount /mnt/82f
Unmounts the automatically generated mountpoint at `/mnt/82f`.
umount -a 82f
Removes all mounts of the file system for which the address starts with `82f`.

View File

@@ -0,0 +1,12 @@
NAME
unalias - removes aliases for programs
SYNOPSIS
unalias name
DESCRIPTION
Allows removal of aliases created with the `alias` command.
EXAMPLES
unalias dir
Removes the `dir` alias (usually an alias for `ls`).

15
data/OpenOS/usr/man/unset Normal file
View File

@@ -0,0 +1,15 @@
NAME
unset - remove an environment variable
SYNOPSIS
unset [VARNAME]
DESCRIPTION
Removes an environment variable
EXAMPLES
unset some_variable
Removes the environment variable some_variable
SEE ALSO
set

View File

@@ -0,0 +1,12 @@
NAME
uptime - how long has the computer been running
SYNOPSIS
uptime
DESCRIPTION
Writes the time in real time hours, minutes and seconds the computer has been running to the standard output.
EXAMPLES
uptime
Displays the time the computer has been running.

View File

@@ -0,0 +1,16 @@
NAME
useradd - adds a player to the list of authorized users
SYNOPSIS
useradd NAME
DESCRIPTION
Adds a player to the list of users that can use the computer. To add a player, he has to be logged in when the command is run. Note that the names are case sensitive. Users can be removed again using `userdel`.
As long as the list of players registered on a computer is empty, the computer can be used by all players. Once there is at least one entry in the list of users, only the players in the list can use the computer. This includes modifying its inventory, performing keyboard and mouse input as well as breaking the computer block.
Computer ownership can be disabled in the configuration.
EXAMPLES
useradd Steve
Adds the player named `Steve` to the list of users.

View File

@@ -0,0 +1,12 @@
NAME
userdel - removes a player from the list of authorized users
SYNOPSIS
userdel NAME
DESCRIPTION
Removes a player from the list of users authorized to use this computer. See `useradd`.
EXAMPLES
userdel Steve
Removes the player named `Steve` from the userlist.

23
data/OpenOS/usr/man/wget Normal file
View File

@@ -0,0 +1,23 @@
NAME
wget - download files via http
SYNOPSIS
wget URL [FILE]
DESCRIPTION
The wget program allows downloading programs from the interwebs, given the URL to download from.
The wget program requires an internet card and internet access to be enabled in the mod's configuration.
OPTIONS
-f
do not prompt before overwriting
-q
only print errors, no status messages
EXAMPLES
wget http://example.com/data.zip
Downloads the file `data.zip` and saves it as `data.zip`.
wget http://example.com/data.zip blah.zip
Downloads the file `data.zip` and saves it as `blah.zip`.

15
data/OpenOS/usr/man/which Normal file
View File

@@ -0,0 +1,15 @@
NAME
which - locate a command
SYNOPSIS
which COMMAND
DESCRIPTION
This program writes the full path to each of the specified programs to the standard output. If a program is an alias, this is indicated. If a program cannot be found and error message will be written.
EXAMPLES
which ls
Displays `/bin/ls.lua`.
which doesntexist dir
Displays `doesntexist: file not found` and `dir: aliased to ls`.

24
data/OpenOS/usr/man/yes Normal file
View File

@@ -0,0 +1,24 @@
NAME
yes - Automatically answers yes to every question.
SYNOPSIS
yes [string]...
yes [-V/h]
DESCRIPTION
Prints strings in command line arguments, if there is none, prints 'y'.
Followed by newline, until it is killed.
This might be used for programs which don't have force (-f) option
and require user interaction.
EXAMPLES
yes
Says y on every line.
yes no
Says no on every line.
yes "yes: I'm great servant, but an evil master."
Repeats sentence.

View File

@@ -0,0 +1,28 @@
Tier 2 and 3 screens can act as touch screens - don't attach a keyboard or sneak-activate them.
You can change the text size on screens by changing their resolution - run `resolution 40 16` in the shell.
Firing arrows on touch capable screens can trigger touch events.
Item colors indicate their tier - white is tier one, yellow is tier two and cyan is tier three.
Use an Analyzer to get more information on blocks - for example, to find out why a computer crashed.
Keyboards have to be attached to or placed next to a screen to work.
You can install OpenOS on a writable medium by running the `install` program.
Internet Cards can be used to make HTTP requests and open raw TCP connections.
If you crafted something by mistake or don't need it any longer, throw it into a disassembler.
Have a look at the code of the built-in programs for examples on how to use the APIs.
Most programs can be interrupted by pressing Ctrl+Alt+C.
Paste the contents of the clipboard using the middle mouse button or a configurable key (default: insert).
Computers will consume less power while idling - i.e. when os.sleep(n > 0.05) is called.
Screens will consume more power the more lit characters they display.
Most blocks act as 'cables' - use relays and power distributors to create separate networks.
Welcome to the dark side - here, have some cookies.
Screens can display Unicode - paste the special chars or use unicode.char.
Run `help` or `man programname` for ingame help on programs shipped with OpenOS - start with `man man`.
For more help, there's a wiki at https://ocdoc.cil.li/ - or find the IRC loot disk and join #oc.
Computers have a very basic, built-in speaker - control it using computer.beep().
Many component methods have a short documentation - use `=component.componentName.methodName` in the Lua interpreter to see it.
You can get a list of all attached components using the `components` program.
If you encounter out of memory errors, throw more RAM at your computer.
Have you tried turning it off and on again?
To disable this greeting, install OpenOS to a writeable medium and remove the `/etc/motd` line from `/etc/profile.lua`.
Did you know OpenComputers has a forum? No? Well, it's at https://oc.cil.li/.
Please report bugs on the Github issue tracker, thank you!
Beware of cycles when building networks, or you may get duplicate messages!