Documentation
¶
Overview ¶
Command gnux is a multi-call binary carrying GNU-compatible implementations of the core utilities, for every platform. See package cmd for how a tool is selected.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd assembles the gnux multi-call binary: a root command carrying one subcommand per tool, and a dispatcher that runs a tool directly when the binary is invoked under that tool's name.
|
Package cmd assembles the gnux multi-call binary: a root command carrying one subcommand per tool, and a dispatcher that runs a tool directly when the binary is invoked under that tool's name. |
|
basenamex
Package basenamex wires the basenamex command (GNU basename) to its engine.
|
Package basenamex wires the basenamex command (GNU basename) to its engine. |
|
catx
Package catx wires the catx command (GNU cat) to its engine.
|
Package catx wires the catx command (GNU cat) to its engine. |
|
cpx
Package cpx wires the cpx command (GNU cp) to its copy engine.
|
Package cpx wires the cpx command (GNU cp) to its copy engine. |
|
dirnamex
Package dirnamex wires the dirnamex command (GNU dirname) to its engine.
|
Package dirnamex wires the dirnamex command (GNU dirname) to its engine. |
|
docs
Package docs generates reference documentation for gnux and every tool it ships, in each format cobra supports (markdown, man, yaml, reST).
|
Package docs generates reference documentation for gnux and every tool it ships, in each format cobra supports (markdown, man, yaml, reST). |
|
echox
Package echox wires the echox command (GNU echo) to its engine.
|
Package echox wires the echox command (GNU echo) to its engine. |
|
envx
Package envx wires the envx command (GNU env) to its engine.
|
Package envx wires the envx command (GNU env) to its engine. |
|
falsex
Package falsex implements the falsex command (GNU false).
|
Package falsex implements the falsex command (GNU false). |
|
headx
Package headx wires the headx command (GNU head) to its engine.
|
Package headx wires the headx command (GNU head) to its engine. |
|
lnx
Package lnx wires the lnx command (GNU ln) to its link engine.
|
Package lnx wires the lnx command (GNU ln) to its link engine. |
|
lsx
Package lsx wires the lsx command (GNU ls) to its listing engine.
|
Package lsx wires the lsx command (GNU ls) to its listing engine. |
|
mkdirx
Package mkdirx wires the mkdirx command (GNU mkdir) to its engine.
|
Package mkdirx wires the mkdirx command (GNU mkdir) to its engine. |
|
mvx
Package mvx wires the mvx command (GNU mv) to its move engine.
|
Package mvx wires the mvx command (GNU mv) to its move engine. |
|
pwdx
Package pwdx wires the pwdx command (GNU pwd) to its engine.
|
Package pwdx wires the pwdx command (GNU pwd) to its engine. |
|
realpathx
Package realpathx wires the realpathx command (GNU realpath) to its engine.
|
Package realpathx wires the realpathx command (GNU realpath) to its engine. |
|
rmdirx
Package rmdirx wires the rmdirx command (GNU rmdir) to its engine.
|
Package rmdirx wires the rmdirx command (GNU rmdir) to its engine. |
|
rmx
Package rmx wires the rmx command (GNU rm) to its removal engine.
|
Package rmx wires the rmx command (GNU rm) to its removal engine. |
|
rmx/directory
Package directory implements rm's -d/--dir flag: remove empty directories.
|
Package directory implements rm's -d/--dir flag: remove empty directories. |
|
rmx/force
Package force implements rm's -f/--force flag: ignore nonexistent files and arguments, never prompt, and suppress the resulting errors.
|
Package force implements rm's -f/--force flag: ignore nonexistent files and arguments, never prompt, and suppress the resulting errors. |
|
rmx/interactive
Package interactive implements rm's prompting flags: -i (prompt before every removal), -I (prompt once before a bulk or recursive removal) and --interactive[=WHEN].
|
Package interactive implements rm's prompting flags: -i (prompt before every removal), -I (prompt once before a bulk or recursive removal) and --interactive[=WHEN]. |
|
rmx/onefilesystem
Package onefilesystem implements rm's --one-file-system flag: when removing a hierarchy recursively, skip any directory on a different file system than the one the removal started on.
|
Package onefilesystem implements rm's --one-file-system flag: when removing a hierarchy recursively, skip any directory on a different file system than the one the removal started on. |
|
rmx/preserveroot
Package preserveroot implements rm's --preserve-root / --no-preserve-root flags, the failsafe that refuses to recurse on the filesystem root '/'.
|
Package preserveroot implements rm's --preserve-root / --no-preserve-root flags, the failsafe that refuses to recurse on the filesystem root '/'. |
|
rmx/recursive
Package recursive implements rm's -r/-R/--recursive flag: remove directories and their contents recursively.
|
Package recursive implements rm's -r/-R/--recursive flag: remove directories and their contents recursively. |
|
rmx/verbose
Package verbose implements rm's -v/--verbose flag: report each removal.
|
Package verbose implements rm's -v/--verbose flag: report each removal. |
|
sleepx
Package sleepx wires the sleepx command (GNU sleep) to its engine.
|
Package sleepx wires the sleepx command (GNU sleep) to its engine. |
|
tailx
Package tailx wires the tailx command (GNU tail) to its engine.
|
Package tailx wires the tailx command (GNU tail) to its engine. |
|
touchx
Package touchx wires the touchx command (GNU touch) to its engine.
|
Package touchx wires the touchx command (GNU touch) to its engine. |
|
truex
Package truex implements the truex command (GNU true).
|
Package truex implements the truex command (GNU true). |
|
wcx
Package wcx wires the wcx command (GNU wc) to its engine.
|
Package wcx wires the wcx command (GNU wc) to its engine. |
|
yesx
Package yesx wires the yesx command (GNU yes) to its engine.
|
Package yesx wires the yesx command (GNU yes) to its engine. |
|
Package core holds the plumbing every gnux engine shares: the standard streams, GNU-style diagnostics, exit-status errors and confirmation prompts.
|
Package core holds the plumbing every gnux engine shares: the standard streams, GNU-style diagnostics, exit-status errors and confirmation prompts. |
|
basename
Package basename implements the engine behind basenamex, a GNU-compatible implementation of the GNU/UNIX basename command: strip the directory and, optionally, a trailing suffix from file names.
|
Package basename implements the engine behind basenamex, a GNU-compatible implementation of the GNU/UNIX basename command: strip the directory and, optionally, a trailing suffix from file names. |
|
cat
Package cat implements the engine behind catx, a GNU-compatible implementation of the GNU/UNIX cat command: concatenate files to standard output, optionally numbering lines and making invisible characters visible.
|
Package cat implements the engine behind catx, a GNU-compatible implementation of the GNU/UNIX cat command: concatenate files to standard output, optionally numbering lines and making invisible characters visible. |
|
cp
Package cp implements the copy engine behind cpx, a GNU-compatible implementation of the GNU/UNIX cp command.
|
Package cp implements the copy engine behind cpx, a GNU-compatible implementation of the GNU/UNIX cp command. |
|
dirname
Package dirname implements the engine behind dirnamex, a GNU-compatible implementation of the GNU/UNIX dirname command: strip the last component from file names.
|
Package dirname implements the engine behind dirnamex, a GNU-compatible implementation of the GNU/UNIX dirname command: strip the last component from file names. |
|
echo
Package echo implements the engine behind echox, a GNU-compatible implementation of the GNU/UNIX echo command: write the operands, separated by single spaces and followed by a newline, to standard output.
|
Package echo implements the engine behind echox, a GNU-compatible implementation of the GNU/UNIX echo command: write the operands, separated by single spaces and followed by a newline, to standard output. |
|
env
Package env implements the engine behind envx, a GNU-compatible implementation of the GNU/UNIX env command: print the environment, or run a command in a modified one.
|
Package env implements the engine behind envx, a GNU-compatible implementation of the GNU/UNIX env command: print the environment, or run a command in a modified one. |
|
head
Package head implements the engine behind headx, a GNU-compatible implementation of the GNU/UNIX head command: print the first part of each file.
|
Package head implements the engine behind headx, a GNU-compatible implementation of the GNU/UNIX head command: print the first part of each file. |
|
ln
Package ln implements the engine behind lnx, a GNU-compatible implementation of the GNU/UNIX ln command: make hard or symbolic links between files.
|
Package ln implements the engine behind lnx, a GNU-compatible implementation of the GNU/UNIX ln command: make hard or symbolic links between files. |
|
ls
Package ls implements the engine behind lsx, a GNU-compatible implementation of the GNU/UNIX ls command: list information about files and the contents of directories.
|
Package ls implements the engine behind lsx, a GNU-compatible implementation of the GNU/UNIX ls command: list information about files and the contents of directories. |
|
mkdir
Package mkdir implements the engine behind mkdirx, a GNU-compatible implementation of the GNU/UNIX mkdir command: create directories, optionally with their parents and an explicit mode.
|
Package mkdir implements the engine behind mkdirx, a GNU-compatible implementation of the GNU/UNIX mkdir command: create directories, optionally with their parents and an explicit mode. |
|
mv
Package mv implements the engine behind mvx, a GNU-compatible implementation of the GNU/UNIX mv command.
|
Package mv implements the engine behind mvx, a GNU-compatible implementation of the GNU/UNIX mv command. |
|
pwd
Package pwd implements the engine behind pwdx, a GNU-compatible implementation of the GNU/UNIX pwd command: print the name of the current working directory.
|
Package pwd implements the engine behind pwdx, a GNU-compatible implementation of the GNU/UNIX pwd command: print the name of the current working directory. |
|
realpath
Package realpath implements the engine behind realpathx, a GNU-compatible implementation of the GNU realpath command: print the resolved absolute name of each file.
|
Package realpath implements the engine behind realpathx, a GNU-compatible implementation of the GNU realpath command: print the resolved absolute name of each file. |
|
rm
Package rm implements the removal engine behind rmx, a GNU-compatible implementation of the GNU/UNIX rm command.
|
Package rm implements the removal engine behind rmx, a GNU-compatible implementation of the GNU/UNIX rm command. |
|
rmdir
Package rmdir implements the engine behind rmdirx, a GNU-compatible implementation of the GNU/UNIX rmdir command: remove directories, but only if they are empty.
|
Package rmdir implements the engine behind rmdirx, a GNU-compatible implementation of the GNU/UNIX rmdir command: remove directories, but only if they are empty. |
|
shell
Package shell implements the gnux shell: a small, portable command interpreter whose commands are the gnux tools, run in-process.
|
Package shell implements the gnux shell: a small, portable command interpreter whose commands are the gnux tools, run in-process. |
|
sleep
Package sleep implements the engine behind sleepx, a GNU-compatible implementation of the GNU/UNIX sleep command: pause for the sum of the given time intervals.
|
Package sleep implements the engine behind sleepx, a GNU-compatible implementation of the GNU/UNIX sleep command: pause for the sum of the given time intervals. |
|
tail
Package tail implements the engine behind tailx, a GNU-compatible implementation of the GNU/UNIX tail command: print the last part of each file and, with --follow, keep printing what is appended to it.
|
Package tail implements the engine behind tailx, a GNU-compatible implementation of the GNU/UNIX tail command: print the last part of each file and, with --follow, keep printing what is appended to it. |
|
touch
Package touch implements the engine behind touchx, a GNU-compatible implementation of the GNU/UNIX touch command: update the access and modification times of files, creating the ones that do not exist.
|
Package touch implements the engine behind touchx, a GNU-compatible implementation of the GNU/UNIX touch command: update the access and modification times of files, creating the ones that do not exist. |
|
wc
Package wc implements the engine behind wcx, a GNU-compatible implementation of the GNU/UNIX wc command: print line, word, character and byte counts for each file.
|
Package wc implements the engine behind wcx, a GNU-compatible implementation of the GNU/UNIX wc command: print line, word, character and byte counts for each file. |
|
yes
Package yes implements the engine behind yesx, a GNU-compatible implementation of the GNU/UNIX yes command: print a line over and over until the reader goes away.
|
Package yes implements the engine behind yesx, a GNU-compatible implementation of the GNU/UNIX yes command: print a line over and over until the reader goes away. |
|
internal
|
|
|
common
Package common holds app-wide constants shared across packages.
|
Package common holds app-wide constants shared across packages. |
|
docmeta
Package docmeta defines the documentation metadata that every tool (and, where a tool documents them individually, every flag) exposes.
|
Package docmeta defines the documentation metadata that every tool (and, where a tool documents them individually, every flag) exposes. |
|
tool
Package tool defines what a gnux tool is - its metadata, flags and entry point - and turns that description into a cobra command.
|
Package tool defines what a gnux tool is - its metadata, flags and entry point - and turns that description into a cobra command. |
|
tools
|
|
|
changelog
command
Command changelog prints the CHANGELOG.md section of one release, for the release workflow to publish as that release's notes.
|
Command changelog prints the CHANGELOG.md section of one release, for the release workflow to publish as that release's notes. |
|
gendocs
command
Command gendocs generates the gnux reference - the entry page, the guide and one page per tool (and per flag, where a tool documents them) - in every cobra format.
|
Command gendocs generates the gnux reference - the entry page, the guide and one page per tool (and per flag, where a tool documents them) - in every cobra format. |
|
wasm
command
Command wasm is the WebAssembly build of gnux that powers the web playground.
|
Command wasm is the WebAssembly build of gnux that powers the web playground. |
Click to show internal directories.
Click to hide internal directories.