| blob | 13359f84fee349bec01d4d9254e112ba986ddffa |
1 '\" t
2 .\" Title: git-init
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-09-25
6 .\" Manual: Git Manual
7 .\" Source: Git 2.47.0.rc0
8 .\" Language: English
9 .\"
10 .TH "GIT\-INIT" "1" "2024-09-25" "Git 2\&.47\&.0\&.rc0" "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 \fBgit init\fR [\fB\-q\fR | \fB\-\-quiet\fR] [\fB\-\-bare\fR] [\fB\-\-template=\fR\fI<template\-directory>\fR]
36 [\fB\-\-separate\-git\-dir\fR \fI<git\-dir>\fR] [\fB\-\-object\-format=\fR\fI<format>\fR]
37 [\fB\-\-ref\-format=\fR\fI<format>\fR]
38 [\fB\-b\fR \fI<branch\-name>\fR | \fB\-\-initial\-branch=\fR\fI<branch\-name>\fR]
39 [\fB\-\-shared\fR[\fB=\fR\fI<permissions>\fR]] [\fI<directory>\fR]
40 .fi
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 \fBgit init\fR in an existing repository is safe\&. It will not overwrite things that are already there\&. The primary reason for rerunning \fBgit init\fR is to pick up newly added templates (or to move the repository to another place if \fB\-\-separate\-git\-dir\fR is given)\&.
50 .SH "OPTIONS"
51 .PP
52 \fB\-q\fR, \fB\-\-quiet\fR
53 .RS 4
54 Only print error and warning messages; all other output will be suppressed\&.
55 .RE
56 .PP
57 \fB\-\-bare\fR
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 \fB\-\-object\-format=\fR\fI<format>\fR
65 .RS 4
66 Specify the given object
67 \fI<format>\fR
68 (hash algorithm) for the repository\&. The valid values are
69 \fBsha1\fR
70 and (if enabled)
71 \fBsha256\fR\&.
72 \fBsha1\fR
73 is the default\&.
74 .sp
75 Note: At present, there is no interoperability between SHA\-256 repositories and SHA\-1 repositories\&.
76 .RE
77 .sp
78 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\&.
79 .PP
80 \fB\-\-ref\-format=\fR\fI<format>\fR
81 .RS 4
82 Specify the given ref storage
83 \fI<format>\fR
84 for the repository\&. The valid values are:
85 .sp
86 .RS 4
87 .ie n \{\
88 \h'-04'\(bu\h'+03'\c
89 .\}
90 .el \{\
91 .sp -1
92 .IP \(bu 2.3
93 .\}
94 \fBfiles\fR
95 for loose files with packed\-refs\&. This is the default\&.
96 .RE
97 .sp
98 .RS 4
99 .ie n \{\
100 \h'-04'\(bu\h'+03'\c
101 .\}
102 .el \{\
103 .sp -1
104 .IP \(bu 2.3
105 .\}
106 \fBreftable\fR
107 for the reftable format\&. This format is experimental and its internals are subject to change\&.
108 .RE
109 .RE
110 .PP
111 \fB\-\-template=\fR\fI<template\-directory>\fR
112 .RS 4
113 Specify the directory from which templates will be used\&. (See the "TEMPLATE DIRECTORY" section below\&.)
114 .RE
115 .PP
116 \fB\-\-separate\-git\-dir=\fR\fI<git\-dir>\fR
117 .RS 4
118 Instead of initializing the repository as a directory to either
119 \fB$GIT_DIR\fR
120 or
121 \fB\&./\&.git/\fR, create a text file there containing the path to the actual repository\&. This file acts as a filesystem\-agnostic Git symbolic link to the repository\&.
122 .sp
123 If this is a reinitialization, the repository will be moved to the specified path\&.
124 .RE
125 .PP
126 \fB\-b\fR \fI<branch\-name>\fR, \fB\-\-initial\-branch=\fR\fI<branch\-name>\fR
127 .RS 4
128 Use
129 \fI<branch\-name>\fR
130 for the initial branch in the newly created repository\&. If not specified, fall back to the default name (currently
131 \fBmaster\fR, but this is subject to change in the future; the name can be customized via the
132 \fBinit\&.defaultBranch\fR
133 configuration variable)\&.
134 .RE
135 .PP
136 \fB\-\-shared\fR[\fB=\fR(\fBfalse\fR|\fBtrue\fR|\fBumask\fR|\fBgroup\fR|\fBall\fR|\fBworld\fR|\fBeverybody\fR|\fI<perm>\fR)]
137 .RS 4
138 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
139 \fBcore\&.sharedRepository\fR
140 is set so that files and directories under
141 \fB$GIT_DIR\fR
142 are created with the requested permissions\&. When not specified, Git will use permissions reported by
143 \fBumask\fR(2)\&.
144 .sp
145 The option can have the following values, defaulting to
146 \fBgroup\fR
147 if no value is given:
148 .PP
149 \fBumask\fR, \fBfalse\fR
150 .RS 4
151 Use permissions reported by
152 \fBumask\fR(2)\&. The default, when
153 \fB\-\-shared\fR
154 is not specified\&.
155 .RE
156 .PP
157 \fBgroup\fR, \fBtrue\fR
158 .RS 4
159 Make the repository group\-writable, (and
160 \fBg+sx\fR, since the git group may not be the primary group of all users)\&. This is used to loosen the permissions of an otherwise safe
161 \fBumask\fR(2) value\&. Note that the umask still applies to the other permission bits (e\&.g\&. if umask is
162 \fB0022\fR, using
163 \fBgroup\fR
164 will not remove read privileges from other (non\-group) users)\&. See
165 \fB0xxx\fR
166 for how to exactly specify the repository permissions\&.
167 .RE
168 .PP
169 \fBall\fR, \fBworld\fR, \fBeverybody\fR
170 .RS 4
171 Same as
172 \fBgroup\fR, but make the repository readable by all users\&.
173 .RE
174 .PP
175 \fI<perm>\fR
176 .RS 4
177 \fI<perm>\fR
178 is a 3\-digit octal number prefixed with
179 \fB0\fR
180 and each file will have mode
181 \fI<perm>\fR\&.
182 \fI<perm>\fR
183 will override users\*(Aq
184 \fBumask\fR(2) value (and not only loosen permissions as
185 \fBgroup\fR
186 and
187 \fBall\fR
188 do)\&.
189 \fB0640\fR
190 will create a repository which is group\-readable, but not group\-writable or accessible to others\&.
191 \fB0660\fR
192 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
193 \fBx\fR
194 bit from the
195 \fBr\fR
196 bit for corresponding classes of users)\&.
197 .RE
198 .RE
199 .sp
200 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\&.
201 .sp
202 If you provide a \fI<directory>\fR, the command is run inside it\&. If this directory does not exist, it will be created\&.
203 .SH "TEMPLATE DIRECTORY"
204 .sp
205 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\&.
206 .sp
207 The template directory will be one of the following (in order):
208 .sp
209 .RS 4
210 .ie n \{\
211 \h'-04'\(bu\h'+03'\c
212 .\}
213 .el \{\
214 .sp -1
215 .IP \(bu 2.3
216 .\}
217 the argument given with the
218 \fB\-\-template\fR
219 option;
220 .RE
221 .sp
222 .RS 4
223 .ie n \{\
224 \h'-04'\(bu\h'+03'\c
225 .\}
226 .el \{\
227 .sp -1
228 .IP \(bu 2.3
229 .\}
230 the contents of the
231 \fB$GIT_TEMPLATE_DIR\fR
232 environment variable;
233 .RE
234 .sp
235 .RS 4
236 .ie n \{\
237 \h'-04'\(bu\h'+03'\c
238 .\}
239 .el \{\
240 .sp -1
241 .IP \(bu 2.3
242 .\}
243 the
244 \fBinit\&.templateDir\fR
245 configuration variable; or
246 .RE
247 .sp
248 .RS 4
249 .ie n \{\
250 \h'-04'\(bu\h'+03'\c
251 .\}
252 .el \{\
253 .sp -1
254 .IP \(bu 2.3
255 .\}
256 the default template directory:
257 \fB/usr/share/git\-core/templates\fR\&.
258 .RE
259 .sp
260 The default template directory includes some directory structure, suggested "exclude patterns" (see \fBgitignore\fR(5)), and sample hook files\&.
261 .sp
262 The sample hooks are all disabled by default\&. To enable one of the sample hooks rename it by removing its \fB\&.sample\fR suffix\&.
263 .sp
264 See \fBgithooks\fR(5) for more general info on hook execution\&.
265 .SH "EXAMPLES"
266 .PP
267 Start a new Git repository for an existing code base
268 .RS 4
269 .sp
270 .if n \{\
271 .RS 4
272 .\}
273 .nf
274 $ cd /path/to/my/codebase
275 $ git init \fB(1)\fR
276 $ git add \&. \fB(2)\fR
277 $ git commit \fB(3)\fR
278 .fi
279 .if n \{\
280 .RE
281 .\}
282 .TS
283 tab(:);
284 r lw(\n(.lu*75u/100u).
285 \fB1.\fR\h'-2n':T{
286 Create a
287 \fB/path/to/my/codebase/\&.git\fR
288 directory\&.
289 T}
290 \fB2.\fR\h'-2n':T{
291 Add all existing files to the index\&.
292 T}
293 \fB3.\fR\h'-2n':T{
294 Record the pristine state as the first commit in the history\&.
295 T}
296 .TE
297 .RE
298 .SH "CONFIGURATION"
299 .sp
300 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:
301 .PP
302 \fBinit\&.templateDir\fR
303 .RS 4
304 Specify the directory from which templates will be copied\&.
305 .RE
306 .PP
307 \fBinit\&.defaultBranch\fR
308 .RS 4
309 Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
310 .RE
311 .PP
312 \fBinit\&.defaultObjectFormat\fR
313 .RS 4
314 Allows overriding the default object format for new repositories\&. See
315 \fB\-\-object\-format=\fR
316 in
317 \fBgit-init\fR(1)\&. Both the command line option and the
318 \fBGIT_DEFAULT_HASH\fR
319 environment variable take precedence over this config\&.
320 .RE
321 .PP
322 \fBinit\&.defaultRefFormat\fR
323 .RS 4
324 Allows overriding the default ref storage format for new repositories\&. See
325 \fB\-\-ref\-format=\fR
326 in
327 \fBgit-init\fR(1)\&. Both the command line option and the
328 \fBGIT_DEFAULT_REF_FORMAT\fR
329 environment variable take precedence over this config\&.
330 .RE
331 .SH "GIT"
332 .sp
333 Part of the \fBgit\fR(1) suite