calckey: New plumbing command, calculates the key that would be used to refer to a file

1 files changed, 35 insertions, 0 deletions

diff --git a/doc/git-annex-calckey.mdwn b/doc/git-annex-calckey.mdwn
new file mode 100644
index 000000000..84fafba4b
--- /dev/null
+++ b/doc/git-annex-calckey.mdwn
@@ -0,0 +1,35 @@
+# NAME
+
+git-annex calckey - calculates the key that would be used to refer to a file
+
+# SYNOPSIS
+
+git annex calckey `[file ...]`
+
+# DESCRIPTION
+
+This plumbing-level command calculates the key that would be used
+to refer to a file. The file is not added to the annex by this command.
+The key is output to stdout.
+
+The backend used is the first listed in the annex.backends configuration
+setting. For example, to force use of the SHA1 backend:
+
+	git annex calckey -c annex.backends=SHA1 file
+
+# OPTIONS
+
+* `--batch`
+
+  Enable batch mode, in which a line containing the filename is read from
+  stdin, the key is output to stdout (with a trailing newline), and repeat.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.