Google Git
Sign in
chromium / external / gitster / git-htmldocs / 779537c075f92f8653e201a9fe6f16ae4bf2f0be / . / gitcredentials.html
blob: 0a227f69eb2ba06af26bce10078df5024e309adc [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:26[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]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>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano98c882d2020-08-13 22:06:57[diff] [blame]7<meta name="generator" content="AsciiDoc 9.0.0rc2" />
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]8<title>gitcredentials(7)</title>
9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
38
39em {
40 font-style: italic;
41 color: navy;
42}
43
44strong {
45 font-weight: bold;
46 color: #083194;
47}
48
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
56h1, h2, h3 {
57 border-bottom: 2px solid silver;
58}
59h2 {
60 padding-top: 0.5em;
61}
62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]71
72div.sectionbody {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]90
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]103 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]104 font-weight: bold;
105 font-size: 1.1em;
106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
150 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]181 padding: 0.5em;
182}
183
184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]190}
191
192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195}
196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206div.verseblock + div.attribution {
207 text-align: left;
208}
209
210div.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;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221}
222
223div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226}
227
228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]230a.image:visited { color: white; }
231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241}
242dd > *:first-child {
243 margin-top: 0.1em;
244}
245
246ul, ol {
247 list-style-position: outside;
248}
249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
253 list-style-type: lower-alpha;
254}
255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
271
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]272tfoot {
273 font-weight: bold;
274}
275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]278
279div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
283div.hdlist tr {
284 padding-bottom: 15px;
285}
286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294}
295td.hdlist2 {
296 vertical-align: top;
297}
298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
306
307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
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;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]341}
342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]352 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]537
538
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]539</style>
540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
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.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
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);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]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);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]603 if (!toc) {
604 return;
605 }
606
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];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]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);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]651 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]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++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]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);
682 }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
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>]";
703 }
704 }
705 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]732/*]]>*/
733</script>
734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]736<div id="header">
737<h1>
738gitcredentials(7) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>gitcredentials -
Junio C Hamanoc9dd6422020-08-10 23:32:55[diff] [blame]743 Providing usernames and passwords to Git
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]744</p>
745</div>
746</div>
747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
750<div class="sectionbody">
751<div class="listingblock">
752<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]753<pre><code>git config credential.https://example.com.username myusername
754git config credential.helper "$helper $options"</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]755</div></div>
756</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]757</div>
758<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]759<h2 id="_description">DESCRIPTION</h2>
760<div class="sectionbody">
761<div class="paragraph"><p>Git will sometimes need credentials from the user in order to perform
762operations; for example, it may need to ask for a username and password
763in order to access a remote repository over HTTP. This manual describes
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]764the mechanisms Git uses to request these credentials, as well as some
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]765features to avoid inputting these credentials repeatedly.</p></div>
766</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]767</div>
768<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]769<h2 id="_requesting_credentials">REQUESTING CREDENTIALS</h2>
770<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]771<div class="paragraph"><p>Without any credential helpers defined, Git will try the following
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]772strategies to ask the user for usernames and passwords:</p></div>
773<div class="olist arabic"><ol class="arabic">
774<li>
775<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]776If the <code>GIT_ASKPASS</code> environment variable is set, the program
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]777 specified by the variable is invoked. A suitable prompt is provided
778 to the program on the command line, and the user&#8217;s input is read
779 from its standard output.
780</p>
781</li>
782<li>
783<p>
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]784Otherwise, if the <code>core.askPass</code> configuration variable is set, its
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]785 value is used as above.
786</p>
787</li>
788<li>
789<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]790Otherwise, if the <code>SSH_ASKPASS</code> environment variable is set, its
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]791 value is used as above.
792</p>
793</li>
794<li>
795<p>
796Otherwise, the user is prompted on the terminal.
797</p>
798</li>
799</ol></div>
800</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]801</div>
802<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]803<h2 id="_avoiding_repetition">AVOIDING REPETITION</h2>
804<div class="sectionbody">
805<div class="paragraph"><p>It can be cumbersome to input the same credentials over and over. Git
806provides two methods to reduce this annoyance:</p></div>
807<div class="olist arabic"><ol class="arabic">
808<li>
809<p>
810Static configuration of usernames for a given authentication context.
811</p>
812</li>
813<li>
814<p>
815Credential helpers to cache or store passwords, or to interact with
816 a system password wallet or keychain.
817</p>
818</li>
819</ol></div>
820<div class="paragraph"><p>The first is simple and appropriate if you do not have secure storage available
821for a password. It is generally configured by adding this to your config:</p></div>
822<div class="listingblock">
823<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]824<pre><code>[credential "https://example.com"]
825 username = me</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]826</div></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]827<div class="paragraph"><p>Credential helpers, on the other hand, are external programs from which Git can
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]828request both usernames and passwords; they typically interface with secure
829storage provided by the OS or other programs.</p></div>
830<div class="paragraph"><p>To use a helper, you must first select one to use. Git currently
831includes the following helpers:</p></div>
832<div class="dlist"><dl>
833<dt class="hdlist1">
834cache
835</dt>
836<dd>
837<p>
838 Cache credentials in memory for a short period of time. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]839 <a href="git-credential-cache.html">git-credential-cache(1)</a> for details.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]840</p>
841</dd>
842<dt class="hdlist1">
843store
844</dt>
845<dd>
846<p>
847 Store credentials indefinitely on disk. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]848 <a href="git-credential-store.html">git-credential-store(1)</a> for details.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]849</p>
850</dd>
851</dl></div>
852<div class="paragraph"><p>You may also have third-party helpers installed; search for
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]853<code>credential-*</code> in the output of <code>git help -a</code>, and consult the
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]854documentation of individual helpers. Once you have selected a helper,
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]855you can tell Git to use it by putting its name into the
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]856credential.helper variable.</p></div>
857<div class="olist arabic"><ol class="arabic">
858<li>
859<p>
860Find a helper.
861</p>
862<div class="listingblock">
863<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]864<pre><code>$ git help -a | grep credential-
865credential-foo</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]866</div></div>
867</li>
868<li>
869<p>
870Read its description.
871</p>
872<div class="listingblock">
873<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]874<pre><code>$ git help credential-foo</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]875</div></div>
876</li>
877<li>
878<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]879Tell Git to use it.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]880</p>
881<div class="listingblock">
882<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]883<pre><code>$ git config --global credential.helper foo</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]884</div></div>
885</li>
886</ol></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]887</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]888</div>
889<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]890<h2 id="_credential_contexts">CREDENTIAL CONTEXTS</h2>
891<div class="sectionbody">
892<div class="paragraph"><p>Git considers each credential to have a context defined by a URL. This context
893is used to look up context-specific configuration, and is passed to any
894helpers, which may use it as an index into secure storage.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]895<div class="paragraph"><p>For instance, imagine we are accessing <code>https://example.com/foo.git</code>. When Git
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]896looks into a config file to see if a section matches this context, it will
897consider the two a match if the context is a more-specific subset of the
898pattern in the config file. For example, if you have this in your config file:</p></div>
899<div class="listingblock">
900<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]901<pre><code>[credential "https://example.com"]
902 username = foo</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]903</div></div>
904<div class="paragraph"><p>then we will match: both protocols are the same, both hosts are the same, and
905the "pattern" URL does not care about the path component at all. However, this
906context would not match:</p></div>
907<div class="listingblock">
908<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]909<pre><code>[credential "https://kernel.org"]
910 username = foo</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]911</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]912<div class="paragraph"><p>because the hostnames differ. Nor would it match <code>foo.example.com</code>; Git
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]913compares hostnames exactly, without considering whether two hosts are part of
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]914the same domain. Likewise, a config entry for <code>http://example.com</code> would not
Junio C Hamanob082a532020-03-05 21:52:25[diff] [blame]915match: Git compares the protocols exactly. However, you may use wildcards in
916the domain name and other pattern matching techniques as with the <code>http.&lt;url&gt;.*</code>
917options.</p></div>
Junio C Hamano32a75272018-10-16 07:37:35[diff] [blame]918<div class="paragraph"><p>If the "pattern" URL does include a path component, then this too must match
919exactly: the context <code>https://example.com/bar/baz.git</code> will match a config
920entry for <code>https://example.com/bar/baz.git</code> (in addition to matching the config
921entry for <code>https://example.com</code>) but will not match a config entry for
922<code>https://example.com/bar</code>.</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]923</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]924</div>
925<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]926<h2 id="_configuration_options">CONFIGURATION OPTIONS</h2>
927<div class="sectionbody">
928<div class="paragraph"><p>Options for a credential context can be configured either in
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]929<code>credential.*</code> (which applies to all credentials), or
930<code>credential.&lt;url&gt;.*</code>, where &lt;url&gt; matches the context as described
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]931above.</p></div>
932<div class="paragraph"><p>The following options are available in either location:</p></div>
933<div class="dlist"><dl>
934<dt class="hdlist1">
935helper
936</dt>
937<dd>
938<p>
939 The name of an external credential helper, and any associated options.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]940 If the helper name is not an absolute path, then the string <code>git
941 credential-</code> is prepended. The resulting string is executed by the
942 shell (so, for example, setting this to <code>foo --option=bar</code> will execute
943 <code>git credential-foo --option=bar</code> via the shell. See the manual of
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]944 specific helpers for examples of their use.
945</p>
Junio C Hamanod5176902017-05-16 04:30:56[diff] [blame]946<div class="paragraph"><p>If there are multiple instances of the <code>credential.helper</code> configuration
947variable, each helper will be tried in turn, and may provide a username,
948password, or nothing. Once Git has acquired both a username and a
949password, no more helpers will be tried.</p></div>
950<div class="paragraph"><p>If <code>credential.helper</code> is configured to the empty string, this resets
951the helper list to empty (so you may override a helper set by a
952lower-priority config file by configuring the empty-string helper,
953followed by whatever set of helpers you would like).</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]954</dd>
955<dt class="hdlist1">
956username
957</dt>
958<dd>
959<p>
960 A default username, if one is not provided in the URL.
961</p>
962</dd>
963<dt class="hdlist1">
964useHttpPath
965</dt>
966<dd>
967<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]968 By default, Git does not consider the "path" component of an http URL
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]969 to be worth matching via external helpers. This means that a credential
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]970 stored for <code>https://example.com/foo.git</code> will also be used for
971 <code>https://example.com/bar.git</code>. If you do want to distinguish these
972 cases, set this option to <code>true</code>.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]973</p>
974</dd>
975</dl></div>
976</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]977</div>
978<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]979<h2 id="_custom_helpers">CUSTOM HELPERS</h2>
980<div class="sectionbody">
981<div class="paragraph"><p>You can write your own custom helpers to interface with any system in
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]982which you keep credentials.</p></div>
983<div class="paragraph"><p>Credential helpers are programs executed by Git to fetch or save
984credentials from and to long-term storage (where "long-term" is simply
985longer than a single Git process; e.g., credentials may be stored
986in-memory for a few minutes, or indefinitely on disk).</p></div>
987<div class="paragraph"><p>Each helper is specified by a single string in the configuration
988variable <code>credential.helper</code> (and others, see <a href="git-config.html">git-config(1)</a>).
989The string is transformed by Git into a command to be executed using
990these rules:</p></div>
991<div class="olist arabic"><ol class="arabic">
992<li>
993<p>
994If the helper string begins with "!", it is considered a shell
995 snippet, and everything after the "!" becomes the command.
996</p>
997</li>
998<li>
999<p>
1000Otherwise, if the helper string begins with an absolute path, the
1001 verbatim helper string becomes the command.
1002</p>
1003</li>
1004<li>
1005<p>
1006Otherwise, the string "git credential-" is prepended to the helper
1007 string, and the result becomes the command.
1008</p>
1009</li>
1010</ol></div>
1011<div class="paragraph"><p>The resulting command then has an "operation" argument appended to it
1012(see below for details), and the result is executed by the shell.</p></div>
1013<div class="paragraph"><p>Here are some example specifications:</p></div>
1014<div class="listingblock">
1015<div class="content">
1016<pre><code># run "git credential-foo"
Junio C Hamano2b43cff2020-05-08 22:27:04[diff] [blame]1017[credential]
1018 helper = foo
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]1019
1020# same as above, but pass an argument to the helper
Junio C Hamano2b43cff2020-05-08 22:27:04[diff] [blame]1021[credential]
1022 helper = "foo --bar=baz"
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]1023
1024# the arguments are parsed by the shell, so use shell
1025# quoting if necessary
Junio C Hamano2b43cff2020-05-08 22:27:04[diff] [blame]1026[credential]
1027 helper = "foo --bar='whitespace arg'"
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]1028
1029# you can also use an absolute path, which will not use the git wrapper
Junio C Hamano2b43cff2020-05-08 22:27:04[diff] [blame]1030[credential]
1031 helper = "/path/to/my/helper --with-arguments"
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]1032
1033# or you can specify your own shell snippet
Junio C Hamano2b43cff2020-05-08 22:27:04[diff] [blame]1034[credential "https://example.com"]
1035 username = your_user
1036 helper = "!f() { test \"$1\" = get &amp;&amp; echo \"password=$(cat $HOME/.secret)\"; }; f"</code></pre>
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]1037</div></div>
1038<div class="paragraph"><p>Generally speaking, rule (3) above is the simplest for users to specify.
1039Authors of credential helpers should make an effort to assist their
1040users by naming their program "git-credential-$NAME", and putting it in
1041the <code>$PATH</code> or <code>$GIT_EXEC_PATH</code> during installation, which will allow a
1042user to enable it with <code>git config credential.helper $NAME</code>.</p></div>
1043<div class="paragraph"><p>When a helper is executed, it will have one "operation" argument
1044appended to its command line, which is one of:</p></div>
1045<div class="dlist"><dl>
1046<dt class="hdlist1">
1047<code>get</code>
1048</dt>
1049<dd>
1050<p>
1051 Return a matching credential, if any exists.
1052</p>
1053</dd>
1054<dt class="hdlist1">
1055<code>store</code>
1056</dt>
1057<dd>
1058<p>
1059 Store the credential, if applicable to the helper.
1060</p>
1061</dd>
1062<dt class="hdlist1">
1063<code>erase</code>
1064</dt>
1065<dd>
1066<p>
1067 Remove a matching credential, if any, from the helper&#8217;s storage.
1068</p>
1069</dd>
1070</dl></div>
1071<div class="paragraph"><p>The details of the credential will be provided on the helper&#8217;s stdin
1072stream. The exact format is the same as the input/output format of the
1073<code>git credential</code> plumbing command (see the section <code>INPUT/OUTPUT
1074FORMAT</code> in <a href="git-credential.html">git-credential(1)</a> for a detailed specification).</p></div>
1075<div class="paragraph"><p>For a <code>get</code> operation, the helper should produce a list of attributes on
1076stdout in the same format (see <a href="git-credential.html">git-credential(1)</a> for common
1077attributes). A helper is free to produce a subset, or even no values at
1078all if it has nothing useful to provide. Any provided attributes will
Junio C Hamano306e7632020-05-14 23:03:19[diff] [blame]1079overwrite those already known about by Git&#8217;s credential subsystem.</p></div>
1080<div class="paragraph"><p>While it is possible to override all attributes, well behaving helpers
1081should refrain from doing so for any attribute other than username and
1082password.</p></div>
1083<div class="paragraph"><p>If a helper outputs a <code>quit</code> attribute with a value of <code>true</code> or <code>1</code>,
1084no further helpers will be consulted, nor will the user be prompted
1085(if no credential has been provided, the operation will then fail).</p></div>
1086<div class="paragraph"><p>Similarly, no more helpers will be consulted once both username and
1087password had been provided.</p></div>
1088<div class="paragraph"><p>For a <code>store</code> or <code>erase</code> operation, the helper&#8217;s output is ignored.</p></div>
1089<div class="paragraph"><p>If a helper fails to perform the requested operation or needs to notify
1090the user of a potential issue, it may write to stderr.</p></div>
1091<div class="paragraph"><p>If it does not support the requested operation (e.g., a read-only store),
1092it should silently ignore the request.</p></div>
Junio C Hamano5b8e1232020-02-17 22:05:06[diff] [blame]1093<div class="paragraph"><p>If a helper receives any other operation, it should silently ignore the
1094request. This leaves room for future operations to be added (older
1095helpers will just ignore the new requests).</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1096</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1097</div>
1098<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1099<h2 id="_git">GIT</h2>
1100<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1101<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1102</div>
1103</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1104</div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1105<div id="footnotes"><hr /></div>
1106<div id="footer">
1107<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1108Last updated
Junio C Hamanoc9dd6422020-08-10 23:32:55[diff] [blame]1109 2020-08-10 16:30:08 PDT
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1110</div>
1111</div>
1112</body>
1113</html>