5523218023 2009-08-24 drh: <title>Fossil Documentation</title> 06689854ae 2008-05-17 drh: <nowiki> d87ca60c58 2008-05-15 stephan: <h1>Installing Fossil</h1> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <p>This page describes how to build and install Fossil. The d87ca60c58 2008-05-15 stephan: whole process is designed to be very easy.</p> d87ca60c58 2008-05-15 stephan: 9eb6ea75c1 2008-11-11 kejoki: <h2>0.0 Using A Pre-compiled Binary</h2> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <p>You can skip steps 1.0 and 2.0 below by downloading 9eb6ea75c1 2008-11-11 kejoki: a <a href="http://www.fossil-scm.org/download.html">pre-compiled binary</a> 9eb6ea75c1 2008-11-11 kejoki: appropriate for your platform. If you use a pre-compiled binary d87ca60c58 2008-05-15 stephan: jump immediate to step 3.0.</p> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <h2>1.0 Obtaining The Source Code</h2> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <p>Fossil is self-hosting, so you can obtain a ZIP archive containing d87ca60c58 2008-05-15 stephan: a snapshot of the latest version directly from fossil's own fossil d87ca60c58 2008-05-15 stephan: repository. Follow these steps:</p> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <ol> 42ed55e82f 2008-06-02 drh: <li><p>Pointer your web browser at 42ed55e82f 2008-06-02 drh: <a href="http://www.fossil-scm.org/"> 42ed55e82f 2008-06-02 drh: http://www.fossil-scm.org/</a>. Click on the "Login" menu button.</p></li> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <li><p>Log in as anonymous. The password is shown on screen. d87ca60c58 2008-05-15 stephan: The reason for requiring this login is to prevent spiders from d87ca60c58 2008-05-15 stephan: walking the entire website, downloading ZIP archives d87ca60c58 2008-05-15 stephan: of every historical version, and thereby soaking up all our bandwidth.</p></li> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <li><p>Click on the d87ca60c58 2008-05-15 stephan: <a href="http://www.fossil-scm.org/fossil/timeline">Timeline</a> or d87ca60c58 2008-05-15 stephan: <a href="http://www.fossil-scm.org/fossil/leaves">Leaves</a> link at d87ca60c58 2008-05-15 stephan: the top of the page.</p></li> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <li><p>Select a version of of fossil you want to download. Click on its d87ca60c58 2008-05-15 stephan: link. Note that you must successfully log in as "anonymous" in step 1 d87ca60c58 2008-05-15 stephan: above in order to see the link to the detailed version information.</p></li> d87ca60c58 2008-05-15 stephan: b79994adcb 2009-08-24 drh: <li><p>On the version information page, click on the "[details]" hyperlink b79994adcb 2009-08-24 drh: that appears right after the check-in comment at the top of the page.</p> b79994adcb 2009-08-24 drh: b79994adcb 2009-08-24 drh: <li><p>Finally, click on the d87ca60c58 2008-05-15 stephan: "Zip Archive" link. This link will build a ZIP archive of the b79994adcb 2009-08-24 drh: complete source code and download it to your browser. b79994adcb 2009-08-24 drh: b79994adcb 2009-08-24 drh: <blockquote><i> b79994adcb 2009-08-24 drh: Note to Mac users: The ZIP archive constructed by Fossil is a well-formed b79994adcb 2009-08-24 drh: ZIP archive. However, the unarchiver that is built into the Mac has a bug b79994adcb 2009-08-24 drh: in that it does not understand all well-formed ZIP archives. So you may b79994adcb 2009-08-24 drh: get an error when the Mac goes to automatically extract the downloaded ZIP b79994adcb 2009-08-24 drh: archive. We are still trying to figure out what it is about Fossil-generated b79994adcb 2009-08-24 drh: ZIP archives that the Mac doesn't like. Until we do, b79994adcb 2009-08-24 drh: your work-around is to manually extract the ZIP archive using the b79994adcb 2009-08-24 drh: "unzip" command from a command-line shell. b79994adcb 2009-08-24 drh: </i></blockquote> d87ca60c58 2008-05-15 stephan: </ol> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <h2>2.0 Compiling</h2> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <p>Follow these steps to compile:</p> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <ol> d87ca60c58 2008-05-15 stephan: <li value="6"> d87ca60c58 2008-05-15 stephan: <p>Create a directory to hold the source code. Then unzip the d87ca60c58 2008-05-15 stephan: ZIP archive you downloaded into that directory. You should be d87ca60c58 2008-05-15 stephan: in the top-level folder of that directory</p></li> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <li><p><b>(Optional:)</b> d87ca60c58 2008-05-15 stephan: Edit the Makefile to set it up like you want. You probably do not d87ca60c58 2008-05-15 stephan: need to do anything. Do not be intimidated: There are only 5 d87ca60c58 2008-05-15 stephan: variables in the makefile that can be changed. The whole Makefile d87ca60c58 2008-05-15 stephan: is only a few dozen lines long and most of those lines are comments.</p> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <li><p>Type "<b>make</b>" d87ca60c58 2008-05-15 stephan: </ol> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <h2>3.0 Installing</h2> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <ol> d87ca60c58 2008-05-15 stephan: <li value="9"> d87ca60c58 2008-05-15 stephan: <p>The finished binary is named "fossil". Put this binary in a d87ca60c58 2008-05-15 stephan: directory that is somewhere on your PATH environment variable. d87ca60c58 2008-05-15 stephan: It does not matter where.</p> d87ca60c58 2008-05-15 stephan: d87ca60c58 2008-05-15 stephan: <li> d87ca60c58 2008-05-15 stephan: <p><b>(Optional:)</b> d87ca60c58 2008-05-15 stephan: To uninstall, just delete the binary.</p> d87ca60c58 2008-05-15 stephan: </ol>