summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/git-annex.mdwn19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 618ddf203..42f80a3dc 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -171,19 +171,30 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
* dropkey [key ...]
- Drops the annexed data for the specified keys from this repository.
+ This plumbing-level command drops the annexed data for the specified
+ keys from this repository.
This can be used to drop content for arbitrary keys, which do not need
to have a file in the git repository pointing at them.
+ A backend will typically need to be specified with --backend. If none
+ is specified, the first configured backend is used.
+
+ Example:
+
+ git annex dropkey --backend=SHA1 7da006579dd64330eb2456001fd01948430572f2
+
* setkey file
- Sets the annxed data for a key to the content of the specified file,
- and then removes the file.
+ This plumbing-level command sets the annxed data for a key to the content of
+ the specified file, and then removes the file.
+
+ A backend will typically need to be specified with --backend. If none
+ is specified, the first configured backend is used.
Example:
- git annex setkey --key=1287765018:3 /tmp/file
+ git annex setkey --backend=WORM --key=1287765018:3 /tmp/file
# OPTIONS