Google Git
Sign in
chromium / external / gitster / git-htmldocs / 84ea1e42221ac3bab88dda1a6ee25a11802cfef9 / . / git-credential.html
blob: 6c850e81f7ee311979fae867c824bf01713b78bc [file] [log] [blame]
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]7<title>git-credential(1)</title>
8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* 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 Hamano8edb4c72012-07-09 20:33:55[diff] [blame]24}
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 Hamano8edb4c72012-07-09 20:33:55[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]50 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:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]70
71div.sectionbody {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]72 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:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]102 color: #527bbd;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]103 font-weight: bold;
104 font-size: 1.1em;
105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
133 margin-top: 1.0em;
134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
149 color: #527bbd;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]180 padding: 0.5em;
181}
182
183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]189}
190
191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
193 text-align: right;
194}
195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
205div.verseblock + div.attribution {
206 text-align: left;
207}
208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
219 border-left: 3px solid #dddddd;
220}
221
222div.exampleblock > div.content {
223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
225}
226
227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]229a.image:visited { color: white; }
230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
238 font-style: normal;
239 color: navy;
240}
241dd > *:first-child {
242 margin-top: 0.1em;
243}
244
245ul, ol {
246 list-style-position: outside;
247}
248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
252 list-style-type: lower-alpha;
253}
254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
270
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]271tfoot {
272 font-weight: bold;
273}
274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]277
278div.hdlist {
279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
282div.hdlist tr {
283 padding-bottom: 15px;
284}
285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
289 vertical-align: top;
290 font-style: normal;
291 padding-right: 0.8em;
292 color: navy;
293}
294td.hdlist2 {
295 vertical-align: top;
296}
297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
305
306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]340}
341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]351 color: #527bbd;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]526body.manpage h2 {
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]534 body.manpage div#toc { display: none; }
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]538</style>
539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]731/*]]>*/
732</script>
733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="manpage">
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]735<div id="header">
736<h1>
737git-credential(1) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>git-credential -
Junio C Hamano62e79372012-08-08 22:53:35[diff] [blame]742 Retrieve and store user credentials
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]743</p>
744</div>
745</div>
746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]747<div class="sect1">
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]748<h2 id="_synopsis">SYNOPSIS</h2>
749<div class="sectionbody">
750<div class="listingblock">
751<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]752<pre><code>git credential &lt;fill|approve|reject&gt;</code></pre>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]753</div></div>
754</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]755</div>
756<div class="sect1">
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]757<h2 id="_description">DESCRIPTION</h2>
758<div class="sectionbody">
759<div class="paragraph"><p>Git has an internal interface for storing and retrieving credentials
760from system-specific helpers, as well as prompting the user for
761usernames and passwords. The git-credential command exposes this
762interface to scripts which may want to retrieve, store, or prompt for
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]763credentials in the same manner as Git. The design of this scriptable
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]764interface models the internal C API; see
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]765<a href="technical/api-credentials.html">the Git credential API</a> for more
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]766background on the concepts.</p></div>
767<div class="paragraph"><p>git-credential takes an "action" option on the command-line (one of
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]768<code>fill</code>, <code>approve</code>, or <code>reject</code>) and reads a credential description
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]769on stdin (see <a href="#IOFMT">INPUT/OUTPUT FORMAT</a>).</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]770<div class="paragraph"><p>If the action is <code>fill</code>, git-credential will attempt to add "username"
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]771and "password" attributes to the description by reading config files,
772by contacting any configured credential helpers, or by prompting the
773user. The username and password attributes of the credential
774description are then printed to stdout together with the attributes
775already provided.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]776<div class="paragraph"><p>If the action is <code>approve</code>, git-credential will send the description
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]777to any configured credential helpers, which may store the credential
778for later use.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]779<div class="paragraph"><p>If the action is <code>reject</code>, git-credential will send the description to
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]780any configured credential helpers, which may erase any stored
781credential matching the description.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]782<div class="paragraph"><p>If the action is <code>approve</code> or <code>reject</code>, no output should be emitted.</p></div>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]783</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]784</div>
785<div class="sect1">
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]786<h2 id="_typical_use_of_git_credential">TYPICAL USE OF GIT CREDENTIAL</h2>
787<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]788<div class="paragraph"><p>An application using git-credential will typically use <code>git
789credential</code> following these steps:</p></div>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]790<div class="olist arabic"><ol class="arabic">
791<li>
792<p>
793Generate a credential description based on the context.
794</p>
795<div class="paragraph"><p>For example, if we want a password for
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]796<code>https://example.com/foo.git</code>, we might generate the following
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]797credential description (don&#8217;t forget the blank line at the end; it
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]798tells <code>git credential</code> that the application finished feeding all the
Junio C Hamanoa080bc32013-04-12 21:33:01[diff] [blame]799information it has):</p></div>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]800<div class="literalblock">
801<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]802<pre><code>protocol=https
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]803host=example.com
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]804path=foo.git</code></pre>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]805</div></div>
806</li>
807<li>
808<p>
809Ask git-credential to give us a username and password for this
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]810 description. This is done by running <code>git credential fill</code>,
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]811 feeding the description from step (1) to its standard input. The complete
812 credential description (including the credential per se, i.e. the
813 login and password) will be produced on standard output, like:
814</p>
815<div class="literalblock">
816<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]817<pre><code>protocol=https
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]818host=example.com
819username=bob
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]820password=secr3t</code></pre>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]821</div></div>
822<div class="paragraph"><p>In most cases, this means the attributes given in the input will be
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]823repeated in the output, but Git may also modify the credential
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]824description, for example by removing the <code>path</code> attribute when the
825protocol is HTTP(s) and <code>credential.useHttpPath</code> is false.</p></div>
826<div class="paragraph"><p>If the <code>git credential</code> knew about the password, this step may
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]827not have involved the user actually typing this password (the
828user may have typed a password to unlock the keychain instead,
829or no user interaction was done if the keychain was already
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]830unlocked) before it returned <code>password=secr3t</code>.</p></div>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]831</li>
832<li>
833<p>
834Use the credential (e.g., access the URL with the username and
835 password from step (2)), and see if it&#8217;s accepted.
836</p>
837</li>
838<li>
839<p>
840Report on the success or failure of the password. If the
841 credential allowed the operation to complete successfully, then
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]842 it can be marked with an "approve" action to tell <code>git
843 credential</code> to reuse it in its next invocation. If the credential
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]844 was rejected during the operation, use the "reject" action so
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]845 that <code>git credential</code> will ask for a new password in its next
846 invocation. In either case, <code>git credential</code> should be fed with
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]847 the credential description obtained from step (2) (which also
848 contain the ones provided in step (1)).
849</p>
850</li>
851</ol></div>
852</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]853</div>
854<div class="sect1">
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]855<h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
856<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]857<div class="paragraph"><p><code>git credential</code> reads and/or writes (depending on the action used)
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]858credential information in its standard input/output. This information
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]859can correspond either to keys for which <code>git credential</code> will obtain
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]860the login/password information (e.g. host, protocol, path), or to the
861actual credential data to be obtained (login/password).</p></div>
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]862<div class="paragraph"><p>The credential is split into a set of named attributes, with one
863attribute per line. Each attribute is
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]864specified by a key-value pair, separated by an <code>=</code> (equals) sign,
865followed by a newline. The key may contain any bytes except <code>=</code>,
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]866newline, or NUL. The value may contain any bytes except newline or NUL.
867In both cases, all bytes are treated as-is (i.e., there is no quoting,
868and one cannot transmit a value with newline or NUL in it). The list of
869attributes is terminated by a blank line or end-of-file.
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]870Git understands the following attributes:</p></div>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]871<div class="dlist"><dl>
872<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]873<code>protocol</code>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]874</dt>
875<dd>
876<p>
877 The protocol over which the credential will be used (e.g.,
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]878 <code>https</code>).
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]879</p>
880</dd>
881<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]882<code>host</code>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]883</dt>
884<dd>
885<p>
886 The remote hostname for a network credential.
887</p>
888</dd>
889<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]890<code>path</code>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]891</dt>
892<dd>
893<p>
894 The path with which the credential will be used. E.g., for
895 accessing a remote https repository, this will be the
896 repository&#8217;s path on the server.
897</p>
898</dd>
899<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]900<code>username</code>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]901</dt>
902<dd>
903<p>
904 The credential&#8217;s username, if we already have one (e.g., from a
905 URL, from the user, or from a previously run helper).
906</p>
907</dd>
908<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]909<code>password</code>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]910</dt>
911<dd>
912<p>
913 The credential&#8217;s password, if we are asking it to be stored.
914</p>
915</dd>
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]916<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]917<code>url</code>
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]918</dt>
919<dd>
920<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]921 When this special attribute is read by <code>git credential</code>, the
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]922 value is parsed as a URL and treated as if its constituent parts
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]923 were read (e.g., <code>url=https://example.com</code> would behave as if
924 <code>protocol=https</code> and <code>host=example.com</code> had been provided). This
Junio C Hamano44dcd492012-07-24 04:35:38[diff] [blame]925 can help callers avoid parsing URLs themselves. Note that any
926 components which are missing from the URL (e.g., there is no
927 username in the example above) will be set to empty; if you want
928 to provide a URL and override some attributes, provide the URL
929 attribute first, followed by any overrides.
930</p>
931</dd>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]932</dl></div>
933</div>
934</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]935</div>
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]936<div id="footnotes"><hr /></div>
937<div id="footer">
938<div id="footer-text">
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]939Last updated 2013-09-17 14:33:14 PDT
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]940</div>
941</div>
942</body>
943</html>