Hex Artifact Content
Not logged in

Artifact 5ba110240ed19d8b2b44b12a1e9e65b5b01fd946:

File www/build.wiki part of check-in [42ed55e82f] - Documentation tweaks. by drh on 2008-06-02 15:18:39.

0000: 3c 6e 6f 77 69 6b 69 3e 0a 3c 68 31 3e 49 6e 73  <nowiki>.<h1>Ins
0010: 74 61 6c 6c 69 6e 67 20 46 6f 73 73 69 6c 3c 2f  talling Fossil</
0020: 68 31 3e 0a 0a 3c 70 3e 54 68 69 73 20 70 61 67  h1>..<p>This pag
0030: 65 20 64 65 73 63 72 69 62 65 73 20 68 6f 77 20  e describes how 
0040: 74 6f 20 62 75 69 6c 64 20 61 6e 64 20 69 6e 73  to build and ins
0050: 74 61 6c 6c 20 46 6f 73 73 69 6c 2e 20 20 54 68  tall Fossil.  Th
0060: 65 0a 77 68 6f 6c 65 20 70 72 6f 63 65 73 73 20  e.whole process 
0070: 69 73 20 64 65 73 69 67 6e 65 64 20 74 6f 20 62  is designed to b
0080: 65 20 76 65 72 79 20 65 61 73 79 2e 3c 2f 70 3e  e very easy.</p>
0090: 0a 0a 3c 68 32 3e 30 2e 30 20 55 73 69 6e 67 20  ..<h2>0.0 Using 
00a0: 41 20 50 72 65 63 6f 6d 70 69 6c 65 64 20 42 69  A Precompiled Bi
00b0: 6e 61 72 79 3c 2f 68 32 3e 0a 0a 3c 70 3e 59 6f  nary</h2>..<p>Yo
00c0: 75 20 63 61 6e 20 73 6b 69 70 20 73 74 65 70 73  u can skip steps
00d0: 20 31 2e 30 20 61 6e 64 20 32 2e 30 20 62 65 6c   1.0 and 2.0 bel
00e0: 6f 77 20 62 79 20 64 6f 77 6e 6c 6f 61 64 69 6e  ow by downloadin
00f0: 67 0a 61 20 3c 61 20 68 72 65 66 3d 22 68 74 74  g.a <a href="htt
0100: 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73  p://www.fossil-s
0110: 63 6d 2e 6f 72 67 2f 64 6f 77 6e 6c 6f 61 64 2e  cm.org/download.
0120: 68 74 6d 6c 22 3e 70 72 65 63 6f 6d 70 69 6c 65  html">precompile
0130: 64 20 62 69 6e 61 72 79 3c 2f 61 3e 0a 61 70 70  d binary</a>.app
0140: 72 6f 70 72 69 61 74 65 20 66 6f 72 20 79 6f 75  ropriate for you
0150: 72 20 70 6c 61 74 66 6f 72 6d 2e 20 20 49 66 20  r platform.  If 
0160: 79 6f 75 20 75 73 65 20 61 20 70 72 65 63 6f 6d  you use a precom
0170: 70 69 6c 65 64 20 62 69 6e 61 72 79 0a 6a 75 6d  piled binary.jum
0180: 70 20 69 6d 6d 65 64 69 61 74 65 20 74 6f 20 73  p immediate to s
0190: 74 65 70 20 33 2e 30 2e 3c 2f 70 3e 0a 0a 3c 68  tep 3.0.</p>..<h
01a0: 32 3e 31 2e 30 20 4f 62 74 61 69 6e 69 6e 67 20  2>1.0 Obtaining 
01b0: 54 68 65 20 53 6f 75 72 63 65 20 43 6f 64 65 3c  The Source Code<
01c0: 2f 68 32 3e 0a 0a 3c 70 3e 46 6f 73 73 69 6c 20  /h2>..<p>Fossil 
01d0: 69 73 20 73 65 6c 66 2d 68 6f 73 74 69 6e 67 2c  is self-hosting,
01e0: 20 73 6f 20 79 6f 75 20 63 61 6e 20 6f 62 74 61   so you can obta
01f0: 69 6e 20 61 20 5a 49 50 20 61 72 63 68 69 76 65  in a ZIP archive
0200: 20 63 6f 6e 74 61 69 6e 69 6e 67 0a 61 20 73 6e   containing.a sn
0210: 61 70 73 68 6f 74 20 6f 66 20 74 68 65 20 6c 61  apshot of the la
0220: 74 65 73 74 20 76 65 72 73 69 6f 6e 20 64 69 72  test version dir
0230: 65 63 74 6c 79 20 66 72 6f 6d 20 66 6f 73 73 69  ectly from fossi
0240: 6c 27 73 20 6f 77 6e 20 66 6f 73 73 69 6c 0a 72  l's own fossil.r
0250: 65 70 6f 73 69 74 6f 72 79 2e 20 20 46 6f 6c 6c  epository.  Foll
0260: 6f 77 20 74 68 65 73 65 20 73 74 65 70 73 3a 3c  ow these steps:<
0270: 2f 70 3e 0a 0a 3c 6f 6c 3e 0a 3c 6c 69 3e 3c 70  /p>..<ol>.<li><p
0280: 3e 50 6f 69 6e 74 65 72 20 79 6f 75 72 20 77 65  >Pointer your we
0290: 62 20 62 72 6f 77 73 65 72 20 61 74 0a 3c 61 20  b browser at.<a 
02a0: 68 72 65 66 3d 22 68 74 74 70 3a 2f 2f 77 77 77  href="http://www
02b0: 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f  .fossil-scm.org/
02c0: 22 3e 0a 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f  ">.http://www.fo
02d0: 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 3c 2f 61  ssil-scm.org/</a
02e0: 3e 2e 20 20 43 6c 69 63 6b 20 6f 6e 20 74 68 65  >.  Click on the
02f0: 20 22 4c 6f 67 69 6e 22 20 6d 65 6e 75 20 62 75   "Login" menu bu
0300: 74 74 6f 6e 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a 0a  tton.</p></li>..
0310: 3c 6c 69 3e 3c 70 3e 4c 6f 67 20 69 6e 20 61 73  <li><p>Log in as
0320: 20 61 6e 6f 6e 79 6d 6f 75 73 2e 20 20 54 68 65   anonymous.  The
0330: 20 70 61 73 73 77 6f 72 64 20 69 73 20 73 68 6f   password is sho
0340: 77 6e 20 6f 6e 20 73 63 72 65 65 6e 2e 0a 54 68  wn on screen..Th
0350: 65 20 72 65 61 73 6f 6e 20 66 6f 72 20 72 65 71  e reason for req
0360: 75 69 72 69 6e 67 20 74 68 69 73 20 6c 6f 67 69  uiring this logi
0370: 6e 20 69 73 20 74 6f 20 70 72 65 76 65 6e 74 20  n is to prevent 
0380: 73 70 69 64 65 72 73 20 66 72 6f 6d 0a 77 61 6c  spiders from.wal
0390: 6b 69 6e 67 20 74 68 65 20 65 6e 74 69 72 65 20  king the entire 
03a0: 77 65 62 73 69 74 65 2c 20 64 6f 77 6e 6c 6f 61  website, downloa
03b0: 64 69 6e 67 20 5a 49 50 20 61 72 63 68 69 76 65  ding ZIP archive
03c0: 73 0a 6f 66 20 65 76 65 72 79 20 68 69 73 74 6f  s.of every histo
03d0: 72 69 63 61 6c 20 76 65 72 73 69 6f 6e 2c 20 61  rical version, a
03e0: 6e 64 20 74 68 65 72 65 62 79 20 73 6f 61 6b 69  nd thereby soaki
03f0: 6e 67 20 75 70 20 61 6c 6c 20 6f 75 72 20 62 61  ng up all our ba
0400: 6e 64 77 69 64 74 68 2e 3c 2f 70 3e 3c 2f 6c 69  ndwidth.</p></li
0410: 3e 0a 0a 3c 6c 69 3e 3c 70 3e 43 6c 69 63 6b 20  >..<li><p>Click 
0420: 6f 6e 20 74 68 65 20 0a 3c 61 20 68 72 65 66 3d  on the .<a href=
0430: 22 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73  "http://www.foss
0440: 69 6c 2d 73 63 6d 2e 6f 72 67 2f 66 6f 73 73 69  il-scm.org/fossi
0450: 6c 2f 74 69 6d 65 6c 69 6e 65 22 3e 54 69 6d 65  l/timeline">Time
0460: 6c 69 6e 65 3c 2f 61 3e 20 6f 72 0a 3c 61 20 68  line</a> or.<a h
0470: 72 65 66 3d 22 68 74 74 70 3a 2f 2f 77 77 77 2e  ref="http://www.
0480: 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 66  fossil-scm.org/f
0490: 6f 73 73 69 6c 2f 6c 65 61 76 65 73 22 3e 4c 65  ossil/leaves">Le
04a0: 61 76 65 73 3c 2f 61 3e 20 6c 69 6e 6b 20 61 74  aves</a> link at
04b0: 0a 74 68 65 20 74 6f 70 20 6f 66 20 74 68 65 20  .the top of the 
04c0: 70 61 67 65 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a 0a  page.</p></li>..
04d0: 3c 6c 69 3e 3c 70 3e 53 65 6c 65 63 74 20 61 20  <li><p>Select a 
04e0: 76 65 72 73 69 6f 6e 20 6f 66 20 6f 66 20 66 6f  version of of fo
04f0: 73 73 69 6c 20 79 6f 75 20 77 61 6e 74 20 74 6f  ssil you want to
0500: 20 64 6f 77 6e 6c 6f 61 64 2e 20 20 43 6c 69 63   download.  Clic
0510: 6b 20 6f 6e 20 69 74 73 0a 6c 69 6e 6b 2e 20 20  k on its.link.  
0520: 4e 6f 74 65 20 74 68 61 74 20 79 6f 75 20 6d 75  Note that you mu
0530: 73 74 20 73 75 63 63 65 73 73 66 75 6c 6c 79 20  st successfully 
0540: 6c 6f 67 20 69 6e 20 61 73 20 22 61 6e 6f 6e 79  log in as "anony
0550: 6d 6f 75 73 22 20 69 6e 20 73 74 65 70 20 31 0a  mous" in step 1.
0560: 61 62 6f 76 65 20 69 6e 20 6f 72 64 65 72 20 74  above in order t
0570: 6f 20 73 65 65 20 74 68 65 20 6c 69 6e 6b 20 74  o see the link t
0580: 6f 20 74 68 65 20 64 65 74 61 69 6c 65 64 20 76  o the detailed v
0590: 65 72 73 69 6f 6e 20 69 6e 66 6f 72 6d 61 74 69  ersion informati
05a0: 6f 6e 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a 0a 3c 6c  on.</p></li>..<l
05b0: 69 3e 3c 70 3e 4f 6e 20 74 68 65 20 76 65 72 73  i><p>On the vers
05c0: 69 6f 6e 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  ion information 
05d0: 70 61 67 65 2c 20 63 6c 69 63 6b 20 6f 6e 20 74  page, click on t
05e0: 68 65 0a 22 5a 69 70 20 41 72 63 68 69 76 65 22  he."Zip Archive"
05f0: 20 6c 69 6e 6b 2e 20 20 54 68 69 73 20 6c 69 6e   link.  This lin
0600: 6b 20 77 69 6c 6c 20 62 75 69 6c 64 20 61 20 5a  k will build a Z
0610: 49 50 20 61 72 63 68 69 76 65 20 6f 66 20 74 68  IP archive of th
0620: 65 20 0a 63 6f 6d 70 6c 65 74 65 20 73 6f 75 72  e .complete sour
0630: 63 65 20 63 6f 64 65 20 61 6e 64 20 64 6f 77 6e  ce code and down
0640: 6c 6f 61 64 20 69 74 20 74 6f 20 79 6f 75 72 20  load it to your 
0650: 62 72 6f 77 73 65 72 2e 3c 2f 70 3e 3c 2f 6c 69  browser.</p></li
0660: 3e 0a 3c 2f 6f 6c 3e 0a 0a 3c 68 32 3e 32 2e 30  >.</ol>..<h2>2.0
0670: 20 43 6f 6d 70 69 6c 69 6e 67 3c 2f 68 32 3e 0a   Compiling</h2>.
0680: 0a 3c 70 3e 46 6f 6c 6c 6f 77 20 74 68 65 73 65  .<p>Follow these
0690: 20 73 74 65 70 73 20 74 6f 20 63 6f 6d 70 69 6c   steps to compil
06a0: 65 3a 3c 2f 70 3e 0a 0a 3c 6f 6c 3e 0a 3c 6c 69  e:</p>..<ol>.<li
06b0: 20 76 61 6c 75 65 3d 22 36 22 3e 0a 3c 70 3e 43   value="6">.<p>C
06c0: 72 65 61 74 65 20 61 20 64 69 72 65 63 74 6f 72  reate a director
06d0: 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 73 6f  y to hold the so
06e0: 75 72 63 65 20 63 6f 64 65 2e 20 20 54 68 65 6e  urce code.  Then
06f0: 20 75 6e 7a 69 70 20 74 68 65 0a 5a 49 50 20 61   unzip the.ZIP a
0700: 72 63 68 69 76 65 20 79 6f 75 20 64 6f 77 6e 6c  rchive you downl
0710: 6f 61 64 65 64 20 69 6e 74 6f 20 74 68 61 74 20  oaded into that 
0720: 64 69 72 65 63 74 6f 72 79 2e 20 20 59 6f 75 20  directory.  You 
0730: 73 68 6f 75 6c 64 20 62 65 0a 69 6e 20 74 68 65  should be.in the
0740: 20 74 6f 70 2d 6c 65 76 65 6c 20 66 6f 6c 64 65   top-level folde
0750: 72 20 6f 66 20 74 68 61 74 20 64 69 72 65 63 74  r of that direct
0760: 6f 72 79 3c 2f 70 3e 3c 2f 6c 69 3e 0a 0a 3c 6c  ory</p></li>..<l
0770: 69 3e 3c 70 3e 3c 62 3e 28 4f 70 74 69 6f 6e 61  i><p><b>(Optiona
0780: 6c 3a 29 3c 2f 62 3e 0a 45 64 69 74 20 74 68 65  l:)</b>.Edit the
0790: 20 4d 61 6b 65 66 69 6c 65 20 74 6f 20 73 65 74   Makefile to set
07a0: 20 69 74 20 75 70 20 6c 69 6b 65 20 79 6f 75 20   it up like you 
07b0: 77 61 6e 74 2e 20 20 59 6f 75 20 70 72 6f 62 61  want.  You proba
07c0: 62 6c 79 20 64 6f 20 6e 6f 74 0a 6e 65 65 64 20  bly do not.need 
07d0: 74 6f 20 64 6f 20 61 6e 79 74 68 69 6e 67 2e 20  to do anything. 
07e0: 20 44 6f 20 6e 6f 74 20 62 65 20 69 6e 74 69 6d   Do not be intim
07f0: 69 64 61 74 65 64 3a 20 20 54 68 65 72 65 20 61  idated:  There a
0800: 72 65 20 6f 6e 6c 79 20 35 0a 76 61 72 69 61 62  re only 5.variab
0810: 6c 65 73 20 69 6e 20 74 68 65 20 6d 61 6b 65 66  les in the makef
0820: 69 6c 65 20 74 68 61 74 20 63 61 6e 20 62 65 20  ile that can be 
0830: 63 68 61 6e 67 65 64 2e 20 20 54 68 65 20 77 68  changed.  The wh
0840: 6f 6c 65 20 4d 61 6b 65 66 69 6c 65 0a 69 73 20  ole Makefile.is 
0850: 6f 6e 6c 79 20 61 20 66 65 77 20 64 6f 7a 65 6e  only a few dozen
0860: 20 6c 69 6e 65 73 20 6c 6f 6e 67 20 61 6e 64 20   lines long and 
0870: 6d 6f 73 74 20 6f 66 20 74 68 6f 73 65 20 6c 69  most of those li
0880: 6e 65 73 20 61 72 65 20 63 6f 6d 6d 65 6e 74 73  nes are comments
0890: 2e 3c 2f 70 3e 0a 0a 3c 6c 69 3e 3c 70 3e 54 79  .</p>..<li><p>Ty
08a0: 70 65 20 22 3c 62 3e 6d 61 6b 65 3c 2f 62 3e 22  pe "<b>make</b>"
08b0: 0a 3c 2f 6f 6c 3e 0a 0a 3c 68 32 3e 33 2e 30 20  .</ol>..<h2>3.0 
08c0: 49 6e 73 74 61 6c 6c 69 6e 67 3c 2f 68 32 3e 0a  Installing</h2>.
08d0: 0a 3c 6f 6c 3e 0a 3c 6c 69 20 76 61 6c 75 65 3d  .<ol>.<li value=
08e0: 22 39 22 3e 0a 3c 70 3e 54 68 65 20 66 69 6e 69  "9">.<p>The fini
08f0: 73 68 65 64 20 62 69 6e 61 72 79 20 69 73 20 6e  shed binary is n
0900: 61 6d 65 64 20 22 66 6f 73 73 69 6c 22 2e 20 20  amed "fossil".  
0910: 50 75 74 20 74 68 69 73 20 62 69 6e 61 72 79 20  Put this binary 
0920: 69 6e 20 61 20 0a 64 69 72 65 63 74 6f 72 79 20  in a .directory 
0930: 74 68 61 74 20 69 73 20 73 6f 6d 65 77 68 65 72  that is somewher
0940: 65 20 6f 6e 20 79 6f 75 72 20 50 41 54 48 20 65  e on your PATH e
0950: 6e 76 69 72 6f 6e 6d 65 6e 74 20 76 61 72 69 61  nvironment varia
0960: 62 6c 65 2e 0a 49 74 20 64 6f 65 73 20 6e 6f 74  ble..It does not
0970: 20 6d 61 74 74 65 72 20 77 68 65 72 65 2e 3c 2f   matter where.</
0980: 70 3e 0a 0a 3c 6c 69 3e 0a 3c 70 3e 3c 62 3e 28  p>..<li>.<p><b>(
0990: 4f 70 74 69 6f 6e 61 6c 3a 29 3c 2f 62 3e 0a 54  Optional:)</b>.T
09a0: 6f 20 75 6e 69 6e 73 74 61 6c 6c 2c 20 6a 75 73  o uninstall, jus
09b0: 74 20 64 65 6c 65 74 65 20 74 68 65 20 62 69 6e  t delete the bin
09c0: 61 72 79 2e 3c 2f 70 3e 0a 3c 2f 6f 6c 3e 0a     ary.</p>.</ol>.