| blob | 6a9c9613d731b0ffaa293ec541bcfa7c1999dc33 |
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: 2024-02-19
6 .\" Manual: Git Manual
7 .\" Source: Git 2.44.0.rc1.44.g96c8a0712e
8 .\" Language: English
9 .\"
10 .TH "GIT\-INIT" "1" "2024\-02\-19" "Git 2\&.44\&.0\&.rc1\&.44\&.g9" "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 [\-\-ref\-format=<format>]
38 [\-b <branch\-name> | \-\-initial\-branch=<branch\-name>]
39 [\-\-shared[=<permissions>]] [<directory>]
40 .fi
41 .sp
42 .SH "DESCRIPTION"
43 .sp
44 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)\&.
45 .sp
46 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\&.
47 .sp
48 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\&.
49 .sp
50 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)\&.
51 .SH "OPTIONS"
52 .PP
53 \-q, \-\-quiet
54 .RS 4
55 Only print error and warning messages; all other output will be suppressed\&.
56 .RE
57 .PP
58 \-\-bare
59 .RS 4
60 Create a bare repository\&. If
61 \fBGIT_DIR\fR
62 environment is not set, it is set to the current working directory\&.
63 .RE
64 .PP
65 \-\-object\-format=<format>
66 .RS 4
67 Specify the given object format (hash algorithm) for the repository\&. The valid values are
68 \fIsha1\fR
69 and (if enabled)
70 \fIsha256\fR\&.
71 \fIsha1\fR
72 is the default\&.
73 .sp
74 Note: At present, there is no interoperability between SHA\-256 repositories and SHA\-1 repositories\&.
75 .RE
76 .sp
77 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\&.
78 .PP
79 \-\-ref\-format=<format>
80 .RS 4
81 Specify the given ref storage format for the repository\&. The valid values are:
82 .sp
83 .RS 4
84 .ie n \{\
85 \h'-04'\(bu\h'+03'\c
86 .\}
87 .el \{\
88 .sp -1
89 .IP \(bu 2.3
90 .\}
91 \fBfiles\fR
92 for loose files with packed\-refs\&. This is the default\&.
93 .RE
94 .RE
95 .PP
96 \-\-template=<template\-directory>
97 .RS 4
98 Specify the directory from which templates will be used\&. (See the "TEMPLATE DIRECTORY" section below\&.)
99 .RE
100 .PP
101 \-\-separate\-git\-dir=<git\-dir>
102 .RS 4
103 Instead of initializing the repository as a directory to either
104 \fB$GIT_DIR\fR
105 or
106 \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\&.
107 .sp
108 If this is a reinitialization, the repository will be moved to the specified path\&.
109 .RE
110 .PP
111 \-b <branch\-name>, \-\-initial\-branch=<branch\-name>
112 .RS 4
113 Use the specified name for the initial branch in the newly created repository\&. If not specified, fall back to the default name (currently
114 \fBmaster\fR, but this is subject to change in the future; the name can be customized via the
115 \fBinit\&.defaultBranch\fR
116 configuration variable)\&.
117 .RE
118 .PP
119 \-\-shared[=(false|true|umask|group|all|world|everybody|<perm>)]
120 .RS 4
121 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
122 \fB$GIT_DIR\fR
123 are created with the requested permissions\&. When not specified, Git will use permissions reported by umask(2)\&.
124 .sp
125 The option can have the following values, defaulting to
126 \fIgroup\fR
127 if no value is given:
128 .PP
129 \fIumask\fR (or \fIfalse\fR)
130 .RS 4
131 Use permissions reported by umask(2)\&. The default, when
132 \fB\-\-shared\fR
133 is not specified\&.
134 .RE
135 .PP
136 \fIgroup\fR (or \fItrue\fR)
137 .RS 4
138 Make the repository group\-writable, (and g+sx, since the git group may not be 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
139 \fI0022\fR, using
140 \fIgroup\fR
141 will not remove read privileges from other (non\-group) users)\&. See
142 \fI0xxx\fR
143 for how to exactly specify the repository permissions\&.
144 .RE
145 .PP
146 \fIall\fR (or \fIworld\fR or \fIeverybody\fR)
147 .RS 4
148 Same as
149 \fIgroup\fR, but make the repository readable by all users\&.
150 .RE
151 .PP
152 \fI<perm>\fR
153 .RS 4
154 \fI<perm>\fR
155 is a 3\-digit octal number prefixed with \(oq0` and each file will have mode
156 \fI<perm>\fR\&.
157 \fI<perm>\fR
158 will override users\(cq umask(2) value (and not only loosen permissions as
159 \fIgroup\fR
160 and
161 \fIall\fR
162 do)\&.
163 \fI0640\fR
164 will create a repository which is group\-readable, but not group\-writable or accessible to others\&.
165 \fI0660\fR
166 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
167 \fBx\fR
168 bit from the
169 \fBr\fR
170 bit for corresponding classes of users)\&.
171 .RE
172 .RE
173 .sp
174 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\&.
175 .sp
176 If you provide a \fIdirectory\fR, the command is run inside it\&. If this directory does not exist, it will be created\&.
177 .SH "TEMPLATE DIRECTORY"
178 .sp
179 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\&.
180 .sp
181 The template directory will be one of the following (in order):
182 .sp
183 .RS 4
184 .ie n \{\
185 \h'-04'\(bu\h'+03'\c
186 .\}
187 .el \{\
188 .sp -1
189 .IP \(bu 2.3
190 .\}
191 the argument given with the
192 \fB\-\-template\fR
193 option;
194 .RE
195 .sp
196 .RS 4
197 .ie n \{\
198 \h'-04'\(bu\h'+03'\c
199 .\}
200 .el \{\
201 .sp -1
202 .IP \(bu 2.3
203 .\}
204 the contents of the
205 \fB$GIT_TEMPLATE_DIR\fR
206 environment variable;
207 .RE
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
218 \fBinit\&.templateDir\fR
219 configuration variable; or
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 default template directory:
231 \fB/usr/share/git\-core/templates\fR\&.
232 .RE
233 .sp
234 The default template directory includes some directory structure, suggested "exclude patterns" (see \fBgitignore\fR(5)), and sample hook files\&.
235 .sp
236 The sample hooks are all disabled by default\&. To enable one of the sample hooks rename it by removing its \fB\&.sample\fR suffix\&.
237 .sp
238 See \fBgithooks\fR(5) for more general info on hook execution\&.
239 .SH "EXAMPLES"
240 .PP
241 Start a new Git repository for an existing code base
242 .RS 4
243 .sp
244 .if n \{\
245 .RS 4
246 .\}
247 .nf
248 $ cd /path/to/my/codebase
249 $ git init \fB(1)\fR
250 $ git add \&. \fB(2)\fR
251 $ git commit \fB(3)\fR
252 .fi
253 .if n \{\
254 .RE
255 .\}
256 .sp
257 .TS
258 tab(:);
259 r lw(\n(.lu*75u/100u).
260 \fB1.\fR\h'-2n':T{
261 Create a /path/to/my/codebase/\&.git directory\&.
262 T}
263 \fB2.\fR\h'-2n':T{
264 Add all existing files to the index\&.
265 T}
266 \fB3.\fR\h'-2n':T{
267 Record the pristine state as the first commit in the history\&.
268 T}
269 .TE
270 .RE
271 .SH "CONFIGURATION"
272 .sp
273 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:
274 .PP
275 init\&.templateDir
276 .RS 4
277 Specify the directory from which templates will be copied\&. (See the "TEMPLATE DIRECTORY" section of
278 \fBgit-init\fR(1)\&.)
279 .RE
280 .PP
281 init\&.defaultBranch
282 .RS 4
283 Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
284 .RE
285 .SH "GIT"
286 .sp
287 Part of the \fBgit\fR(1) suite