git-init.html

   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 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-init(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-init(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-init -
 317    Create an empty git repository or reinitialize an existing one
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>git init</em> [-q | --quiet] [--bare] [--template=&lt;template_directory&gt;] [--shared[=&lt;permissions&gt;]] [directory]</p></div>
 324 </div>
 325 <h2 id="_options">OPTIONS</h2>
 326 <div class="sectionbody">
 327 <div class="vlist"><dl>
 328 <dt>
 329 -q
 330 </dt>
 331 <dt>
 332 --quiet
 333 </dt>
 334 <dd>
 335 <p>
 336 Only print error and warning messages, all other output will be suppressed.
 337 </p>
 338 </dd>
 339 <dt>
 340 --bare
 341 </dt>
 342 <dd>
 343 <p>
 344 Create a bare repository. If GIT_DIR environment is not set, it is set to the
 345 current working directory.
 346 </p>
 347 </dd>
 348 <dt>
 349 --template=&lt;template_directory&gt;
 350 </dt>
 351 <dd>
 352 <p>
 353 Specify the directory from which templates will be used.  (See the "TEMPLATE
 354 DIRECTORY" section below.)
 355 </p>
 356 </dd>
 357 <dt>
 358 --shared[={false|true|umask|group|all|world|everybody|0xxx}]
 359 </dt>
 360 <dd>
 361 <p>
 362 Specify that the git repository is to be shared amongst several users.  This
 363 allows users belonging to the same group to push into that
 364 repository.  When specified, the config variable "core.sharedRepository" is
 365 set so that files and directories under <tt>$GIT_DIR</tt> are created with the
 366 requested permissions.  When not specified, git will use permissions reported
 367 by umask(2).
 368 </p>
 369 <div class="para"><p>The option can have the following values, defaulting to <em>group</em> if no value
 370 is given:</p></div>
 371 <div class="ilist"><ul>
 372 <li>
 373 <p>
 374 <em>umask</em> (or <em>false</em>): Use permissions reported by umask(2). The default,
 375    when <tt>--shared</tt> is not specified.
 376 </p>
 377 </li>
 378 <li>
 379 <p>
 380 <em>group</em> (or <em>true</em>): Make the repository group-writable, (and g+sx, since
 381    the git group may be not the primary group of all users).
 382    This is used to loosen the permissions of an otherwise safe umask(2) value.
 383    Note that the umask still applies to the other permission bits (e.g. if
 384    umask is <em>0022</em>, using <em>group</em> will not remove read privileges from other
 385    (non-group) users). See <em>0xxx</em> for how to exactly specify the repository
 386    permissions.
 387 </p>
 388 </li>
 389 <li>
 390 <p>
 391 <em>all</em> (or <em>world</em> or <em>everybody</em>): Same as <em>group</em>, but make the repository
 392    readable by all users.
 393 </p>
 394 </li>
 395 <li>
 396 <p>
 397 <em>0xxx</em>: <em>0xxx</em> is an octal number and each file will have mode <em>0xxx</em>.
 398    <em>0xxx</em> will override users' umask(2) value (and not only loosen permissions
 399    as <em>group</em> and <em>all</em> does). <em>0640</em> will create a repository which is
 400    group-readable, but not group-writable or accessible to others. <em>0660</em> will
 401    create a repo that is readable and writable to the current user and group,
 402    but inaccessible to others.
 403 </p>
 404 <div class="para"><p>By default, the configuration flag receive.denyNonFastForwards is enabled
 405 in shared repositories, so that you cannot force a non fast-forwarding push
 406 into it.</p></div>
 407 <div class="para"><p>If you name a (possibly non-existent) directory at the end of the command
 408 line, the command is run inside the directory (possibly after creating it).</p></div>
 409 </li>
 410 </ul></div>
 411 </dd>
 412 </dl></div>
 413 </div>
 414 <h2 id="_description">DESCRIPTION</h2>
 415 <div class="sectionbody">
 416 <div class="para"><p>This command creates an empty git repository - basically a <tt>.git</tt> directory
 417 with subdirectories for <tt>objects</tt>, <tt>refs/heads</tt>, <tt>refs/tags</tt>, and
 418 template files.
 419 An initial <tt>HEAD</tt> file that references the HEAD of the master branch
 420 is also created.</p></div>
 421 <div class="para"><p>If the <tt>$GIT_DIR</tt> environment variable is set then it specifies a path
 422 to use instead of <tt>./.git</tt> for the base of the repository.</p></div>
 423 <div class="para"><p>If the object storage directory is specified via the <tt>$GIT_OBJECT_DIRECTORY</tt>
 424 environment variable then the sha1 directories are created underneath -
 425 otherwise the default <tt>$GIT_DIR/objects</tt> directory is used.</p></div>
 426 <div class="para"><p>Running <em>git init</em> in an existing repository is safe. It will not overwrite
 427 things that are already there. The primary reason for rerunning <em>git init</em>
 428 is to pick up newly added templates.</p></div>
 429 <div class="para"><p>Note that <em>git init</em> is the same as <em>git init-db</em>.  The command
 430 was primarily meant to initialize the object database, but over
 431 time it has become responsible for setting up the other aspects
 432 of the repository, such as installing the default hooks and
 433 setting the configuration variables.  The old name is retained
 434 for backward compatibility reasons.</p></div>
 435 </div>
 436 <h2 id="_template_directory">TEMPLATE DIRECTORY</h2>
 437 <div class="sectionbody">
 438 <div class="para"><p>The template directory contains files and directories that will be copied to
 439 the <tt>$GIT_DIR</tt> after it is created.</p></div>
 440 <div class="para"><p>The template directory used will (in order):</p></div>
 441 <div class="ilist"><ul>
 442 <li>
 443 <p>
 444 The argument given with the <tt>--template</tt> option.
 445 </p>
 446 </li>
 447 <li>
 448 <p>
 449 The contents of the <tt>$GIT_TEMPLATE_DIR</tt> environment variable.
 450 </p>
 451 </li>
 452 <li>
 453 <p>
 454 The <tt>init.templatedir</tt> configuration variable.
 455 </p>
 456 </li>
 457 <li>
 458 <p>
 459 The default template directory: <tt>/usr/share/git-core/templates</tt>.
 460 </p>
 461 </li>
 462 </ul></div>
 463 <div class="para"><p>The default template directory includes some directory structure, some
 464 suggested "exclude patterns", and copies of sample "hook" files.
 465 The suggested patterns and hook files are all modifiable and extensible.</p></div>
 466 </div>
 467 <h2 id="_examples">EXAMPLES</h2>
 468 <div class="sectionbody">
 469 <div class="vlist"><dl>
 470 <dt>
 471 Start a new git repository for an existing code base
 472 </dt>
 473 <dd>
 474 <div class="listingblock">
 475 <div class="content">
 476 <pre><tt>$ cd /path/to/my/codebase
 477 $ git init      <b>(1)</b>
 478 $ git add .     <b>(2)</b></tt></pre>
 479 </div></div>
 480 <div class="colist"><ol>
 481 <li>
 482 <p>
 483 prepare /path/to/my/codebase/.git directory
 484 </p>
 485 </li>
 486 <li>
 487 <p>
 488 add all existing file to the index
 489 </p>
 490 </li>
 491 </ol></div>
 492 </dd>
 493 </dl></div>
 494 </div>
 495 <h2 id="_author">Author</h2>
 496 <div class="sectionbody">
 497 <div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
 498 </div>
 499 <h2 id="_documentation">Documentation</h2>
 500 <div class="sectionbody">
 501 <div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 502 </div>
 503 <h2 id="_git">GIT</h2>
 504 <div class="sectionbody">
 505 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 506 </div>
 507 <div id="footer">
 508 <div id="footer-text">
 509 Last updated 2010-04-24 02:55:58 UTC
 510 </div>
 511 </div>
 512 </body>
 513 </html>