aboutsummaryrefslogtreecommitdiff
path: root/src/nix/nar-dump-path.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/nix/nar-dump-path.md')
-rw-r--r--src/nix/nar-dump-path.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/nix/nar-dump-path.md b/src/nix/nar-dump-path.md
new file mode 100644
index 000000000..26191ad25
--- /dev/null
+++ b/src/nix/nar-dump-path.md
@@ -0,0 +1,17 @@
+R""(
+
+# Examples
+
+* To serialise directory `foo` as a NAR:
+
+ ```console
+ # nix nar dump-path ./foo > foo.nar
+ ```
+
+# Description
+
+This command generates a NAR file containing the serialisation of
+*path*, which must contain only regular files, directories and
+symbolic links. The NAR is written to standard output.
+
+)""