Fossil SCM

Update the quick-start guide documentation to provide hyperlinks to the command-line help in the web interface. Add the beginning of a technical overview article, but as that article is still incomplete, do not hyperlink to it.

drh 2010-12-26 00:43 trunk
Commit 0e1447a6ea799421066336cd1ed7dda53b34b1f6
Parent de4c07ca52ef1f3…
2 files changed +64 -70 +140
~ www/quickstart.wiki + www/tech_overview.wiki
M www/quickstart.wiki
+64 -70
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -1,67 +1,60 @@
11
 <title>Fossil Quick Start Guide</title>
2
-<nowiki>
32
 <h1 align="center">Fossil Quick Start</h1>
43
54
 <p>This is a guide to get you started using fossil quickly
65
 and painlessly.</p>
76
8
-<h2>Installing</h2><blockquote>
7
+<h2>Installing</h2>
98
109
 <p>Fossil is a single self-contained C program. You need to
1110
 either download a
1211
 <a href="http://www.fossil-scm.org/download.html">precompiled binary</a>
1312
 or <a href="build.wiki">build it yourself</a> from sources.
1413
 Install fossil by putting the fossil binary
1514
 someplace on your PATH environment variable.</p>
1615
17
-</blockquote>
1816
 <a name="fslclone"></a>
19
-
20
-<h2>General Work Flow</h2><blockquote>
17
+<h2>General Work Flow</h2>
2118
2219
 <p>Fossil works with repository files, a database with the project's
2320
 complete history, and with checked-out local trees, the working directory
2421
 you use to do your work. In most operations that require you to work on a
2522
 specific repository you must have a checked out tree in place to work from.
2623
 The resulting workflow looks like this:</p>
2724
2825
 <ul>
29
- <li>Create or clone a repository file. (<b>fossil new</b> or
30
- <b>fossil clone</b>)
31
- <li>Check out a local tree. (<b>fossil open</b>)
26
+ <li>Create or clone a repository file. ([/help/new|fossil new] or
27
+ [/help/clone | fossil clone])
28
+ <li>Check out a local tree. ([/help/open | fossil open])
3229
 <li>Perform operations on the repository (including repository
3330
 configuration).
34
- <li><em>Optionally</em> close the local tree. (<b>fossil
35
- close</b>, but this is rarely used.)
31
+ <li><em>Optionally</em> close the local tree.
32
+ ([/help/close | fossil close], but this is rarely used.)
3633
 </ul>
3734
3835
 <p>The following sections will give you a brief overview of these
3936
 operations.</p>
4037
41
-</blockquote>
42
-
43
-<h2>Starting A New Project</h2><blockquote>
38
+<h2>Starting A New Project</h2>
4439
4540
 <p>To start a new project with fossil, create a new empty repository
46
- this way:</p>
41
+ this way: ([/help/new | more info]) </p>
4742
4843
 <blockquote>
4944
 <b>fossil new </b><i> repository-filename</i>
5045
 </blockquote>
5146
52
-</blockquote>
53
-
54
-<h2>Cloning An Existing Repository</h2><blockquote>
47
+<h2>Cloning An Existing Repository</h2>
5548
5649
 <p>Most fossil operations interact with a repository that is on the
5750
 local disk drive, not on a remote system. Hence, before accessing
5851
 a remote repository it is necessary to make a local copy of that
5952
 repository. Making a local copy of a remote repository is called
6053
 "cloning".</p>
6154
62
- <p>Clone a remote repository as follows:</p>
55
+ <p>Clone a remote repository as follows: ([/help/clone | more info])</p>
6356
6457
 <blockquote>
6558
 <b>fossil clone</b> <i>URL repository-filename</i>
6659
 </blockquote>
6760
@@ -82,23 +75,23 @@
8275
 is not required.</p>
8376
8477
 <p>Note: If you are behind a restrictive firewall, you might need
8578
 to <a href="#proxy">specify an HTTP proxy</a> to use.</p>
8679
87
-</blockquote><h2>Importing From Another Version Control System</h2><blockquote>
80
+<h2>Importing From Another Version Control System</h2>
8881
8982
 <p>Rather than start a new project, or clone an existing Fossil project,
9083
 you might prefer to
9184
 <a href="./inout.wiki">import an existing Git project</a>
92
- into Fossil.
85
+ into Fossil using the [/help/import | fossil import] command.
9386
94
-</blockquote><h2>Checking Out A Local Tree</h2><blockquote>
87
+<h2>Checking Out A Local Tree</h2>
9588
9689
 <p>To work on a project in fossil, you need to check out a local
9790
 copy of the source tree. Create the directory you want to be
9891
 the root of your tree and cd into that directory. Then
99
- do this:</p>
92
+ do this: ([/help/open | more info])</p>
10093
10194
 <blockquote>
10295
 <b>fossil open </b><i> repository-filename</i>
10396
 </blockquote>
10497
@@ -107,25 +100,26 @@
107100
 From anywhere underneath the root of your local tree, you
108101
 can type commands like the following to find out the status of
109102
 your local tree:</p>
110103
111104
 <blockquote>
112
- <b>fossil info</b><br>
113
- <b>fossil status</b><br>
114
- <b>fossil changes</b><br>
115
- <b>fossil diff</b><br>
116
- <b>fossil timeline</b><br>
117
- <b>fossil ls</b><br>
118
- <b>fossil branch list</b><br>
105
+ <b>[/help/info | fossil info]</b><br>
106
+ <b>[/help/status | fossil status]</b><br>
107
+ <b>[/help/changes | fossil changes]</b><br>
108
+ <b>[/help/diff | fossil diff]</b><br>
109
+ <b>[/help/timeline | fossil timeline]</b><br>
110
+ <b>[/help/ls | fossil ls]</b><br>
111
+ <b>[/help/branch | fossil branch]</b><br>
119112
 </blockquote>
