Fossil SCM
Clarifications of the "quickstart.wiki" documentation.
Commit
70dcb9fc8baea109ee504804db921f27dcc06764
Parent
44a4c365a75a1f2…
1 file changed
+15
-11
+15
-11
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -14,14 +14,18 @@ | ||
| 14 | 14 | someplace on your PATH environment variable.</p> |
| 15 | 15 | |
| 16 | 16 | </blockquote> |
| 17 | 17 | <h2>Cloning A Existing Repository</h2> |
| 18 | 18 | <blockquote> |
| 19 | - <p>Cloning is the first step in checking out a repository, | |
| 20 | - and is fossil's equivalent to making a local copy of a remote repository.</p> | |
| 21 | 19 | |
| 22 | - <p>Use this command:</p> | |
| 20 | + <p>Most fossil operations interact with a repository that is on the | |
| 21 | + local disk drive, not on a remote system. Hence, before accessing | |
| 22 | + a remote repository it is necessary to make a local copy of that | |
| 23 | + repository. Making a local copy of a remote repository is called | |
| 24 | + "cloning".</p> | |
| 25 | + | |
| 26 | + <p>Clone a remote repository as follows:</p> | |
| 23 | 27 | |
| 24 | 28 | <blockquote> |
| 25 | 29 | <b>fossil clone</b> <i>URL repository-filename</i> |
| 26 | 30 | </blockquote> |
| 27 | 31 | |
| @@ -29,17 +33,17 @@ | ||
| 29 | 33 | you want to clone. You can call the new repository anything you |
| 30 | 34 | want - there are no naming restrictions. As an example, you can |
| 31 | 35 | clone the fossil repository this way:</p> |
| 32 | 36 | |
| 33 | 37 | <blockquote> |
| 34 | - <b>fossil clone http://www.fossil-scm.org/fossil myclone.fsl</b> | |
| 38 | + <b>fossil clone http://www.fossil-scm.org/fossil myclone.fossil</b> | |
| 35 | 39 | </blockquote> |
| 36 | 40 | |
| 37 | - <p>Cloning only a local copy of the source tree (as a single file), but | |
| 38 | - not something you can directly browse. After cloning, you can access | |
| 39 | - the files in the repository using the <tt>open</tt> command, | |
| 40 | - described below</p> | |
| 41 | + <p>The new local copy of the respository is stored in a single file, | |
| 42 | + which in the example above is named "myclone.fossil". | |
| 43 | + You can name your repositories anything you want. The ".fossil" suffix | |
| 44 | + is not required.</p> | |
| 41 | 45 | |
| 42 | 46 | <p>Note: If you are behind a restrictive firewall, you might need |
| 43 | 47 | to <a href="#proxy">specify an HTTP proxy</a> to use.</p> |
| 44 | 48 | |
| 45 | 49 | </blockquote><h2>Starting A New Project</h2><blockquote> |
| @@ -179,11 +183,11 @@ | ||
| 179 | 183 | <b>commit</b> and possibly also <b>push</b> your changes. Remember |
| 180 | 184 | that nobody else can see your changes until you <b>commit</b> and |
| 181 | 185 | if other are using a different repository you will also need to |
| 182 | 186 | <b>push</b>.</p> |
| 183 | 187 | |
| 184 | -<a name="serversetup"> | |
| 188 | +<a name="serversetup"></a> | |
| 185 | 189 | </blockquote><h2>Setting Up A Server</h2><blockquote> |
| 186 | 190 | |
| 187 | 191 | <p>The easiest way to set up a server is:</p> |
| 188 | 192 | |
| 189 | 193 | <blockquote> |
| @@ -209,11 +213,11 @@ | ||
| 209 | 213 | inetd server. To use the CGI server, create a CGI script that |
| 210 | 214 | looks something like this:</p> |
| 211 | 215 | |
| 212 | 216 | <blockquote><b> |
| 213 | 217 | #!/usr/local/bin/fossil<br> |
| 214 | - repository: /home/proj1/repos1.fsl | |
| 218 | + repository: /home/proj1/repos1.fossil | |
| 215 | 219 | </b></blockquote> |
| 216 | 220 | |
| 217 | 221 | <p>Adjust the paths in this CGI script to match your installation. |
| 218 | 222 | Now point clients at the CGI script. That's all there is to it!</p> |
| 219 | 223 | |
| @@ -221,11 +225,11 @@ | ||
| 221 | 225 | installation, make an entry in /etc/inetd.conf that looks something |
| 222 | 226 | like this:</p> |
| 223 | 227 | |
| 224 | 228 | <blockquote><b> |
| 225 | 229 | 80 stream tcp nowait.1000 root /usr/bin/fossil \<br> |
| 226 | - /usr/bin/fossil http /home/proj1/repos1.fsl | |
| 230 | + /usr/bin/fossil http /home/proj1/repos1.fossil | |
| 227 | 231 | </b></blockquote> |
| 228 | 232 | |
| 229 | 233 | <p>Adjust the paths to suit your installation, of course. Notice that |
| 230 | 234 | fossil runs as root. This is not required - you can run it as an |
| 231 | 235 | unprivileged user. But it is more secure to run fossil as root. |
| 232 | 236 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -14,14 +14,18 @@ | |
| 14 | someplace on your PATH environment variable.</p> |
| 15 | |
| 16 | </blockquote> |
| 17 | <h2>Cloning A Existing Repository</h2> |
| 18 | <blockquote> |
| 19 | <p>Cloning is the first step in checking out a repository, |
| 20 | and is fossil's equivalent to making a local copy of a remote repository.</p> |
| 21 | |
| 22 | <p>Use this command:</p> |
| 23 | |
| 24 | <blockquote> |
| 25 | <b>fossil clone</b> <i>URL repository-filename</i> |
| 26 | </blockquote> |
| 27 | |
| @@ -29,17 +33,17 @@ | |
| 29 | you want to clone. You can call the new repository anything you |
| 30 | want - there are no naming restrictions. As an example, you can |
| 31 | clone the fossil repository this way:</p> |
| 32 | |
| 33 | <blockquote> |
| 34 | <b>fossil clone http://www.fossil-scm.org/fossil myclone.fsl</b> |
| 35 | </blockquote> |
| 36 | |
| 37 | <p>Cloning only a local copy of the source tree (as a single file), but |
| 38 | not something you can directly browse. After cloning, you can access |
| 39 | the files in the repository using the <tt>open</tt> command, |
| 40 | described below</p> |
| 41 | |
| 42 | <p>Note: If you are behind a restrictive firewall, you might need |
| 43 | to <a href="#proxy">specify an HTTP proxy</a> to use.</p> |
| 44 | |
| 45 | </blockquote><h2>Starting A New Project</h2><blockquote> |
| @@ -179,11 +183,11 @@ | |
| 179 | <b>commit</b> and possibly also <b>push</b> your changes. Remember |
| 180 | that nobody else can see your changes until you <b>commit</b> and |
| 181 | if other are using a different repository you will also need to |
| 182 | <b>push</b>.</p> |
| 183 | |
| 184 | <a name="serversetup"> |
| 185 | </blockquote><h2>Setting Up A Server</h2><blockquote> |
| 186 | |
| 187 | <p>The easiest way to set up a server is:</p> |
| 188 | |
| 189 | <blockquote> |
| @@ -209,11 +213,11 @@ | |
| 209 | inetd server. To use the CGI server, create a CGI script that |
| 210 | looks something like this:</p> |
| 211 | |
| 212 | <blockquote><b> |
| 213 | #!/usr/local/bin/fossil<br> |
| 214 | repository: /home/proj1/repos1.fsl |
| 215 | </b></blockquote> |
| 216 | |
| 217 | <p>Adjust the paths in this CGI script to match your installation. |
| 218 | Now point clients at the CGI script. That's all there is to it!</p> |
| 219 | |
| @@ -221,11 +225,11 @@ | |
| 221 | installation, make an entry in /etc/inetd.conf that looks something |
| 222 | like this:</p> |
| 223 | |
| 224 | <blockquote><b> |
| 225 | 80 stream tcp nowait.1000 root /usr/bin/fossil \<br> |
| 226 | /usr/bin/fossil http /home/proj1/repos1.fsl |
| 227 | </b></blockquote> |
| 228 | |
| 229 | <p>Adjust the paths to suit your installation, of course. Notice that |
| 230 | fossil runs as root. This is not required - you can run it as an |
| 231 | unprivileged user. But it is more secure to run fossil as root. |
| 232 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -14,14 +14,18 @@ | |
| 14 | someplace on your PATH environment variable.</p> |
| 15 | |
| 16 | </blockquote> |
| 17 | <h2>Cloning A Existing Repository</h2> |
| 18 | <blockquote> |
| 19 | |
| 20 | <p>Most fossil operations interact with a repository that is on the |
| 21 | local disk drive, not on a remote system. Hence, before accessing |
| 22 | a remote repository it is necessary to make a local copy of that |
| 23 | repository. Making a local copy of a remote repository is called |
| 24 | "cloning".</p> |
| 25 | |
| 26 | <p>Clone a remote repository as follows:</p> |
| 27 | |
| 28 | <blockquote> |
| 29 | <b>fossil clone</b> <i>URL repository-filename</i> |
| 30 | </blockquote> |
| 31 | |
| @@ -29,17 +33,17 @@ | |
| 33 | you want to clone. You can call the new repository anything you |
| 34 | want - there are no naming restrictions. As an example, you can |
| 35 | clone the fossil repository this way:</p> |
| 36 | |
| 37 | <blockquote> |
| 38 | <b>fossil clone http://www.fossil-scm.org/fossil myclone.fossil</b> |
| 39 | </blockquote> |
| 40 | |
| 41 | <p>The new local copy of the respository is stored in a single file, |
| 42 | which in the example above is named "myclone.fossil". |
| 43 | You can name your repositories anything you want. The ".fossil" suffix |
| 44 | is not required.</p> |
| 45 | |
| 46 | <p>Note: If you are behind a restrictive firewall, you might need |
| 47 | to <a href="#proxy">specify an HTTP proxy</a> to use.</p> |
| 48 | |
| 49 | </blockquote><h2>Starting A New Project</h2><blockquote> |
| @@ -179,11 +183,11 @@ | |
| 183 | <b>commit</b> and possibly also <b>push</b> your changes. Remember |
| 184 | that nobody else can see your changes until you <b>commit</b> and |
| 185 | if other are using a different repository you will also need to |
| 186 | <b>push</b>.</p> |
| 187 | |
| 188 | <a name="serversetup"></a> |
| 189 | </blockquote><h2>Setting Up A Server</h2><blockquote> |
| 190 | |
| 191 | <p>The easiest way to set up a server is:</p> |
| 192 | |
| 193 | <blockquote> |
| @@ -209,11 +213,11 @@ | |
| 213 | inetd server. To use the CGI server, create a CGI script that |
| 214 | looks something like this:</p> |
| 215 | |
| 216 | <blockquote><b> |
| 217 | #!/usr/local/bin/fossil<br> |
| 218 | repository: /home/proj1/repos1.fossil |
| 219 | </b></blockquote> |
| 220 | |
| 221 | <p>Adjust the paths in this CGI script to match your installation. |
| 222 | Now point clients at the CGI script. That's all there is to it!</p> |
| 223 | |
| @@ -221,11 +225,11 @@ | |
| 225 | installation, make an entry in /etc/inetd.conf that looks something |
| 226 | like this:</p> |
| 227 | |
| 228 | <blockquote><b> |
| 229 | 80 stream tcp nowait.1000 root /usr/bin/fossil \<br> |
| 230 | /usr/bin/fossil http /home/proj1/repos1.fossil |
| 231 | </b></blockquote> |
| 232 | |
| 233 | <p>Adjust the paths to suit your installation, of course. Notice that |
| 234 | fossil runs as root. This is not required - you can run it as an |
| 235 | unprivileged user. But it is more secure to run fossil as root. |
| 236 |