table of contents
other versions
- wheezy 3.20120629
- wheezy-backports 5.20141024~bpo70+1
- jessie 5.20141125
- jessie-backports 5.20151208-1~bpo8+1
- testing 6.20170101-1+b1
- unstable 6.20170101-1+b1
| git-annex-shell(1) | General Commands Manual | git-annex-shell(1) |
NAME¶
git-annex-shell - Restricted login shell for git-annex only SSH accessSYNOPSIS¶
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. Since its syntax is identical to git-shell's, it can be used as a drop-in replacement anywhere git-shell is used. For example it can be used as a user's restricted login shell.COMMANDS¶
Any command not listed below is passed through to git-shell. Note that the directory parameter should be an absolute path, otherwise it is assumed to be relative to the user's home directory. Also the first "/~/" or "/~user/" is expanded to the specified home directory.- configlist directory
- This outputs a subset of the git configuration, in the same form as git config --list
- inannex directory [key ...]
- This checks if all specified keys are present in the annex, and exits zero if so.
- dropkey directory [key ...]
- This drops the annexed data for the specified keys.
- recvkey directory key
- This runs rsync in server mode to receive the content of a key, and stores the content in the annex.
- sendkey directory key
- This runs rsync in server mode to transfer out the content of a key.
- commit directory
- This commits any staged changes to the git-annex branch. It also runs the annex-content hook.
OPTIONS¶
Most options are the same as in git-annex. The ones specific to git-annex-shell are:- --uuid=UUID
- git-annex uses this to specify the UUID of the repository it was expecting git-annex-shell to access, as a sanity check.
HOOK¶
After content is received or dropped from the repository by git-annex-shell, it runs a hook, .git/hooks/annex-content (or hooks/annex-content on a bare repository). The hook is not currently passed any information about what changed.ENVIRONMENT¶
- GIT_ANNEX_SHELL_READONLY
- If set, disallows any command that could modify the repository.
- GIT_ANNEX_SHELL_LIMITED
- If set, disallows running git-shell to handle unknown commands.