Autogenerated HTML docs for v2.45.0-31-gd4cc1
[git-htmldocs.git] / git-init.html
blob8a329281c6d1d60ecdde260ab136655086d76a3f
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-init(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-init(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-init -
743 Create an empty Git repository or reinitialize an existing one
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><code>git init</code> [<code>-q</code> | <code>--quiet</code>] [<code>--bare</code>] [<code>--template=</code><em>&lt;template-directory&gt;</em>]
753 [<code>--separate-git-dir</code> <em>&lt;git-dir&gt;</em>] [<code>--object-format=</code><em>&lt;format&gt;</em>]
754 [<code>--ref-format=</code><em>&lt;format&gt;</em>]
755 [<code>-b</code> <em>&lt;branch-name&gt;</em> | <code>--initial-branch=</code><em>&lt;branch-name&gt;</em>]
756 [<code>--shared</code>[<code>=</code><em>&lt;permissions&gt;</em>]] [<em>&lt;directory&gt;</em>]</pre>
757 <div class="attribution">
758 </div></div>
759 </div>
760 </div>
761 <div class="sect1">
762 <h2 id="_description">DESCRIPTION</h2>
763 <div class="sectionbody">
764 <div class="paragraph"><p>This command creates an empty Git repository - basically a <code>.git</code>
765 directory with subdirectories for <code>objects</code>, <code>refs/heads</code>,
766 <code>refs/tags</code>, and template files. An initial branch without any
767 commits will be created (see the <code>--initial-branch</code> option below
768 for its name).</p></div>
769 <div class="paragraph"><p>If the <code>$GIT_DIR</code> environment variable is set then it specifies a path
770 to use instead of <code>./.git</code> for the base of the repository.</p></div>
771 <div class="paragraph"><p>If the object storage directory is specified via the
772 <code>$GIT_OBJECT_DIRECTORY</code> environment variable then the sha1 directories
773 are created underneath; otherwise, the default <code>$GIT_DIR/objects</code>
774 directory is used.</p></div>
775 <div class="paragraph"><p>Running <code>git init</code> in an existing repository is safe. It will not
776 overwrite things that are already there. The primary reason for
777 rerunning <code>git init</code> is to pick up newly added templates (or to move
778 the repository to another place if <code>--separate-git-dir</code> is given).</p></div>
779 </div>
780 </div>
781 <div class="sect1">
782 <h2 id="_options">OPTIONS</h2>
783 <div class="sectionbody">
784 <div class="dlist"><dl>
785 <dt class="hdlist1">
786 <code>-q</code>
787 </dt>
788 <dt class="hdlist1">
789 <code>--quiet</code>
790 </dt>
791 <dd>
793 Only print error and warning messages; all other output will be suppressed.
794 </p>
795 </dd>
796 <dt class="hdlist1">
797 <code>--bare</code>
798 </dt>
799 <dd>
801 Create a bare repository. If <code>GIT_DIR</code> environment is not set, it is set to the
802 current working directory.
803 </p>
804 </dd>
805 <dt class="hdlist1">
806 <code>--object-format=</code><em>&lt;format&gt;</em>
807 </dt>
808 <dd>
810 Specify the given object <em>&lt;format&gt;</em> (hash algorithm) for the repository. The valid
811 values are <code>sha1</code> and (if enabled) <code>sha256</code>. <code>sha1</code> is the default.
812 </p>
813 <div class="paragraph"><p>Note: At present, there is no interoperability between SHA-256
814 repositories and SHA-1 repositories.</p></div>
815 </dd>
816 </dl></div>
817 <div class="paragraph"><p>Historically, we warned that SHA-256 repositories may later need
818 backward incompatible changes when we introduce such interoperability
819 features. Today, we only expect compatible changes. Furthermore, if such
820 changes prove to be necessary, it can be expected that SHA-256 repositories
821 created with today&#8217;s Git will be usable by future versions of Git
822 without data loss.</p></div>
823 <div class="dlist"><dl>
824 <dt class="hdlist1">
825 <code>--ref-format=</code><em>&lt;format&gt;</em>
826 </dt>
827 <dd>
829 Specify the given ref storage <em>&lt;format&gt;</em> for the repository. The valid values are:
830 </p>
831 <div class="ulist"><ul>
832 <li>
834 <code>files</code> for loose files with packed-refs. This is the default.
835 </p>
836 </li>
837 <li>
839 <code>reftable</code> for the reftable format. This format is experimental and its
840 internals are subject to change.
841 </p>
842 </li>
843 </ul></div>
844 </dd>
845 <dt class="hdlist1">
846 <code>--template=</code><em>&lt;template-directory&gt;</em>
847 </dt>
848 <dd>
850 Specify the directory from which templates will be used. (See the "TEMPLATE
851 DIRECTORY" section below.)
852 </p>
853 </dd>
854 <dt class="hdlist1">
855 <code>--separate-git-dir=</code><em>&lt;git-dir&gt;</em>
856 </dt>
857 <dd>
859 Instead of initializing the repository as a directory to either <code>$GIT_DIR</code> or
860 <code>./.git/</code>, create a text file there containing the path to the actual
861 repository. This file acts as a filesystem-agnostic Git symbolic link to the
862 repository.
863 </p>
864 <div class="paragraph"><p>If this is a reinitialization, the repository will be moved to the specified path.</p></div>
865 </dd>
866 <dt class="hdlist1">
867 <code>-b</code> <em>&lt;branch-name&gt;</em>
868 </dt>
869 <dt class="hdlist1">
870 <code>--initial-branch=</code><em>&lt;branch-name&gt;</em>
871 </dt>
872 <dd>
874 Use <em>&lt;branch-name&gt;</em> for the initial branch in the newly created
875 repository. If not specified, fall back to the default name (currently
876 <code>master</code>, but this is subject to change in the future; the name can be
877 customized via the <code>init.defaultBranch</code> configuration variable).
878 </p>
879 </dd>
880 <dt class="hdlist1">
881 <code>--shared</code>[<code>=</code>(<code>false</code>|<code>true</code>|<code>umask</code>|<code>group</code>|<code>all</code>|<code>world</code>|<code>everybody</code>|<em>&lt;perm&gt;</em>)]
882 </dt>
883 <dd>
885 Specify that the Git repository is to be shared amongst several users. This
886 allows users belonging to the same group to push into that
887 repository. When specified, the config variable <code>core.sharedRepository</code> is
888 set so that files and directories under <code>$GIT_DIR</code> are created with the
889 requested permissions. When not specified, Git will use permissions reported
890 by <code>umask</code>(2).
891 </p>
892 <div class="paragraph"><p>The option can have the following values, defaulting to <code>group</code> if no value
893 is given:</p></div>
894 <div class="openblock">
895 <div class="content">
896 <div class="dlist"><dl>
897 <dt class="hdlist1">
898 <code>umask</code>
899 </dt>
900 <dt class="hdlist1">
901 <code>false</code>
902 </dt>
903 <dd>
905 Use permissions reported by <code>umask</code>(2). The default, when <code>--shared</code> is not
906 specified.
907 </p>
908 </dd>
909 <dt class="hdlist1">
910 <code>group</code>
911 </dt>
912 <dt class="hdlist1">
913 <code>true</code>
914 </dt>
915 <dd>
917 Make the repository group-writable, (and <code>g+sx</code>, since the git group may not be
918 the primary group of all users). This is used to loosen the permissions of an
919 otherwise safe <code>umask</code>(2) value. Note that the umask still applies to the other
920 permission bits (e.g. if umask is <code>0022</code>, using <code>group</code> will not remove read
921 privileges from other (non-group) users). See <code>0xxx</code> for how to exactly specify
922 the repository permissions.
923 </p>
924 </dd>
925 <dt class="hdlist1">
926 <code>all</code>
927 </dt>
928 <dt class="hdlist1">
929 <code>world</code>
930 </dt>
931 <dt class="hdlist1">
932 <code>everybody</code>
933 </dt>
934 <dd>
936 Same as <code>group</code>, but make the repository readable by all users.
937 </p>
938 </dd>
939 <dt class="hdlist1">
940 <em>&lt;perm&gt;</em>
941 </dt>
942 <dd>
944 <em>&lt;perm&gt;</em> is a 3-digit octal number prefixed with &#8216;0` and each file
945 will have mode <em>&lt;perm&gt;</em>. <em>&lt;perm&gt;</em> will override users&#8217; <code>umask</code>(2)
946 value (and not only loosen permissions as <code>group</code> and <code>all</code>
947 do). <code>0640</code> will create a repository which is group-readable, but
948 not group-writable or accessible to others. <code>0660</code> will create a repo
949 that is readable and writable to the current user and group, but
950 inaccessible to others (directories and executable files get their
951 <code>x</code> bit from the <code>r</code> bit for corresponding classes of users).
952 </p>
953 </dd>
954 </dl></div>
955 </div></div>
956 </dd>
957 </dl></div>
958 <div class="paragraph"><p>By default, the configuration flag <code>receive.denyNonFastForwards</code> is enabled
959 in shared repositories, so that you cannot force a non fast-forwarding push
960 into it.</p></div>
961 <div class="paragraph"><p>If you provide a <em>&lt;directory&gt;</em>, the command is run inside it. If this directory
962 does not exist, it will be created.</p></div>
963 </div>
964 </div>
965 <div class="sect1">
966 <h2 id="_template_directory">TEMPLATE DIRECTORY</h2>
967 <div class="sectionbody">
968 <div class="paragraph"><p>Files and directories in the template directory whose name do not start with a
969 dot will be copied to the <code>$GIT_DIR</code> after it is created.</p></div>
970 <div class="paragraph"><p>The template directory will be one of the following (in order):</p></div>
971 <div class="ulist"><ul>
972 <li>
974 the argument given with the <code>--template</code> option;
975 </p>
976 </li>
977 <li>
979 the contents of the <code>$GIT_TEMPLATE_DIR</code> environment variable;
980 </p>
981 </li>
982 <li>
984 the <code>init.templateDir</code> configuration variable; or
985 </p>
986 </li>
987 <li>
989 the default template directory: <code>/usr/share/git-core/templates</code>.
990 </p>
991 </li>
992 </ul></div>
993 <div class="paragraph"><p>The default template directory includes some directory structure, suggested
994 "exclude patterns" (see <a href="gitignore.html">gitignore(5)</a>), and sample hook files.</p></div>
995 <div class="paragraph"><p>The sample hooks are all disabled by default. To enable one of the
996 sample hooks rename it by removing its <code>.sample</code> suffix.</p></div>
997 <div class="paragraph"><p>See <a href="githooks.html">githooks(5)</a> for more general info on hook execution.</p></div>
998 </div>
999 </div>
1000 <div class="sect1">
1001 <h2 id="_examples">EXAMPLES</h2>
1002 <div class="sectionbody">
1003 <div class="dlist"><dl>
1004 <dt class="hdlist1">
1005 Start a new Git repository for an existing code base
1006 </dt>
1007 <dd>
1008 <div class="listingblock">
1009 <div class="content">
1010 <pre><code>$ cd /path/to/my/codebase
1011 $ git init <b>&lt;1&gt;</b>
1012 $ git add . <b>&lt;2&gt;</b>
1013 $ git commit <b>&lt;3&gt;</b></code></pre>
1014 </div></div>
1015 <div class="colist arabic"><ol>
1016 <li>
1018 Create a <code>/path/to/my/codebase/.git</code> directory.
1019 </p>
1020 </li>
1021 <li>
1023 Add all existing files to the index.
1024 </p>
1025 </li>
1026 <li>
1028 Record the pristine state as the first commit in the history.
1029 </p>
1030 </li>
1031 </ol></div>
1032 </dd>
1033 </dl></div>
1034 </div>
1035 </div>
1036 <div class="sect1">
1037 <h2 id="_configuration">CONFIGURATION</h2>
1038 <div class="sectionbody">
1039 <div class="paragraph"><p>Everything below this line in this section is selectively included
1040 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1041 as what&#8217;s found there:</p></div>
1042 <div class="dlist"><dl>
1043 <dt class="hdlist1">
1044 <code>init.templateDir</code>
1045 </dt>
1046 <dd>
1048 Specify the directory from which templates will be copied.
1049 </p>
1050 </dd>
1051 <dt class="hdlist1">
1052 <code>init.defaultBranch</code>
1053 </dt>
1054 <dd>
1056 Allows overriding the default branch name e.g. when initializing
1057 a new repository.
1058 </p>
1059 </dd>
1060 </dl></div>
1061 </div>
1062 </div>
1063 <div class="sect1">
1064 <h2 id="_git">GIT</h2>
1065 <div class="sectionbody">
1066 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1067 </div>
1068 </div>
1069 </div>
1070 <div id="footnotes"><hr /></div>
1071 <div id="footer">
1072 <div id="footer-text">
1073 Last updated
1074 2024-04-09 14:45:01 PDT
1075 </div>
1076 </div>
1077 </body>
1078 </html>