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