summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-07-02 17:44:25 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-07-02 17:44:25 -0400
commit5d6c7bccb3037633dc3360dcc22639adb5fe5793 (patch)
tree6f6ba780ad7f2104e3cee68778e5cd19b958605c /doc
parentd46832a3537cfbdc44a4b0b39c6a16abe5e15581 (diff)
Brought back the setkey plumbing command that was removed in 2011, since we found a use case for it. Note that the command's syntax was changed for consistency.
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-dropkey.mdwn2
-rw-r--r--doc/git-annex-setkey.mdwn30
-rw-r--r--doc/git-annex.mdwn7
3 files changed, 39 insertions, 0 deletions
diff --git a/doc/git-annex-dropkey.mdwn b/doc/git-annex-dropkey.mdwn
index 7a25e23b2..0db29f900 100644
--- a/doc/git-annex-dropkey.mdwn
+++ b/doc/git-annex-dropkey.mdwn
@@ -21,6 +21,8 @@ exist; using it can easily result in data loss.
[[git-annex]](1)
+[[git-annex-setkey]](1)
+
# AUTHOR
Joey Hess <id@joeyh.name>
diff --git a/doc/git-annex-setkey.mdwn b/doc/git-annex-setkey.mdwn
new file mode 100644
index 000000000..439984c2b
--- /dev/null
+++ b/doc/git-annex-setkey.mdwn
@@ -0,0 +1,30 @@
+# NAME
+
+git-annex setkey - sets annexed content for a key
+
+# SYNOPSIS
+
+git annex setkey key file
+
+# DESCRIPTION
+
+This plumbing-level command makes the content of the specified key
+be set to the specified file. The file is moved into the annex.
+
+No checking is done that the file contains the expected contents of the key.
+So it's generally a better idea to use [[git-annex-reinject]](1) instead of
+this command.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+[[git-annex-reinject]](1)
+
+[[git-annex-dropkey]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index a0d5a0b00..7a3edf0ef 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -547,6 +547,13 @@ subdirectories).
See [[git-annex-registerurl]](1) for details.
+* `setkey key file`
+
+ Moves a file into the annex as the content of a key.
+
+ See [[git-annex-setkey]](1) for details.
+
+
* `dropkey [key ...]`
Drops annexed content for specified keys.