add git-annex-shell command

This is not yet complete, as it does not allow starting rsync or scp.

2 files changed, 68 insertions, 5 deletions

diff --git a/doc/git-annex-shell.mdwn b/doc/git-annex-shell.mdwn
new file mode 100644
index 000000000..34d9c8afe
--- /dev/null
+++ b/doc/git-annex-shell.mdwn
@@ -0,0 +1,63 @@
+# NAME
+
+git-annex-shell - Restricted login shell for git-annex only SSH access
+
+# SYNOPSIS
+
+git-annex-shell -c command [params ...]
+
+# DESCRIPTION
+
+git-annex-shell is a restricted shell, similar to git-shell, which 
+can be used as a login shell for SSH accounts you want to restrict.
+
+# COMMANDS
+
+* git-annex fromkey file
+
+  This can be used to maually set up a file to link to a specified key
+  in the key-value backend. How you determine an existing key in the backend
+  varies. For the URL backend, the key is just a URL to the content.
+
+  Example:
+
+	git annex fromkey --backend=URL --key=http://www.archive.org/somefile somefile
+
+* git-annex dropkey [key ...]
+
+  This 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.
+
+* git-annex setkey file
+
+  This 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.
+
+Any other command is passed through to git-shell.
+
+# OPTIONS
+
+Same as git-annex or git-shell, depending on the command being run.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+git-shell(1)
+
+# AUTHOR
+
+Joey Hess <joey@kitenet.net>
+
+<http://git-annex.branchable.com/>
+
+Warning: this page is automatically made into a man page via [mdwn2man](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=mdwn2man;hb=HEAD).  Edit with care
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index caef49d97..8e6ff2c0c 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -4,7 +4,7 @@ git-annex - manage files with git, without checking their contents in
 
 # SYNOPSIS
 
-git annex subcommand [params ...]
+git annex command [params ...]
 
 # DESCRIPTION
 
@@ -55,13 +55,13 @@ content from the key-value store.
 	# git annex move iso --to=usbdrive
 	move iso/Debian_5.0.iso (moving to usbdrive...) ok
 
-# SUBCOMMANDS
+# COMMANDS
 
 Like many git commands, git-annex can be passed a path that 
 is either a file or a directory. In the latter case it acts on all relevant
 files in the directory.
 
-Many git-annex subcommands will stage changes for later `git commit` by you.
+Many git-annex commands will stage changes for later `git commit` by you.
 
 * add [path ...]
 
@@ -91,7 +91,7 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
 
 * edit [path ...]
 
-  This is an alias for the unlock subcommand. May be easier to remember,
+  This is an alias for the unlock command. May be easier to remember,
   if you think of this as allowing you to edit an annexed file.
 
 * move [path ...]
@@ -122,7 +122,7 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
 
 * fsck [path ...]
 
-  With no parameters, this subcommand checks the whole annex for consistency,
+  With no parameters, this command checks the whole annex for consistency,
   and warns about any problems found.
 
   With parameters, only the specified files are checked.