Overview
| SHA1 Hash: | 0e265b01847057ad96aa67b59dab50cd04c13066 |
|---|---|
| Date: | 2007-08-01 20:05:49 |
| User: | drh |
| Comment: | Documentation updates. Added Makefile. |
| Timelines: | ancestors | descendants | both | trunk |
| Other Links: | files | ZIP archive | manifest |
Tags And Properties
- branch=trunk inherited from [a28c83647d]
- sym-trunk inherited from [a28c83647d]
Changes
[hide diffs]Added BUILD.txt version [e7fed9d5b6]
@@ -1,1 +1,35 @@ +All of the source code for fossil is contained in the src/ subdirectory. +But there is a lot of generated code, so you will probably want to +use the Makefile. To do a complete build, just type: + + make + +That should work out-of-the-box on Macs and Linux systems. If +you have trouble, or you want to do something fancy, just edit +the Makefile in the top-level folder. There are 5 things you +might want to change in the Makefile. All 5 things are well +commented. The complete Makefile is only a few dozen lines long. +Do not be intimidated. + +-------------------------------------------------------------------------- + +Here are some notes on what is happening behind the scenes: + +* The Makefile just set up a few macros and then invokes the + real makefile in src/main.mk. The src/main.mk makefile is + automatically generated by a TCL script found at src/makemake.tcl. + Do not edit src/main.mk directly. Update src/makemake.tcl and + then rerun it. + +* The *.h header files are automatically generated using a program + called "makeheaders". Source code to the makeheaders program is + found in src/makeheaders.c. Documentation is found in + src/makeheaders.html. + +* Most *.c source files are preprocessed using a program called + "translate". The sources to translate are found in src/translate.c. + A header comment in src/translate.c explains in detail what it does. +* The src/mkindex.c program generates some C code that implements + static lookup tables. See the header comment in the source code + for details on what it does.
Added COPYRIGHT-GPL2.txt version [06877624ea]
@@ -1,1 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License.
Added Makefile version [90562f7233]
@@ -1,1 +1,41 @@ +#!/usr/bin/make +# +#### The toplevel directory of the source tree. Fossil can be built +# in a directory that is separate from the source tree. Just change +# the following to point from the build directory to the src/ folder. +# +SRCDIR = ./src + +#### C Compiler and options for use in building executables that +# will run on the platform that is doing the build. This is used +# to compile code-generator programs as part of the build process. +# See TCC below for the C compiler for building the finished binary. +# +BCC = gcc -g -O2 + +#### The suffix to add to executable files. ".exe" for windows. +# Nothing for unix. +# +E = + +#### C Compile and options for use in building executables that +# will run on the target platform. This is usually the same +# as BCC, unless you are cross-compiling. This C compiler builds +# the finished binary for fossil. The BCC compiler above is used +# for building intermediate code-generator tools. +# +#TCC = gcc -O6 +#TCC = gcc -g -O0 -Wall -fprofile-arcs -ftest-coverage +TCC = gcc -g -Os -Wall + +#### Extra arguments for linking the finished binary. Fossil needs +# to link against the Z-Lib compression library. There are no +# other dependencies. We sometimes add the -static option here +# so that we can build a static executable that will run in a +# chroot jail. +# +LIB = -lz -static +# You should not need to change anything below this line +############################################################################### +include $(SRCDIR)/main.mk
Deleted src/linux-gcc.mk version [cb88682a83]
Added www/build.html version [0933d47927]
@@ -1,1 +1,73 @@ +<html> +<title>Building And Installing Fossil</title> +</head> +<body bgcolor="white"> +<h1>Installing Fossil</h1> + +<p>This page describes how to build and install Fossil. The +whole process is designed to be very easy.</p> + +<h2>1.0 Obtaining The Source Code</h2> + +<p>Fossil is self-hosting, so you can obtain a ZIP archive containing +a snapshot of the latest version directly from fossil's own fossil +repository. Follow these steps:</p> + +<ol> +<li><p>Pointer your webbrowser at +<a href="http://fossil-scm.hwaci.com/fossil/login"> +http://fossil-scm.hwaci.com/fossil/login</a>.</p></li> + +<li><p>Log in as anonymous. The password is shown on screen. +The reason for requiring this login is to prevent help spiders from +walking the walking the entire website, downloading ZIP archives +of every historical version, and thereby soaking up all our bandwidth.</p></li> + +<li><p>Click on the +<a href="http://fossil-scm.hwaci.com/fossil/timeline">Timeline</a> or +<a href="http://fossil-scm.hwaci.com/fossil/leaves">Leaves</a> link at +the top of the page.</p></li> + +<li><p>Select a version of of fossil you want to download. Click on its +link. Note that you must successfully log in as "anonymous" in step 1 +above in order to see the link to the detailed version information.</p></li> + +<li><p>On the version information page, click on the +"Zip Archive" link. This build a ZIP archive of the complete source +code and return it to your browser.</p></li> +</ol> + +<h2>2.0 Compiling</h2> + +<p>Follow these stops to compile:</p> + +<ol> +<li value="6"> +<p>Create a directory to hold the source code. Then unzip the +ZIP archive you downloaded into that directory. You should be +in the top-level folder of that directory</p></li> + +<li><p><b>(Optional:)</b> +Edit the Makefile to set it up like you want. You probably do not +need to do anything. Do not be intimidated: There are only 5 +variables in the makefile that can be changed. The whole Makefile +is only a few dozen lines long and most of those lines are comments.</p> + +<li><p>Type "<b>make</b>" +</ol> + +<h2>3.0 Installing</h2> + +<ol> +<li value="9"> +<p>The finished binary is named "fossil". Put this binary in a +directory that is somewhere on your PATH environment variable. +It does not matter where.</p> + +<li> +<p><b>(Optional:)</b> +To uninstall, just delete the binary.</p> +</ol> +</body> +</html>
Modified www/index.html from [30f3834664] to [188269ac14].
@@ -6,16 +6,14 @@ <h1>Fossil - A Software Configuration Management System</h1> <p> This is a preliminary homepage for a new software configuration management system called "Fossil". -The code is currently under development, and has been for about -two years. (We have iterated the design multiple times.) -Nothing is available for download or inspection -as of this writing (2007-07-24). -But the system is self-hosting now. -Hopefully something will be available soon. +The system is +<a href="http://fossil-scm.hwaci.com/fossil/index">self-hosting</a>. +You can download the lastest sources +compile it your self using the instructions below. </p> <p>Design Goals For Fossil:</p> <ul> @@ -71,17 +69,19 @@ <a href="http://www.oreillynet.com/pub/a/oreilly/tim/news/2005/09/30/what-is-web-20.html">Web 2.0</a>. Fossil attempts to better capture "collective intelligence" and "the wisdom of crowds" by opening up write access to the masses.</li> </ul> -<p>Links:</p> +<p>Other Links:</p> <ul> +<li><a href="build.html">Building And Installing</a></li> +<li><a href="quickstart.html">Quick Start</a> guide to using fossil <li><a href="pop.html">Principals Of Operation</a></li> <li>The <a href="selfcheck.html">automatic self-check</a> mechanism helps insure project integrity.</li> <li>The <a href="fileformat.html">file format</a> used by every content file stored in the repository.</li> </ul> </body> </html>
Added www/quickstart.html version [8e6c0f9e23]
@@ -1,1 +1,226 @@ +<html> +<title>Fossil - Quick Start</title> +<body bgcolor="white"> +<h1 align="center">Fossil Quick Start</h1> + +<p>This is a guide to get you started using fossil quickly +and painlessly.</p> + +<h2>Installing</h2><blockquote> + + <p>Fossil is a single self-contained C program that you need to + <a href="build.html">install</a> before using. Build the binary + and put is someplace on your PATH environment variable.</p> + + </blockquote> + <h2>Cloning A Existing Repository</h2> + <blockquote> + + <p>Use this command:</p> + + <blockquote> + <b>fossil clone</b> <i>URL repository-filename</i> + </blockquote> + + <p>The <i>URL</i> above is the http URL for the fossil repository + you want to clone. The new repository can be called anything you + want - there are no naming restrictions. As an example, you can + clone the fossil repository this way:</p> + + <blockquote> + <b>fossil clone http://fossil-scm.hwaci.com/fossil myclone.fsl</b> + </blockquote> + +</blockquote><h2>Starting A New Project</h2><blockquote> + + <p>To start a new project with fossil, create a new empty repository + this way:</p> + + <blockquote> + <b>fossil new </b><i> repository-filename</i> + </blockquote> + +</blockquote><h2>Configuring Your Local Repository</h2><blockquote> + + <p>When you create a new repository, either by cloning an existing + project or create a new project of your, you usually want to do some + local configuration. This is accomplished using a webbrowser. First + start a fossil webserver like this:</p> + + <blockquote> + <b>fossil server </b><i> repository-filename</i> + </blockquote> + + <p>This creates a mini-webserver listening on port 8080. You can + specify a different port using the <b>-port</b> option on the command-line. + After the server is running, point your webbrowser at + http://localhost:8080/ and start configuring.</p> + + <p>By default, fossil does not require a login for HTTP connections + coming in from the IP loopback address 127.0.0.1. You can, and perhaps + should, change this after you create a few users.</p> + + <p>When you are finished configuring, just press Control-C or use + the <b>kill</b> command to shut down the mini-server.</p> + +</blockquote><h2>Checking Out A Local Tree</h2><blockquote> + + <p>To work on a project in fossil, you need to check out a local + copy of the source tree. Create the directory you want to be + the root of your tree and cd into that directory. Then + to this:</p> + + <blockquote> + <b>fossil open </b><i> repository-filename</i> + </blockquote> + + <p>This leaves you with the original (empty) version of the tree + checked out. To get to the latest version, also do this:</p> + + <blockquote> + <b>fossil update</b> + </blockquote> + + <p>From anywhere underneath the root of your local tree, you + can type commands like the following to find out the status of + your local tree:</p> + + <blockquote> + <b>fossil info</b><br> + <b>fossil status</b><br> + <b>fossil changes</b><br> + <b>fossil timeline</b><br> + <b>fossil leaves</b><br> + <b>fossil ls</b><br> + <b>fossil branches</b><br> + </blockquote> + +</blockquote><h2>Making Changes</h2><blockquote> + + <p>To add new files to your project, or remove old files, use these + commands:</p> + + <blockquote> + <b>fossil add</b> <i>file...</i><br> + <b>fossil rm</b> <i>file...</i> + </blockquote> + + <p>You can also edit files freely. Once you are ready to commit + your changes, type:</p> + + <blockquote> + <b>fossil commit</b> + </blockquote> + + <p>You will be prompted for check-in comments using whatever editor + is specified by your VISUAL or EDITOR environment variable. After + you save your check-in comments, your changes will be checked in.</p> + +</blockquote><h2>Sharing Changes</h2><blockquote> + + <p>The changes you <b>commit</b> are only on your local repository. + To share those changes with other repositories, do:</p> + + <blockquote> + <b>fossil push</b> <i>URL</i> + </blockquote> + + <p>Where <i>URL</i> is the http: URL of the server repository you + want to share your changes with. If you omit the <i>URL</i> argument, + fossil will use whatever server you most recently synced with.</p> + + <p>The <b>push</b> command only sends your changes to others. To + Receive changes from others, use <b>pull</b>. Or go both ways at + once using <b>sync</b>:</p> + + <blockquote> + <b>fossil pull</b> <i>URL</i><br> + <b>fossil sync</b> <i>URL</i> + </blockquote> + + <p>When you pull in changes from others, they go into your repository, + not into your checked-out local tree. To get the changes into your + local tree, use <b>update</b>:</p> + + <blockquote> + <b>fossil update</b> <i>UUID</i> + </blockquote> + + <p>The <i>UUID</i> is some unique abbreviation to the 40-character + version ID. If you omit the <i>UUID</i> fossil moves you to the + leaf version of the branch your are currently on. If your branch + has multiple leaves, you get an error - you'll have to specify the + leaf you want using a <i>UUID</i> argument.</p> + +</blockquote><h2>Branching And Merging</h2><blockquote> + + <p>You can create branches by doing multiple commits off of the + same base version. To merge to branches back together, first + <b>update</b> to the leaf of one branch. Then do a <b>merge</b> + of the leaf of the other branch:</p> + + <blockquote> + <b>fossil merge</b> <i>UUID</i> + </blockquote> + + <p>Test to make sure your merge didn't mess up the code, then + <b>commit</b> and possibly also <b>push</b> your changes. Remember + that nobody else can see your changes until you <b>commit</b> and + if other are using a different repository you will also need to + <b>push</b>.</p> + +</blockquote><h2>Setting Up A Server</h2><blockquote> + + <p>The easiest way to set up a server is:</p> + + <blockquote> + <b>fossil server</b> <i>repository-filename</i> + </blockquote> + + <p>You can omit the <i>repository-filename</i> if you are within + a checked-out local tree. This server uses port 8080 by default + but you can specify a different port using the <b>-port</b> command.</p> + + <p>Command-line servers like this are useful when two people want + to share a repository on temporary or ad-hoc basis. For a more + permanent installation, you should use either the CGI server or the + inetd server. To use the CGI server, create a CGI script that + looks something like this:</p> + + <blockquote><b> + #!/usr/local/bin/fossil<br> + repository: /home/proj1/repos1.fsl + </b></blockquote> + + <p>Adjust the paths in this CGI script to match your installation. + Now point clients at the CGI script. That's all there is to it!</p> + + <p>You can also run fossil off of inetd or xinetd. For an inetd + installation, make an entry in /etc/inetd.conf that looks something + like this:</p> + + <blockquote><b> + 80 stream tcp nowait.1000 root /usr/bin/fossil \<br> + /usr/bin/fossil http /home/proj1/repos1.fsl + </b></blockquote> + + <p>Adjust the paths to suit your installation, of course. Notice that + fossil runs as run. This is not required - you can run it as an + unprivileged user. But it is more secure to run fossil as root. + When you do run fossil as root, it automatically puts itself in a + chroot jail in the same directory as the repository, then drops + root privileges prior to reading any information from the request.</p> + +</blockquote><h2>More Hints</h2><blockquote> + + <p>Try these commands:</p> + + <blockquote><b> + fossil command<br> + fossil test-command + </b></blockquote> + + <p>Explore and have fun!</p> + +</blockquote></body></html>