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(file|manifest) <id>\fP
20Write a comment cert for a file or manifest version.
21.TP
22\fBapprove\fP \fI(file|manifest) <id1> <id2>\fP
23Make a cert approving of a file or manifest change.
24.TP
25\fBdisapprove\fP \fI(file|manifest) <id1> <id2>\fP
26Make a cert disapproving of a file or manifest change.
27.TP
28\fBtag\fP \fI<id> <tagname>\fP
29Put a symbolic tag cert on a manifest version.
30.TP
31\fBtestresult\fP \fI<id> (1|0)\fP
32Indicate a passing or failing test result on a manifest version.
33.TP
34\fBagraph\fP
35Dump ancestry graph to stdout.
36.TP
37\fBdiff\fP
38Show diffs between working copy and database.
39.TP
40\fBstatus\fP
41Show status of working copy.
42.TP
43\fBlog\fP \fI[id] \fP
44Show historical log of manifests, starting from working copy
45base version, or \fI[id]\fP if given.
46.TP
47\fBcert\fP \fI(file|manifest) <id> <certname> [certval]\fP
48Create a custom cert for a file or manifest. Reads cert value
49from stdin if no value given on command line.
50.TP
51\fBvcheck\fP \fI(create|check) [id]\fP
52Produce or check \fBvcheck\fP certs for the given manifest \fI[id]\fP.
53.TP
54\fBgenkey\fP \fI<keyid>\fP
55Generate an RSA key-pair and store it in the database.
56.TP
57\fBlist certs\fP \fI(file|manifest) <id>\fP
58List certs associated with manifest or file.
59.TP
60\fBlist keys\fP \fI[partial-id]\fP
61List keys matching glob, or list all keys if no glob given.
62.TP
63\fBlist queue\fP
64List contents of outgoing network queue.
65.TP
66\fBlist branches\fP
67List all branches.
68.TP
69\fBlist unknown\fP
70List files in working directory, but not in manifest or work list.
71.TP
72\fBlist ignored\fP
73List files intentionally ignored due to the ignore_file hook.
74.TP
75\fBfetch\fP \fI[URL]\fP
76Fetch recent packets from network servers. Does not read public
77or private key packets; use the \fBread\fP command instead.
78.TP
79\fBpost\fP
80Post queued packets to network servers.
81.TP
82\fBqueue list\fP
83List contents of outgoing network queue.
84.TP
85\fBqueue print\fP \fI<target> <packet>\fP
86Print packet in outgoing network queue.
87.TP
88\fBqueue delete\fP \fI<target> <packet>\fP
89Delete packet from outgoing network queue
90.TP
91\fBqueue add\fP \fI<url>\fP
92Queue contents of standard input to transmit to \fI<url>\fP
93.TP
94\fBqueue addtree\fP \fI<url> [id]\fP
95Queue history of \fIid\fP to transmit to \fI<url>\fP
96.TP
97\fBfcerts\fP \fI<id>\fP
98Write file cert packets to stdout.
99.TP
100\fBfdata\fP \fI<id>\fP
101Write file data packet to stdout.
102.TP
103\fBfdelta\fP \fI<oldid> <newid>\fP
104Write file delta packet to stdout.
105.TP
106\fBmcerts\fP \fI<id>\fP
107Write manifest cert packets to stdout.
108.TP
109\fBmdata\fP \fI<id>\fP
110Write manifest data packet to stdout.
111.TP
112\fBprivkey\fP \fI<id>\fP
113Write private key packet to stdout.
114.TP
115\fBpubkey\fP \fI<id>\fP
116Write public key packet to stdout.
117.TP
118\fBread\fP
119Read packets from stdin. This is the only way of reading cryptographic
120key packets; the \fBfetch\fP command will not read public or private
121keys from the network. It is very important to \fBonly read keys from
122trusted sources\fP; all other trust relationships are built out of the
123trust assigned to keys.
124.TP
125\fBcvs_import\fP \fI<cvsroot>\fP
126import all versions in CVS repository
127.TP
128\fBrcs_import\fP \fI<rcsfile> ...\fP
129import all versions in RCS files
130.TP
131\fBcheckout\fP \fI[manifest-id]\fP \fI<directory\fP
132Check out tree state from database.
133.TP
134\fBco\fP \fI[manifest-id]\fP \fI<directory\fP
135Check out tree state from database; an alias for \fBcheckout\fP.
136.TP
137\fBcat\fP \fI(file|manifest) <id>\fP
138Write file or manifest from database to stdout.
139.TP
140\fBheads\fP
141Show unmerged heads of branch, or report when branch is merged.
142.TP
143\fBmerge\fP
144Merge unmerged heads of branch.
145.TP
146\fBadd\fP \fI<pathname> [...]\fP
147Add files to working copy. adding a file does not copy it into the database,
148merely adds it to the manifest. You must \fBcommit\fP your changes in order
149to copy added files to the database.
150.TP
151\fBcommit\fP \fI[log message]\fP
152Commit working copy to database. If a log message is provided on the command
153line, it is used; otherwise a log message editor will be invoked.
154.TP
155\fBdrop\fP \fI<pathname> [...]\fP
156Drop files from working copy. Files are not deleted from working copy,
157merely removed from the manifest.
158.TP
159\fBrename\fP \fI<src> \fI<dst>\fP
160Rename files from \fI<src> \fP to \fI<dst> \fP in working copy.
161.TP
162\fBupdate\fP
163Update working copy.
164.TP
165\fBdb\fP \fI(init|info|version|migrate)\fP
166Manipulate database state.
167.SH DESCRIPTION
168Monotone is a version control system, which allows you to keep old
169versions of files, as well as special \fImanifest files\fP which
170describe the location of files in a tree. Unlike other systems,
171versions in monotone are \fIidentified\fP by cryptographic hash, and
172operations are authenticated by individual users' evaluating
173cryptographic signatures on meta-data, rather than any central
174authority.
175
176Monotone keeps a collection of versions in a single-file relational
177database. It is essentially serverless, using network servers only as
178untrusted communication facilities. A monotone database is a regular
179file, which contains all the information needed to extract previous
180versions of files, verify signatures, merge and modify versions, and
181communicate with network servers.
182.SH OPTIONS
183.TP
184\fB--help\fP
185Print help message.
186.TP
187\fB--verbose\fP
188Trace execution verbosely. default is to be silent, unless
189an error occurs, in which case failure log is dumped.
190.TP
191\fB--nostd\fP
192Do not evaluate "standard" lua hooks compiled into \fBmonotone\fP.
193.TP
194\fB--norc\fP
195Do not load lua hooks from user's \fB~/.monotonerc\fP file.
196.TP
197\fB--rcfile=\fP\fI<file>\fP
198Load extra lua hooks from \fIfile\fP (may be given multiple times).
199.TP
200\fB--db=\fP\fI<file>\fP
201Use database in \fIfile\fP.
202.TP
203\fB--key=\fP\fI<keyid>\fP
204Use \fIkeyid\fP for operations which produce RSA signatures. Default
205is inferred from presence of unique private key in database. Can also
206be customized on a per-branch basis with hook function
207\fBget_branch_key(branchname)\fP.
208.TP
209\fB--branch=\fP\fI<branchname>\fP
210Use \fIbranchname\fP for operations on a branch. Default is inferred
211in operations on existing branches (commit, update, etc).
212.SH ENVIRONMENT
213.TP
214\fBEDITOR\fP
215Used to edit comments, log messages, etc.
216.TP
217\fBVISUAL\fP
218Used in preference to \fBEDITOR\fP, if set.
219.SH FILES
220.TP
221\fB$HOME/.monotonerc\fP
222A lua script, used as a customization file.
223.SH NOTES
224.IP \(bu
225Command line options override environment variables and
226settings in lua scripts (such as \fB.monotonerc\fP)
227.SH "SEE ALSO"
228\fBinfo monotone\fP
229.SH BUGS
230see http://savannah.nongnu.org/bugs/?group=monotone
231.SH AUTHOR
232graydon hoare <graydon@pobox.com>

Archive Download this file

Branches

Tags

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