docs - refresh man pages
This commit is contained in:
daniel committed
1 parent
7eda8b1a8d
commit
a463834e0a
21 files changed
+972
-524
No files matched your search
+47
-12
@@ -111,6 +111,7 @@
|
||||
<pre><code><strong>NAME</strong>
|
||||
shell - MontaukOS interactive command shell
|
||||
|
||||
|
||||
<strong>DESCRIPTION</strong>
|
||||
The MontaukOS shell is a command interpreter launched by init
|
||||
after system services have started. It provides command
|
||||
@@ -121,6 +122,7 @@
|
||||
a command is not a builtin, the shell searches for a matching
|
||||
ELF binary and executes it as a child process.
|
||||
|
||||
|
||||
<strong>COMMAND RESOLUTION</strong>
|
||||
When a non-builtin command is entered, the shell searches for
|
||||
a matching binary in the following order:
|
||||
@@ -144,16 +146,20 @@
|
||||
Arguments after the command name are passed to the spawned
|
||||
process.
|
||||
|
||||
|
||||
<strong>BUILTINS</strong>
|
||||
|
||||
|
||||
<strong>help</strong>
|
||||
Display a categorized list of available commands.
|
||||
|
||||
|
||||
<strong>ls [dir]</strong>
|
||||
List files in the current directory, or in the specified
|
||||
directory. Directory entries are shown with a trailing slash.
|
||||
Examples: ls, ls man, ls os
|
||||
|
||||
|
||||
<strong>cd [dir]</strong>
|
||||
Change the working directory. With no argument, returns to the
|
||||
logged-in user's home directory (0:/users/<user>); with /,
|
||||
@@ -161,33 +167,42 @@
|
||||
The shell prompt reflects the current directory.
|
||||
Examples: cd os, cd .., cd
|
||||
|
||||
|
||||
<strong>pwd</strong>
|
||||
Print the current working directory as an absolute path
|
||||
(e.g. "0:/os").
|
||||
|
||||
|
||||
<strong>echo [-n] ...</strong>
|
||||
Print the arguments. -n suppresses the trailing newline.
|
||||
|
||||
|
||||
<strong>set [VAR=value]</strong>
|
||||
With no argument, list all shell variables (built-in and
|
||||
user-defined). With VAR=value, set a variable. With a bare
|
||||
name, print that variable's value.
|
||||
|
||||
|
||||
<strong>unset VAR</strong>
|
||||
Remove a user-defined shell variable.
|
||||
|
||||
|
||||
<strong>true / false</strong>
|
||||
Return exit status 0 / 1 without doing anything. Useful with
|
||||
&& and ||.
|
||||
|
||||
|
||||
<strong>N:</strong>
|
||||
A bare "<number>:" (e.g. "1:") switches the current drive to
|
||||
drive N and resets the working directory to that drive's root.
|
||||
|
||||
|
||||
<strong>exit</strong>
|
||||
Terminate the shell process (with the last command's exit code).
|
||||
|
||||
|
||||
<strong>SYNTAX</strong>
|
||||
|
||||
<strong>Variables</strong>
|
||||
NAME=value Set a shell variable (no leading $)
|
||||
$VAR or ${VAR} Expand a variable's value
|
||||
@@ -196,11 +211,13 @@
|
||||
home directory, current directory)
|
||||
\$ Escape a literal '$'
|
||||
|
||||
|
||||
<strong>Tilde expansion</strong>
|
||||
A leading ~ expands to the session home directory
|
||||
(0:/users/<user>) when followed by end-of-string, '/', or a
|
||||
space.
|
||||
|
||||
|
||||
<strong>Command chaining</strong>
|
||||
cmd1 ; cmd2 Run cmd2 unconditionally after cmd1
|
||||
cmd1 && cmd2 Run cmd2 only if cmd1 succeeded (exit 0)
|
||||
@@ -209,25 +226,29 @@
|
||||
Single and double quotes protect ;, &&, and || from being
|
||||
treated as separators.
|
||||
|
||||
|
||||
<strong>Comments</strong>
|
||||
A '#' outside of quotes starts a comment; the rest of the line
|
||||
is ignored.
|
||||
|
||||
|
||||
<strong>EXTERNAL COMMANDS</strong>
|
||||
All external commands live in 0:/os/ (see COMMAND RESOLUTION).
|
||||
Where a dedicated man page exists it is noted below; run
|
||||
'man <command>' for details.
|
||||
|
||||
|
||||
<strong>File commands</strong>
|
||||
cat <file> Display file contents
|
||||
edit [file] Text editor -- see edit(1)
|
||||
edit [file] Text editor -- see <a href="edit.html">edit(1)</a>
|
||||
copy <src> <dst> Copy a file
|
||||
move <src> <dst> Move/rename a file
|
||||
rm <file> Remove a file
|
||||
touch <file> Create an empty file
|
||||
|
||||
|
||||
<strong>System commands</strong>
|
||||
man <topic> View manual pages -- see man(1)
|
||||
man <topic> View manual pages -- see <a href="man.html">man(1)</a>
|
||||
whoami Print the current username
|
||||
info / mtkfetch Show system information
|
||||
date Show current date and time
|
||||
@@ -235,30 +256,39 @@
|
||||
proclist List running processes
|
||||
power CPU power/thermal status (power [watch [secs]])
|
||||
clear Clear the screen and framebuffer
|
||||
fontscale [n] Get or set terminal font scale -- see fontscale(1)
|
||||
fontscale [n] Get or set terminal font scale -- see <a href="fontscale.html">fontscale(1)</a>
|
||||
lua Lua interpreter
|
||||
tcc TinyCC (in-system C compiler)
|
||||
reset Reboot the system
|
||||
shutdown Shut down the system
|
||||
reset / reboot Request a supervised system reboot
|
||||
shutdown / poweroff Request a supervised system shutdown
|
||||
suspend Enter ACPI sleep
|
||||
|
||||
Interactive shutdown and reboot are shell builtins: they post a
|
||||
capability-checked request and exit the console, allowing login.elf to
|
||||
flush filesystems and perform the final power operation. They do not grant
|
||||
CAP_POWER_CONTROL to the shell.
|
||||
|
||||
|
||||
<strong>Network commands</strong>
|
||||
ping <host> Send ICMP echo requests -- see ping(1)
|
||||
nslookup <host> DNS lookup -- see nslookup(1)
|
||||
ping <host> Send ICMP echo requests -- see <a href="ping.html">ping(1)</a>
|
||||
nslookup <host> DNS lookup -- see <a href="nslookup.html">nslookup(1)</a>
|
||||
ifconfig Show/set network configuration
|
||||
tcpconnect <host> <port> Interactive TCP client
|
||||
irc IRC client
|
||||
dhcp DHCP client -- see dhcp(1)
|
||||
fetch <url> HTTP/HTTPS client (TLS 1.2) -- see fetch(1)
|
||||
wiki <title> Wikipedia article viewer -- see wiki(1)
|
||||
dhcp DHCP client -- see <a href="dhcp.html">dhcp(1)</a>
|
||||
fetch <url> HTTP/HTTPS client (TLS 1.2) -- see <a href="fetch.html">fetch(1)</a>
|
||||
wiki <title> Wikipedia article viewer -- see <a href="wiki.html">wiki(1)</a>
|
||||
httpd HTTP server
|
||||
|
||||
Network commands accept both IP addresses and hostnames.
|
||||
Hostnames are resolved via the configured DNS server.
|
||||
|
||||
|
||||
<strong>Bluetooth</strong>
|
||||
btlist List connected Bluetooth devices
|
||||
btbonds List bonded (paired) Bluetooth devices
|
||||
|
||||
|
||||
<strong>Software-defined radio</strong>
|
||||
sdr [freqMHz [rateHz]] Receive and report basic signal
|
||||
statistics from an attached RTL-SDR dongle
|
||||
@@ -270,22 +300,26 @@
|
||||
disks, devexplorer, procmgr, powermgr, printers, timezone,
|
||||
weather, wikipedia. There is no 0:/games/ directory.
|
||||
|
||||
|
||||
<strong>TAB COMPLETION</strong>
|
||||
Pressing Tab completes the word under the cursor against, in
|
||||
order: executable names in 0:/os/, shell builtins, and file/
|
||||
directory entries in the current directory. A single match is
|
||||
completed inline; multiple matches are listed below the prompt.
|
||||
|
||||
|
||||
<strong>INPUT</strong>
|
||||
The shell uses non-blocking keyboard input via SYS_GETKEY (with
|
||||
SYS_INPUT_WAIT to sleep between events) to support arrow key
|
||||
detection. Lines are limited to 255 characters.
|
||||
|
||||
|
||||
<strong>Editing</strong>
|
||||
Backspace Delete character before cursor
|
||||
Tab Tab-complete the current word
|
||||
Enter Execute the command line
|
||||
|
||||
|
||||
<strong>History</strong>
|
||||
The shell stores the last 32 unique commands. Duplicate
|
||||
consecutive entries are suppressed.
|
||||
@@ -293,6 +327,7 @@
|
||||
Up Arrow Recall previous command
|
||||
Down Arrow Recall next command (or clear line)
|
||||
|
||||
|
||||
<strong>PROMPT</strong>
|
||||
The prompt displays the current drive and working directory:
|
||||
|
||||
@@ -300,9 +335,9 @@
|
||||
0:/os> _ (in os/ directory)
|
||||
1:/> _ (at root of drive 1)
|
||||
|
||||
<strong>SEE ALSO</strong>
|
||||
man(1), intro(1), syscalls(2)</code></pre>
|
||||
|
||||
<strong>SEE ALSO</strong>
|
||||
<a href="man.html">man(1)</a>, <a href="intro.html">intro(1)</a>, <a href="syscalls.html">syscalls(2)</a></code></pre>
|
||||
<hr>
|
||||
|
||||
<div class="center">
|
||||
|
||||
Reference in new issue
Block a user