aboutsummaryrefslogtreecommitdiffstats
path: root/docs/USAGE.md
blob: 295ae0b4befcd9dbb9e3d13db726b38de1630869 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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.