aboutsummaryrefslogtreecommitdiff
path: root/src/libstore/local-binary-cache-store.md
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2023-03-21 14:03:05 +0100
committerEelco Dolstra <edolstra@gmail.com>2023-03-21 14:03:40 +0100
commit9eb53bbf17037691e1278c71517d74d0962aa43f (patch)
tree33fdd4666bbff78bc801ff241ac67877a952e993 /src/libstore/local-binary-cache-store.md
parent7704118d2816c2f7939db6771cd4665d5a68596d (diff)
Support per-store Markdown documentation
Diffstat (limited to 'src/libstore/local-binary-cache-store.md')
-rw-r--r--src/libstore/local-binary-cache-store.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/libstore/local-binary-cache-store.md b/src/libstore/local-binary-cache-store.md
new file mode 100644
index 000000000..93fddc840
--- /dev/null
+++ b/src/libstore/local-binary-cache-store.md
@@ -0,0 +1,16 @@
+R"(
+
+**Store URL format**: `file://`*path*
+
+This store allows reading and writing a binary cache stored in *path*
+in the local filesystem. If *path* does not exist, it will be created.
+
+For example, the following builds or downloads `nixpkgs#hello` into
+the local store and then copies it to the binary cache in
+`/tmp/binary-cache`:
+
+```
+# nix copy --to file:///tmp/binary-cache nixpkgs#hello
+```
+
+)"