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.
118.TP
119\fBcheckout\fP \fI[manifest-id]\fP \fI<directory\fP
120Check out tree state from database.
121.TP
122\fBco\fP \fI[manifest-id]\fP \fI<directory\fP
123Check out tree state from database; an alias for \fBcheckout\fP.
124.TP
125\fBcat\fP \fI(file|manifest) <id>\fP
126Write file or manifest from database to stdout.
127.TP
128\fBheads\fP
129Show unmerged heads of branch, or report when branch is merged.
130.TP
131\fBmerge\fP
132Merge unmerged heads of branch.
133.TP
134\fBadd\fP \fI<pathname> [...]\fP
135Add files to working copy. adding a file does not copy it into the database,
136merely adds it to the work list. You must \fBcommit\fP your changes in order
137to copy added files to the database.
138.TP
139\fBdrop\fP \fI<pathname> [...]\fP
140Drop files from working copy. Files are not deleted from working copy,
141merely noted as removals in the work list.
142.TP
143\fBrename\fP \fI<src> \fI<dst>\fP
144Rename files from \fI<src> \fP to \fI<dst> \fP in working copy.
145.TP
146\fBcommit\fP \fI[--message=<log message>] [<pathname>...]\fP
147Commit working copy to database. If a --message option is provided on
148the command ine, it is used; otherwise a log message editor will be
149invoked.
150.TP
151\fBupdate\fP
152Update working copy.
153.TP
154\fBpush\fP \fI<host> <collection>\fP
155Push contents of \fI<collection>\fP to database on \fI<host>\fP
156.TP
157\fBpull\fP \fI<host> <collection>\fP
158Push contents of \fI<collection>\fP from database on \fI<host>\fP
159.TP
160\fBsync\fP \fI<host> <collection>\fP
161Sync contents of \fI<collection>\fP with database on \fI<host>\fP
162.TP
163\fBserve\fP \fI<host> <collection>\fP
164Serve contents of \fI<collection>\fP at network address \fI<host>\fP
165.TP
166\fBset\fP \fI<domain> <name> <value>\fP
167Set the db var \fI<name>\fP in domain \fI<domain>\fP to value
168\fI<value>\fP.
169.TP
170\fBunset\fP \fI<domain> <name>\fP
171Delete any setting for db var \fI<name>\fP in domain \fI<domain>\fP.
172.TP
173\fBautomate\fP \fI(interface_version|heads|descendents|erase_ancestors|toposort|ancestry_difference|leaves)\fP
174Scripting interface.
175.TP
176\fBdb\fP \fI(init|info|version|dump|load|migrate|rebuild|execute|check)\fP
177Manipulate database state.
178.SH DESCRIPTION
179Monotone is a version control system, which allows you to keep old
180versions of files, as well as special \fImanifest files\fP which
181describe the location of files in a tree. Unlike other systems,
182versions in monotone are \fIidentified\fP by cryptographic hash, and
183operations are authenticated by individual users' evaluating
184cryptographic signatures on meta-data, rather than any central
185authority.
186
187Monotone keeps a collection of versions in a single-file relational
188database. It is essentially serverless, using network servers only as
189untrusted communication facilities. A monotone database is a regular
190file, which contains all the information needed to extract previous
191versions of files, verify signatures, merge and modify versions, and
192communicate with network servers.
193.SH OPTIONS
194.TP
195\fB--help\fP
196Print help message.
197.TP
198\fB--debug\fP
199Turn on debugging log on standard error stream. This is very
200verbose. Default is to be silent, unless an error occurs, in which
201case failure log is dumped.
202.TP
203\fB--quiet\fP
204Turn off normal progress messages.
205.TP
206\fB--dump=\fP\fI<file>\fP
207Dump debugging log to \fIfile\fP on failure.
208.TP
209\fB--nostd\fP
210Do not evaluate "standard" lua hooks compiled into \fBmonotone\fP.
211.TP
212\fB--norc\fP
213Do not load lua hooks from user's \fB~/.monotonerc\fP file.
214.TP
215\fB--rcfile=\fP\fI<file>\fP
216Load extra lua hooks from \fIfile\fP (may be given multiple times).
217.TP
218\fB--db=\fP\fI<file>\fP
219Use database in \fIfile\fP.
220.TP
221\fB--key=\fP\fI<keyid>\fP
222Use \fIkeyid\fP for operations which produce RSA signatures. Default
223is inferred from presence of unique private key in database. Can also
224be customized on a per-branch basis with hook function
225\fBget_branch_key(branchname)\fP.
226.TP
227\fB-k\fP \fI<keyid>\fP
228An alias for \fB--key=\fP\fI<keyid>\fP
229.TP
230\fB--branch=\fP\fI<branchname>\fP
231Use \fIbranchname\fP for operations on a branch. Default is inferred
232in operations on existing branches (commit, update, etc).
233.TP
234\fB-b\fP \fI<branchname>\fP
235An alias for \fB--branch=\fP\fI<branchname>\fP
236.TP
237\fB--ticket=\fP\fIdot|count\fP
238Use the given method to print tickers. The \fBcount\fP method prints
239the count for each ticker on one line, incrementing the numbers in
240place, while the \fBdot\fP method prints a continuous string of
241characters (like some programs provide a progress line of dots).
242The default is \fBcount\fP.
243.TP
244\fB--revision=\fP\fI<id>\fP
245Currently this option only applies to the diff command where it may be
246used to compare a working copy with a specific revision or to compare
247two specific revisions. It will likely apply to other commands in the
248future.
249.TP
250\fB-r\fP \fI<id>\fP
251An alias for \fB--revision=\fP\fI<id>\fP
252.TP
253\fB--message=\fI<log message>\fP
254Use the given message as the changelog when committing a new revision
255rather than invoking the log message editor. Currently this option only
256applies to the commit command but it may also apply to the comment
257command in the future.
258.TP
259\fB-m \fI<log message>\fP
260An alias for \fB--message=\fI<log message>\fP
261.TP
262\fB--root=\fI<root dir>\fP
263Stop the search for a working copy (containing the @file{MT} directory)
264at the specified root directory rather than at the physical root of the
265filesystem.
266.TP
267\fB-xargs=\fI<file>\fP
268Inject the contents of the file in place among the command line
269arguments. This may be useful in case the command line would
270otherwise become too long for your system.
271.TP
272\fB-@ \fI<file>\fP
273An alias for \fB--xargs=\fI<file>\fP
274
275.SH ENVIRONMENT
276.TP
277\fBEDITOR\fP
278Used to edit comments, log messages, etc.
279.TP
280\fBVISUAL\fP
281Used in preference to \fBEDITOR\fP, if set.
282.SH FILES
283.TP
284\fB$HOME/.monotonerc\fP
285A lua script, used as a customization file.
286.SH NOTES
287.IP \(bu
288Command line options override environment variables and
289settings in lua scripts (such as \fB.monotonerc\fP)
290.SH "SEE ALSO"
291\fBinfo monotone\fP
292.SH BUGS
293see http://savannah.nongnu.org/bugs/?group=monotone
294.SH AUTHOR
295graydon hoare <graydon@pobox.com>

Archive Download this file

Branches

Tags

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