Google Git
Sign in
chromium / external / gitster / git-htmldocs / 8760ea6311a1c56f0d2c7bb31af840eb49f0f007 / . / git-status.html
blob: 108063614b5f303170638f8764de7a25b8193803 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[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>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]6<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-status(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-status(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-status -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]269 Show the working tree status
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano8fd52302006-08-10 00:18:08[diff] [blame]275<p><em>git-status</em> &lt;options&gt;&#8230;</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]276</div>
277<h2>DESCRIPTION</h2>
278<div class="sectionbody">
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]279<p>Displays paths that have differences between the index file and the
280current HEAD commit, paths that have differences between the working
281tree and the index file, and paths in the working tree that are not
282tracked by git (and are not ignored by <a href="gitignore.html">gitignore(5)</a>). The first
283are what you _would_ commit by running <tt>git commit</tt>; the second and
284third are what you _could_ commit by running <tt>git add</tt> before running
285<tt>git commit</tt>.</p>
Junio C Hamano8fd52302006-08-10 00:18:08[diff] [blame]286<p>The command takes the same set of options as <tt>git-commit</tt>; it
287shows what would be committed if the same options are given to
288<tt>git-commit</tt>.</p>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]289<p>If there is no path that is different between the index file and
290the current HEAD commit (i.e., there is nothing to commit by running
291<tt>git-commit</tt>), the command exits with non-zero status.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]292</div>
293<h2>OUTPUT</h2>
294<div class="sectionbody">
295<p>The output from this command is designed to be used as a commit
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]296template comment, and all the output lines are prefixed with <em>#</em>.</p>
Junio C Hamano00b8b632007-12-07 09:50:49[diff] [blame]297<p>The paths mentioned in the output, unlike many other git commands, are
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]298made relative to the current directory if you are working in a
299subdirectory (this is on purpose, to help cutting and pasting). See
300the status.relativePaths config option below.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]301</div>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]302<h2>CONFIGURATION</h2>
303<div class="sectionbody">
304<p>The command honors <tt>color.status</tt> (or <tt>status.color</tt> &#8212; they
305mean the same thing and the latter is kept for backward
306compatibility) and <tt>color.status.&lt;slot&gt;</tt> configuration variables
307to colorize its output.</p>
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]308<p>If the config variable <tt>status.relativePaths</tt> is set to false, then all
309paths shown are relative to the repository root, not to the current
310directory.</p>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]311</div>
312<h2>See Also</h2>
313<div class="sectionbody">
314<p><a href="gitignore.html">gitignore(5)</a></p>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]315</div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]316<h2>Author</h2>
317<div class="sectionbody">
318<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and
319Junio C Hamano &lt;junkio@cox.net&gt;.</p>
320</div>
321<h2>Documentation</h2>
322<div class="sectionbody">
323<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
324</div>
325<h2>GIT</h2>
326<div class="sectionbody">
327<p>Part of the <a href="git.html">git(7)</a> suite</p>
328</div>
329<div id="footer">
330<div id="footer-text">
Junio C Hamano35738e82008-01-07 07:55:46[diff] [blame]331Last updated 07-Jan-2008 07:50:51 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]332</div>
333</div>
334</body>
335</html>