aboutsummaryrefslogtreecommitdiff
path: root/src/nix/add-to-store.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/nix/add-to-store.md')
-rw-r--r--src/nix/add-to-store.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/nix/add-to-store.md b/src/nix/add-to-store.md
new file mode 100644
index 000000000..593ad67ad
--- /dev/null
+++ b/src/nix/add-to-store.md
@@ -0,0 +1,28 @@
+R""(
+
+# Description
+
+Copy the file or directory *path* to the Nix store, and
+print the resulting store path on standard output.
+
+> **Warning**
+>
+> The resulting store path is not registered as a garbage
+> collector root, so it could be deleted before you have a
+> chance to register it.
+
+# Examples
+
+Add a regular file to the store:
+
+```console
+# echo foo > bar
+
+# nix add-to-store --flat ./bar
+/nix/store/cbv2s4bsvzjri77s2gb8g8bpcb6dpa8w-bar
+
+# cat /nix/store/cbv2s4bsvzjri77s2gb8g8bpcb6dpa8w-bar
+foo
+```
+
+)""