Liking cljdoc? Tell your friends :D

bsdkrun.zfs

ZFS volumes: one zpool per volume on a disk image, held by one machine at a time (Linux, FreeBSD, NetBSD). Branches are datasets cloned copy-on-write inside the pool (zfs snapshot + zfs clone), so a branch costs nothing until it diverges. Mirrors sdk/ruby/lib/bsdkrun/zfs.rb.

ZFS volumes: one zpool per volume on a disk image, held by one machine at
a time (Linux, FreeBSD, NetBSD). Branches are datasets cloned copy-on-write
inside the pool (`zfs snapshot` + `zfs clone`), so a branch costs nothing
until it diverges. Mirrors `sdk/ruby/lib/bsdkrun/zfs.rb`.
raw docstring

attach!clj

(attach! target machine)
(attach! target machine {:keys [mount]})

Attach VOL or VOL@BRANCH to a machine at :mount (/mnt/VOL, or /mnt/VOL-BRANCH, by default). A pool is imported by one machine at a time; a stopped machine picks it up on start, a running holder mounts the branch live. Returns the CLI's one-line report.

Attach `VOL` or `VOL@BRANCH` to a machine at `:mount` (`/mnt/VOL`, or
`/mnt/VOL-BRANCH`, by default). A pool is imported by one machine at a
time; a stopped machine picks it up on start, a running holder mounts the
branch live. Returns the CLI's one-line report.
sourceraw docstring

branch!clj

(branch! volume name)
(branch! volume name {:keys [from]})

Fork a branch copy-on-write from :from (main by default). Runs in the machine holding the volume or in a short-lived FreeBSD helper, so it can take as long as a BSD boot. Returns the new VOL@BRANCH.

Fork a branch copy-on-write from `:from` (`main` by default). Runs in the
machine holding the volume or in a short-lived FreeBSD helper, so it can
take as long as a BSD boot. Returns the new `VOL@BRANCH`.
sourceraw docstring

branchesclj

(branches volume)

The branches of one volume.

The branches of one volume.
sourceraw docstring

create!clj

(create! name)
(create! name {:keys [size]})

Create a volume: a sparse image that becomes a zpool with a main branch the first time a guest imports it. {:size "10G"} (the default).

Create a volume: a sparse image that becomes a zpool with a `main` branch
the first time a guest imports it. `{:size "10G"}` (the default).
sourceraw docstring

destroy!clj

(destroy! targets)
(destroy! targets {:keys [force]})

Destroy branches (VOL@BRANCH) or whole volumes (VOL). targets is a string or a vector of strings; {:force true} destroys a volume a stopped machine still has attached.

Destroy branches (`VOL@BRANCH`) or whole volumes (`VOL`). `targets` is a
string or a vector of strings; `{:force true}` destroys a volume a stopped
machine still has attached.
sourceraw docstring

detach!clj

(detach! target machine)

Detach one branch (VOL@BRANCH) or the whole volume (VOL) from a machine.

Detach one branch (`VOL@BRANCH`) or the whole volume (`VOL`) from a machine.
sourceraw docstring

listclj

(list)

List ZFS volumes, with their branches and holder.

List ZFS volumes, with their branches and holder.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close