Merge branch 'rs/opt-help-text'
[git/kirr.git] / Documentation / git-shell.txt
blob6403126a029bf43acaa219296353f7ab1f2040a0
1 git-shell(1)
2 ============
4 NAME
5 ----
6 git-shell - Restricted login shell for Git-only SSH access
9 SYNOPSIS
10 --------
11 'git shell' [-c <command> <argument>]
13 DESCRIPTION
14 -----------
16 A login shell for SSH accounts to provide restricted Git access. When
17 '-c' is given, the program executes <command> non-interactively;
18 <command> can be one of 'git receive-pack', 'git upload-pack', 'git
19 upload-archive', 'cvs server', or a command in COMMAND_DIR. The shell
20 is started in interactive mode when no arguments are given; in this
21 case, COMMAND_DIR must exist, and any of the executables in it can be
22 invoked.
24 'cvs server' is a special command which executes git-cvsserver.
26 COMMAND_DIR is the path "$HOME/git-shell-commands". The user must have
27 read and execute permissions to the directory in order to execute the
28 programs in it. The programs are executed with a cwd of $HOME, and
29 <argument> is parsed as a command-line string.
31 Author
32 ------
33 Written by Linus Torvalds <torvalds@osdl.org>
35 Documentation
36 --------------
37 Documentation by Petr Baudis and the git-list <git@vger.kernel.org>.
39 GIT
40 ---
41 Part of the linkgit:git[1] suite