From bd18ca94bdbb4cd498f0906072e9d9c1bfd3f05d Mon Sep 17 00:00:00 2001 From: JillThornhill <121565493+JillThornhill@users.noreply.github.com> Date: Tue, 9 May 2023 16:50:12 +0200 Subject: [PATCH] Create reference.md Moved some stuff from original README in here; still needs some editing --- docs/reference.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/reference.md diff --git a/docs/reference.md b/docs/reference.md new file mode 100644 index 0000000..3c49a6b --- /dev/null +++ b/docs/reference.md @@ -0,0 +1,32 @@ +# Reference Manual: disko + +## Module Options + +TODO: Still to be documented + +## # Reference Manual: disko + +## Command Line Options + +``` +$ nix run github:nix-community/disko -- +disko [options] disk-config.nix +or disko [options] --flake github:somebody/somewhere +Options: +* -m, --mode mode + set the mode, either create or mount +* -f, --flake uri + fetch the disko config relative to this flake's root +* --arg name value + pass value to nix-build. can be used to set disk-names for example +* --argstr name value + pass value to nix-build as string +* --root-mountpoint /mnt + where to mount the device tree +* --dry-run + just show the path to the script instead of running it +* --debug + run with set -x +``` + +##