From 5f46fde558c467414fa151ad962caaf7f07628fa Mon Sep 17 00:00:00 2001
From: Jan Tuomi <jan@jantuomi.fi>
Date: Mon, 16 Feb 2026 12:59:14 +0200
Subject: Initial commit

---
 docs/USAGE.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 docs/USAGE.md

(limited to 'docs/USAGE.md')

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.
-- 
cgit v1.3