120113
121
-</blockquote><h2>Configuring Your Local Repository</h2><blockquote>
114
+<h2>Configuring Your Local Repository</h2>
122115
123116
 <p>When you create a new repository, either by cloning an existing
124117
 project or create a new project of your own, you usually want to do some
125118
 local configuration. This is easily accomplished using the webserver
126
- that is built into fossil. Start the fossil webserver like this:</p>
119
+ that is built into fossil. Start the fossil webserver like this:
120
+ ([/help/ui | more info])</p>
127121
128122
 <blockquote>
129123
 <b>fossil ui </b><i> repository-filename</i>
130124
 </blockquote>
131125
@@ -147,119 +141,122 @@
147141
 should, change this after you create a few users.</p>
148142
149143
 <p>When you are finished configuring, just press Control-C or use
150144
 the <b>kill</b> command to shut down the mini-server.</p>
151145
152
-</blockquote><h2>Making Changes</h2><blockquote>
146
+<h2>Making Changes</h2>
153147
154148
 <p>To add new files to your project, or remove old files, use these
155149
 commands:</p>
156150
157151
 <blockquote>
158
- <b>fossil add</b> <i>file...</i><br>
159
- <b>fossil rm</b> <i>file...</i>
152
+ <b>[/help/add | fossil add]</b> <i>file...</i><br>
153
+ <b>[/help/rm | fossil rm]</b> <i>file...</i>
160154
 </blockquote>
161155
162156
 <p>You can also edit files freely. Once you are ready to commit
163157
 your changes, type:</p>
164158
165159
 <blockquote>
166
- <b>fossil commit</b>
160
+ <b>[/help/commit | fossil commit]</b>
167161
 </blockquote>
168162
169163
 <p>You will be prompted for check-in comments using whatever editor
170164
 is specified by your VISUAL or EDITOR environment variable.</p>
171165
172
-</blockquote><h2>Sharing Changes</h2><blockquote>
166
+<h2>Sharing Changes</h2>
173167
174
- <p>The changes you <b>commit</b> are only on your local repository.
168
+ <p>The changes you [/help/commit | commit] are only
169
+ on your local repository.
175170
 To share those changes with other repositories, do:</p>
176171
177172
 <blockquote>
178
- <b>fossil push</b> <i>URL</i>
173
+ <b>[/help/push | fossil push]</b> <i>URL</i>
179174
 </blockquote>
180175
181176
 <p>Where <i>URL</i> is the http: URL of the server repository you
182177
 want to share your changes with. If you omit the <i>URL</i> argument,
183178
 fossil will use whatever server you most recently synced with.</p>
184179
185
- <p>The <b>push</b> command only sends your changes to others. To
186
- Receive changes from others, use <b>pull</b>. Or go both ways at
187
- once using <b>sync</b>:</p>
180
+ <p>The [/help/push | push] command only sends your changes to others. To
181
+ Receive changes from others, use [/help/pull | pull]. Or go both ways at
182
+ once using [/help/sync | sync]:</p>
188183
189184
 <blockquote>
190
- <b>fossil pull</b> <i>URL</i><br>
191
- <b>fossil sync</b> <i>URL</i>
185
+ <b>[/help/pull | fossil pull]</b> <i>URL</i><br>
186
+ <b>[/help/sync | fossil sync]</b> <i>URL</i>
192187
 </blockquote>
193188
194189
 <p>When you pull in changes from others, they go into your repository,
195190
 not into your checked-out local tree. To get the changes into your
196
- local tree, use <b>update</b>:</p>
191
+ local tree, use [/help/update | update]:</p>
197192
198193
 <blockquote>
199
- <b>fossil update</b> <i>VERSION</i>
194
+ <b>[/help/update | fossil update]</b> <i>VERSION</i>
200195
 </blockquote>
201196
202197
 <p>The <i>VERSION</i> can be the name of a branch or tag or any
203198
 abbreviation to the 40-character
204199
 artifact identifier for a particular check-in, or it can be a
205
- date/time stamp. (<a href="./checkin_names.wiki">More information</a>.)
200
+ date/time stamp. ([./checkin_names.wiki | more info])
206201
 If you omit
207202
 the <i>VERSION</i>, then fossil moves you to the
208203
 latest version of the branch your are currently on.</p>
209204
210
-</blockquote><h2>Branching And Merging</h2><blockquote>
205
+<h2>Branching And Merging</h2>
211206
212207
 <p>You can create branches by doing multiple commits off of the
213208
 same base version. To merge to branches back together, first
214
- <b>update</b> to the leaf of one branch. Then do a <b>merge</b>
215
- of the leaf of the other branch:</p>
209
+ [/help/update | update] to the leaf of one branch. Then do a
210
+ [/help/merge | merge] of the leaf of the other branch:</p>
216211
217212
 <blockquote>
218
- <b>fossil merge</b> <i>VERSION</i>
213
+ <b>[/help/merge | fossil merge]</b> <i>VERSION</i>
219214
 </blockquote>
220215
221
- <p>The <i>VERSION</i> can be any of the forms allowed for <b>update</b>.
216
+ <p>The <i>VERSION</i> can be any of the forms allowed for
217
+ [/help/update | update].
222218
 After performing the merge, you will normally want to test it to
223219
 make sure it does not break anything, then
