Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| SHA1 Hash: | 43472d55f31dc4b191bed0e11955ae20ba43741c |
|---|---|
| Date: | 2010-06-18 03:21:48 |
| User: | michael |
| Comment: | Fixed up the quickstart to present information in a more logical order. |
Tags And Properties
- bgcolor=#f0ffc0 propagates to descendants added by [152c23c3dc] on 2010-06-23 11:51:17
- branch=ttmrichter propagates to descendants
- date=2010-06-18 03:21:48 added by [152c23c3dc] on 2010-06-23 11:51:17
- sym-trunk cancelled
- sym-ttmrichter propagates to descendants
Changes
Changes to www/quickstart.wiki
12 <a href="http://www.fossil-scm.org/download.html">precompiled binary</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. 13 or <a href="build.wiki">build it yourself</a> from sources. 14 Install fossil by putting the fossil binary 14 Install fossil by putting the fossil binary 15 someplace on your PATH environment variable.</p> 15 someplace on your PATH environment variable.</p> 16 16 17 </blockquote> 17 </blockquote> 18 <a name="fslclone"></a> 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 19 <h2>Cloning An Existing Repository</h2><blockquote> 54 <h2>Cloning An Existing Repository</h2><blockquote> 20 55 21 <p>Most fossil operations interact with a repository that is on the 56 <p>Most fossil operations interact with a repository that is on the 22 local disk drive, not on a remote system. Hence, before accessing 57 local disk drive, not on a remote system. Hence, before accessing 23 a remote repository it is necessary to make a local copy of that 58 a remote repository it is necessary to make a local copy of that 24 repository. Making a local copy of a remote repository is called 59 repository. Making a local copy of a remote repository is called 25 "cloning".</p> 60 "cloning".</p> ................................................................................................................................................................................ 45 which in the example above is named "myclone.fossil". 80 which in the example above is named "myclone.fossil". 46 You can name your repositories anything you want. The ".fossil" suffix 81 You can name your repositories anything you want. The ".fossil" suffix 47 is not required.</p> 82 is not required.</p> 48 83 49 <p>Note: If you are behind a restrictive firewall, you might need 84 <p>Note: If you are behind a restrictive firewall, you might need 50 to <a href="#proxy">specify an HTTP proxy</a> to use.</p> 85 to <a href="#proxy">specify an HTTP proxy</a> to use.</p> 51 86 52 </blockquote><h2>Starting A New Project</h2><blockquote> < 53 < 54 <p>To start a new project with fossil, create a new empty repository < 55 this way:</p> < 56 < 57 <blockquote> < 58 <b>fossil new </b><i> repository-filename</i> < 59 </blockquote> < 60 < 61 </blockquote><h2>Configuring Your Local Repository</h2><blockquote> < 62 < 63 <p>When you create a new repository, either by cloning an existing < 64 project or create a new project of your own, you usually want to do some < 65 local configuration. This is easily accomplished using the webserver < 66 that is built into fossil. Start the fossil webserver like this:</p> < 67 < 68 <blockquote> < 69 <b>fossil ui </b><i> repository-filename</i> < 70 </blockquote> < 71 < 72 <p>This starts a web server then automatically launches your < 73 web browser and makes it point to this web server. If your system < 74 has an unusual configuration, fossil might not be able to figure out < 75 how to start your web browser. In that case, first tell fossil < 76 where to find your web browser using a command like this:</p> < 77 < 78 <blockquote> < 79 <b>fossil setting web-browser </b><i> path-to-web-browser</i> < 80 </blockquote> < 81 < 82 <p>By default, fossil does not require a login for HTTP connections < 83 coming in from the IP loopback address 127.0.0.1. You can, and perhaps < 84 should, change this after you create a few users.</p> < 85 < 86 <p>When you are finished configuring, just press Control-C or use < 87 the <b>kill</b> command to shut down the mini-server.</p> < 88 < 89 </blockquote><h2>Checking Out A Local Tree</h2><blockquote> 87 </blockquote><h2>Checking Out A Local Tree</h2><blockquote> 90 88 91 <p>To work on a project in fossil, you need to check out a local 89 <p>To work on a project in fossil, you need to check out a local 92 copy of the source tree. Create the directory you want to be 90 copy of the source tree. Create the directory you want to be 93 the root of your tree and cd into that directory. Then 91 the root of your tree and cd into that directory. Then 94 do this:</p> 92 do this:</p> 95 93 ................................................................................................................................................................................ 108 <b>fossil status</b><br> 106 <b>fossil status</b><br> 109 <b>fossil changes</b><br> 107 <b>fossil changes</b><br> 110 <b>fossil timeline</b><br> 108 <b>fossil timeline</b><br> 111 <b>fossil leaves</b><br> 109 <b>fossil leaves</b><br> 112 <b>fossil ls</b><br> 110 <b>fossil ls</b><br> 113 <b>fossil branch list</b><br> 111 <b>fossil branch list</b><br> 114 </blockquote> 112 </blockquote> > 113 > 114 </blockquote><h2>Configuring Your Local Repository</h2><blockquote> > 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:</p> > 120 > 121 <blockquote> > 122 <b>fossil ui </b><i> repository-filename</i> > 123 </blockquote> > 124 > 125 <p>(Note that this requires you to have checked out a local tree > 126 beforehand.)</p> > 127 > 128 <p>This starts a web server then automatically launches your > 129 web browser and makes it point to this web server. If your system > 130 has an unusual configuration, fossil might not be able to figure out > 131 how to start your web browser. In that case, first tell fossil > 132 where to find your web browser using a command like this:</p> > 133 > 134 <blockquote> > 135 <b>fossil setting web-browser </b><i> path-to-web-browser</i> > 136 </blockquote> > 137 > 138 <p>By default, fossil does not require a login for HTTP connections > 139 coming in from the IP loopback address 127.0.0.1. You can, and perhaps > 140 should, change this after you create a few users.</p> > 141 > 142 <p>When you are finished configuring, just press Control-C or use > 143 the <b>kill</b> command to shut down the mini-server.</p> 115 144 116 </blockquote><h2>Making Changes</h2><blockquote> 145 </blockquote><h2>Making Changes</h2><blockquote> 117 146 118 <p>To add new files to your project, or remove old files, use these 147 <p>To add new files to your project, or remove old files, use these 119 commands:</p> 148 commands:</p> 120 149 121 <blockquote> 150 <blockquote>