Add commands

Author: SimonSchubert

assets/commands/apptainer-cache.md

@@ -0,0 +1,76 @@
+# TAGLINE
+
+Manage the local Apptainer container cache
+
+# TLDR
+
+**List all cached images**
+
+```apptainer cache list```
+
+**List cached images with details**
+
+```apptainer cache list -v```
+
+**List only OCI cached images**
+
+```apptainer cache list -T oci```
+
+**Clean all cached images**
+
+```apptainer cache clean```
+
+**Clean cache without confirmation**
+
+```apptainer cache clean -f```
+
+**Clean cache entries older than 30 days**
+
+```apptainer cache clean -D 30```
+
+**Dry run to see what would be cleaned**
+
+```apptainer cache clean -n```
+
+# SYNOPSIS
+
+**apptainer cache** [_subcommand_] [_options_]
+
+# DESCRIPTION
+
+**apptainer cache** manages the local Apptainer container image cache. When pulling or building containers, Apptainer stores intermediate images and layers locally to speed up subsequent operations. This command allows listing cache contents and cleaning up disk space.
+
+The cache is stored at **$HOME/.apptainer/cache** by default, or at the path specified by the **APPTAINER_CACHEDIR** environment variable.
+
+# SUBCOMMANDS
+
+**list**
+> Display the contents of the local cache, showing size and type of cached images
+
+**clean**
+> Remove items from the local cache to reclaim disk space
+
+# PARAMETERS
+
+**-T, --type** _strings_
+> Limit operation to specific cache types: **library**, **oci**, **shub**, **blob**, **net**, **oras**, **all** (default: all)
+
+**-v, --verbose**
+> Display detailed information about cached images (list only)
+
+**-D, --days** _int_
+> Remove cache entries older than the specified number of days (clean only)
+
+**-n, --dry-run**
+> Show what would be deleted without actually removing anything (clean only)
+
+**-f, --force**
+> Suppress confirmation prompts and clean immediately (clean only)
+
+# CAVEATS
+
+Large builds and frequent pulls can consume significant disk space in the cache directory. The cache is per-user and does not affect other users on the system. Cleaning the cache forces re-download of images on next use.
+
+# SEE ALSO
+
+[apptainer](/man/apptainer)(1), [apptainer-build](/man/apptainer-build)(1), [apptainer-pull](/man/apptainer-pull)(1)

assets/commands/autoload.md

@@ -0,0 +1,76 @@
+# TAGLINE
+
+Autoload shell functions for lazy loading
+
+# TLDR
+
+**Autoload a function** by name
+
+```autoload [function_name]```
+
+**Autoload with immediate undefined-function handling** (zsh)
+
+```autoload -U [function_name]```
+
+**Autoload with zsh-style function initialization** (suppresses alias expansion)
+
+```autoload -Uz [function_name]```
+
+**Autoload all functions** in a directory added to fpath
+
+```autoload -Uz $fpath[1]/*(.:t)```
+
+**Autoload the completion system**
+
+```autoload -Uz compinit && compinit```
+
+**Autoload the prompt system**
+
+```autoload -Uz promptinit && promptinit```
+
+# SYNOPSIS
+
+**autoload** [_-UXmtz_] [_name ..._]
+
+# PARAMETERS
+
+**-U**
+> Suppress alias expansion when the function is loaded
+
+**-z**
+> Use zsh-style function definitions (default in zsh)
+
+**-k**
+> Use ksh-style function definitions
+
+**-X**
+> Immediately load and execute the function (used inside the function itself)
+
+**-t**
+> Enable execution tracing for the autoloaded function
+
+**-m**
+> Treat arguments as patterns for matching function names
+
+**+X**
+> Force the function to be loaded immediately without executing it
+
+# DESCRIPTION
+
+**autoload** marks shell function names for deferred loading. Instead of reading a function definition into memory at startup, the shell records only the function name. When the function is first called, the shell searches the directories listed in **$fpath** for a file matching the function name, reads its definition, and executes it.
+
+This mechanism significantly reduces shell startup time when many functions are available but rarely used. The function file should contain the function body directly (not wrapped in a `function name { }` block for zsh-style autoloading).
+
+**autoload** is essential for zsh's completion system (**compinit**), prompt themes (**promptinit**), and many other standard functions distributed with zsh.
+
+# CAVEATS
+
+The function file must be in a directory listed in **$fpath**. The file name must exactly match the function name. Functions autoloaded with **-U** will not have aliases expanded in their definitions, which is strongly recommended to avoid unexpected behavior. Only available as a shell builtin in zsh and ksh.
+
+# HISTORY
+
+**autoload** originates from **ksh** (Korn Shell), designed by **David Korn** at Bell Labs in the **1980s**. Zsh adopted and extended the concept, making it central to its modular function system. The **-U** and **-z** flags are zsh-specific additions.
+
+# SEE ALSO
+
+[zsh](/man/zsh)(1), [source](/man/source)(1), [compinit](/man/compinit)(1)

assets/commands/bye.md