224
- <b>commit</b> your chagnes. In the default configuration, the <b>commit</b>
225
- command will also automatically <b>push</b> your changes, but that
220
+ [/help/commit | commit] your changes.
221
+ In the default configuration, the [/help/commit|commit]
222
+ command will also automatically [/help/push|push] your changes, but that
226223
 feature can be disabled. (More information about
227
- <a href="concepts.wiki#workflow">autosync</a> and how to disable it.)
224
+ [./concepts.wiki#workflow|autosync] and how to disable it.)
228225
 Remember that your coworkers can not see your changes until you
229
- <b>commit</b> and <b>push</b> them.</p>
226
+ commit and push them.</p>
230227
231228
 <p>The merge command has options to cherrypick individual
232229
 changes, or to back out individual changes.</p>
233230
234231
 <p>If a merge or update doesn't work out (perhaps something breaks or
235232
 there are many merge conflicts) then you back up using:</p>
236233
237234
 <blockquote>
238
- <b>fossil undo</b>
235
+ <b>[/help/undo | fossil undo]</b>
239236
 </blockquote>
240237
241238
 <p>This will back out the changes that the merge or update made to the
242
- working checkout. There is also a <b>redo</b> command if you undo by
239
+ working checkout. There is also a [/help/redo|redo] command if you undo by
243240
 mistake. Undo and redo only work for changes that have
244
- not yet been checked in using <b>commit</b> and there is only a single
241
+ not yet been checked in using commit and there is only a single
245242
 level of undo/redo.</p>
246243
247244
248245
 <a name="serversetup"></a>
249
-</blockquote><h2>Setting Up A Server</h2><blockquote>
246
+<h2>Setting Up A Server</h2>
250247
251248
 <p>The easiest way to set up a server is:</p>
252249
253250
 <blockquote>
254
- <b>fossil server</b> <i>repository-filename</i>
251
+ <b>[/help/server | fossil server]</b> <i>repository-filename</i>
255252
 </blockquote>
256253
257254
 <p>Or</b>
258255
259256
 <blockquote>
260
- <b>fossil ui</b> <i>repository-filename</i>
257
+ <b>[/help/ui | fossil ui]</b> <i>repository-filename</i>
261258
 </blockquote>
262259
263260
 <p>The <b>ui</b> command is intended for accessing the web interface
264261
 from a local desktop. The <b>ui</b> command binds to the loopback IP
