File: in-general.html

package info (click to toggle)
arch 1.0pre15-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 20,180 kB
  • ctags: 4,560
  • sloc: ansic: 64,410; sh: 29,168; lisp: 1,896; awk: 1,044; makefile: 484; sed: 26
file content (338 lines) | stat: -rw-r--r-- 9,949 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<html>
<head>
<title>arch Commands in General</title>
</head>
<body>

<a name="arch_Commands_in_General"></a>

<a href="http://www.regexps.com">The Hackerlab at <code>regexps.com</code></a>

<h2 align=center>arch Commands in General</h2>




<small>
<b>up: </b><a href="arch.html#arch">arch</a></br>
<b>next: </b><a href="project-trees.html#arch_Project_Trees">arch Project Trees</a></br>


</small>
<br>






<p>Every command in <code>arch</code>
 is accessed via the program <code>arch</code>
, using an
ordinary sub-command syntax:
</p><pre>
        % larch &lt;sub-command> &lt;options> &lt;parameters>

</pre>
<p>A list of all sub-commands can be obtained from:
</p><pre>
        % larch --help-commands

</pre>
<p>The most complete documentation for each command is available via its
help message.  The help messages in <code>arch</code>
 are roughly comperable to
traditional unix <code>man</code>
 pages.   For example, try:
</p><pre>
        % larch make-archive --help
        create a new archive directory
        usage: make-archive [options] (-u | name) directory

</pre>
<pre>
         -V --version                  print version info
         -h --help                     display help

</pre>
<pre>
         -r --readme file              save FILE as the README
                                       for this archive

</pre>
<pre>
         -u --update                   update an existing archive

</pre>
<pre>
        NAME is the global name for the archive.  It must be an
        email address with a fully qualified domain name, optionally
        followed by &quot;--&quot; and a string of letters, digits, periods
        and dashes.

</pre>
<pre>
        Normally the archive directory must not already exist, but.
        there is an exception:

</pre>
<pre>
        If -u or --update is specified, then attempt to bring
        an existing archive up to date with respect to this
        version of arch and update meta-info, such as the README.
        file.

</pre>
<pre>
        If -u or --update is specified, the archive name must
        not be specified.

</pre>
<p>There is a great deal of regularity among commands regarding option
names and parameter syntax.  Hopefully, you'll pick this up as you
learn the various commands.
</p>
<a name="The_arch_Commands"></a>



<h3 align=center>The arch Commands</h3>










<p>Here is a synopsis of all <code>arch</code>
 commands: the output of <code>larch
--help-commands</code>
:
</p><pre>

                       larch sub-commands
                       -----------------

* User Commands

                       my-id : print or change your id
          my-default-archive : print or change your default archive

            register-archive : record the location of an archive
             whereis-archive : print the registered location of an archive
                    archives : report registered archives and their locations


* Project Tree Commands

                   init-tree : initialize a new project tree
                   tree-root : find and print the root of a project tree

                tree-version : print the default version for a project tree
            set-tree-version : set the default version for a source tree


* Project Tree Inventory Commands

                   inventory : inventory a source tree

              tagging-method : print or change a project tree tagging method
                   tree-lint : audit a source tree
                missing-tags : list files missing inventory tags
                    file-tag : print the tag of a project tree file

                         add : add an explicit inventory tag
                      delete : remove an explicit inventory tag
                        move : move an explicit inventory tag

            explicit-default : set the default explicit tag for a directory

                set-manifest : set the inventory manifest from project tree
                    manifest : print the inventory manifest
              check-manifest : compare the inventory manifest to reality


* Patch Set Commands

                     mkpatch : compare two source trees and create a patch tree
                     dopatch : apply a patch tree to a source tree

                patch-report : generate a report from a patch set

                 empty-patch : make a null patch set


* Archive Commands

                make-archive : create a new archive directory

               make-category : create a new category within an archive
                 make-branch : create a new branch within an archive
                make-version : create a new version within an archive

                  categories : list the categories in an archive
                    branches : list the branches in an archive category
                    versions : list the versions in an archive branch
                   revisions : list the revisions in an archive version

             cat-archive-log : print the contents of an archive log entry

      archive-cache-revision : cache a full source tree in an archive
    archive-cached-revisions : list full source trees cached in an archive
    archive-uncache-revision : remove a cached revision from an archive

             category-readme : print the =README of a category
               branch-readme : print the =README of a branch
              version-readme : print the =README of a version


* Patch Log Commands

                    make-log : initialize a new log file entry

                        logs : list patch logs in a project tree
                     add-log : add a version patch log to a project tree

                      log-ls : print version patches in a project tree
                     cat-log : print the contents of a project tree log entry
            log-header-field : filter a header field from a log entry

                   changelog : generate a change log from a patch log
               log-for-merge : generate a log entry bodyfor a merge

                merge-points : report where two branches have been merged
               new-on-branch : list tree patches new to a branch


* Archive Transaction Commands

                      import : archive a from-scratch base revision
                      commit : archive a revision
                         get : construct a project tree for a revision

                   get-patch : retrieve a patch set from an archive

                 lock-branch : lock a branch
               lock-revision : acquire the lock for the next revision

                 push-mirror : update a read-only repository mirror


* Multi-project Configuration Commands


                build-config : instantiate a multi-project tree
               update-config : update a multi-project tree
               replay-config : replay a multi-project tree

               record-config : record a revision-specific configuration
                 show-config : show the revision frontier of a configuration

              config-history : report the history of a configuration


* Commands for Branching and Merging


                      update : merge local changes with the latest revision
                      replay : merge the latest revsion with local changes
                 delta-patch : compute and apply an arbitrary patch
                  star-merge : merge of mutually merged branches

                         tag : create a continuation revision (tag or branch)

              prepare-branch : create a project tree for a new branch
               finish-branch : commit project tree as a new branch

                        join : join a sibling branch

               whats-missing : print patches missing from a project tree


* Local Cache Commands

                what-changed : compare project tree to cached pristine
                  file-diffs : compare file with cached pristine revision

                   pristines : list the pristine trees in a project tree
               lock-pristine : lock a pristine revision locking


* Revision Library Commands

         my-revision-library : print or set your revision library path

                library-find : find a revision in a revision library
                 library-add : add a revision to a revision library
              library-remove : remove a revision from a revision library

            library-archives : list the archives in the revision library
          library-categories : list categories in the revision library
            library-branches : list branches in the revision library
            library-versions : list versions in the revision library
           library-revisions : list revisions in the revision library

                 library-log : print a log message from the library
                library-file : find a file in a revision library


* Web Related Commands

               patch-set-web : create or update a patch-set web
        update-distributions : build or update an FTP area

           distribution-name : revision name -> distribution name


* Notification Commands

                      notify : trigger actions for changes to an archive
                 my-notifier : print or set your default notify directory

         mail-new-categories : send email notices about new categories
           mail-new-branches : send email notices about new branches
           mail-new-versions : send email notices about new versions
          mail-new-revisions : send email notices about new revisions

              notify-library : add new revisions to the library

          push-new-revisions : send email notices about new revisions

              sendmail-mailx : send email with sendmail ala POSIX mailx


For help with a command, try: larch command --help



</pre>



















<small><i>arch: The arch Revision Control System

</i></small><br>


<a href="http://www.regexps.com">The Hackerlab at <code>regexps.com</code></a>

</body>