Google Git
Sign in
chromium / external / gitster / git-htmldocs / b968dbbd6a939fc1282a7837026e131ed921e122 / . / git-init.html
blob: b65c7e68d80decc9ff043295b7c5809c3b5c06ac [file] [log] [blame]
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6<meta name="generator" content="AsciiDoc 7.0.2" />
7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
Junio C Hamano91f77a02007-01-12 02:43:42[diff] [blame]259<title>git-init(1)</title>
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]260</head>
261<body>
262<div id="header">
263<h1>
Junio C Hamano91f77a02007-01-12 02:43:42[diff] [blame]264git-init(1) Manual Page
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
Junio C Hamano91f77a02007-01-12 02:43:42[diff] [blame]268<p>git-init -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]269 Create an empty git repository or reinitialize an existing one
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]275<p><em>git-init</em> [-q | --quiet] [--template=&lt;template_directory&gt;] [--shared[=&lt;permissions&gt;]]</p>
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]276</div>
277<h2>OPTIONS</h2>
278<div class="sectionbody">
279<dl>
280<dt>
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]281-q, --quiet
282</dt>
283<dd>
284<p>
285Only print error and warning messages, all other output will be suppressed.
286</p>
287</dd>
288<dt>
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]289--template=&lt;template_directory&gt;
290</dt>
291<dd>
292<p>
293Provide the directory from which templates will be used. The default template
294directory is <tt>/usr/share/git-core/templates</tt>.
295</p>
296<p>When specified, <tt>&lt;template_directory&gt;</tt> is used as the source of the template
297files rather than the default. The template files include some directory
298structure, some suggested "exclude patterns", and copies of non-executing
299"hook" files. The suggested patterns and hook files are all modifiable and
300extensible.</p>
301</dd>
302<dt>
303--shared[={false|true|umask|group|all|world|everybody}]
304</dt>
305<dd>
306<p>
307Specify that the git repository is to be shared amongst several users. This
308allows users belonging to the same group to push into that
309repository. When specified, the config variable "core.sharedRepository" is
310set so that files and directories under <tt>$GIT_DIR</tt> are created with the
311requested permissions. When not specified, git will use permissions reported
312by umask(2).
313</p>
314<p>The option can have the following values, defaulting to <em>group</em> if no value
315is given:</p>
316<ul>
317<li>
318<p>
319<em>umask</em> (or <em>false</em>): Use permissions reported by umask(2). The default,
320 when <tt>--shared</tt> is not specified.
321</p>
322</li>
323<li>
324<p>
325<em>group</em> (or <em>true</em>): Make the repository group-writable, (and g+sx, since
326 the git group may be not the primary group of all users).
327</p>
328</li>
329<li>
330<p>
331<em>all</em> (or <em>world</em> or <em>everybody</em>): Same as <em>group</em>, but make the repository
332 readable by all users.
333</p>
334<p>By default, the configuration flag receive.denyNonFastforward is enabled
335in shared repositories, so that you cannot force a non fast-forwarding push
336into it.</p>
337</li>
338</ul>
339</dd>
340</dl>
341</div>
342<h2>DESCRIPTION</h2>
343<div class="sectionbody">
344<p>This command creates an empty git repository - basically a <tt>.git</tt> directory
345with subdirectories for <tt>objects</tt>, <tt>refs/heads</tt>, <tt>refs/tags</tt>, and
346template files.
347An initial <tt>HEAD</tt> file that references the HEAD of the master branch
348is also created.</p>
349<p>If the <tt>$GIT_DIR</tt> environment variable is set then it specifies a path
350to use instead of <tt>./.git</tt> for the base of the repository.</p>
351<p>If the object storage directory is specified via the <tt>$GIT_OBJECT_DIRECTORY</tt>
352environment variable then the sha1 directories are created underneath -
353otherwise the default <tt>$GIT_DIR/objects</tt> directory is used.</p>
Junio C Hamano91f77a02007-01-12 02:43:42[diff] [blame]354<p>Running <tt>git-init</tt> in an existing repository is safe. It will not overwrite
355things that are already there. The primary reason for rerunning <tt>git-init</tt>
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]356is to pick up newly added templates.</p>
Junio C Hamano91f77a02007-01-12 02:43:42[diff] [blame]357<p>Note that <tt>git-init</tt> is the same as <tt>git-init-db</tt>. The command
358was primarily meant to initialize the object database, but over
359time it has become responsible for setting up the other aspects
360of the repository, such as installing the default hooks and
361setting the configuration variables. The old name is retained
Junio C Hamano24351a82007-01-13 08:09:17[diff] [blame]362for backward compatibility reasons.</p>
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]363</div>
364<h2>EXAMPLES</h2>
365<div class="sectionbody">
366<dl>
367<dt>
368Start a new git repository for an existing code base
369</dt>
370<dd>
371<div class="listingblock">
372<div class="content">
373<pre><tt>$ cd /path/to/my/codebase
Junio C Hamano91f77a02007-01-12 02:43:42[diff] [blame]374$ git-init <b>(1)</b>
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]375$ git-add . <b>(2)</b></tt></pre>
376</div></div>
377<ol>
378<li>
379<p>
380prepare /path/to/my/codebase/.git directory
381</p>
382</li>
383<li>
384<p>
385add all existing file to the index
386</p>
387</li>
388</ol>
389</dd>
390</dl>
391</div>
392<h2>Author</h2>
393<div class="sectionbody">
394<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
395</div>
396<h2>Documentation</h2>
397<div class="sectionbody">
398<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
399</div>
400<h2>GIT</h2>
401<div class="sectionbody">
402<p>Part of the <a href="git.html">git(7)</a> suite</p>
403</div>
404<div id="footer">
405<div id="footer-text">
Junio C Hamanobb6e0782007-07-19 02:14:50[diff] [blame]406Last updated 19-Jul-2007 02:09:44 UTC
Junio C Hamano617d8c42007-01-11 00:35:51[diff] [blame]407</div>
408</div>
409</body>
410</html>