| blob | 1dd8d7f0ad64f8d67ddf31916ed31484ee784cdf |
1 '\" t
2 .\" Title: git-init
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2023-10-20
6 .\" Manual: Git Manual
7 .\" Source: Git 2.42.0.424.gceadf0f3cf
8 .\" Language: English
9 .\"
10 .TH "GIT\-INIT" "1" "2023\-10\-20" "Git 2\&.42\&.0\&.424\&.gceadf0" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-init \- Create an empty Git repository or reinitialize an existing one
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit init\fR [\-q | \-\-quiet] [\-\-bare] [\-\-template=<template\-directory>]
36 [\-\-separate\-git\-dir <git\-dir>] [\-\-object\-format=<format>]
37 [\-b <branch\-name> | \-\-initial\-branch=<branch\-name>]
38 [\-\-shared[=<permissions>]] [<directory>]
39 .fi
40 .sp
41 .SH "DESCRIPTION"
42 .sp
43 This command creates an empty Git repository \- basically a \fB\&.git\fR directory with subdirectories for \fBobjects\fR, \fBrefs/heads\fR, \fBrefs/tags\fR, and template files\&. An initial branch without any commits will be created (see the \fB\-\-initial\-branch\fR option below for its name)\&.
44 .sp
45 If the \fB$GIT_DIR\fR environment variable is set then it specifies a path to use instead of \fB\&./\&.git\fR for the base of the repository\&.
46 .sp
47 If the object storage directory is specified via the \fB$GIT_OBJECT_DIRECTORY\fR environment variable then the sha1 directories are created underneath \- otherwise the default \fB$GIT_DIR/objects\fR directory is used\&.
48 .sp
49 Running \fIgit init\fR in an existing repository is safe\&. It will not overwrite things that are already there\&. The primary reason for rerunning \fIgit init\fR is to pick up newly added templates (or to move the repository to another place if \-\-separate\-git\-dir is given)\&.
50 .SH "OPTIONS"
51 .PP
52 \-q, \-\-quiet
53 .RS 4
54 Only print error and warning messages; all other output will be suppressed\&.
55 .RE
56 .PP
57 \-\-bare
58 .RS 4
59 Create a bare repository\&. If
60 \fBGIT_DIR\fR
61 environment is not set, it is set to the current working directory\&.
62 .RE
63 .PP
64 \-\-object\-format=<format>
65 .RS 4
66 Specify the given object format (hash algorithm) for the repository\&. The valid values are
67 \fIsha1\fR
68 and (if enabled)
69 \fIsha256\fR\&.
70 \fIsha1\fR
71 is the default\&.
72 .sp
73 Note: At present, there is no interoperability between SHA\-256 repositories and SHA\-1 repositories\&.
74 .RE
75 .sp
76 Historically, we warned that SHA\-256 repositories may later need backward incompatible changes when we introduce such interoperability features\&. Today, we only expect compatible changes\&. Furthermore, if such changes prove to be necessary, it can be expected that SHA\-256 repositories created with today\(cqs Git will be usable by future versions of Git without data loss\&.
77 .PP
78 \-\-template=<template\-directory>
79 .RS 4
80 Specify the directory from which templates will be used\&. (See the "TEMPLATE DIRECTORY" section below\&.)
81 .RE
82 .PP
83 \-\-separate\-git\-dir=<git\-dir>
84 .RS 4
85 Instead of initializing the repository as a directory to either
86 \fB$GIT_DIR\fR
87 or
88 \fB\&./\&.git/\fR, create a text file there containing the path to the actual repository\&. This file acts as filesystem\-agnostic Git symbolic link to the repository\&.
89 .sp
90 If this is reinitialization, the repository will be moved to the specified path\&.
91 .RE
92 .PP
93 \-b <branch\-name>, \-\-initial\-branch=<branch\-name>
94 .RS 4
95 Use the specified name for the initial branch in the newly created repository\&. If not specified, fall back to the default name (currently
96 \fBmaster\fR, but this is subject to change in the future; the name can be customized via the
97 \fBinit\&.defaultBranch\fR
98 configuration variable)\&.
99 .RE
100 .PP
101 \-\-shared[=(false|true|umask|group|all|world|everybody|<perm>)]
102 .RS 4
103 Specify that the Git repository is to be shared amongst several users\&. This allows users belonging to the same group to push into that repository\&. When specified, the config variable "core\&.sharedRepository" is set so that files and directories under
104 \fB$GIT_DIR\fR
105 are created with the requested permissions\&. When not specified, Git will use permissions reported by umask(2)\&.
106 .sp
107 The option can have the following values, defaulting to
108 \fIgroup\fR
109 if no value is given:
110 .PP
111 \fIumask\fR (or \fIfalse\fR)
112 .RS 4
113 Use permissions reported by umask(2)\&. The default, when
114 \fB\-\-shared\fR
115 is not specified\&.
116 .RE
117 .PP
118 \fIgroup\fR (or \fItrue\fR)
119 .RS 4
120 Make the repository group\-writable, (and g+sx, since the git group may be not the primary group of all users)\&. This is used to loosen the permissions of an otherwise safe umask(2) value\&. Note that the umask still applies to the other permission bits (e\&.g\&. if umask is
121 \fI0022\fR, using
122 \fIgroup\fR
123 will not remove read privileges from other (non\-group) users)\&. See
124 \fI0xxx\fR
125 for how to exactly specify the repository permissions\&.
126 .RE
127 .PP
128 \fIall\fR (or \fIworld\fR or \fIeverybody\fR)
129 .RS 4
130 Same as
131 \fIgroup\fR, but make the repository readable by all users\&.
132 .RE
133 .PP
134 \fI<perm>\fR
135 .RS 4
136 \fI<perm>\fR
137 is a 3\-digit octal number prefixed with \(oq0` and each file will have mode
138 \fI<perm>\fR\&.
139 \fI<perm>\fR
140 will override users\(cq umask(2) value (and not only loosen permissions as
141 \fIgroup\fR
142 and
143 \fIall\fR
144 does)\&.
145 \fI0640\fR
146 will create a repository which is group\-readable, but not group\-writable or accessible to others\&.
147 \fI0660\fR
148 will create a repo that is readable and writable to the current user and group, but inaccessible to others (directories and executable files get their
149 \fBx\fR
150 bit from the
151 \fBr\fR
152 bit for corresponding classes of users)\&.
153 .RE
154 .RE
155 .sp
156 By default, the configuration flag \fBreceive\&.denyNonFastForwards\fR is enabled in shared repositories, so that you cannot force a non fast\-forwarding push into it\&.
157 .sp
158 If you provide a \fIdirectory\fR, the command is run inside it\&. If this directory does not exist, it will be created\&.
159 .SH "TEMPLATE DIRECTORY"
160 .sp
161 Files and directories in the template directory whose name do not start with a dot will be copied to the \fB$GIT_DIR\fR after it is created\&.
162 .sp
163 The template directory will be one of the following (in order):
164 .sp
165 .RS 4
166 .ie n \{\
167 \h'-04'\(bu\h'+03'\c
168 .\}
169 .el \{\
170 .sp -1
171 .IP \(bu 2.3
172 .\}
173 the argument given with the
174 \fB\-\-template\fR
175 option;
176 .RE
177 .sp
178 .RS 4
179 .ie n \{\
180 \h'-04'\(bu\h'+03'\c
181 .\}
182 .el \{\
183 .sp -1
184 .IP \(bu 2.3
185 .\}
186 the contents of the
187 \fB$GIT_TEMPLATE_DIR\fR
188 environment variable;
189 .RE
190 .sp
191 .RS 4
192 .ie n \{\
193 \h'-04'\(bu\h'+03'\c
194 .\}
195 .el \{\
196 .sp -1
197 .IP \(bu 2.3
198 .\}
199 the
200 \fBinit\&.templateDir\fR
201 configuration variable; or
202 .RE
203 .sp
204 .RS 4
205 .ie n \{\
206 \h'-04'\(bu\h'+03'\c
207 .\}
208 .el \{\
209 .sp -1
210 .IP \(bu 2.3
211 .\}
212 the default template directory:
213 \fB/usr/share/git\-core/templates\fR\&.
214 .RE
215 .sp
216 The default template directory includes some directory structure, suggested "exclude patterns" (see \fBgitignore\fR(5)), and sample hook files\&.
217 .sp
218 The sample hooks are all disabled by default\&. To enable one of the sample hooks rename it by removing its \fB\&.sample\fR suffix\&.
219 .sp
220 See \fBgithooks\fR(5) for more general info on hook execution\&.
221 .SH "EXAMPLES"
222 .PP
223 Start a new Git repository for an existing code base
224 .RS 4
225 .sp
226 .if n \{\
227 .RS 4
228 .\}
229 .nf
230 $ cd /path/to/my/codebase
231 $ git init \fB(1)\fR
232 $ git add \&. \fB(2)\fR
233 $ git commit \fB(3)\fR
234 .fi
235 .if n \{\
236 .RE
237 .\}
238 .sp
239 .TS
240 tab(:);
241 r lw(\n(.lu*75u/100u).
242 \fB1.\fR\h'-2n':T{
243 Create a /path/to/my/codebase/\&.git directory\&.
244 T}
245 \fB2.\fR\h'-2n':T{
246 Add all existing files to the index\&.
247 T}
248 \fB3.\fR\h'-2n':T{
249 Record the pristine state as the first commit in the history\&.
250 T}
251 .TE
252 .RE
253 .SH "CONFIGURATION"
254 .sp
255 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
256 .PP
257 init\&.templateDir
258 .RS 4
259 Specify the directory from which templates will be copied\&. (See the "TEMPLATE DIRECTORY" section of
260 \fBgit-init\fR(1)\&.)
261 .RE
262 .PP
263 init\&.defaultBranch
264 .RS 4
265 Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
266 .RE
267 .SH "GIT"
268 .sp
269 Part of the \fBgit\fR(1) suite