Debian Codegraph @

doc/html/hg-status.html

raw
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6 <meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
7 <title>hg status</title>
8 <link rel="stylesheet" href="../style.css" type="text/css" />
9 </head>
10 <body>
11 <div class="document" id="hg-status">
12 <span id="hg-status-1"></span>
13 <h1 class="title">hg status</h1>
14 <h2 class="subtitle" id="show-changed-files-in-the-working-directory">show changed files in the working directory</h2>
15
16 <div class="contents htmlonly topic" id="contents">
17 <p class="topic-title"><a class="reference internal" href="#top">Contents</a></p>
18 <ul class="simple">
19 <li><a class="reference internal" href="#synopsis" id="toc-entry-1">Synopsis</a></li>
20 <li><a class="reference internal" href="#description" id="toc-entry-2">Description</a></li>
21 <li><a class="reference internal" href="#options" id="toc-entry-3">Options</a></li>
22 <li><a class="reference internal" href="#aliases" id="toc-entry-4">Aliases</a></li>
23 </ul>
24 </div>
25 <div class="section" id="synopsis">
26 <h1><a class="toc-backref" href="#contents">Synopsis</a></h1>
27 <pre class="literal-block">
28 hg status [OPTION]... [FILE]...
29 </pre>
30 </div>
31 <div class="section" id="description">
32 <h1><a class="toc-backref" href="#contents">Description</a></h1>
33 <p>Show status of files in the repository. If names are given, only
34 files that match are shown. Files that are clean or ignored or
35 the source of a copy/move operation, are not listed unless
36 -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
37 Unless options described with &quot;show only ...&quot; are given, the
38 options -mardu are used.</p>
39 <p>Option -q/--quiet hides untracked (unknown and ignored) files
40 unless explicitly requested with -u/--unknown or -i/--ignored.</p>
41 <div class="admonition note">
42 <p class="first admonition-title">Note</p>
43 <p class="last"><a class="reference external" href="hg-status.html"><tt class="docutils literal">hg status</tt></a> may appear to disagree with diff if permissions have
44 changed or a merge has occurred. The standard diff format does
45 not report permission changes and diff only reports changes
46 relative to one merge parent.</p>
47 </div>
48 <p>If one revision is given, it is used as the base revision.
49 If two revisions are given, the differences between them are
50 shown. The --change option can also be used as a shortcut to list
51 the changed files of a revision from its first parent.</p>
52 <p>The codes used to show the status of files are:</p>
53 <pre class="literal-block">
54 M = modified
55 A = added
56 R = removed
57 C = clean
58 ! = missing (deleted by non-hg command, but still tracked)
59 ? = not tracked
60 I = ignored
61 = origin of the previous file (with --copies)
62 </pre>
63 <div class="verbose docutils container">
64 <p>The -t/--terse option abbreviates the output by showing only the directory
65 name if all the files in it share the same status. The option takes an
66 argument indicating the statuses to abbreviate: 'm' for 'modified', 'a'
67 for 'added', 'r' for 'removed', 'd' for 'deleted', 'u' for 'unknown', 'i'
68 for 'ignored' and 'c' for clean.</p>
69 <p>It abbreviates only those statuses which are passed. Note that clean and
70 ignored files are not displayed with '--terse ic' unless the -c/--clean
71 and -i/--ignored options are also used.</p>
72 <p>The -v/--verbose option shows information when the repository is in an
73 unfinished merge, shelve, rebase state etc. You can have this behavior
74 turned on by default by enabling the <tt class="docutils literal">commands.status.verbose</tt> option.</p>
75 <p>You can skip displaying some of these states by setting
76 <tt class="docutils literal">commands.status.skipstates</tt> to one or more of: 'bisect', 'graft',
77 'histedit', 'merge', 'rebase', or 'unshelve'.</p>
78 <p>Template:</p>
79 <p>The following keywords are supported in addition to the common template
80 keywords and functions. See also <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a>.</p>
81 <table class="docutils field-list" frame="void" rules="none">
82 <col class="field-name" />
83 <col class="field-body" />
84 <tbody valign="top">
85 <tr class="field"><th class="field-name">path:</th><td class="field-body">String. Repository-absolute path of the file.</td>
86 </tr>
87 <tr class="field"><th class="field-name">source:</th><td class="field-body">String. Repository-absolute path of the file originated from.
88 Available if <tt class="docutils literal"><span class="pre">--copies</span></tt> is specified.</td>
89 </tr>
90 <tr class="field"><th class="field-name">status:</th><td class="field-body">String. Character denoting file's status.</td>
91 </tr>
92 </tbody>
93 </table>
94 <p>Examples:</p>
95 <ul>
96 <li><p class="first">show changes in the working directory relative to a
97 changeset:</p>
98 <pre class="literal-block">
99 hg status --rev 9353
100 </pre>
101 </li>
102 <li><p class="first">show changes in the working directory relative to the
103 current directory (see <a class="reference external" href="topic-patterns.html"><tt class="docutils literal">hg help patterns</tt></a> for more information):</p>
104 <pre class="literal-block">
105 hg status re:
106 </pre>
107 </li>
108 <li><p class="first">show all changes including copies in an existing changeset:</p>
109 <pre class="literal-block">
110 hg status --copies --change 9353
111 </pre>
112 </li>
113 <li><p class="first">get a NUL separated list of added files, suitable for xargs:</p>
114 <pre class="literal-block">
115 hg status -an0
116 </pre>
117 </li>
118 <li><p class="first">show more information about the repository status, abbreviating
119 added, removed, modified, deleted, and untracked paths:</p>
120 <pre class="literal-block">
121 hg status -v -t mardu
122 </pre>
123 </li>
124 </ul>
125 </div>
126 <p>Returns 0 on success.</p>
127 </div>
128 <div class="section" id="options">
129 <h1><a class="toc-backref" href="#contents">Options</a></h1>
130 <table class="docutils option-list" frame="void" rules="none">
131 <col class="option" />
132 <col class="description" />
133 <tbody valign="top">
134 <tr><td class="option-group">
135 <kbd><span class="option">-A</span>, <span class="option">--all</span></kbd></td>
136 <td>show status of all files</td></tr>
137 <tr><td class="option-group">
138 <kbd><span class="option">-m</span>, <span class="option">--modified</span></kbd></td>
139 <td>show only modified files</td></tr>
140 <tr><td class="option-group">
141 <kbd><span class="option">-a</span>, <span class="option">--added</span></kbd></td>
142 <td>show only added files</td></tr>
143 <tr><td class="option-group">
144 <kbd><span class="option">-r</span>, <span class="option">--removed</span></kbd></td>
145 <td>show only removed files</td></tr>
146 <tr><td class="option-group">
147 <kbd><span class="option">-d</span>, <span class="option">--deleted</span></kbd></td>
148 <td>show only missing files</td></tr>
149 <tr><td class="option-group">
150 <kbd><span class="option">-c</span>, <span class="option">--clean</span></kbd></td>
151 <td>show only files without changes</td></tr>
152 <tr><td class="option-group">
153 <kbd><span class="option">-u</span>, <span class="option">--unknown</span></kbd></td>
154 <td>show only unknown (not tracked) files</td></tr>
155 <tr><td class="option-group">
156 <kbd><span class="option">-i</span>, <span class="option">--ignored</span></kbd></td>
157 <td>show only ignored files</td></tr>
158 <tr><td class="option-group" colspan="2">
159 <kbd><span class="option">-n</span>, <span class="option">--no-status</span></kbd></td>
160 </tr>
161 <tr><td>&nbsp;</td><td>hide status prefix</td></tr>
162 <tr><td class="option-group" colspan="2">
163 <kbd><span class="option">-t</span>, <span class="option">--terse <var>&lt;VALUE&gt;</var></span></kbd></td>
164 </tr>
165 <tr><td>&nbsp;</td><td>show the terse output (EXPERIMENTAL) (default: nothing)</td></tr>
166 <tr><td class="option-group">
167 <kbd><span class="option">-C</span>, <span class="option">--copies</span></kbd></td>
168 <td>show source of copied files (DEFAULT: ui.statuscopies)</td></tr>
169 <tr><td class="option-group">
170 <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
171 <td>end filenames with NUL, for use with xargs</td></tr>
172 <tr><td class="option-group">
173 <kbd><span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
174 <td>show difference from revision</td></tr>
175 <tr><td class="option-group">
176 <kbd><span class="option">--change <var>&lt;REV&gt;</var></span></kbd></td>
177 <td>list the changed files of a revision</td></tr>
178 <tr><td class="option-group" colspan="2">
179 <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
180 </tr>
181 <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
182 <tr><td class="option-group" colspan="2">
183 <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
184 </tr>
185 <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
186 <tr><td class="option-group">
187 <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
188 <td>recurse into subrepositories</td></tr>
189 <tr><td class="option-group" colspan="2">
190 <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
191 </tr>
192 <tr><td>&nbsp;</td><td>display with template</td></tr>
193 </tbody>
194 </table>
195 <p>[+] marked option can be specified multiple times</p>
196 </div>
197 <div class="section" id="aliases">
198 <h1><a class="toc-backref" href="#contents">Aliases</a></h1>
199 <pre class="literal-block">
200 st
201 </pre>
202 </div>
203 </div>
204 </body>
205 </html>