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

Archive Download this file

Branches

Tags

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