diff options
| author | Jan Tuomi <jan@jantuomi.fi> | 2026-02-16 12:59:14 +0200 |
|---|---|---|
| committer | Jan Tuomi <jan@jantuomi.fi> | 2026-02-16 12:59:14 +0200 |
| commit | 5f46fde558c467414fa151ad962caaf7f07628fa (patch) | |
| tree | 247d6fd45ddbc811fb71d2009fbbd2042e158791 /docs/USAGE.md | |
Initial commit
Diffstat (limited to 'docs/USAGE.md')
| -rw-r--r-- | docs/USAGE.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/USAGE.md b/docs/USAGE.md new file mode 100644 index 0000000..295ae0b --- /dev/null +++ b/docs/USAGE.md @@ -0,0 +1,20 @@ +# jprov Usage + +## Synopsis +```bash +jprov [-y] [--dry-run] <jailname> +``` + +## Behavior Summary +- Validates configs and referenced paths. +- Stops and destroys any existing jail named `<jailname>`. +- Clones the template dataset into a new jail dataset. +- Generates `/etc/jail.conf.d/<jailname>.conf` (or configured path). +- Mounts nullfs volumes, copies overlay, and executes the provisioning command. + +## Exit Codes +- `0`: success +- `1`: failure + +## Dry Run +`--dry-run` logs actions without executing destructive or provisioning steps. |