@@ -0,0 +1,35 @@
+# TAGLINE
+
+Exit the shell
+
+# TLDR
+
+**Exit the current shell** session
+
+```bye```
+
+**Exit with a specific status** code
+
+```bye [exit_code]```
+
+# SYNOPSIS
+
+**bye** [_n_]
+
+# DESCRIPTION
+
+**bye** is a zsh builtin that terminates the current shell session. It is functionally identical to **exit**. When called, it runs any **EXIT** traps and zshexit hooks before closing the shell.
+
+If an optional numeric argument is provided, it is used as the exit status returned to the parent process. Without an argument, the exit status of the last command executed is used.
+
+# CAVEATS
+
+**bye** is specific to zsh and not available in bash or other shells. For portability, use **exit** instead. If there are running background jobs, zsh may warn before exiting on the first attempt.
+
+# HISTORY
+
+**bye** was included in **zsh** as a convenience alias for **exit**, reflecting a common command used in interactive systems like FTP clients and some early Unix shells.
+
+# SEE ALSO
+
+[exit](/man/exit)(1), [logout](/man/logout)(1), [zsh](/man/zsh)(1)

assets/commands/chdir.md

@@ -0,0 +1,43 @@
+# TAGLINE
+
+Change the current working directory
+
+# TLDR
+
+**Change to a specific directory**
+
+```chdir [path/to/directory]```
+
+**Change to home directory**
+
+```chdir ~```
+
+**Change to parent directory**
+
+```chdir ..```
+
+**Change to previous directory**
+
+```chdir -```
+
+# SYNOPSIS
+
+**chdir** [_directory_]
+
+# DESCRIPTION
+
+**chdir** changes the current working directory of the shell to the specified path. It is functionally equivalent to **cd** and available as a builtin in zsh, csh, and tcsh.
+
+When called without arguments, it changes to the user's home directory. The **CDPATH** variable is searched if the specified directory is not found relative to the current directory.
+
+# CAVEATS
+
+**chdir** is not available in bash (use **cd** instead). For portable scripts, always use **cd**. The command is a shell builtin and does not exist as a standalone executable.
+
+# HISTORY
+
+**chdir** is the original name of the directory-changing system call in **Unix**, dating back to the **First Edition** in **1971**. The **cd** command was introduced as a shorter alias. Shells like **csh** (1978) and later **zsh** retained **chdir** as a builtin alongside **cd**.
+
+# SEE ALSO
+
+[cd](/man/cd)(1), [pushd](/man/pushd)(1), [popd](/man/popd)(1), [pwd](/man/pwd)(1)

assets/commands/disable.md

@@ -0,0 +1,67 @@
+# TAGLINE
+
+Disable shell builtins or other named elements
+
+# TLDR
+
+**Disable a shell builtin**
+
+```disable [builtin_name]```
+
+**Disable a shell function**
+
+```disable -f [function_name]```
+
+**Disable a reserved word**
+
+```disable -r [reserved_word]```
+
+**List all disabled builtins**
+
+```disable```
+
+**Re-enable a disabled builtin**
+
+```enable [builtin_name]```
+
+# SYNOPSIS
+
+**disable** [_-afmprs_] [_name ..._]
+
+# PARAMETERS
+
+**-a**
+> Disable aliases
+
+**-f**
+> Disable shell functions
+
+**-m**
+> Treat arguments as patterns for matching
+
+**-p**
+> Disable shell parameters (variables)
+
+**-r**
+> Disable reserved words
+
+**-s**
+> Disable suffix aliases (zsh)
+
+# DESCRIPTION
+
+**disable** is a zsh builtin that prevents named elements from being used. When a builtin is disabled, the shell will search **$PATH** for an external command of the same name instead. This is useful for forcing the use of an external version of a command over the shell builtin, such as using an external **echo** or **test** instead of the builtin version.
+
+Disabled elements can be re-enabled with the **enable** builtin.
+
+# CAVEATS
+
+Only available in zsh. In bash, the equivalent functionality is provided by **enable -n**. Disabling critical builtins like **cd** or **exit** can make the shell difficult to use. The effect does not persist across shell sessions unless added to shell configuration files.
+
+# HISTORY
+
+The concept of disabling builtins was introduced in **bash** with the **enable -n** syntax. **Zsh** provides the dedicated **disable** command as part of its more modular approach to shell configuration, extending the concept to functions, aliases, and reserved words.
+
+# SEE ALSO
+
+[enable](/man/enable)(1), [builtin](/man/builtin)(1), [zsh](/man/zsh)(1)

assets/commands/getln.md

@@ -0,0 +1,37 @@
+# TAGLINE
+
+Read a line from the shell buffer stack
+
+# TLDR
+
+**Read a line from the buffer stack** into a variable
+
+```getln [variable_name]```
+
+**Read a line and process it**
+
+```getln line && echo $line```
+
+# SYNOPSIS
+
+**getln** _name_ [_name ..._]
+
+# DESCRIPTION
+
+**getln** is a zsh builtin that reads the top entry from the shell's **buffer stack** and assigns it to the named variable. The buffer stack is a LIFO (last-in, first-out) data structure where lines can be pushed using **print -z** or **pushln** and later retrieved with **getln**.
+
+If multiple variable names are given, the line is split into words and assigned to each variable in order, similar to **read**.
+
+The buffer stack is typically used for programmatic input manipulation, where a script prepares command lines to be executed or processed later.
+
+# CAVEATS
+
+Only available in zsh. The buffer stack is a zsh-specific feature not found in other shells. If the buffer stack is empty, **getln** will assign an empty string. The buffer stack is separate from the command history.
+
+# HISTORY
+
+**getln** is part of **zsh's** buffer stack mechanism, a unique feature of the Z Shell that allows programmatic queuing and retrieval of text lines within the shell environment.
+
+# SEE ALSO
+
+[pushln](/man/pushln)(1), [print](/man/print)(1), [read](/man/read)(1), [zsh](/man/zsh)(1)