monotone

monotone Mtn Source Tree

Root/monotone.1

1.TH "monotone" 1
2.SH NAME
3monotone \- distributed version control system
4.SH SYNOPSIS
5\fBmonotone\fP \fI[options] <command> [parameters]\fP
6.P
7Options, which affect global behavior or set default values, come
8first in the argument list. A single command must follow, indicating
9the operation to perform, followed by parameters which vary depending
10on the command.
11.SS Note
12This manpage is a summary of some of the features and commands of
13\fBmonotone\fP, but it is not the most detailed source of information
14available. For a complete discussion of the concepts and a tutorial on
15its use, please refer to the texinfo manual (via the \fBinfo
16monotone\fP command, or online).
17.SS Commands
18.TP
19\fBcomment\fP \fI<id>\fP
20Write a comment cert for a revision.
21.TP
22\fBapprove\fP \fI<id>\fP
23Make a "branch" cert approving of a revision's membership in a branch.
24.TP
25\fBdisapprove\fP \fI<id1>\fP
26Disapprove of a revision, committing the inverse changes as as a
27descendant of the disapproved revision.
28.TP
29\fBtag\fP \fI<id> <tagname>\fP
30Put a symbolic tag cert on a revision.
31.TP
32\fBtestresult\fP \fI<id> (0|1|true|false|yes|no|pass|fail)\fP
33Indicate a passing or failing test result on a revision.
34.TP
35\fBagraph\fP
36Dump revision graph to stdout in VCG format.
37.TP
38\fBdiff \fI[--revision=<id1> [--revision=<id2>] ] [<pathname>...]\fP
39Show diffs between working copy and database.
40.TP
41\fBstatus \fI[<pathname>...]\fP
42Show status of working copy.
43.TP
44\fBlog\fP \fI[id] \fP
45Show historical log of revisions, starting from working copy
46base revision, or \fI[id]\fP if given.
47.TP
48\fBcert\fP \fI<id> <certname> [certval]\fP
49Create a custom cert for a revision. Reads cert value
50from stdin if no value given on command line.
51.TP
52\fBgenkey\fP \fI<keyid>\fP
53Generate an RSA key-pair and store it in the database.
54.TP
55\chkeypass\fP \fI<keyid>\fP
56Change passphrase of the private half of a key.
57.TP
58\fBlist certs\fP \fI<id>\fP
59List certs associated with revision.
60.TP
61\fBlist keys\fP \fI[partial-id]\fP
62List keys matching glob, or list all keys if no glob given.
63.TP
64\fBlist branches\fP
65List all branches.
66.TP
67\fBlist tags\fP
68List all tags.
69.TP
70\fBlist vars \fI[<domain>]\fP
71List all vars (possibly limited by domain).
72.TP
73\fBlist unknown \fI[<pathname...]\fP
74List files in working directory, but not in revision's manifest or
75work list.
76.TP
77\fBlist ignored \fI[<pathname...]\fP
78List files intentionally ignored due to the ignore_file hook.
79.TP
80\fBlist missing \fI[<pathname...]\fP
81List files in revision's manifest, but not in working directory.
82.TP
83\fBfdata\fP \fI<id>\fP
84Write file data packet to stdout.
85.TP
86\fBfdelta\fP \fI<oldid> <newid>\fP
87Write file delta packet to stdout.
88.TP
89\fBmdata\fP \fI<id>\fP
90Write manifest data packet to stdout.
91.TP
92\fBmdelta\fP \fI<oldid> <newid>\fP
93Write manifest delta packet to stdout.
94.TP
95\fBcerts\fP \fI<id>\fP
96Write revision cert packets to stdout.
97.TP
98\fBrdata\fP \fI<id>\fP
99Write revision data packet to stdout.
100.TP
101\fBprivkey\fP \fI<id>\fP
102Write private key packet to stdout.
103.TP
104\fBpubkey\fP \fI<id>\fP
105Write public key packet to stdout.
106.TP
107\fBread\fP
108Read packets from stdin.
109.TP
110\fBcvs_import\fP \fI<cvsroot>\fP
111Import all versions in CVS repository. Reconstructs revisions and
112converts metadata to certificates. A private signing key must already
113exist in the database.
114.TP
115\fBrcs_import\fP \fI<rcsfile> ...\fP
116Import all file versions in RCS files. Does not reconstruct revisions
117across the entire tree. You do not want this command, it is for
118debugging; use cvs_import.
119.TP
120\fBcheckout\fP \fI[manifest-id]\fP \fI<directory\fP
121Check out tree state from database.
122.TP
123\fBco\fP \fI[manifest-id]\fP \fI<directory\fP
124Check out tree state from database; an alias for \fBcheckout\fP.
125.TP
126\fBcat\fP \fI(file|manifest) <id>\fP
127Write file or manifest from database to stdout.
128.TP
129\fBheads\fP
130Show unmerged heads of branch, or report when branch is merged.
131.TP
132\fBmerge\fP
133Merge unmerged heads of branch.
134.TP
135\fBadd\fP \fI<pathname> [...]\fP
136Add files to working copy. adding a file does not copy it into the database,
137merely adds it to the work list. You must \fBcommit\fP your changes in order
138to copy added files to the database.
139.TP
140\fBdrop\fP \fI<pathname> [...]\fP
141Drop files from working copy. Files are not deleted from working copy,
142merely noted as removals in the work list.
143.TP
144\fBrename\fP \fI<src> \fI<dst>\fP
145Rename files from \fI<src> \fP to \fI<dst> \fP in working copy.
146.TP
147\fBcommit\fP \fI[--message=<log message>] [<pathname>...]\fP
148Commit working copy to database. If a --message option is provided on
149the command ine, it is used; otherwise a log message editor will be
150invoked.
151.TP
152\fBupdate\fP \fI[revision-id]\fP
153Update working copy.
154.TP
155\fBrefresh_inodeprints\fP
156Turn on inodeprints mode, and force a cache refresh.
157.TP
158\fBpush\fP \fI[<host> [<collection>]]\fP
159Push contents of \fI<collection>\fP to database on \fI<host>\fP
160.TP
161\fBpull\fP \fI[<host> [<collection>]]\fP
162Push contents of \fI<collection>\fP from database on \fI<host>\fP
163.TP
164\fBsync\fP \fI<host> <collection>\fP
165Sync contents of \fI<collection>\fP with database on \fI<host>\fP
166.TP
167\fBserve\fP \fI<host> <collection>\fP
168Serve contents of \fI<collection>\fP at network address \fI<host>\fP
169.TP
170\fBset\fP \fI<domain> <name> <value>\fP
171Set the db var \fI<name>\fP in domain \fI<domain>\fP to value
172\fI<value>\fP.
173.TP
174\fBunset\fP \fI<domain> <name>\fP
175Delete any setting for db var \fI<name>\fP in domain \fI<domain>\fP.
176.TP
177\fBautomate\fP \fI(interface_version|heads|descendents|erase_ancestors|toposort|ancestry_difference|leaves|inventory)\fP
178Scripting interface.
179.TP
180\fBdb\fP \fI(init|info|version|dump|load|migrate|rebuild|execute|check)\fP
181Manipulate database state.
182.SH DESCRIPTION
183Monotone is a version control system, which allows you to keep old
184versions of files, as well as special \fImanifest files\fP which
185describe the location of files in a tree. Unlike other systems,
186versions in monotone are \fIidentified\fP by cryptographic hash, and
187operations are authenticated by individual users' evaluating
188cryptographic signatures on meta-data, rather than any central
189authority.
190
191Monotone keeps a collection of versions in a single-file relational
192database. It is essentially serverless, using network servers only as
193untrusted communication facilities. A monotone database is a regular
194file, which contains all the information needed to extract previous
195versions of files, verify signatures, merge and modify versions, and
196communicate with network servers.
197.SH OPTIONS
198.TP
199\fB--help\fP
200Print help message.
201.TP
202\fB--debug\fP
203Turn on debugging log on standard error stream. This is very
204verbose. Default is to be silent, unless an error occurs, in which
205case failure log is dumped.
206.TP
207\fB--quiet\fP
208Turn off normal progress messages.
209.TP
210\fB--dump=\fP\fI<file>\fP
211Dump debugging log to \fIfile\fP on failure.
212.TP
213\fB--nostd\fP
214Do not evaluate "standard" lua hooks compiled into \fBmonotone\fP.
215.TP
216\fB--norc\fP
217Do not load lua hooks from user's \fB~/.monotonerc\fP file.
218.TP
219\fB--rcfile=\fP\fI<file>\fP
220Load extra lua hooks from \fIfile\fP (may be given multiple times).
221.TP
222\fB--db=\fP\fI<file>\fP
223Use database in \fIfile\fP.
224.TP
225\fB--key=\fP\fI<keyid>\fP
226Use \fIkeyid\fP for operations which produce RSA signatures. Default
227is inferred from presence of unique private key in database. Can also
228be customized on a per-branch basis with hook function
229\fBget_branch_key(branchname)\fP.
230.TP
231\fB-k\fP \fI<keyid>\fP
232An alias for \fB--key=\fP\fI<keyid>\fP
233.TP
234\fB--branch=\fP\fI<branchname>\fP
235Use \fIbranchname\fP for operations on a branch. Default is inferred
236in operations on existing branches (commit, update, etc).
237.TP
238\fB-b\fP \fI<branchname>\fP
239An alias for \fB--branch=\fP\fI<branchname>\fP
240.TP
241\fB--ticket=\fP\fIdot|count\fP
242Use the given method to print tickers. The \fBcount\fP method prints
243the count for each ticker on one line, incrementing the numbers in
244place, while the \fBdot\fP method prints a continuous string of
245characters (like some programs provide a progress line of dots).
246The default is \fBcount\fP.
247.TP
248\fB--revision=\fP\fI<id>\fP
249Currently this option only applies to the diff command where it may be
250used to compare a working copy with a specific revision or to compare
251two specific revisions. It will likely apply to other commands in the
252future.
253.TP
254\fB-r\fP \fI<id>\fP
255An alias for \fB--revision=\fP\fI<id>\fP
256.TP
257\fB--message=\fI<log message>\fP
258Use the given message as the changelog when committing a new revision
259rather than invoking the log message editor. Currently this option only
260applies to the commit command but it may also apply to the comment
261command in the future.
262.TP
263\fB-m \fI<log message>\fP
264An alias for \fB--message=\fI<log message>\fP
265.TP
266\fB--author=\fI<author email>\fP
267Use the given author as the value of the "author" cert when committing
268a new revision, rather than the default author. Useful when
269committing a patch on behalf of someone else, or when importing
270history from another version control system.
271.TP
272\fB--date=\fI<date and time>\fP
273Use the given given date and time as value of the "date" cert when
274committing a new revision, rather than the current time. Useful when
275importing history from another version control system.
276.TP
277\fB--root=\fI<root dir>\fP
278Stop the search for a working copy (containing the @file{MT} directory)
279at the specified root directory rather than at the physical root of the
280filesystem.
281.TP
282\fB--xargs=\fI<file>\fP
283Inject the contents of the file in place among the command line
284arguments. This may be useful in case the command line would
285otherwise become too long for your system. This option can be used
286more than once if needed.
287.TP
288\fB-@ \fI<file>\fP
289An alias for \fB--xargs=\fI<file>\fP
290.TP
291
292.SH ENVIRONMENT
293.TP
294\fBEDITOR\fP
295Used to edit comments, log messages, etc.
296.TP
297\fBVISUAL\fP
298Used in preference to \fBEDITOR\fP, if set.
299.SH FILES
300.TP
301\fB$HOME/.monotonerc\fP
302A lua script, used as a customization file.
303.SH NOTES
304.IP \(bu
305Command line options override environment variables and
306settings in lua scripts (such as \fB.monotonerc\fP)
307.SH "SEE ALSO"
308\fBinfo monotone\fP
309.SH BUGS
310see http://savannah.nongnu.org/bugs/?group=monotone
311.SH AUTHOR
312graydon hoare <graydon@pobox.com>

Archive Download this file

Branches

Tags

Quick Links:     www.monotone.ca    -     Downloads    -     Documentation    -     Wiki    -     Code Forge    -     Build Status