From 50a65f02a8d3de8ae9e8cc1fc2ab28edd87983e0 Mon Sep 17 00:00:00 2001 From: Ben Wiederhake Date: Tue, 26 Oct 2021 22:12:12 +0200 Subject: [PATCH] Manpages: Auto-generate many through ArgsParser This set was hand-curated, guided by the questions: - Does it have at least three options, i.e. is the help page non-trivial? - Is the program unusual, i.e. does listing it in Help or on man.serenityos.org spread awareness? - Is the program common, but we only implement a subset of 'common' flags? --- Base/usr/share/man/man1/Eyes.md | 20 ++++++++++++ Base/usr/share/man/man1/TelnetServer.md | 18 +++++++++++ Base/usr/share/man/man1/UserspaceEmulator.md | 26 ++++++++++++++++ Base/usr/share/man/man1/WebServer.md | 24 +++++++++++++++ Base/usr/share/man/man1/config.md | 27 +++++++++++++++++ Base/usr/share/man/man1/fortune.md | 24 +++++++++++++++ Base/usr/share/man/man1/grep.md | 31 +++++++++++++++++++ Base/usr/share/man/man1/gunzip.md | 22 ++++++++++++++ Base/usr/share/man/man1/gzip.md | 23 ++++++++++++++ Base/usr/share/man/man1/ifconfig.md | 24 +++++++++++++++ Base/usr/share/man/man1/lsof.md | 28 +++++++++++++++++ Base/usr/share/man/man1/nc.md | 29 ++++++++++++++++++ Base/usr/share/man/man1/netstat.md | 25 +++++++++++++++ Base/usr/share/man/man1/nl.md | 25 +++++++++++++++ Base/usr/share/man/man1/ntpquery.md | 23 ++++++++++++++ Base/usr/share/man/man1/passwd.md | 27 +++++++++++++++++ Base/usr/share/man/man1/profile.md | 26 ++++++++++++++++ Base/usr/share/man/man1/readelf.md | 32 ++++++++++++++++++++ Base/usr/share/man/man1/shot.md | 24 +++++++++++++++ Base/usr/share/man/man1/sql.md | 24 +++++++++++++++ Base/usr/share/man/man1/strace.md | 28 +++++++++++++++++ Base/usr/share/man/man1/tail.md | 26 ++++++++++++++++ Base/usr/share/man/man1/tr.md | 23 ++++++++++++++ Base/usr/share/man/man1/traceroute.md | 23 ++++++++++++++ Base/usr/share/man/man1/tree.md | 23 ++++++++++++++ Base/usr/share/man/man1/truncate.md | 22 ++++++++++++++ Base/usr/share/man/man1/utmpupdate.md | 24 +++++++++++++++ Base/usr/share/man/man1/wc.md | 23 ++++++++++++++ Base/usr/share/man/man8/usermod.md | 32 ++++++++++++++++++++ 29 files changed, 726 insertions(+) create mode 100644 Base/usr/share/man/man1/Eyes.md create mode 100644 Base/usr/share/man/man1/TelnetServer.md create mode 100644 Base/usr/share/man/man1/UserspaceEmulator.md create mode 100644 Base/usr/share/man/man1/WebServer.md create mode 100644 Base/usr/share/man/man1/config.md create mode 100644 Base/usr/share/man/man1/fortune.md create mode 100644 Base/usr/share/man/man1/grep.md create mode 100644 Base/usr/share/man/man1/gunzip.md create mode 100644 Base/usr/share/man/man1/gzip.md create mode 100644 Base/usr/share/man/man1/ifconfig.md create mode 100644 Base/usr/share/man/man1/lsof.md create mode 100644 Base/usr/share/man/man1/nc.md create mode 100644 Base/usr/share/man/man1/netstat.md create mode 100644 Base/usr/share/man/man1/nl.md create mode 100644 Base/usr/share/man/man1/ntpquery.md create mode 100644 Base/usr/share/man/man1/passwd.md create mode 100644 Base/usr/share/man/man1/profile.md create mode 100644 Base/usr/share/man/man1/readelf.md create mode 100644 Base/usr/share/man/man1/shot.md create mode 100644 Base/usr/share/man/man1/sql.md create mode 100644 Base/usr/share/man/man1/strace.md create mode 100644 Base/usr/share/man/man1/tail.md create mode 100644 Base/usr/share/man/man1/tr.md create mode 100644 Base/usr/share/man/man1/traceroute.md create mode 100644 Base/usr/share/man/man1/tree.md create mode 100644 Base/usr/share/man/man1/truncate.md create mode 100644 Base/usr/share/man/man1/utmpupdate.md create mode 100644 Base/usr/share/man/man1/wc.md create mode 100644 Base/usr/share/man/man8/usermod.md diff --git a/Base/usr/share/man/man1/Eyes.md b/Base/usr/share/man/man1/Eyes.md new file mode 100644 index 00000000000..deaf371b1b8 --- /dev/null +++ b/Base/usr/share/man/man1/Eyes.md @@ -0,0 +1,20 @@ +## Name + +Eyes + +## Synopsis + +```sh +$ Eyes [--num-eyes number] [--max-in-row number] [--grid-rows number] [--grid-cols number] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-n number`, `--num-eyes number`: Number of eyes +* `-m number`, `--max-in-row number`: Maximum number of eyes in a row +* `-r number`, `--grid-rows number`: Number of rows in grid (incompatible with --number) +* `-c number`, `--grid-cols number`: Number of columns in grid (incompatible with --number) + + diff --git a/Base/usr/share/man/man1/TelnetServer.md b/Base/usr/share/man/man1/TelnetServer.md new file mode 100644 index 00000000000..1a11b7f5fbe --- /dev/null +++ b/Base/usr/share/man/man1/TelnetServer.md @@ -0,0 +1,18 @@ +## Name + +TelnetServer + +## Synopsis + +```sh +$ TelnetServer [-p port] [-c command] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-p port`: Port to listen on +* `-c command`: Program to run on connection + + diff --git a/Base/usr/share/man/man1/UserspaceEmulator.md b/Base/usr/share/man/man1/UserspaceEmulator.md new file mode 100644 index 00000000000..0b3111283d3 --- /dev/null +++ b/Base/usr/share/man/man1/UserspaceEmulator.md @@ -0,0 +1,26 @@ +## Name + +UserspaceEmulator + +## Synopsis + +```sh +$ UserspaceEmulator [--report-to-debug] [--pause] [--profile] [--profile-interval num_instructions] [--profile-file path] [--roi] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `--report-to-debug`: Write reports to the debug log +* `-p`, `--pause`: Pause on startup +* `--profile`: Generate a ProfileViewer-compatible profile +* `-i num_instructions`, `--profile-interval num_instructions`: Set the profile instruction capture interval, 128 by default +* `--profile-file path`: File path for profile dump +* `--roi`: Enable Region-of-Interest mode for profiling + +## Arguments: + +* `command`: Command to emulate + + diff --git a/Base/usr/share/man/man1/WebServer.md b/Base/usr/share/man/man1/WebServer.md new file mode 100644 index 00000000000..11a4797ddb4 --- /dev/null +++ b/Base/usr/share/man/man1/WebServer.md @@ -0,0 +1,24 @@ +## Name + +WebServer + +## Synopsis + +```sh +$ WebServer [--listen-address listen_address] [--port port] [--user username] [--pass password] [path] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-l listen_address`, `--listen-address listen_address`: IP address to listen on +* `-p port`, `--port port`: Port to listen on +* `-U username`, `--user username`: HTTP basic authentication username +* `-P password`, `--pass password`: HTTP basic authentication password + +## Arguments: + +* `path`: Path to serve the contents of + + diff --git a/Base/usr/share/man/man1/config.md b/Base/usr/share/man/man1/config.md new file mode 100644 index 00000000000..7ff2729ae60 --- /dev/null +++ b/Base/usr/share/man/man1/config.md @@ -0,0 +1,27 @@ +## Name + +config + +## Synopsis + +```sh +$ config [value] +``` + +## Description + +Show or modify values in the configuration files through ConfigServer. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version + +## Arguments: + +* `domain`: Config domain +* `group`: Group name +* `key`: Key name +* `value`: Value to write + + diff --git a/Base/usr/share/man/man1/fortune.md b/Base/usr/share/man/man1/fortune.md new file mode 100644 index 00000000000..5d20775aa05 --- /dev/null +++ b/Base/usr/share/man/man1/fortune.md @@ -0,0 +1,24 @@ +## Name + +fortune + +## Synopsis + +```sh +$ fortune [path] +``` + +## Description + +Open a fortune cookie, receive a free quote for the day! + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version + +## Arguments: + +* `path`: Path to JSON file with quotes (/res/fortunes.json by default) + + diff --git a/Base/usr/share/man/man1/grep.md b/Base/usr/share/man/man1/grep.md new file mode 100644 index 00000000000..ad1ae076b96 --- /dev/null +++ b/Base/usr/share/man/man1/grep.md @@ -0,0 +1,31 @@ +## Name + +grep + +## Synopsis + +```sh +$ grep [--recursive] [--extended-regexp] [--regexp Pattern] [-i] [--invert-match] [--quiet] [--no-messages] [--binary-mode ] [--text] [-I] [--color WHEN] [file...] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-r`, `--recursive`: Recursively scan files +* `-E`, `--extended-regexp`: Extended regular expressions +* `-e Pattern`, `--regexp Pattern`: Pattern +* `-i`: Make matches case-insensitive +* `-v`, `--invert-match`: Select non-matching lines +* `-q`, `--quiet`: Do not write anything to standard output +* `-s`, `--no-messages`: Suppress error messages for nonexistent or unreadable files +* `--binary-mode`: Action to take for binary files ([binary], text, skip) +* `-a`, `--text`: Treat binary files as text (same as --binary-mode text) +* `-I`: Ignore binary files (same as --binary-mode skip) +* `--color WHEN`: When to use colored output for the matching text ([auto], never, always) + +## Arguments: + +* `file`: File(s) to process + + diff --git a/Base/usr/share/man/man1/gunzip.md b/Base/usr/share/man/man1/gunzip.md new file mode 100644 index 00000000000..3fbcda4be2c --- /dev/null +++ b/Base/usr/share/man/man1/gunzip.md @@ -0,0 +1,22 @@ +## Name + +gunzip + +## Synopsis + +```sh +$ gunzip [--keep] [--stdout] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-k`, `--keep`: Keep (don't delete) input files +* `-c`, `--stdout`: Write to stdout, keep original files unchanged + +## Arguments: + +* `FILE`: File to decompress + + diff --git a/Base/usr/share/man/man1/gzip.md b/Base/usr/share/man/man1/gzip.md new file mode 100644 index 00000000000..32f80f2f552 --- /dev/null +++ b/Base/usr/share/man/man1/gzip.md @@ -0,0 +1,23 @@ +## Name + +gzip + +## Synopsis + +```sh +$ gzip [--keep] [--stdout] [--decompress] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-k`, `--keep`: Keep (don't delete) input files +* `-c`, `--stdout`: Write to stdout, keep original files unchanged +* `-d`, `--decompress`: Decompress + +## Arguments: + +* `FILES`: Files + + diff --git a/Base/usr/share/man/man1/ifconfig.md b/Base/usr/share/man/man1/ifconfig.md new file mode 100644 index 00000000000..7e77af027f3 --- /dev/null +++ b/Base/usr/share/man/man1/ifconfig.md @@ -0,0 +1,24 @@ +## Name + +ifconfig + +## Synopsis + +```sh +$ ifconfig [--ipv4 ip] [--adapter adapter] [--gateway gateway] [--mask mask] +``` + +## Description + +Display or modify the configuration of each network interface. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-i ip`, `--ipv4 ip`: Set the IP address of the selected network +* `-a adapter`, `--adapter adapter`: Select a specific network adapter to configure +* `-g gateway`, `--gateway gateway`: Set the default gateway of the selected network +* `-m mask`, `--mask mask`: Set the network mask of the selected network + + diff --git a/Base/usr/share/man/man1/lsof.md b/Base/usr/share/man/man1/lsof.md new file mode 100644 index 00000000000..0a9baf2b9dd --- /dev/null +++ b/Base/usr/share/man/man1/lsof.md @@ -0,0 +1,28 @@ +## Name + +lsof + +## Synopsis + +```sh +$ lsof [-p pid] [-d fd] [-u login/UID] [-g PGID] [filename] +``` + +## Description + +List open files of a processes. This can mean actual files in the file system, sockets, pipes, etc. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-p pid`: Select by PID +* `-d fd`: Select by file descriptor +* `-u login/UID`: Select by login/UID +* `-g PGID`: Select by process group ID + +## Arguments: + +* `filename`: Filename + + diff --git a/Base/usr/share/man/man1/nc.md b/Base/usr/share/man/man1/nc.md new file mode 100644 index 00000000000..0ffb51f88a2 --- /dev/null +++ b/Base/usr/share/man/man1/nc.md @@ -0,0 +1,29 @@ +## Name + +nc + +## Synopsis + +```sh +$ nc [--listen] [--verbose] [--udp] [-N] +``` + +## Description + +Network cat: Connect to network sockets as if it were a file. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-l`, `--listen`: Listen instead of connecting +* `-v`, `--verbose`: Log everything that's happening +* `-u`, `--udp`: UDP mode +* `-N`: Close connection after reading stdin to the end + +## Arguments: + +* `target`: Address to listen on, or the address or hostname to connect to +* `port`: Port to connect to or listen on + + diff --git a/Base/usr/share/man/man1/netstat.md b/Base/usr/share/man/man1/netstat.md new file mode 100644 index 00000000000..036dc5d5277 --- /dev/null +++ b/Base/usr/share/man/man1/netstat.md @@ -0,0 +1,25 @@ +## Name + +netstat + +## Synopsis + +```sh +$ netstat [--all] [--list] [--tcp] [--udp] [--program] +``` + +## Description + +Display network connections + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-a`, `--all`: Display both listening and non-listening sockets +* `-l`, `--list`: Display only listening sockets +* `-t`, `--tcp`: Display only TCP network connections +* `-u`, `--udp`: Display only UDP network connections +* `-p`, `--program`: Show the PID and name of the program to which each socket belongs + + diff --git a/Base/usr/share/man/man1/nl.md b/Base/usr/share/man/man1/nl.md new file mode 100644 index 00000000000..67a1c4c775a --- /dev/null +++ b/Base/usr/share/man/man1/nl.md @@ -0,0 +1,25 @@ +## Name + +nl + +## Synopsis + +```sh +$ nl [--body-numbering style] [--increment number] [--separator string] [--startnum number] [--width number] [file...] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-b style`, `--body-numbering style`: Line numbering style: 't' for non-empty lines, 'a' for all lines, 'n' for no lines +* `-i number`, `--increment number`: Line count increment +* `-s string`, `--separator string`: Separator between line numbers and lines +* `-v number`, `--startnum number`: Initial line number +* `-w number`, `--width number`: Number width + +## Arguments: + +* `file`: Files to process + + diff --git a/Base/usr/share/man/man1/ntpquery.md b/Base/usr/share/man/man1/ntpquery.md new file mode 100644 index 00000000000..79325ef21fe --- /dev/null +++ b/Base/usr/share/man/man1/ntpquery.md @@ -0,0 +1,23 @@ +## Name + +ntpquery + +## Synopsis + +```sh +$ ntpquery [--adjust] [--set] [--verbose] [host] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-a`, `--adjust`: Gradually adjust system time (requires root) +* `-s`, `--set`: Immediately set system time (requires root) +* `-v`, `--verbose`: Verbose output + +## Arguments: + +* `host`: NTP server + + diff --git a/Base/usr/share/man/man1/passwd.md b/Base/usr/share/man/man1/passwd.md new file mode 100644 index 00000000000..d2343f21015 --- /dev/null +++ b/Base/usr/share/man/man1/passwd.md @@ -0,0 +1,27 @@ +## Name + +passwd + +## Synopsis + +```sh +$ passwd [--delete] [--lock] [--unlock] [username] +``` + +## Description + +Modify an account password. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-d`, `--delete`: Delete password +* `-l`, `--lock`: Lock password +* `-u`, `--unlock`: Unlock password + +## Arguments: + +* `username`: Username + + diff --git a/Base/usr/share/man/man1/profile.md b/Base/usr/share/man/man1/profile.md new file mode 100644 index 00000000000..7012e83cd51 --- /dev/null +++ b/Base/usr/share/man/man1/profile.md @@ -0,0 +1,26 @@ +## Name + +profile + +## Synopsis + +```sh +$ profile [-p PID] [-a] [-e] [-d] [-f] [-w] [-c command] [-t event_type] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-p PID`: Target PID +* `-a`: Profile all processes (super-user only) +* `-e`: Enable +* `-d`: Disable +* `-f`: Free the profiling buffer for the associated process(es). +* `-w`: Enable profiling and wait for user input to disable. +* `-c command`: Command +* `-t event_type`: Enable tracking specific event type + +Event type can be one of: sample, context_switch, page_fault, syscall, kmalloc and kfree. + + diff --git a/Base/usr/share/man/man1/readelf.md b/Base/usr/share/man/man1/readelf.md new file mode 100644 index 00000000000..6f2e59e60f6 --- /dev/null +++ b/Base/usr/share/man/man1/readelf.md @@ -0,0 +1,32 @@ +## Name + +readelf + +## Synopsis + +```sh +$ readelf [--all] [--file-header] [--program-headers] [--section-headers] [--headers] [--syms] [--dyn-syms] [--dynamic] [--notes] [--relocs] [--unwind] [--checksec] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-a`, `--all`: Display all +* `-h`, `--file-header`: Display ELF header +* `-l`, `--program-headers`: Display program headers +* `-S`, `--section-headers`: Display section headers +* `-e`, `--headers`: Equivalent to: -h -l -S -s -r -d -n -u -c +* `-s`, `--syms`: Display the symbol table +* `--dyn-syms`: Display the dynamic symbol table +* `-d`, `--dynamic`: Display the dynamic section +* `-n`, `--notes`: Display core notes +* `-r`, `--relocs`: Display relocations +* `-u`, `--unwind`: Display unwind info +* `-c`, `--checksec`: Display security hardening info + +## Arguments: + +* `path`: ELF path + + diff --git a/Base/usr/share/man/man1/shot.md b/Base/usr/share/man/man1/shot.md new file mode 100644 index 00000000000..bc49258153b --- /dev/null +++ b/Base/usr/share/man/man1/shot.md @@ -0,0 +1,24 @@ +## Name + +shot + +## Synopsis + +```sh +$ shot [--clipboard] [--delay seconds] [--screen index] [--region] [output] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-c`, `--clipboard`: Output to clipboard +* `-d seconds`, `--delay seconds`: Seconds to wait before taking a screenshot +* `-s index`, `--screen index`: The index of the screen (default: -1 for all screens) +* `-r`, `--region`: Select a region to capture + +## Arguments: + +* `output`: Output filename + + diff --git a/Base/usr/share/man/man1/sql.md b/Base/usr/share/man/man1/sql.md new file mode 100644 index 00000000000..dd5b1c174e7 --- /dev/null +++ b/Base/usr/share/man/man1/sql.md @@ -0,0 +1,24 @@ +## Name + +sql + +## Synopsis + +```sh +$ sql [--database database] [--read file] [--source file] [--no-sqlrc] +``` + +## Description + +This is a client for the SerenitySQL database server. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-d database`, `--database database`: Database to connect to +* `-r file`, `--read file`: File to read +* `-s file`, `--source file`: File to source +* `-n`, `--no-sqlrc`: Don't read ~/.sqlrc + + diff --git a/Base/usr/share/man/man1/strace.md b/Base/usr/share/man/man1/strace.md new file mode 100644 index 00000000000..bb4a1a52097 --- /dev/null +++ b/Base/usr/share/man/man1/strace.md @@ -0,0 +1,28 @@ +## Name + +strace + +## Synopsis + +```sh +$ strace [--pid pid] [--output output] [--exclude exclude] [--include include] [argument...] +``` + +## Description + +Trace all syscalls and their result. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-p pid`, `--pid pid`: Trace the given PID +* `-o output`, `--output output`: Filename to write output to +* `-e exclude`, `--exclude exclude`: Comma-delimited syscalls to exclude +* `-i include`, `--include include`: Comma-delimited syscalls to include + +## Arguments: + +* `argument`: Arguments to exec + + diff --git a/Base/usr/share/man/man1/tail.md b/Base/usr/share/man/man1/tail.md new file mode 100644 index 00000000000..eb99f778a7c --- /dev/null +++ b/Base/usr/share/man/man1/tail.md @@ -0,0 +1,26 @@ +## Name + +tail + +## Synopsis + +```sh +$ tail [--follow] [--lines number] +``` + +## Description + +Print the end ('tail') of a file. + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-f`, `--follow`: Output data as it is written to the file +* `-n number`, `--lines number`: Fetch the specified number of lines + +## Arguments: + +* `file`: File path + + diff --git a/Base/usr/share/man/man1/tr.md b/Base/usr/share/man/man1/tr.md new file mode 100644 index 00000000000..5052c4c91e4 --- /dev/null +++ b/Base/usr/share/man/man1/tr.md @@ -0,0 +1,23 @@ +## Name + +tr + +## Synopsis + +```sh +$ tr [--complement] [--delete] [to] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-c`, `--complement`: Take the complement of the first set +* `-d`, `--delete`: Delete characters instead of replacing + +## Arguments: + +* `from`: Set of characters to translate from +* `to`: Set of characters to translate to + + diff --git a/Base/usr/share/man/man1/traceroute.md b/Base/usr/share/man/man1/traceroute.md new file mode 100644 index 00000000000..0a2029a8eb2 --- /dev/null +++ b/Base/usr/share/man/man1/traceroute.md @@ -0,0 +1,23 @@ +## Name + +traceroute + +## Synopsis + +```sh +$ traceroute [--max-hops hops] [--max-retries tries] [--timeout seconds] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-h hops`, `--max-hops hops`: use at most to the destination +* `-r tries`, `--max-retries tries`: retry TTL at most times +* `-t seconds`, `--timeout seconds`: wait at most for a response + +## Arguments: + +* `destination`: destination + + diff --git a/Base/usr/share/man/man1/tree.md b/Base/usr/share/man/man1/tree.md new file mode 100644 index 00000000000..0eda307e8fb --- /dev/null +++ b/Base/usr/share/man/man1/tree.md @@ -0,0 +1,23 @@ +## Name + +tree + +## Synopsis + +```sh +$ tree [--all] [--only-directories] [--maximum-depth level] [directories...] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-a`, `--all`: Show hidden files +* `-d`, `--only-directories`: Show only directories +* `-L level`, `--maximum-depth level`: Maximum depth of the tree + +## Arguments: + +* `directories`: Directories to print + + diff --git a/Base/usr/share/man/man1/truncate.md b/Base/usr/share/man/man1/truncate.md new file mode 100644 index 00000000000..7d5dd21fac3 --- /dev/null +++ b/Base/usr/share/man/man1/truncate.md @@ -0,0 +1,22 @@ +## Name + +truncate + +## Synopsis + +```sh +$ truncate [--size size] [--reference file] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-s size`, `--size size`: Resize the target file to (or by) this size. Prefix with + or - to expand or shrink the file, or a bare number to set the size exactly +* `-r file`, `--reference file`: Resize the target file to match the size of this one + +## Arguments: + +* `file`: File path + + diff --git a/Base/usr/share/man/man1/utmpupdate.md b/Base/usr/share/man/man1/utmpupdate.md new file mode 100644 index 00000000000..fe1dac2bf99 --- /dev/null +++ b/Base/usr/share/man/man1/utmpupdate.md @@ -0,0 +1,24 @@ +## Name + +utmpupdate + +## Synopsis + +```sh +$ utmpupdate [--create] [--delete] [--PID PID] [--from From] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-c`, `--create`: Create entry +* `-d`, `--delete`: Delete entry +* `-p PID`, `--PID PID`: PID +* `-f From`, `--from From`: From + +## Arguments: + +* `tty`: TTY name + + diff --git a/Base/usr/share/man/man1/wc.md b/Base/usr/share/man/man1/wc.md new file mode 100644 index 00000000000..f08e0b47232 --- /dev/null +++ b/Base/usr/share/man/man1/wc.md @@ -0,0 +1,23 @@ +## Name + +wc + +## Synopsis + +```sh +$ wc [--lines] [--bytes] [--words] [file...] +``` + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-l`, `--lines`: Output line count +* `-c`, `--bytes`: Output byte count +* `-w`, `--words`: Output word count + +## Arguments: + +* `file`: File to process + + diff --git a/Base/usr/share/man/man8/usermod.md b/Base/usr/share/man/man8/usermod.md new file mode 100644 index 00000000000..614281c106f --- /dev/null +++ b/Base/usr/share/man/man8/usermod.md @@ -0,0 +1,32 @@ +## Name + +usermod + +## Synopsis + +```sh +$ usermod [--uid uid] [--gid gid] [--lock] [--unlock] [--home new-home] [--move] [--shell path-to-shell] [--gecos general-info] +``` + +## Description + +Modify a user account + +## Options: + +* `--help`: Display help message and exit +* `--version`: Print version +* `-u uid`, `--uid uid`: The new numerical value of the user's ID +* `-g gid`, `--gid gid`: The group number of the user's new initial login group +* `-L`, `--lock`: Lock password +* `-U`, `--unlock`: Unlock password +* `-d new-home`, `--home new-home`: The user's new login directory +* `-m`, `--move`: Move the content of the user's home directory to the new location +* `-s path-to-shell`, `--shell path-to-shell`: The name of the user's new login shell +* `-n general-info`, `--gecos general-info`: Change the GECOS field of the user + +## Arguments: + +* `username`: Username of the account to modify + +