aboutsummaryrefslogtreecommitdiff
path: root/src/nix/nar-cat.md
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2020-12-09 19:21:48 +0100
committerEelco Dolstra <edolstra@gmail.com>2020-12-21 13:32:28 +0100
commit2cc02bbe7675acb4754b928b5c57fa316600e877 (patch)
treecc5f5b2e9ad90b9aeb032e614c97bee0ba7b892c /src/nix/nar-cat.md
parenta407d14339c2c480f0103a501bcd8a3373d935cb (diff)
Add 'nix nar' manpages
Diffstat (limited to 'src/nix/nar-cat.md')
-rw-r--r--src/nix/nar-cat.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/nix/nar-cat.md b/src/nix/nar-cat.md
new file mode 100644
index 000000000..55c481a28
--- /dev/null
+++ b/src/nix/nar-cat.md
@@ -0,0 +1,19 @@
+R""(
+
+# Examples
+
+* List a file in a NAR and pipe it through `gunzip`:
+
+ ```console
+ # nix nar cat ./hello.nar /share/man/man1/hello.1.gz | gunzip
+ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4.
+ .TH HELLO "1" "November 2014" "hello 2.10" "User Commands"
+ …
+ ```
+
+# Description
+
+This command prints on standard output the contents of the regular
+file *path* inside the NAR file *nar*.
+
+)""