git/Documentation/git-shell.txt
Ramkumar Ramachandra 70256a3a67 shell: Rewrite documentation and improve error message
Update the documentation of 'git shell' to mention the interactive
mode and COMMAND_DIR. Also provide a hint when interactive mode is not
available in the shell.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
Reviewed-by: Greg Brockman <gdb@MIT.EDU>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-08-24 10:47:21 -07:00

42 lines
1.1 KiB
Plaintext

git-shell(1)
============
NAME
----
git-shell - Restricted login shell for Git-only SSH access
SYNOPSIS
--------
'git shell' [-c <command> <argument>]
DESCRIPTION
-----------
A login shell for SSH accounts to provide restricted Git access. When
'-c' is given, the program executes <command> non-interactively;
<command> can be one of 'git receive-pack', 'git upload-pack', 'git
upload-archive', 'cvs server', or a command in COMMAND_DIR. The shell
is started in interactive mode when no arguments are given; in this
case, COMMAND_DIR must exist, and any of the executables in it can be
invoked.
'cvs server' is a special command which executes git-cvsserver.
COMMAND_DIR is the path "$HOME/git-shell-commands". The user must have
read and execute permissions to the directory in order to execute the
programs in it. The programs are executed with a cwd of $HOME, and
<argument> is parsed as a command-line string.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Documentation
--------------
Documentation by Petr Baudis and the git-list <git@vger.kernel.org>.
GIT
---
Part of the linkgit:git[1] suite