265262
 address only (and is thus makes the web interface visible only on the
@@ -303,11 +300,12 @@
303300
 unprivileged user. But it is more secure to run fossil as root.
304301
 When you do run fossil as root, it automatically puts itself in a
305302
 chroot jail in the same directory as the repository, then drops
306303
 root privileges prior to reading any information from the request.</p>
307304
308
-</blockquote><a name="proxy"></a><h2>HTTP Proxies</h2><blockquote>
305
+<a name="proxy"></a>
306
+<h2>HTTP Proxies</h2>
309307
310308
 <p>If you are behind a restrictive firewall that requires you to use
311309
 an HTTP proxy to reach the internet, then you can configure the proxy
312310
 in three different ways. You can tell fossil about your proxy using
313311
 a command-line option on commands that use the network,
@@ -317,11 +315,11 @@
317315
 <b>fossil clone </b><i>URL</i> <b>--proxy</b> <i>Proxy-URL</i>
318316
 </blockquote>
319317
320318
 <p>It is annoying to have to type in the proxy URL every time you
321319
 sync your project, though, so you can make the proxy configuration
322
- persistent using the <b>setting</b> command:</p>
320
+ persistent using the [/help/setting | setting] command:</p>
323321
324322
 <blockquote>
325323
 <b>fossil setting proxy </b><i>Proxy-URL</i>
326324
 </blockquote>
327325
@@ -346,19 +344,15 @@
346344
347345
 <blockquote>
348346
 <b>fossil sync http://192.168.1.36:8080/ --proxy off</b>
349347
 </blockquote>
350348
351
-</blockquote><h2>More Hints</h2><blockquote>
349
+<h2>More Hints</h2>
352350
353351
 <p>Try these commands:</p>
354352
355353
 <blockquote><b>
356
- fossil help<br>
357
- fossil test-commands
354
+ [/help/help | fossil help]<br>
355
+ [/help/test-command | fossil test-commands]
358356
 </b></blockquote>
359357
360358
 <p>Explore and have fun!</p>
361
-
362
-
363
-</blockquote>
364
-</nowiki>
365359
366360
ADDED www/tech_overview.wiki
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -1,67 +1,60 @@
1 <title>Fossil Quick Start Guide</title>
2 <nowiki>
3 <h1 align="center">Fossil Quick Start</h1>
4
5 <p>This is a guide to get you started using fossil quickly
6 and painlessly.</p>
7
8 <h2>Installing</h2><blockquote>
9
10 <p>Fossil is a single self-contained C program. You need to
11 either download a
12 <a href="http://www.fossil-scm.org/download.html">precompiled binary</a>
13 or <a href="build.wiki">build it yourself</a> from sources.
14 Install fossil by putting the fossil binary
15 someplace on your PATH environment variable.</p>
16
17 </blockquote>
18 <a name="fslclone"></a>
19
20 <h2>General Work Flow</h2><blockquote>
21
22 <p>Fossil works with repository files, a database with the project's
23 complete history, and with checked-out local trees, the working directory
24 you use to do your work. In most operations that require you to work on a
25 specific repository you must have a checked out tree in place to work from.
26 The resulting workflow looks like this:</p>
27
28 <ul>
29 <li>Create or clone a repository file. (<b>fossil new</b> or
30 <b>fossil clone</b>)
31 <li>Check out a local tree. (<b>fossil open</b>)
32 <li>Perform operations on the repository (including repository
33 configuration).
34 <li><em>Optionally</em> close the local tree. (<b>fossil
35 close</b>, but this is rarely used.)
36 </ul>
37
38 <p>The following sections will give you a brief overview of these
39 operations.</p>
40
41 </blockquote>
42
43 <h2>Starting A New Project</h2><blockquote>
44
45 <p>To start a new project with fossil, create a new empty repository
46 this way:</p>
47
48 <blockquote>
49 <b>fossil new </b><i> repository-filename</i>
50 </blockquote>
51
52 </blockquote>
53
54 <h2>Cloning An Existing Repository</h2><blockquote>
55
56 <p>Most fossil operations interact with a repository that is on the
57 local disk drive, not on a remote system. Hence, before accessing
58 a remote repository it is necessary to make a local copy of that
59 repository. Making a local copy of a remote repository is called
60 "cloning".</p>
61
62 <p>Clone a remote repository as follows:</p>
63
64 <blockquote>
65 <b>fossil clone</b> <i>URL repository-filename</i>
66 </blockquote>
67
@@ -82,23 +75,23 @@
82 is not required.</p>
83
84 <p>Note: If you are behind a restrictive firewall, you might need
85 to <a href="#proxy">specify an HTTP proxy</a> to use.</p>
86
87 </blockquote><h2>Importing From Another Version Control System</h2><blockquote>
88
89 <p>Rather than start a new project, or clone an existing Fossil project,
90 you might prefer to
91 <a href="./inout.wiki">import an existing Git project</a>
92 into Fossil.
93
94 </blockquote><h2>Checking Out A Local Tree</h2><blockquote>
95
96 <p>To work on a project in fossil, you need to check out a local
97 copy of the source tree. Create the directory you want to be
98 the root of your tree and cd into that directory. Then
99 do this:</p>
100
101 <blockquote>
102 <b>fossil open </b><i> repository-filename</i>
103 </blockquote>
104
@@ -107,25 +100,26 @@
107 From anywhere underneath the root of your local tree, you
108 can type commands like the following to find out the status of
109 your local tree:</p>
110
111 <blockquote>
112 <b>fossil info</b><br>
113 <b>fossil status</b><br>
114 <b>fossil changes</b><br>
115 <b>fossil diff</b><br>
116 <b>fossil timeline</b><br>
117 <b>fossil ls</b><br>
118 <b>fossil branch list</b><br>
119 </blockquote>
120
121 </blockquote><h2>Configuring Your Local Repository</h2><blockquote>
122
123 <p>When you create a new repository, either by cloning an existing
124 project or create a new project of your own, you usually want to do some
125 local configuration. This is easily accomplished using the webserver
126 that is built into fossil. Start the fossil webserver like this:</p>
 
127
128 <blockquote>
129 <b>fossil ui </b><i> repository-filename</i>
130 </blockquote>
131
@@ -147,119 +141,122 @@
147 should, change this after you create a few users.</p>
148
149 <p>When you are finished configuring, just press Control-C or use
150 the <b>kill</b> command to shut down the mini-server.</p>
151
152 </blockquote><h2>Making Changes</h2><blockquote>
153
154 <p>To add new files to your project, or remove old files, use these
155 commands:</p>
156
157 <blockquote>
158 <b>fossil add</b> <i>file...</i><br>
159 <b>fossil rm</b> <i>file...</i>
160 </blockquote>
161
162 <p>You can also edit files freely. Once you are ready to commit
163 your changes, type:</p>
164
165 <blockquote>
166 <b>fossil commit</b>
167 </blockquote>
168
169 <p>You will be prompted for check-in comments using whatever editor
170 is specified by your VISUAL or EDITOR environment variable.</p>
171
172 </blockquote><h2>Sharing Changes</h2><blockquote>
173
174 <p>The changes you <b>commit</b> are only on your local repository.
 
175 To share those changes with other repositories, do:</p>
176
177 <blockquote>
178 <b>fossil push</b> <i>URL</i>
179 </blockquote>
180
181 <p>Where <i>URL</i> is the http: URL of the server repository you
182 want to share your changes with. If you omit the <i>URL</i> argument,
183 fossil will use whatever server you most recently synced with.</p>
184
185 <p>The <b>push</b> command only sends your changes to others. To
186 Receive changes from others, use <b>pull</b>. Or go both ways at
187 once using <b>sync</b>:</p>
188
189 <blockquote>
190 <b>fossil pull</b> <i>URL</i><br>
191 <b>fossil sync</b> <i>URL</i>
192 </blockquote>
193
194 <p>When you pull in changes from others, they go into your repository,
195 not into your checked-out local tree. To get the changes into your
196 local tree, use <b>update</b>:</p>
197
198 <blockquote>
199 <b>fossil update</b> <i>VERSION</i>
200 </blockquote>
201
202 <p>The <i>VERSION</i> can be the name of a branch or tag or any
203 abbreviation to the 40-character
204 artifact identifier for a particular check-in, or it can be a
205 date/time stamp. (<a href="./checkin_names.wiki">More information</a>.)
206 If you omit
207 the <i>VERSION</i>, then fossil moves you to the
208 latest version of the branch your are currently on.</p>
209
210 </blockquote><h2>Branching And Merging</h2><blockquote>
211
212 <p>You can create branches by doing multiple commits off of the
213 same base version. To merge to branches back together, first
214 <b>update</b> to the leaf of one branch. Then do a <b>merge</b>
215 of the leaf of the other branch:</p>
216
217 <blockquote>
218 <b>fossil merge</b> <i>VERSION</i>
219 </blockquote>
220
221 <p>The <i>VERSION</i> can be any of the forms allowed for <b>update</b>.
 
222 After performing the merge, you will normally want to test it to
223 make sure it does not break anything, then
224 <b>commit</b> your chagnes. In the default configuration, the <b>commit</b>
225 command will also automatically <b>push</b> your changes, but that
 
226 feature can be disabled. (More information about
227 <a href="concepts.wiki#workflow">autosync</a> and how to disable it.)
228 Remember that your coworkers can not see your changes until you
229 <b>commit</b> and <b>push</b> them.</p>
230
231 <p>The merge command has options to cherrypick individual
232 changes, or to back out individual changes.</p>
233
234 <p>If a merge or update doesn't work out (perhaps something breaks or
235 there are many merge conflicts) then you back up using:</p>
236
237 <blockquote>
238 <b>fossil undo</b>
239 </blockquote>
240
241 <p>This will back out the changes that the merge or update made to the
242 working checkout. There is also a <b>redo</b> command if you undo by
243 mistake. Undo and redo only work for changes that have
244 not yet been checked in using <b>commit</b> and there is only a single
245 level of undo/redo.</p>
246
247
248 <a name="serversetup"></a>
249 </blockquote><h2>Setting Up A Server</h2><blockquote>
250
251 <p>The easiest way to set up a server is:</p>
252
253 <blockquote>
254 <b>fossil server</b> <i>repository-filename</i>
255 </blockquote>
256
257 <p>Or</b>
258
259 <blockquote>
260 <b>fossil ui</b> <i>repository-filename</i>
261 </blockquote>
262
263 <p>The <b>ui</b> command is intended for accessing the web interface
264 from a local desktop. The <b>ui</b> command binds to the loopback IP
265 address only (and is thus makes the web interface visible only on the
@@ -303,11 +300,12 @@
303 unprivileged user. But it is more secure to run fossil as root.
304 When you do run fossil as root, it automatically puts itself in a
305 chroot jail in the same directory as the repository, then drops
306 root privileges prior to reading any information from the request.</p>
307
308 </blockquote><a name="proxy"></a><h2>HTTP Proxies</h2><blockquote>
 
309
310 <p>If you are behind a restrictive firewall that requires you to use
311 an HTTP proxy to reach the internet, then you can configure the proxy
312 in three different ways. You can tell fossil about your proxy using
313 a command-line option on commands that use the network,
@@ -317,11 +315,11 @@
317 <b>fossil clone </b><i>URL</i> <b>--proxy</b> <i>Proxy-URL</i>
318 </blockquote>
319
320 <p>It is annoying to have to type in the proxy URL every time you
321 sync your project, though, so you can make the proxy configuration
322 persistent using the <b>setting</b> command:</p>
323
324 <blockquote>
325 <b>fossil setting proxy </b><i>Proxy-URL</i>
326 </blockquote>
327
@@ -346,19 +344,15 @@
346
347 <blockquote>
348 <b>fossil sync http://192.168.1.36:8080/ --proxy off</b>
349 </blockquote>
350
351 </blockquote><h2>More Hints</h2><blockquote>
352
353 <p>Try these commands:</p>
354
355 <blockquote><b>
356 fossil help<br>
357 fossil test-commands
358 </b></blockquote>
359
360 <p>Explore and have fun!</p>
361
362
363 </blockquote>
364 </nowiki>
365
366 DDED www/tech_overview.wiki
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -1,67 +1,60 @@
1 <title>Fossil Quick Start Guide</title>
 
2 <h1 align="center">Fossil Quick Start</h1>
3
4 <p>This is a guide to get you started using fossil quickly
5 and painlessly.</p>
6
7 <h2>Installing</h2>
8
9 <p>Fossil is a single self-contained C program. You need to
10 either download a
11 <a href="http://www.fossil-scm.org/download.html">precompiled binary</a>
12 or <a href="build.wiki">build it yourself</a> from sources.
13 Install fossil by putting the fossil binary
14 someplace on your PATH environment variable.</p>
15
 
16 <a name="fslclone"></a>
17 <h2>General Work Flow</h2>
 
18
19 <p>Fossil works with repository files, a database with the project's
20 complete history, and with checked-out local trees, the working directory
21 you use to do your work. In most operations that require you to work on a
22 specific repository you must have a checked out tree in place to work from.
23 The resulting workflow looks like this:</p>
24
25 <ul>
26 <li>Create or clone a repository file. ([/help/new|fossil new] or
27 [/help/clone | fossil clone])
28 <li>Check out a local tree. ([/help/open | fossil open])
29 <li>Perform operations on the repository (including repository
30 configuration).
31 <li><em>Optionally</em> close the local tree.
32 ([/help/close | fossil close], but this is rarely used.)
33 </ul>
34
35 <p>The following sections will give you a brief overview of these
36 operations.</p>
37
38 <h2>Starting A New Project</h2>
 
 
39
40 <p>To start a new project with fossil, create a new empty repository
41 this way: ([/help/new | more info]) </p>
42
43 <blockquote>
44 <b>fossil new </b><i> repository-filename</i>
45 </blockquote>
46
47 <h2>Cloning An Existing Repository</h2>
 
 
48
49 <p>Most fossil operations interact with a repository that is on the
50 local disk drive, not on a remote system. Hence, before accessing
51 a remote repository it is necessary to make a local copy of that
52 repository. Making a local copy of a remote repository is called
53 "cloning".</p>
54
55 <p>Clone a remote repository as follows: ([/help/clone | more info])</p>
56
57 <blockquote>
58 <b>fossil clone</b> <i>URL repository-filename</i>
59 </blockquote>
60
@@ -82,23 +75,23 @@
75 is not required.</p>
76
77 <p>Note: If you are behind a restrictive firewall, you might need
78 to <a href="#proxy">specify an HTTP proxy</a> to use.</p>
79
80 <h2>Importing From Another Version Control System</h2>
81
82 <p>Rather than start a new project, or clone an existing Fossil project,
83 you might prefer to
84 <a href="./inout.wiki">import an existing Git project</a>
85 into Fossil using the [/help/import | fossil import] command.
86
87 <h2>Checking Out A Local Tree</h2>
88
89 <p>To work on a project in fossil, you need to check out a local
90 copy of the source tree. Create the directory you want to be
91 the root of your tree and cd into that directory. Then
92 do this: ([/help/open | more info])</p>
93
94 <blockquote>
95 <b>fossil open </b><i> repository-filename</i>
96 </blockquote>
97
@@ -107,25 +100,26 @@
100 From anywhere underneath the root of your local tree, you
101 can type commands like the following to find out the status of
102 your local tree:</p>
103
104 <blockquote>
105 <b>[/help/info | fossil info]</b><br>
106 <b>[/help/status | fossil status]</b><br>
107 <b>[/help/changes | fossil changes]</b><br>
108 <b>[/help/diff | fossil diff]</b><br>
109 <b>[/help/timeline | fossil timeline]</b><br>
110 <b>[/help/ls | fossil ls]</b><br>
111 <b>[/help/branch | fossil branch]</b><br>
112 </blockquote>
113
114 <h2>Configuring Your Local Repository</h2>
115
116 <p>When you create a new repository, either by cloning an existing
117 project or create a new project of your own, you usually want to do some
118 local configuration. This is easily accomplished using the webserver
119 that is built into fossil. Start the fossil webserver like this:
120 ([/help/ui | more info])</p>
121
122 <blockquote>
123 <b>fossil ui </b><i> repository-filename</i>
124 </blockquote>
125
@@ -147,119 +141,122 @@
141 should, change this after you create a few users.</p>
142
143 <p>When you are finished configuring, just press Control-C or use
144 the <b>kill</b> command to shut down the mini-server.</p>
145
146 <h2>Making Changes</h2>
147
148 <p>To add new files to your project, or remove old files, use these
149 commands:</p>
150
151 <blockquote>
152 <b>[/help/add | fossil add]</b> <i>file...</i><br>
153 <b>[/help/rm | fossil rm]</b> <i>file...</i>
154 </blockquote>
155
156 <p>You can also edit files freely. Once you are ready to commit
157 your changes, type:</p>
158
159 <blockquote>
160 <b>[/help/commit | fossil commit]</b>
161 </blockquote>
162
163 <p>You will be prompted for check-in comments using whatever editor
164 is specified by your VISUAL or EDITOR environment variable.</p>
165
166 <h2>Sharing Changes</h2>
167
168 <p>The changes you [/help/commit | commit] are only
169 on your local repository.
170 To share those changes with other repositories, do:</p>
171
172 <blockquote>
173 <b>[/help/push | fossil push]</b> <i>URL</i>
174 </blockquote>
175
176 <p>Where <i>URL</i> is the http: URL of the server repository you
177 want to share your changes with. If you omit the <i>URL</i> argument,
178 fossil will use whatever server you most recently synced with.</p>
179
180 <p>The [/help/push | push] command only sends your changes to others. To
181 Receive changes from others, use [/help/pull | pull]. Or go both ways at
182 once using [/help/sync | sync]:</p>
183
184 <blockquote>
185 <b>[/help/pull | fossil pull]</b> <i>URL</i><br>
186 <b>[/help/sync | fossil sync]</b> <i>URL</i>
187 </blockquote>
188
189 <p>When you pull in changes from others, they go into your repository,
190 not into your checked-out local tree. To get the changes into your
191 local tree, use [/help/update | update]:</p>
192
193 <blockquote>
194 <b>[/help/update | fossil update]</b> <i>VERSION</i>
195 </blockquote>
196
197 <p>The <i>VERSION</i> can be the name of a branch or tag or any
198 abbreviation to the 40-character
199 artifact identifier for a particular check-in, or it can be a
200 date/time stamp. ([./checkin_names.wiki | more info])
201 If you omit
202 the <i>VERSION</i>, then fossil moves you to the
203 latest version of the branch your are currently on.</p>
204
205 <h2>Branching And Merging</h2>
206
207 <p>You can create branches by doing multiple commits off of the
208 same base version. To merge to branches back together, first
209 [/help/update | update] to the leaf of one branch. Then do a
210 [/help/merge | merge] of the leaf of the other branch:</p>
211
212 <blockquote>
213 <b>[/help/merge | fossil merge]</b> <i>VERSION</i>
214 </blockquote>
215
216 <p>The <i>VERSION</i> can be any of the forms allowed for
217 [/help/update | update].
218 After performing the merge, you will normally want to test it to
219 make sure it does not break anything, then
220 [/help/commit | commit] your changes.
221 In the default configuration, the [/help/commit|commit]
222 command will also automatically [/help/push|push] your changes, but that
223 feature can be disabled. (More information about
224 [./concepts.wiki#workflow|autosync] and how to disable it.)
225 Remember that your coworkers can not see your changes until you
226 commit and push them.</p>
227
228 <p>The merge command has options to cherrypick individual
229 changes, or to back out individual changes.</p>
230
231 <p>If a merge or update doesn't work out (perhaps something breaks or
232 there are many merge conflicts) then you back up using:</p>
233
234 <blockquote>
235 <b>[/help/undo | fossil undo]</b>
236 </blockquote>
237
238 <p>This will back out the changes that the merge or update made to the
239 working checkout. There is also a [/help/redo|redo] command if you undo by
240 mistake. Undo and redo only work for changes that have
241 not yet been checked in using commit and there is only a single
242 level of undo/redo.</p>
243
244
245 <a name="serversetup"></a>
246 <h2>Setting Up A Server</h2>
247
248 <p>The easiest way to set up a server is:</p>
249
250 <blockquote>
251 <b>[/help/server | fossil server]</b> <i>repository-filename</i>
252 </blockquote>
253
254 <p>Or</b>
255
256 <blockquote>
257 <b>[/help/ui | fossil ui]</b> <i>repository-filename</i>
258 </blockquote>
259
260 <p>The <b>ui</b> command is intended for accessing the web interface
261 from a local desktop. The <b>ui</b> command binds to the loopback IP
262 address only (and is thus makes the web interface visible only on the
@@ -303,11 +300,12 @@
300 unprivileged user. But it is more secure to run fossil as root.
301 When you do run fossil as root, it automatically puts itself in a
302 chroot jail in the same directory as the repository, then drops
303 root privileges prior to reading any information from the request.</p>
304
305 <a name="proxy"></a>
306 <h2>HTTP Proxies</h2>
307
308 <p>If you are behind a restrictive firewall that requires you to use
309 an HTTP proxy to reach the internet, then you can configure the proxy
310 in three different ways. You can tell fossil about your proxy using
311 a command-line option on commands that use the network,
@@ -317,11 +315,11 @@
315 <b>fossil clone </b><i>URL</i> <b>--proxy</b> <i>Proxy-URL</i>
316 </blockquote>
317
318 <p>It is annoying to have to type in the proxy URL every time you
319 sync your project, though, so you can make the proxy configuration
320 persistent using the [/help/setting | setting] command:</p>
321
322 <blockquote>
323 <b>fossil setting proxy </b><i>Proxy-URL</i>
324 </blockquote>
325
@@ -346,19 +344,15 @@
344
345 <blockquote>
346 <b>fossil sync http://192.168.1.36:8080/ --proxy off</b>
347 </blockquote>
348
349 <h2>More Hints</h2>
350
351 <p>Try these commands:</p>
352
353 <blockquote><b>
354 [/help/help | fossil help]<br>
355 [/help/test-command | fossil test-commands]
356 </b></blockquote>
357
358 <p>Explore and have fun!</p>
 
 
 
 
359
360 DDED www/tech_overview.wiki
A www/tech_overview.wiki
+140
--- a/www/tech_overview.wiki
+++ b/www/tech_overview.wiki
@@ -0,0 +1,140 @@
1
+Totallonly opens <title>Technical Ov since in
2
+itle>Technical Overview</do indeed
3
+exactly correspond to source code f. You might think of these artifacts s "files",
4
+since in many cases the artifacts arcontrol artifacts"
5
+="center">
6
+<tr>
7
+<td width="33 These controd width="33% </h3>
8
+
9
+</td>
10
+<td width="34%</h3>
11
+
12
+</td>
13
+<td width="33%</h3>
14
+eblockquote><FOSSIL_HOME exists
15
+</blockquotallonly opens <title>Technical Overview</title>
16
+<h2 align="center">
17
+A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
18
+</h2>
19
+
20
+<h2>1.0 Introduction</h2>
21
+
22
+At its lowest level, a Fossil r,
23
+and so on. lowest level, a Fossil repository consists of an unordered set
24
+of immutable "anOverview</title>
25
+<h2 align="center">
26
+A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
27
+</h2>
28
+
29
+<h2>1.0 Introduction</h2>
30
+t<h2>1.0 Introduction</h2>
31
+
32
+At its lowest level, a Fossil repository consists of an ugeneration". You might think of these artifacts as "files",
33
+sintth="33% </h3>
34
+
35
+</td>
36
+<td width="34%</h3>
37
+
38
+</td>
39
+<td width="33%</h3
40
+1" width="80%" cellpaddy opens <title>Technical Overview</title>
41
+<h2 align="center">
42
+A Technical centethat<h2>1.0 Introduction</h2>
43
+
44
+At its lowest level, a Fossil resitory cof immutable "artifacts". You might think of these artifacts as "files",
45
+since in many cases the artifacts are exaborder="1" width="80%" cellpadding="0" align="center">
46
+<tr>
47
+<td width=store%</h3>
48
+
49
+</td>
50
+<td width="33%</h3>
51
+eblockquote><FOSSIL_HOME exists
52
+</bloc>
53
+<h2 align="center">
54
+A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
55
+</h2>
56
+
57
+<h2>1.And SQLite makes updates to these database files atomic,
58
+even if repository consists of an unorderoccurs in n the face of system crashes and power failures, meaning that even
59
+a power loss in the middle of aaes",
60
+since in many cases the artifa
61
+can be used to extracn="center">
62
+A Technical centethat<h2>1.0 Introduction</h2>
63
+
64
+At its lowest level, a Fossil resitory cof immutable "artifacts". You might think of these artifacts as "files",
65
+since in many
66
+contentartifacts as "files",
67
+since inwts". You might think of these artifacts as "files",
68
+since in many cases the artifacts arcontrol artifacts"
69
+="center">
70
+<tr>
71
+<td width="33 These controd width="33% </h3>
72
+
73
+</td>
74
+<td width="34%</h3>
75
+
76
+</td>
77
+<td width="33%</h3>
78
+eblockquote><FOSSIL_HOME exists
79
+</blockquotallonly opens <title>Technical Overview</title>
80
+<h2 align="center">
81
+exactly correspond to source code f. You might think of these artifacts s "files",
82
+since in many cases the artifacts arcontrol artifacts"
83
+="center">
84
+<tr>
85
+<td width="33 These controd width align="center">
86
+<tr>
87
+<td width="33% </h3>
88
+
89
+</td>
90
+<td width="34%</h3>
91
+
92
+</td>
93
+<td width="33%</h3>
94
+eblockquote><FOSSIL_HOME exists
95
+</bloc>
96
+<h2 align="center">
97
+A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
98
+</h2>
99
+
100
+<h2>1.And SQLite makes updates to these database files atomic,
101
+even if repository consists of an unorderoccurs in the middle consists of an unordered set
102
+of immutable "artifacts". You might think of these artifacts as "files",
103
+since in many ca ntitle>Technical Overview</title>
104
+<h2 align="center">
105
+A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
106
+</h2>
107
+
108
+<h2>1.0 Introduction</h2>
109
+
110
+At its lowest level, a Fossil repository consists of an unordered set
111
+of immutable "ar-s as "files",
112
+since in many cases the artifacts are exaborder="1" width="80%" cellpadding="0" align="center">
113
+<tr>
114
+<td width="33% </h3>
115
+
116
+</td>
117
+<td width="34%</h3>
118
+
119
+</td>
120
+<blockquotallonly opens <title>Technical Overview</title>
121
+<h2 a repository consists of an unordered set
122
+of immutable "artifacts". You might think of these artifacts as "files",
123
+since in many cases the artifaes",
124
+since in many cases the artifa
125
+can be ussponr">
126
+<tr>
127
+<td widcontains,
128
+among other thanrtifacts"
129
+="center">
130
+<tr>
131
+<td width="33 These controd width="33% </h3>
132
+
133
+</td>
134
+<td width="34%</h3>
135
+
136
+</td>
137
+<td width="33%</h3>
138
+eblockquote><FOSSIL_HOME exists
139
+</blockquotallonly opens <title>Technical Overview</title>
140
+<h2 al
--- a/www/tech_overview.wiki
+++ b/www/tech_overview.wiki
@@ -0,0 +1,140 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
--- a/www/tech_overview.wiki
+++ b/www/tech_overview.wiki
@@ -0,0 +1,140 @@
1 Totallonly opens <title>Technical Ov since in
2 itle>Technical Overview</do indeed
3 exactly correspond to source code f. You might think of these artifacts s "files",
4 since in many cases the artifacts arcontrol artifacts"
5 ="center">
6 <tr>
7 <td width="33 These controd width="33% </h3>
8
9 </td>
10 <td width="34%</h3>
11
12 </td>
13 <td width="33%</h3>
14 eblockquote><FOSSIL_HOME exists
15 </blockquotallonly opens <title>Technical Overview</title>
16 <h2 align="center">
17 A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
18 </h2>
19
20 <h2>1.0 Introduction</h2>
21
22 At its lowest level, a Fossil r,
23 and so on. lowest level, a Fossil repository consists of an unordered set
24 of immutable "anOverview</title>
25 <h2 align="center">
26 A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
27 </h2>
28
29 <h2>1.0 Introduction</h2>
30 t<h2>1.0 Introduction</h2>
31
32 At its lowest level, a Fossil repository consists of an ugeneration". You might think of these artifacts as "files",
33 sintth="33% </h3>
34
35 </td>
36 <td width="34%</h3>
37
38 </td>
39 <td width="33%</h3
40 1" width="80%" cellpaddy opens <title>Technical Overview</title>
41 <h2 align="center">
42 A Technical centethat<h2>1.0 Introduction</h2>
43
44 At its lowest level, a Fossil resitory cof immutable "artifacts". You might think of these artifacts as "files",
45 since in many cases the artifacts are exaborder="1" width="80%" cellpadding="0" align="center">
46 <tr>
47 <td width=store%</h3>
48
49 </td>
50 <td width="33%</h3>
51 eblockquote><FOSSIL_HOME exists
52 </bloc>
53 <h2 align="center">
54 A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
55 </h2>
56
57 <h2>1.And SQLite makes updates to these database files atomic,
58 even if repository consists of an unorderoccurs in n the face of system crashes and power failures, meaning that even
59 a power loss in the middle of aaes",
60 since in many cases the artifa
61 can be used to extracn="center">
62 A Technical centethat<h2>1.0 Introduction</h2>
63
64 At its lowest level, a Fossil resitory cof immutable "artifacts". You might think of these artifacts as "files",
65 since in many
66 contentartifacts as "files",
67 since inwts". You might think of these artifacts as "files",
68 since in many cases the artifacts arcontrol artifacts"
69 ="center">
70 <tr>
71 <td width="33 These controd width="33% </h3>
72
73 </td>
74 <td width="34%</h3>
75
76 </td>
77 <td width="33%</h3>
78 eblockquote><FOSSIL_HOME exists
79 </blockquotallonly opens <title>Technical Overview</title>
80 <h2 align="center">
81 exactly correspond to source code f. You might think of these artifacts s "files",
82 since in many cases the artifacts arcontrol artifacts"
83 ="center">
84 <tr>
85 <td width="33 These controd width align="center">
86 <tr>
87 <td width="33% </h3>
88
89 </td>
90 <td width="34%</h3>
91
92 </td>
93 <td width="33%</h3>
94 eblockquote><FOSSIL_HOME exists
95 </bloc>
96 <h2 align="center">
97 A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
98 </h2>
99
100 <h2>1.And SQLite makes updates to these database files atomic,
101 even if repository consists of an unorderoccurs in the middle consists of an unordered set
102 of immutable "artifacts". You might think of these artifacts as "files",
103 since in many ca ntitle>Technical Overview</title>
104 <h2 align="center">
105 A Technical Overview<br>Of The Design Anderview of Fossilbr>Of Fossil
106 </h2>
107
108 <h2>1.0 Introduction</h2>
109
110 At its lowest level, a Fossil repository consists of an unordered set
111 of immutable "ar-s as "files",
112 since in many cases the artifacts are exaborder="1" width="80%" cellpadding="0" align="center">
113 <tr>
114 <td width="33% </h3>
115
116 </td>
117 <td width="34%</h3>
118
119 </td>
120 <blockquotallonly opens <title>Technical Overview</title>
121 <h2 a repository consists of an unordered set
122 of immutable "artifacts". You might think of these artifacts as "files",
123 since in many cases the artifaes",
124 since in many cases the artifa
125 can be ussponr">
126 <tr>
127 <td widcontains,
128 among other thanrtifacts"
129 ="center">
130 <tr>
131 <td width="33 These controd width="33% </h3>
132
133 </td>
134 <td width="34%</h3>
135
136 </td>
137 <td width="33%</h3>
138 eblockquote><FOSSIL_HOME exists
139 </blockquotallonly opens <title>Technical Overview</title>
140 <h2 al

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button