diff options
| author | Junio C Hamano <gitster@pobox.com> | 2014-01-17 14:46:49 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-01-17 14:46:49 -0800 |
| commit | 61525f915b47e953b4288a9afcee45e47b352214 (patch) | |
| tree | f0649f89cc7a77c0296305f4673fc2bc7e0a6d54 /git-credential.html | |
| parent | bc8d4783cac3c942fc9e8cf2f3eae4aea8cab5cb (diff) | |
| download | git-htmldocs-61525f915b47e953b4288a9afcee45e47b352214.tar.gz | |
Autogenerated HTML docs for v1.9-rc0
Diffstat (limited to 'git-credential.html')
| -rw-r--r-- | git-credential.html | 106 |
1 files changed, 55 insertions, 51 deletions
diff --git a/git-credential.html b/git-credential.html index 3a0d93514..d56c62cb6 100644 --- a/git-credential.html +++ b/git-credential.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.8" />
+<meta name="generator" content="AsciiDoc 8.6.6" />
<title>git-credential(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -87,15 +87,11 @@ ul, ol, li > p { ul > li { color: #aaa; }
ul > li > * { color: black; }
-.monospaced, code, pre {
- font-family: "Courier New", Courier, monospace;
- font-size: inherit;
- color: navy;
+pre {
padding: 0;
margin: 0;
}
-
#author {
color: #527bbd;
font-weight: bold;
@@ -353,7 +349,7 @@ div.colist td img { margin-bottom: 0.1em;
}
-div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -411,14 +407,18 @@ span.underline { text-decoration: underline; } span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
-div.unbreakable { page-break-inside: avoid; }
-
/*
* xhtml11 specific
*
* */
+tt {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -452,6 +452,12 @@ div.tableblock > table[frame="vsides"] { *
* */
+.monospaced {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -531,8 +537,6 @@ body.manpage div.sectionbody { @media print {
body.manpage div#toc { display: none; }
}
-
-
</style>
<script type="text/javascript">
/*<+'])');
+ var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
@@ -606,7 +610,7 @@ toc: function (toclevels) { var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div'
+ if (entry.nodeName == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
@@ -652,7 +656,7 @@ footnotes: function () { var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
- if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
@@ -747,7 +751,7 @@ git-credential(1) Manual Page <div class="sectionbody">
<div class="listingblock">
<div class="content">
-<pre><code>git credential <fill|approve|reject></code></pre>
+<pre><tt>git credential <fill|approve|reject></tt></pre>
</div></div>
</div>
</div>
@@ -763,69 +767,69 @@ interface models the internal C API; see <a href="technical/api-credentials.html">the Git credential API</a> for more
background on the concepts.</p></div>
<div class="paragraph"><p>git-credential takes an "action" option on the command-line (one of
-<code>fill</code>, <code>approve</code>, or <code>reject</code>) and reads a credential description
+<tt>fill</tt>, <tt>approve</tt>, or <tt>reject</tt>) and reads a credential description
on stdin (see <a href="#IOFMT">INPUT/OUTPUT FORMAT</a>).</p></div>
-<div class="paragraph"><p>If the action is <code>fill</code>, git-credential will attempt to add "username"
+<div class="paragraph"><p>If the action is <tt>fill</tt>, git-credential will attempt to add "username"
and "password" attributes to the description by reading config files,
by contacting any configured credential helpers, or by prompting the
user. The username and password attributes of the credential
description are then printed to stdout together with the attributes
already provided.</p></div>
-<div class="paragraph"><p>If the action is <code>approve</code>, git-credential will send the description
+<div class="paragraph"><p>If the action is <tt>approve</tt>, git-credential will send the description
to any configured credential helpers, which may store the credential
for later use.</p></div>
-<div class="paragraph"><p>If the action is <code>reject</code>, git-credential will send the description to
+<div class="paragraph"><p>If the action is <tt>reject</tt>, git-credential will send the description to
any configured credential helpers, which may erase any stored
credential matching the description.</p></div>
-<div class="paragraph"><p>If the action is <code>approve</code> or <code>reject</code>, no output should be emitted.</p></div>
+<div class="paragraph"><p>If the action is <tt>approve</tt> or <tt>reject</tt>, no output should be emitted.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_typical_use_of_git_credential">TYPICAL USE OF GIT CREDENTIAL</h2>
<div class="sectionbody">
-<div class="paragraph"><p>An application using git-credential will typically use <code>git
-credential</code> following these steps:</p></div>
+<div class="paragraph"><p>An application using git-credential will typically use <tt>git
+credential</tt> following these steps:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Generate a credential description based on the context.
</p>
<div class="paragraph"><p>For example, if we want a password for
-<code>https://example.com/foo.git</code>, we might generate the following
+<tt>https://example.com/foo.git</tt>, we might generate the following
credential description (don’t forget the blank line at the end; it
-tells <code>git credential</code> that the application finished feeding all the
+tells <tt>git credential</tt> that the application finished feeding all the
information it has):</p></div>
<div class="literalblock">
<div class="content">
-<pre><code>protocol=https
+<pre><tt>protocol=https
host=example.com
-path=foo.git</code></pre>
+path=foo.git</tt></pre>
</div></div>
</li>
<li>
<p>
Ask git-credential to give us a username and password for this
- description. This is done by running <code>git credential fill</code>,
+ description. This is done by running <tt>git credential fill</tt>,
feeding the description from step (1) to its standard input. The complete
credential description (including the credential per se, i.e. the
login and password) will be produced on standard output, like:
</p>
<div class="literalblock">
<div class="content">
-<pre><code>protocol=https
+<pre><tt>protocol=https
host=example.com
username=bob
-password=secr3t</code></pre>
+password=secr3t</tt></pre>
</div></div>
<div class="paragraph"><p>In most cases, this means the attributes given in the input will be
repeated in the output, but Git may also modify the credential
-description, for example by removing the <code>path</code> attribute when the
-protocol is HTTP(s) and <code>credential.useHttpPath</code> is false.</p></div>
-<div class="paragraph"><p>If the <code>git credential</code> knew about the password, this step may
+description, for example by removing the <tt>path</tt> attribute when the
+protocol is HTTP(s) and <tt>credential.useHttpPath</tt> is false.</p></div>
+<div class="paragraph"><p>If the <tt>git credential</tt> knew about the password, this step may
not have involved the user actually typing this password (the
user may have typed a password to unlock the keychain instead,
or no user interaction was done if the keychain was already
-unlocked) before it returned <code>password=secr3t</code>.</p></div>
+unlocked) before it returned <tt>password=secr3t</tt>.</p></div>
</li>
<li>
<p>
@@ -837,11 +841,11 @@ Use the credential (e.g., access the URL with the username and <p>
Report on the success or failure of the password. If the
credential allowed the operation to complete successfully, then
- it can be marked with an "approve" action to tell <code>git
- credential</code> to reuse it in its next invocation. If the credential
+ it can be marked with an "approve" action to tell <tt>git
+ credential</tt> to reuse it in its next invocation. If the credential
was rejected during the operation, use the "reject" action so
- that <code>git credential</code> will ask for a new password in its next
- invocation. In either case, <code>git credential</code> should be fed with
+ that <tt>git credential</tt> will ask for a new password in its next
+ invocation. In either case, <tt>git credential</tt> should be fed with
the credential description obtained from step (2) (which also
contain the ones provided in step (1)).
</p>
@@ -852,15 +856,15 @@ Report on the success or failure of the password. If the <div class="sect1">
<h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
<div class="sectionbody">
-<div class="paragraph"><p><code>git credential</code> reads and/or writes (depending on the action used)
+<div class="paragraph"><p><tt>git credential</tt> reads and/or writes (depending on the action used)
credential information in its standard input/output. This information
-can correspond either to keys for which <code>git credential</code> will obtain
+can correspond either to keys for which <tt>git credential</tt> will obtain
the login/password information (e.g. host, protocol, path), or to the
actual credential data to be obtained (login/password).</p></div>
<div class="paragraph"><p>The credential is split into a set of named attributes, with one
attribute per line. Each attribute is
-specified by a key-value pair, separated by an <code>=</code> (equals) sign,
-followed by a newline. The key may contain any bytes except <code>=</code>,
+specified by a key-value pair, separated by an <tt>=</tt> (equals) sign,
+followed by a newline. The key may contain any bytes except <tt>=</tt>,
newline, or NUL. The value may contain any bytes except newline or NUL.
In both cases, all bytes are treated as-is (i.e., there is no quoting,
and one cannot transmit a value with newline or NUL in it). The list of
@@ -868,16 +872,16 @@ attributes is terminated by a blank line or end-of-file. Git understands the following attributes:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
-<code>protocol</code>
+<tt>protocol</tt>
</dt>
<dd>
<p>
The protocol over which the credential will be used (e.g.,
- <code>https</code>).
+ <tt>https</tt>).
</p>
</dd>
<dt class="hdlist1">
-<code>host</code>
+<tt>host</tt>
</dt>
<dd>
<p>
@@ -885,7 +889,7 @@ Git understands the following attributes:</p></div> </p>
</dd>
<dt class="hdlist1">
-<code>path</code>
+<tt>path</tt>
</dt>
<dd>
<p>
@@ -895,7 +899,7 @@ Git understands the following attributes:</p></div> </p>
</dd>
<dt class="hdlist1">
-<code>username</code>
+<tt>username</tt>
</dt>
<dd>
<p>
@@ -904,7 +908,7 @@ Git understands the following attributes:</p></div> </p>
</dd>
<dt class="hdlist1">
-<code>password</code>
+<tt>password</tt>
</dt>
<dd>
<p>
@@ -912,14 +916,14 @@ Git understands the following attributes:</p></div> </p>
</dd>
<dt class="hdlist1">
-<code>url</code>
+<tt>url</tt>
</dt>
<dd>
<p>
- When this special attribute is read by <code>git credential</code>, the
+ When this special attribute is read by <tt>git credential</tt>, the
value is parsed as a URL and treated as if its constituent parts
- were read (e.g., <code>url=https://example.com</code> would behave as if
- <code>protocol=https</code> and <code>host=example.com</code> had been provided). This
+ were read (e.g., <tt>url=https://example.com</tt> would behave as if
+ <tt>protocol=https</tt> and <tt>host=example.com</tt> had been provided). This
can help callers avoid parsing URLs themselves. Note that any
components which are missing from the URL (e.g., there is no
username in the example above) will be set to empty; if you want
|