6ab29139eb42804e32ba8612eaf13cc742465cf9
[git.git] / man1 / git-sh-setup.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-SH-SETUP" 1 "" "" ""
21 .SH NAME
22 git-sh-setup \- Common git shell script setup code.
23 .SH "SYNOPSIS"
24
25
26 git\-sh\-setup
27
28 .SH "DESCRIPTION"
29
30
31 Sets up the normal git environment variables and a few helper functions (currently just "die()"), and returns ok if it all looks like a git archive\&. So, to make the rest of the git scripts more careful and readable, use it as follows:
32
33 .IP
34 \&. git\-sh\-setup || die "Not a git archive"
35 .SH "AUTHOR"
36
37
38 Written by Linus Torvalds <torvalds@osdl\&.org>
39
40 .SH "DOCUMENTATION"
41
42
43 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
44
45 .SH "GIT"
46
47
48 Part of the \fBgit\fR(7) suite
49