blob: 129194aa294c0afc423f990ba79b251f83fadb41 [file] [log] [blame]
Junio C Hamano0df92712011-12-21 22:30:441<!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>
Junio C Hamano9d971152012-12-19 00:43:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano61525f92014-01-17 22:46:496<meta name="generator" content="AsciiDoc 8.6.6" />
Junio C Hamano0df92712011-12-21 22:30:447<title>gitcredentials(7)</title>
8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano0df92712011-12-21 22:30:4424}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
37
38em {
39 font-style: italic;
40 color: navy;
41}
42
43strong {
44 font-weight: bold;
45 color: #083194;
46}
47
Junio C Hamano0df92712011-12-21 22:30:4448h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:4450 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
55h1, h2, h3 {
56 border-bottom: 2px solid silver;
57}
58h2 {
59 padding-top: 0.5em;
60}
61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamano0df92712011-12-21 22:30:4470
71div.sectionbody {
Junio C Hamano0df92712011-12-21 22:30:4472 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano0df92712011-12-21 22:30:4489
Junio C Hamano61525f92014-01-17 22:46:4990pre {
Junio C Hamano0df92712011-12-21 22:30:4491 padding: 0;
92 margin: 0;
93}
94
Junio C Hamano9d971152012-12-19 00:43:1195#author {
Junio C Hamano0df92712011-12-21 22:30:4496 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:4497 font-weight: bold;
98 font-size: 1.1em;
99}
Junio C Hamano9d971152012-12-19 00:43:11100#email {
Junio C Hamano0df92712011-12-21 22:30:44101}
Junio C Hamano9d971152012-12-19 00:43:11102#revnumber, #revdate, #revremark {
Junio C Hamano0df92712011-12-21 22:30:44103}
104
Junio C Hamano9d971152012-12-19 00:43:11105#footer {
Junio C Hamano0df92712011-12-21 22:30:44106 font-size: small;
107 border-top: 2px solid silver;
108 padding-top: 0.5em;
109 margin-top: 4.0em;
110}
Junio C Hamano9d971152012-12-19 00:43:11111#footer-text {
Junio C Hamano0df92712011-12-21 22:30:44112 float: left;
113 padding-bottom: 0.5em;
114}
Junio C Hamano9d971152012-12-19 00:43:11115#footer-badges {
Junio C Hamano0df92712011-12-21 22:30:44116 float: right;
117 padding-bottom: 0.5em;
118}
119
Junio C Hamano9d971152012-12-19 00:43:11120#preamble {
Junio C Hamano0df92712011-12-21 22:30:44121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
123}
Junio C Hamano9d971152012-12-19 00:43:11124div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano0df92712011-12-21 22:30:44125div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
126div.admonitionblock {
127 margin-top: 1.0em;
128 margin-bottom: 1.5em;
129}
130div.admonitionblock {
131 margin-top: 2.0em;
132 margin-bottom: 2.0em;
133 margin-right: 10%;
134 color: #606060;
135}
136
137div.content { /* Block element content. */
138 padding: 0;
139}
140
141/* Block element titles. */
142div.title, caption.title {
143 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44144 font-weight: bold;
145 text-align: left;
146 margin-top: 1.0em;
147 margin-bottom: 0.5em;
148}
149div.title + * {
150 margin-top: 0;
151}
152
153td div.title:first-child {
154 margin-top: 0.0em;
155}
156div.content div.title:first-child {
157 margin-top: 0.0em;
158}
159div.content + div.title {
160 margin-top: 0.0em;
161}
162
163div.sidebarblock > div.content {
164 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11165 border: 1px solid #dddddd;
166 border-left: 4px solid #f0f0f0;
Junio C Hamano0df92712011-12-21 22:30:44167 padding: 0.5em;
168}
169
170div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 5px solid #f0f0f0;
173 background: #f8f8f8;
Junio C Hamano0df92712011-12-21 22:30:44174 padding: 0.5em;
175}
176
177div.quoteblock, div.verseblock {
178 padding-left: 1.0em;
179 margin-left: 1.0em;
180 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11181 border-left: 5px solid #f0f0f0;
182 color: #888;
Junio C Hamano0df92712011-12-21 22:30:44183}
184
185div.quoteblock > div.attribution {
186 padding-top: 0.5em;
187 text-align: right;
188}
189
Junio C Hamano9d971152012-12-19 00:43:11190div.verseblock > pre.content {
191 font-family: inherit;
192 font-size: inherit;
Junio C Hamano0df92712011-12-21 22:30:44193}
194div.verseblock > div.attribution {
195 padding-top: 0.75em;
196 text-align: left;
197}
198/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
199div.verseblock + div.attribution {
200 text-align: left;
201}
202
203div.admonitionblock .icon {
204 vertical-align: top;
205 font-size: 1.1em;
206 font-weight: bold;
207 text-decoration: underline;
208 color: #527bbd;
209 padding-right: 0.5em;
210}
211div.admonitionblock td.content {
212 padding-left: 0.5em;
213 border-left: 3px solid #dddddd;
214}
215
216div.exampleblock > div.content {
217 border-left: 3px solid #dddddd;
218 padding-left: 0.5em;
219}
220
221div.imageblock div.content { padding-left: 0; }
222span.image img { border-style: none; }
223a.image:visited { color: white; }
224
225dl {
226 margin-top: 0.8em;
227 margin-bottom: 0.8em;
228}
229dt {
230 margin-top: 0.5em;
231 margin-bottom: 0;
232 font-style: normal;
233 color: navy;
234}
235dd > *:first-child {
236 margin-top: 0.1em;
237}
238
239ul, ol {
240 list-style-position: outside;
241}
242ol.arabic {
243 list-style-type: decimal;
244}
245ol.loweralpha {
246 list-style-type: lower-alpha;
247}
248ol.upperalpha {
249 list-style-type: upper-alpha;
250}
251ol.lowerroman {
252 list-style-type: lower-roman;
253}
254ol.upperroman {
255 list-style-type: upper-roman;
256}
257
258div.compact ul, div.compact ol,
259div.compact p, div.compact p,
260div.compact div, div.compact div {
261 margin-top: 0.1em;
262 margin-bottom: 0.1em;
263}
264
Junio C Hamano0df92712011-12-21 22:30:44265tfoot {
266 font-weight: bold;
267}
268td > div.verse {
269 white-space: pre;
270}
Junio C Hamano0df92712011-12-21 22:30:44271
272div.hdlist {
273 margin-top: 0.8em;
274 margin-bottom: 0.8em;
275}
276div.hdlist tr {
277 padding-bottom: 15px;
278}
279dt.hdlist1.strong, td.hdlist1.strong {
280 font-weight: bold;
281}
282td.hdlist1 {
283 vertical-align: top;
284 font-style: normal;
285 padding-right: 0.8em;
286 color: navy;
287}
288td.hdlist2 {
289 vertical-align: top;
290}
291div.hdlist.compact tr {
292 margin: 0;
293 padding-bottom: 0;
294}
295
296.comment {
297 background: yellow;
298}
299
300.footnote, .footnoteref {
301 font-size: 0.8em;
302}
303
304span.footnote, span.footnoteref {
305 vertical-align: super;
306}
307
308#footnotes {
309 margin: 20px 0 20px 0;
310 padding: 7px 0 0 0;
311}
312
313#footnotes div.footnote {
314 margin: 0 0 5px 0;
315}
316
317#footnotes hr {
318 border: none;
319 border-top: 1px solid silver;
320 height: 1px;
321 text-align: left;
322 margin-left: 0;
323 width: 20%;
324 min-width: 100px;
325}
326
Junio C Hamano9d971152012-12-19 00:43:11327div.colist td {
328 padding-right: 0.5em;
329 padding-bottom: 0.3em;
330 vertical-align: top;
331}
332div.colist td img {
333 margin-top: 0.3em;
Junio C Hamano0df92712011-12-21 22:30:44334}
335
Junio C Hamano9d971152012-12-19 00:43:11336@media print {
337 #footer-badges { display: none; }
338}
339
340#toc {
Junio C Hamano0df92712011-12-21 22:30:44341 margin-bottom: 2.5em;
342}
343
Junio C Hamano9d971152012-12-19 00:43:11344#toctitle {
Junio C Hamano0df92712011-12-21 22:30:44345 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44346 font-size: 1.1em;
347 font-weight: bold;
348 margin-top: 1.0em;
349 margin-bottom: 0.1em;
350}
351
Junio C Hamano61525f92014-01-17 22:46:49352div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano0df92712011-12-21 22:30:44353 margin-top: 0;
354 margin-bottom: 0;
355}
356div.toclevel2 {
357 margin-left: 2em;
358 font-size: 0.9em;
359}
360div.toclevel3 {
361 margin-left: 4em;
362 font-size: 0.9em;
363}
364div.toclevel4 {
365 margin-left: 6em;
366 font-size: 0.9em;
367}
Junio C Hamano9d971152012-12-19 00:43:11368
369span.aqua { color: aqua; }
370span.black { color: black; }
371span.blue { color: blue; }
372span.fuchsia { color: fuchsia; }
373span.gray { color: gray; }
374span.green { color: green; }
375span.lime { color: lime; }
376span.maroon { color: maroon; }
377span.navy { color: navy; }
378span.olive { color: olive; }
379span.purple { color: purple; }
380span.red { color: red; }
381span.silver { color: silver; }
382span.teal { color: teal; }
383span.white { color: white; }
384span.yellow { color: yellow; }
385
386span.aqua-background { background: aqua; }
387span.black-background { background: black; }
388span.blue-background { background: blue; }
389span.fuchsia-background { background: fuchsia; }
390span.gray-background { background: gray; }
391span.green-background { background: green; }
392span.lime-background { background: lime; }
393span.maroon-background { background: maroon; }
394span.navy-background { background: navy; }
395span.olive-background { background: olive; }
396span.purple-background { background: purple; }
397span.red-background { background: red; }
398span.silver-background { background: silver; }
399span.teal-background { background: teal; }
400span.white-background { background: white; }
401span.yellow-background { background: yellow; }
402
403span.big { font-size: 2em; }
404span.small { font-size: 0.6em; }
405
406span.underline { text-decoration: underline; }
407span.overline { text-decoration: overline; }
408span.line-through { text-decoration: line-through; }
409
Junio C Hamano9d971152012-12-19 00:43:11410
411/*
412 * xhtml11 specific
413 *
414 * */
415
Junio C Hamano61525f92014-01-17 22:46:49416tt {
417 font-family: monospace;
418 font-size: inherit;
419 color: navy;
420}
421
Junio C Hamano9d971152012-12-19 00:43:11422div.tableblock {
423 margin-top: 1.0em;
424 margin-bottom: 1.5em;
425}
426div.tableblock > table {
427 border: 3px solid #527bbd;
428}
429thead, p.table.header {
430 font-weight: bold;
431 color: #527bbd;
432}
433p.table {
434 margin-top: 0;
435}
436/* Because the table frame attribute is overriden by CSS in most browsers. */
437div.tableblock > table[frame="void"] {
438 border-style: none;
439}
440div.tableblock > table[frame="hsides"] {
441 border-left-style: none;
442 border-right-style: none;
443}
444div.tableblock > table[frame="vsides"] {
445 border-top-style: none;
446 border-bottom-style: none;
447}
448
449
450/*
451 * html5 specific
452 *
453 * */
454
Junio C Hamano61525f92014-01-17 22:46:49455.monospaced {
456 font-family: monospace;
457 font-size: inherit;
458 color: navy;
459}
460
Junio C Hamano9d971152012-12-19 00:43:11461table.tableblock {
462 margin-top: 1.0em;
463 margin-bottom: 1.5em;
464}
465thead, p.tableblock.header {
466 font-weight: bold;
467 color: #527bbd;
468}
469p.tableblock {
470 margin-top: 0;
471}
472table.tableblock {
473 border-width: 3px;
474 border-spacing: 0px;
475 border-style: solid;
476 border-color: #527bbd;
477 border-collapse: collapse;
478}
479th.tableblock, td.tableblock {
480 border-width: 1px;
481 padding: 4px;
482 border-style: solid;
483 border-color: #527bbd;
484}
485
486table.tableblock.frame-topbot {
487 border-left-style: hidden;
488 border-right-style: hidden;
489}
490table.tableblock.frame-sides {
491 border-top-style: hidden;
492 border-bottom-style: hidden;
493}
494table.tableblock.frame-none {
495 border-style: hidden;
496}
497
498th.tableblock.halign-left, td.tableblock.halign-left {
499 text-align: left;
500}
501th.tableblock.halign-center, td.tableblock.halign-center {
502 text-align: center;
503}
504th.tableblock.halign-right, td.tableblock.halign-right {
505 text-align: right;
506}
507
508th.tableblock.valign-top, td.tableblock.valign-top {
509 vertical-align: top;
510}
511th.tableblock.valign-middle, td.tableblock.valign-middle {
512 vertical-align: middle;
513}
514th.tableblock.valign-bottom, td.tableblock.valign-bottom {
515 vertical-align: bottom;
516}
517
518
519/*
520 * manpage specific
521 *
522 * */
523
524body.manpage h1 {
Junio C Hamano0df92712011-12-21 22:30:44525 padding-top: 0.5em;
526 padding-bottom: 0.5em;
527 border-top: 2px solid silver;
528 border-bottom: 2px solid silver;
529}
Junio C Hamano9d971152012-12-19 00:43:11530body.manpage h2 {
Junio C Hamano0df92712011-12-21 22:30:44531 border-style: none;
532}
Junio C Hamano9d971152012-12-19 00:43:11533body.manpage div.sectionbody {
534 margin-left: 3em;
Junio C Hamano0df92712011-12-21 22:30:44535}
536
537@media print {
Junio C Hamano9d971152012-12-19 00:43:11538 body.manpage div#toc { display: none; }
Junio C Hamano0df92712011-12-21 22:30:44539}
Junio C Hamano0df92712011-12-21 22:30:44540</style>
541<script type="text/javascript">
542/*<![CDATA[*/
Junio C Hamano0df92712011-12-21 22:30:44543var asciidoc = { // Namespace.
544
545/////////////////////////////////////////////////////////////////////
546// Table Of Contents generator
547/////////////////////////////////////////////////////////////////////
548
549/* Author: Mihai Bazon, September 2002
550 * http://students.infoiasi.ro/~mishoo
551 *
552 * Table Of Content generator
553 * Version: 0.4
554 *
555 * Feel free to use this script under the terms of the GNU General Public
556 * License, as long as you do not remove or alter this notice.
557 */
558
559 /* modified by Troy D. Hanson, September 2006. License: GPL */
560 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561
562// toclevels = 1..4.
563toc: function (toclevels) {
564
565 function getText(el) {
566 var text = "";
567 for (var i = el.firstChild; i != null; i = i.nextSibling) {
568 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
569 text += i.data;
570 else if (i.firstChild != null)
571 text += getText(i);
572 }
573 return text;
574 }
575
576 function TocEntry(el, text, toclevel) {
577 this.element = el;
578 this.text = text;
579 this.toclevel = toclevel;
580 }
581
582 function tocEntries(el, toclevels) {
583 var result = new Array;
Junio C Hamano61525f92014-01-17 22:46:49584 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
Junio C Hamano0df92712011-12-21 22:30:44585 // Function that scans the DOM tree for header elements (the DOM2
586 // nodeIterator API would be a better technique but not supported by all
587 // browsers).
588 var iterate = function (el) {
589 for (var i = el.firstChild; i != null; i = i.nextSibling) {
590 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
591 var mo = re.exec(i.tagName);
592 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
593 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 }
595 iterate(i);
596 }
597 }
598 }
599 iterate(el);
600 return result;
601 }
602
603 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11604 if (!toc) {
605 return;
606 }
607
608 // Delete existing TOC entries in case we're reloading the TOC.
609 var tocEntriesToRemove = [];
610 var i;
611 for (i = 0; i < toc.childNodes.length; i++) {
612 var entry = toc.childNodes[i];
Junio C Hamano61525f92014-01-17 22:46:49613 if (entry.nodeName == 'div'
Junio C Hamano9d971152012-12-19 00:43:11614 && entry.getAttribute("class")
615 && entry.getAttribute("class").match(/^toclevel/))
616 tocEntriesToRemove.push(entry);
617 }
618 for (i = 0; i < tocEntriesToRemove.length; i++) {
619 toc.removeChild(tocEntriesToRemove[i]);
620 }
621
622 // Rebuild TOC entries.
Junio C Hamano0df92712011-12-21 22:30:44623 var entries = tocEntries(document.getElementById("content"), toclevels);
624 for (var i = 0; i < entries.length; ++i) {
625 var entry = entries[i];
626 if (entry.element.id == "")
627 entry.element.id = "_toc_" + i;
628 var a = document.createElement("a");
629 a.href = "#" + entry.element.id;
630 a.appendChild(document.createTextNode(entry.text));
631 var div = document.createElement("div");
632 div.appendChild(a);
633 div.className = "toclevel" + entry.toclevel;
634 toc.appendChild(div);
635 }
636 if (entries.length == 0)
637 toc.parentNode.removeChild(toc);
638},
639
640
641/////////////////////////////////////////////////////////////////////
642// Footnotes generator
643/////////////////////////////////////////////////////////////////////
644
645/* Based on footnote generation code from:
646 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
647 */
648
649footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11650 // Delete existing footnote entries in case we're reloading the footnodes.
651 var i;
Junio C Hamano0df92712011-12-21 22:30:44652 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11653 if (!noteholder) {
654 return;
655 }
656 var entriesToRemove = [];
657 for (i = 0; i < noteholder.childNodes.length; i++) {
658 var entry = noteholder.childNodes[i];
Junio C Hamano61525f92014-01-17 22:46:49659 if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11660 entriesToRemove.push(entry);
661 }
662 for (i = 0; i < entriesToRemove.length; i++) {
663 noteholder.removeChild(entriesToRemove[i]);
664 }
665
666 // Rebuild footnote entries.
667 var cont = document.getElementById("content");
Junio C Hamano0df92712011-12-21 22:30:44668 var spans = cont.getElementsByTagName("span");
669 var refs = {};
670 var n = 0;
671 for (i=0; i<spans.length; i++) {
672 if (spans[i].className == "footnote") {
673 n++;
Junio C Hamano9d971152012-12-19 00:43:11674 var note = spans[i].getAttribute("data-note");
675 if (!note) {
676 // Use [\s\S] in place of . so multi-line matches work.
677 // Because JavaScript has no s (dotall) regex flag.
678 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
679 spans[i].innerHTML =
680 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
681 "' title='View footnote' class='footnote'>" + n + "</a>]";
682 spans[i].setAttribute("data-note", note);
683 }
Junio C Hamano0df92712011-12-21 22:30:44684 noteholder.innerHTML +=
685 "<div class='footnote' id='_footnote_" + n + "'>" +
686 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
687 n + "</a>. " + note + "</div>";
Junio C Hamano0df92712011-12-21 22:30:44688 var id =spans[i].getAttribute("id");
689 if (id != null) refs["#"+id] = n;
690 }
691 }
692 if (n == 0)
693 noteholder.parentNode.removeChild(noteholder);
694 else {
695 // Process footnoterefs.
696 for (i=0; i<spans.length; i++) {
697 if (spans[i].className == "footnoteref") {
698 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
699 href = href.match(/#.*/)[0]; // Because IE return full URL.
700 n = refs[href];
701 spans[i].innerHTML =
702 "[<a href='#_footnote_" + n +
703 "' title='View footnote' class='footnote'>" + n + "</a>]";
704 }
705 }
706 }
Junio C Hamano9d971152012-12-19 00:43:11707},
708
709install: function(toclevels) {
710 var timerId;
711
712 function reinstall() {
713 asciidoc.footnotes();
714 if (toclevels) {
715 asciidoc.toc(toclevels);
716 }
717 }
718
719 function reinstallAndRemoveTimer() {
720 clearInterval(timerId);
721 reinstall();
722 }
723
724 timerId = setInterval(reinstall, 500);
725 if (document.addEventListener)
726 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
727 else
728 window.onload = reinstallAndRemoveTimer;
Junio C Hamano0df92712011-12-21 22:30:44729}
730
731}
Junio C Hamano9d971152012-12-19 00:43:11732asciidoc.install();
Junio C Hamano0df92712011-12-21 22:30:44733/*]]>*/
734</script>
735</head>
Junio C Hamano9d971152012-12-19 00:43:11736<body class="manpage">
Junio C Hamano0df92712011-12-21 22:30:44737<div id="header">
738<h1>
739gitcredentials(7) Manual Page
740</h1>
741<h2>NAME</h2>
742<div class="sectionbody">
743<p>gitcredentials -
Junio C Hamano076ffcc2013-02-06 05:13:21744 providing usernames and passwords to Git
Junio C Hamano0df92712011-12-21 22:30:44745</p>
746</div>
747</div>
748<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11749<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44750<h2 id="_synopsis">SYNOPSIS</h2>
751<div class="sectionbody">
752<div class="listingblock">
753<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49754<pre><tt>git config credential.https://example.com.username myusername
755git config credential.helper "$helper $options"</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44756</div></div>
757</div>
Junio C Hamano9d971152012-12-19 00:43:11758</div>
759<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44760<h2 id="_description">DESCRIPTION</h2>
761<div class="sectionbody">
762<div class="paragraph"><p>Git will sometimes need credentials from the user in order to perform
763operations; for example, it may need to ask for a username and password
764in order to access a remote repository over HTTP. This manual describes
Junio C Hamano076ffcc2013-02-06 05:13:21765the mechanisms Git uses to request these credentials, as well as some
Junio C Hamano0df92712011-12-21 22:30:44766features to avoid inputting these credentials repeatedly.</p></div>
767</div>
Junio C Hamano9d971152012-12-19 00:43:11768</div>
769<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44770<h2 id="_requesting_credentials">REQUESTING CREDENTIALS</h2>
771<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21772<div class="paragraph"><p>Without any credential helpers defined, Git will try the following
Junio C Hamano0df92712011-12-21 22:30:44773strategies to ask the user for usernames and passwords:</p></div>
774<div class="olist arabic"><ol class="arabic">
775<li>
776<p>
Junio C Hamano61525f92014-01-17 22:46:49777If the <tt>GIT_ASKPASS</tt> environment variable is set, the program
Junio C Hamano0df92712011-12-21 22:30:44778 specified by the variable is invoked. A suitable prompt is provided
779 to the program on the command line, and the user&#8217;s input is read
780 from its standard output.
781</p>
782</li>
783<li>
784<p>
Junio C Hamano61525f92014-01-17 22:46:49785Otherwise, if the <tt>core.askpass</tt> configuration variable is set, its
Junio C Hamano0df92712011-12-21 22:30:44786 value is used as above.
787</p>
788</li>
789<li>
790<p>
Junio C Hamano61525f92014-01-17 22:46:49791Otherwise, if the <tt>SSH_ASKPASS</tt> environment variable is set, its
Junio C Hamano0df92712011-12-21 22:30:44792 value is used as above.
793</p>
794</li>
795<li>
796<p>
797Otherwise, the user is prompted on the terminal.
798</p>
799</li>
800</ol></div>
801</div>
Junio C Hamano9d971152012-12-19 00:43:11802</div>
803<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44804<h2 id="_avoiding_repetition">AVOIDING REPETITION</h2>
805<div class="sectionbody">
806<div class="paragraph"><p>It can be cumbersome to input the same credentials over and over. Git
807provides two methods to reduce this annoyance:</p></div>
808<div class="olist arabic"><ol class="arabic">
809<li>
810<p>
811Static configuration of usernames for a given authentication context.
812</p>
813</li>
814<li>
815<p>
816Credential helpers to cache or store passwords, or to interact with
817 a system password wallet or keychain.
818</p>
819</li>
820</ol></div>
821<div class="paragraph"><p>The first is simple and appropriate if you do not have secure storage available
822for a password. It is generally configured by adding this to your config:</p></div>
823<div class="listingblock">
824<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49825<pre><tt>[credential "https://example.com"]
826 username = me</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44827</div></div>
Junio C Hamano076ffcc2013-02-06 05:13:21828<div class="paragraph"><p>Credential helpers, on the other hand, are external programs from which Git can
Junio C Hamano0df92712011-12-21 22:30:44829request both usernames and passwords; they typically interface with secure
830storage provided by the OS or other programs.</p></div>
831<div class="paragraph"><p>To use a helper, you must first select one to use. Git currently
832includes the following helpers:</p></div>
833<div class="dlist"><dl>
834<dt class="hdlist1">
835cache
836</dt>
837<dd>
838<p>
839 Cache credentials in memory for a short period of time. See
Junio C Hamanoa28a9202012-06-21 07:08:23840 <a href="git-credential-cache.html">git-credential-cache(1)</a> for details.
Junio C Hamano0df92712011-12-21 22:30:44841</p>
842</dd>
843<dt class="hdlist1">
844store
845</dt>
846<dd>
847<p>
848 Store credentials indefinitely on disk. See
Junio C Hamanoa28a9202012-06-21 07:08:23849 <a href="git-credential-store.html">git-credential-store(1)</a> for details.
Junio C Hamano0df92712011-12-21 22:30:44850</p>
851</dd>
852</dl></div>
853<div class="paragraph"><p>You may also have third-party helpers installed; search for
Junio C Hamano61525f92014-01-17 22:46:49854<tt>credential-*</tt> in the output of <tt>git help -a</tt>, and consult the
Junio C Hamano0df92712011-12-21 22:30:44855documentation of individual helpers. Once you have selected a helper,
Junio C Hamano076ffcc2013-02-06 05:13:21856you can tell Git to use it by putting its name into the
Junio C Hamano0df92712011-12-21 22:30:44857credential.helper variable.</p></div>
858<div class="olist arabic"><ol class="arabic">
859<li>
860<p>
861Find a helper.
862</p>
863<div class="listingblock">
864<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49865<pre><tt>$ git help -a | grep credential-
866credential-foo</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44867</div></div>
868</li>
869<li>
870<p>
871Read its description.
872</p>
873<div class="listingblock">
874<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49875<pre><tt>$ git help credential-foo</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44876</div></div>
877</li>
878<li>
879<p>
Junio C Hamano076ffcc2013-02-06 05:13:21880Tell Git to use it.
Junio C Hamano0df92712011-12-21 22:30:44881</p>
882<div class="listingblock">
883<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49884<pre><tt>$ git config --global credential.helper foo</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44885</div></div>
886</li>
887</ol></div>
Junio C Hamano61525f92014-01-17 22:46:49888<div class="paragraph"><p>If there are multiple instances of the <tt>credential.helper</tt> configuration
Junio C Hamano0df92712011-12-21 22:30:44889variable, each helper will be tried in turn, and may provide a username,
Junio C Hamano076ffcc2013-02-06 05:13:21890password, or nothing. Once Git has acquired both a username and a
Junio C Hamano0df92712011-12-21 22:30:44891password, no more helpers will be tried.</p></div>
892</div>
Junio C Hamano9d971152012-12-19 00:43:11893</div>
894<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44895<h2 id="_credential_contexts">CREDENTIAL CONTEXTS</h2>
896<div class="sectionbody">
897<div class="paragraph"><p>Git considers each credential to have a context defined by a URL. This context
898is used to look up context-specific configuration, and is passed to any
899helpers, which may use it as an index into secure storage.</p></div>
Junio C Hamano61525f92014-01-17 22:46:49900<div class="paragraph"><p>For instance, imagine we are accessing <tt>https://example.com/foo.git</tt>. When Git
Junio C Hamano0df92712011-12-21 22:30:44901looks into a config file to see if a section matches this context, it will
902consider the two a match if the context is a more-specific subset of the
903pattern in the config file. For example, if you have this in your config file:</p></div>
904<div class="listingblock">
905<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49906<pre><tt>[credential "https://example.com"]
907 username = foo</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44908</div></div>
909<div class="paragraph"><p>then we will match: both protocols are the same, both hosts are the same, and
910the "pattern" URL does not care about the path component at all. However, this
911context would not match:</p></div>
912<div class="listingblock">
913<div class="content">
Junio C Hamano61525f92014-01-17 22:46:49914<pre><tt>[credential "https://kernel.org"]
915 username = foo</tt></pre>
Junio C Hamano0df92712011-12-21 22:30:44916</div></div>
Junio C Hamano61525f92014-01-17 22:46:49917<div class="paragraph"><p>because the hostnames differ. Nor would it match <tt>foo.example.com</tt>; Git
Junio C Hamano0df92712011-12-21 22:30:44918compares hostnames exactly, without considering whether two hosts are part of
Junio C Hamano61525f92014-01-17 22:46:49919the same domain. Likewise, a config entry for <tt>http://example.com</tt> would not
Junio C Hamano076ffcc2013-02-06 05:13:21920match: Git compares the protocols exactly.</p></div>
Junio C Hamano0df92712011-12-21 22:30:44921</div>
Junio C Hamano9d971152012-12-19 00:43:11922</div>
923<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44924<h2 id="_configuration_options">CONFIGURATION OPTIONS</h2>
925<div class="sectionbody">
926<div class="paragraph"><p>Options for a credential context can be configured either in
Junio C Hamano61525f92014-01-17 22:46:49927<tt>credential.*</tt> (which applies to all credentials), or
928<tt>credential.&lt;url&gt;.*</tt>, where &lt;url&gt; matches the context as described
Junio C Hamano0df92712011-12-21 22:30:44929above.</p></div>
930<div class="paragraph"><p>The following options are available in either location:</p></div>
931<div class="dlist"><dl>
932<dt class="hdlist1">
933helper
934</dt>
935<dd>
936<p>
937 The name of an external credential helper, and any associated options.
Junio C Hamano61525f92014-01-17 22:46:49938 If the helper name is not an absolute path, then the string <tt>git
939 credential-</tt> is prepended. The resulting string is executed by the
940 shell (so, for example, setting this to <tt>foo --option=bar</tt> will execute
941 <tt>git credential-foo --option=bar</tt> via the shell. See the manual of
Junio C Hamano0df92712011-12-21 22:30:44942 specific helpers for examples of their use.
943</p>
944</dd>
945<dt class="hdlist1">
946username
947</dt>
948<dd>
949<p>
950 A default username, if one is not provided in the URL.
951</p>
952</dd>
953<dt class="hdlist1">
954useHttpPath
955</dt>
956<dd>
957<p>
Junio C Hamano076ffcc2013-02-06 05:13:21958 By default, Git does not consider the "path" component of an http URL
Junio C Hamano0df92712011-12-21 22:30:44959 to be worth matching via external helpers. This means that a credential
Junio C Hamano61525f92014-01-17 22:46:49960 stored for <tt>https://example.com/foo.git</tt> will also be used for
961 <tt>https://example.com/bar.git</tt>. If you do want to distinguish these
962 cases, set this option to <tt>true</tt>.
Junio C Hamano0df92712011-12-21 22:30:44963</p>
964</dd>
965</dl></div>
966</div>
Junio C Hamano9d971152012-12-19 00:43:11967</div>
968<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44969<h2 id="_custom_helpers">CUSTOM HELPERS</h2>
970<div class="sectionbody">
971<div class="paragraph"><p>You can write your own custom helpers to interface with any system in
Junio C Hamano076ffcc2013-02-06 05:13:21972which you keep credentials. See the documentation for Git&#8217;s
Junio C Hamano0df92712011-12-21 22:30:44973<a href="technical/api-credentials.html">credentials API</a> for details.</p></div>
974</div>
Junio C Hamano9d971152012-12-19 00:43:11975</div>
976<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44977<h2 id="_git">GIT</h2>
978<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23979<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano0df92712011-12-21 22:30:44980</div>
981</div>
Junio C Hamano9d971152012-12-19 00:43:11982</div>
Junio C Hamano0df92712011-12-21 22:30:44983<div id="footnotes"><hr /></div>
984<div id="footer">
985<div id="footer-text">
Junio C Hamano683a8612013-08-23 20:50:09986Last updated 2013-08-20 08:40:27 PDT
Junio C Hamano0df92712011-12-21 22:30:44987</div>
988</div>
989</body>
990</html>