~ubuntu-branches/debian/sid/tortoisehg/sid

« back to all changes in this revision

Viewing changes to debian/thg.1.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ludovico Cavedon
  • Date: 2011-03-18 19:57:13 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20110318195713-nh62nv9y26rrdtmh
Tags: 2.0.2-1
* New upstream release.
* Update copyright file.
* Depend on PyQt4 libraries rather than on PyGtk.
* Rename manpage from hgtk to thg.
* No longer include _hgtk zsh completion file.
* Install wrapper script hgtk and add manpage link for it (LP: #732328).
* Update manpage with new options and commands.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
 
 
5
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
 
6
  <!ENTITY dhfirstname "Ludovico">
 
7
  <!ENTITY dhsurname   "Cavedon">
 
8
  <!-- dhusername could also be set to "&firstname; &surname;". -->
 
9
  <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
 
10
  <!ENTITY dhemail     "cavedon@debian.org">
 
11
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
 
12
       allowed: see man(7), man(1) and
 
13
       http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
 
14
  <!ENTITY dhsection   "1">
 
15
  <!-- TITLE should be something like "User commands" or similar (see
 
16
       http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
 
17
  <!ENTITY dhtitle     "thg User Manual">
 
18
  <!ENTITY dhucpackage "THG">
 
19
  <!ENTITY dhpackage   "thg">
 
20
]>
 
21
 
 
22
<refentry>
 
23
  <refentryinfo>
 
24
    <title>&dhtitle;</title>
 
25
    <productname>&dhpackage;</productname>
 
26
    <authorgroup>
 
27
      <author>
 
28
       <firstname>&dhfirstname;</firstname>
 
29
        <surname>&dhsurname;</surname>
 
30
        <contrib>Wrote this manpage for the Debian system.</contrib>
 
31
        <address>
 
32
          <email>&dhemail;</email>
 
33
        </address>
 
34
      </author>
 
35
    </authorgroup>
 
36
    <copyright>
 
37
      <year>2009-2011</year>
 
38
      <holder>&dhusername; &lt;&dhemail;&gt;></holder>
 
39
    </copyright>
 
40
    <legalnotice>
 
41
      <para>This manual page was written for the Debian system
 
42
        (and may be used by others).</para>
 
43
      <para>Permission is granted to copy, distribute and/or modify this
 
44
        document under the terms of the GNU General Public License,
 
45
        Version 2 or (at your option) any later version published by
 
46
        the Free Software Foundation.</para>
 
47
      <para>On Debian systems, the complete text of the GNU General Public
 
48
        License can be found in
 
49
        <filename>/usr/share/common-licenses/GPL-2</filename>.</para>
 
50
    </legalnotice>
 
51
    <date>03/18/2011</date>
 
52
  </refentryinfo>
 
53
  <refmeta>
 
54
    <refentrytitle>&dhucpackage;</refentrytitle>
 
55
    <manvolnum>&dhsection;</manvolnum>
 
56
    <refmiscinfo class="version">0.8</refmiscinfo>
 
57
  </refmeta>
 
58
  <refnamediv>
 
59
    <refname>&dhpackage;</refname>
 
60
    <refpurpose>TortoiseHg's GUI tools for Mercurial SCM (Hg)</refpurpose>
 
61
  </refnamediv>
 
62
  <refsynopsisdiv>
 
63
    <cmdsynopsis>
 
64
      <command>&dhpackage;</command>
 
65
      <arg choice="opt"><option><replaceable>global options</replaceable></option></arg>
 
66
      <arg choice="plain"><replaceable>command</replaceable></arg>
 
67
      <arg choice="opt"><option><replaceable>command options</replaceable></option></arg>
 
68
    </cmdsynopsis>
 
69
  </refsynopsisdiv>
 
70
  <refsect1 id="description">
 
71
    <title>DESCRIPTION</title>
 
72
    <para>This manual page documents briefly the
 
73
      <command>&dhpackage;</command>command.</para>
 
74
    <para>This manual page was written for the Debian distribution
 
75
        because the original program does not have a manual page.</para>
 
76
    <para><command>&dhpackage;</command> is a program that invokes TortoiseHg's
 
77
        GUI tools for Mercurial SCM (i.e.
 
78
            <citerefentry>
 
79
              <refentrytitle>hg</refentrytitle>
 
80
              <manvolnum>1</manvolnum>
 
81
            </citerefentry>)</para>
 
82
  </refsect1>
 
83
  <refsect1 id="options">
 
84
    <title>OPTIONS</title>
 
85
    <para>The program follows the usual GNU command line syntax,
 
86
      with long options starting with two dashes (`-').  A summary of
 
87
      options is included below.  </para>
 
88
 
 
89
    <refsect2 id="global_options">
 
90
      <title>Global Options</title>
 
91
      <variablelist>
 
92
        <!-- Use the variablelist.term.separator and the
 
93
             variablelist.term.break.after parameters to
 
94
             control the term elements. -->
 
95
        <varlistentry>
 
96
          <term><option>-R</option></term>
 
97
          <term><option>--repository</option></term>
 
98
          <listitem>
 
99
            <para>Set the repository root directory or symbolic path name.</para>
 
100
          </listitem>
 
101
        </varlistentry>
 
102
        <varlistentry>
 
103
          <term><option>-v</option></term>
 
104
          <term><option>--verbose</option></term>
 
105
          <listitem>
 
106
            <para>Enable additional output.</para>
 
107
          </listitem>
 
108
        </varlistentry>
 
109
        <varlistentry>
 
110
          <term><option>-q</option></term>
 
111
          <term><option>--quiet</option></term>
 
112
          <listitem>
 
113
            <para>Suppress output.</para>
 
114
          </listitem>
 
115
        </varlistentry>
 
116
        <varlistentry>
 
117
          <term><option>-h</option></term>
 
118
          <term><option>--help</option></term>
 
119
          <listitem>
 
120
            <para>Display help and exit.</para>
 
121
          </listitem>
 
122
        </varlistentry>
 
123
        <varlistentry>
 
124
          <term><option>--debugger</option></term>
 
125
          <listitem>
 
126
            <para>Start debugger.</para>
 
127
          </listitem>
 
128
        </varlistentry>
 
129
        <varlistentry>
 
130
          <term><option>--profile</option></term>
 
131
          <listitem>
 
132
            <para>Print command execution profile.</para>
 
133
          </listitem>
 
134
        </varlistentry>
 
135
        <varlistentry>
 
136
          <term><option>--nofork</option></term>
 
137
          <listitem>
 
138
            <para>Do not fork GUI process.</para>
 
139
          </listitem>
 
140
        </varlistentry>
 
141
        <varlistentry>
 
142
          <term><option>--fork</option></term>
 
143
          <listitem>
 
144
            <para>Always fork GUI process.</para>
 
145
          </listitem>
 
146
        </varlistentry>
 
147
        <varlistentry>
 
148
          <term><option>--listfile</option></term>
 
149
          <listitem>
 
150
            <para>Read file list from file.</para>
 
151
          </listitem>
 
152
        </varlistentry>
 
153
        <varlistentry>
 
154
          <term><option>--listfileutf8</option></term>
 
155
          <listitem>
 
156
            <para>Read file list from file encoding utf-8.</para>
 
157
          </listitem>
 
158
        </varlistentry>
 
159
      </variablelist>
 
160
    </refsect2>
 
161
 
 
162
    <refsect2 id="commands">
 
163
      <title>Commands</title>
 
164
 
 
165
      <para>Here is a bref list of the supported commands. More detailed
 
166
        documentation on a specific command can be obtained by running:
 
167
        <command>&dhpackage; help
 
168
          <arg choice="plain"><replaceable>command</replaceable></arg></command>
 
169
      </para>
 
170
 
 
171
      <variablelist>
 
172
        <!-- Use the variablelist.term.separator and the
 
173
             variablelist.term.break.after parameters to
 
174
             control the term elements. -->
 
175
 
 
176
        <varlistentry>
 
177
          <term><option>about</option></term>
 
178
          <listitem>
 
179
            <para>About dialog.</para>
 
180
          </listitem>
 
181
        </varlistentry>
 
182
        <varlistentry>
 
183
          <term><option>add</option></term>
 
184
          <listitem>
 
185
            <para>Add files.</para>
 
186
          </listitem>
 
187
        </varlistentry>
 
188
        <varlistentry>
 
189
          <term><option>annotate</option></term>
 
190
          <term><option>blame</option></term>
 
191
          <listitem>
 
192
            <para>Annotate dialog.</para>
 
193
          </listitem>
 
194
        </varlistentry>
 
195
        <varlistentry>
 
196
          <term><option>archive</option></term>
 
197
          <listitem>
 
198
            <para>Archive dialog.</para>
 
199
          </listitem>
 
200
        </varlistentry>
 
201
        <varlistentry>
 
202
          <term><option>backout</option></term>
 
203
          <listitem>
 
204
            <para>Backout tool.</para>
 
205
          </listitem>
 
206
        </varlistentry>
 
207
        <varlistentry>
 
208
          <term><option>bisect</option></term>
 
209
          <listitem>
 
210
            <para>Bisect dialog.</para>
 
211
          </listitem>
 
212
        </varlistentry>
 
213
        <varlistentry>
 
214
          <term><option>clone</option></term>
 
215
          <listitem>
 
216
            <para>Clone tool.</para>
 
217
          </listitem>
 
218
        </varlistentry>
 
219
        <varlistentry>
 
220
          <term><option>commit</option></term>
 
221
          <term><option>ci</option></term>
 
222
          <listitem>
 
223
            <para>Commit tool.</para>
 
224
          </listitem>
 
225
        </varlistentry>
 
226
        <varlistentry>
 
227
          <term><option>drag_copy</option></term>
 
228
          <listitem>
 
229
            <para>Copy the selected files to the desired directory.</para>
 
230
          </listitem>
 
231
        </varlistentry>
 
232
        <varlistentry>
 
233
          <term><option>drag_move</option></term>
 
234
          <listitem>
 
235
            <para>Move the selected files to the desired directory.</para>
 
236
          </listitem>
 
237
        </varlistentry>
 
238
        <varlistentry>
 
239
          <term><option>email</option></term>
 
240
          <listitem>
 
241
            <para>Send changesets by email.</para>
 
242
          </listitem>
 
243
        </varlistentry>
 
244
        <varlistentry>
 
245
          <term><option>forget</option></term>
 
246
          <listitem>
 
247
            <para>Forget selected files.</para>
 
248
          </listitem>
 
249
        </varlistentry>
 
250
        <varlistentry>
 
251
          <term><option>grep</option></term>
 
252
          <term><option>search</option></term>
 
253
          <listitem>
 
254
            <para>Grep/search dialog.</para>
 
255
          </listitem>
 
256
        </varlistentry>
 
257
        <varlistentry>
 
258
          <term><option>guess</option></term>
 
259
          <listitem>
 
260
            <para>Guess previous renames or copies.</para>
 
261
          </listitem>
 
262
        </varlistentry>
 
263
        <varlistentry>
 
264
          <term><option>help</option></term>
 
265
          <listitem>
 
266
            <para>Show help for a command, extension, or list of commands.</para>
 
267
          </listitem>
 
268
        </varlistentry>
 
269
        <varlistentry>
 
270
          <term><option>hgignore</option></term>
 
271
          <term><option>ignore</option></term>
 
272
          <term><option>filter</option></term>
 
273
          <listitem>
 
274
            <para>Ignore filter editor.</para>
 
275
          </listitem>
 
276
        </varlistentry>
 
277
        <varlistentry>
 
278
          <term><option>import</option></term>
 
279
          <listitem>
 
280
            <para>Import an ordered set of patches.</para>
 
281
          </listitem>
 
282
        </varlistentry>
 
283
        <varlistentry>
 
284
          <term><option>init</option></term>
 
285
          <listitem>
 
286
            <para>Init dialog.</para>
 
287
          </listitem>
 
288
        </varlistentry>
 
289
        <varlistentry>
 
290
          <term><option>log</option></term>
 
291
          <term><option>history</option></term>
 
292
          <term><option>explorer</option></term>
 
293
          <term><option>workbench</option></term>
 
294
          <listitem>
 
295
            <para>Workbench application.</para>
 
296
          </listitem>
 
297
        </varlistentry>
 
298
        <varlistentry>
 
299
          <term><option>manifest</option></term>
 
300
          <listitem>
 
301
            <para>Display the current or given revision of the project manifest.</para>
 
302
          </listitem>
 
303
        </varlistentry>
 
304
        <varlistentry>
 
305
          <term><option>merge</option></term>
 
306
          <listitem>
 
307
            <para>Merge wizard.</para>
 
308
          </listitem>
 
309
        </varlistentry>
 
310
        <varlistentry>
 
311
          <term><option>mq</option></term>
 
312
          <listitem>
 
313
            <para>Mercurial Queue tool.</para>
 
314
          </listitem>
 
315
        </varlistentry>
 
316
        <varlistentry>
 
317
          <term><option>purge</option></term>
 
318
          <listitem>
 
319
            <para>Purge unknown and/or ignore files from repository.</para>
 
320
          </listitem>
 
321
        </varlistentry>
 
322
        <varlistentry>
 
323
          <term><option>qqueue</option></term>
 
324
          <listitem>
 
325
            <para>Manage multiple MQ patch queues.</para>
 
326
          </listitem>
 
327
        </varlistentry>
 
328
        <varlistentry>
 
329
          <term><option>qreorder</option></term>
 
330
          <listitem>
 
331
            <para>Reorder unapplied MQ patches.</para>
 
332
          </listitem>
 
333
        </varlistentry>
 
334
        <varlistentry>
 
335
          <term><option>rebase</option></term>
 
336
          <listitem>
 
337
            <para>Rebase dialog.</para>
 
338
          </listitem>
 
339
        </varlistentry>
 
340
        <varlistentry>
 
341
          <term><option>rejects</option></term>
 
342
          <listitem>
 
343
            <para>Manually resolve rejected patch chunks.</para>
 
344
          </listitem>
 
345
        </varlistentry>
 
346
        <varlistentry>
 
347
          <term><option>remove</option></term>
 
348
          <term><option>rm</option></term>
 
349
          <listitem>
 
350
            <para>Remove selected files.</para>
 
351
          </listitem>
 
352
        </varlistentry>
 
353
        <varlistentry>
 
354
          <term><option>rename</option></term>
 
355
          <term><option>mv</option></term>
 
356
          <term><option>copy</option></term>
 
357
          <listitem>
 
358
            <para>Rename dialog.</para>
 
359
          </listitem>
 
360
        </varlistentry>
 
361
        <varlistentry>
 
362
          <term><option>repoconfig</option></term>
 
363
          <listitem>
 
364
            <para>Repository configuration editor.</para>
 
365
          </listitem>
 
366
        </varlistentry>
 
367
        <varlistentry>
 
368
          <term><option>resolve</option></term>
 
369
          <listitem>
 
370
            <para>Resolve dialog.</para>
 
371
          </listitem>
 
372
        </varlistentry>
 
373
        <varlistentry>
 
374
          <term><option>revert</option></term>
 
375
          <listitem>
 
376
            <para>Revert selected files.</para>
 
377
          </listitem>
 
378
        </varlistentry>
 
379
        <varlistentry>
 
380
          <term><option>serve</option></term>
 
381
          <listitem>
 
382
            <para>Start stand-alone webserver.</para>
 
383
          </listitem>
 
384
        </varlistentry>
 
385
        <varlistentry>
 
386
          <term><option>shelve</option></term>
 
387
          <term><option>unshelve</option></term>
 
388
          <listitem>
 
389
            <para>Move changes between working directory and patches.</para>
 
390
          </listitem>
 
391
        </varlistentry>
 
392
        <varlistentry>
 
393
          <term><option>status</option></term>
 
394
          <listitem>
 
395
            <para>Browse working copy status.</para>
 
396
          </listitem>
 
397
        </varlistentry>
 
398
        <varlistentry>
 
399
          <term><option>strip</option></term>
 
400
          <listitem>
 
401
            <para>Strip dialog.</para>
 
402
          </listitem>
 
403
        </varlistentry>
 
404
        <varlistentry>
 
405
          <term><option>sync</option></term>
 
406
          <term><option>synchronize</option></term>
 
407
          <listitem>
 
408
            <para>Synchronize with other repositories.</para>
 
409
          </listitem>
 
410
        </varlistentry>
 
411
        <varlistentry>
 
412
          <term><option>tag</option></term>
 
413
          <listitem>
 
414
            <para>Tag tool.</para>
 
415
          </listitem>
 
416
        </varlistentry>
 
417
        <varlistentry>
 
418
          <term><option>test</option></term>
 
419
          <listitem>
 
420
            <para>Test arbitrary widgets.</para>
 
421
          </listitem>
 
422
        </varlistentry>
 
423
        <varlistentry>
 
424
          <term><option>update</option></term>
 
425
          <term><option>checkout</option></term>
 
426
          <term><option>co</option></term>
 
427
          <listitem>
 
428
            <para>Update/checkout tool.</para>
 
429
          </listitem>
 
430
        </varlistentry>
 
431
        <varlistentry>
 
432
          <term><option>userconfig</option></term>
 
433
          <listitem>
 
434
            <para>User configuration editor.</para>
 
435
          </listitem>
 
436
        </varlistentry>
 
437
        <varlistentry>
 
438
          <term><option>vdiff</option></term>
 
439
          <listitem>
 
440
            <para>Launch configured visual diff tool.</para>
 
441
          </listitem>
 
442
        </varlistentry>
 
443
        <varlistentry>
 
444
          <term><option>version</option></term>
 
445
          <listitem>
 
446
            <para>Output version and copyright information.</para>
 
447
          </listitem>
 
448
        </varlistentry>
 
449
      </variablelist>
 
450
    </refsect2>
 
451
  </refsect1>
 
452
  <refsect1 id="bugs">
 
453
    <!-- Or use this section to tell about upstream BTS. -->
 
454
    <title>BUGS</title>
 
455
    <para>The upstreams <acronym>BTS</acronym> can be found
 
456
      at <ulink url="http://bitbucket.org/tortoisehg/stable/issues/"/>.</para>
 
457
  </refsect1>
 
458
  <refsect1 id="see_also">
 
459
    <title>SEE ALSO</title>
 
460
    <!-- In alpabetical order. -->
 
461
    <para><citerefentry>
 
462
        <refentrytitle>hg</refentrytitle>
 
463
        <manvolnum>1</manvolnum>
 
464
      </citerefentry></para>
 
465
  </refsect1>
 
466
</refentry>
 
467