Hex Artifact Content
Not logged in

Artifact ef08562a8f21037fbb8f23e28210696ed0810942:

File www/build.wiki part of check-in [e2431b17df] - Fix an issue with the command-line timeline. Fix typos in documentation. by drh on 2009-11-09 21:32:36.

0000: 3c 74 69 74 6c 65 3e 42 75 69 6c 64 69 6e 67 20  <title>Building 
0010: 61 6e 64 20 49 6e 73 74 61 6c 6c 69 6e 67 20 46  and Installing F
0020: 6f 73 73 69 6c 3c 2f 74 69 74 6c 65 3e 0a 3c 6e  ossil</title>.<n
0030: 6f 77 69 6b 69 3e 0a 0a 3c 70 3e 54 68 69 73 20  owiki>..<p>This 
0040: 70 61 67 65 20 64 65 73 63 72 69 62 65 73 20 68  page describes h
0050: 6f 77 20 74 6f 20 62 75 69 6c 64 20 61 6e 64 20  ow to build and 
0060: 69 6e 73 74 61 6c 6c 20 46 6f 73 73 69 6c 2e 20  install Fossil. 
0070: 20 54 68 65 0a 77 68 6f 6c 65 20 70 72 6f 63 65   The.whole proce
0080: 73 73 20 69 73 20 64 65 73 69 67 6e 65 64 20 74  ss is designed t
0090: 6f 20 62 65 20 76 65 72 79 20 65 61 73 79 2e 3c  o be very easy.<
00a0: 2f 70 3e 0a 0a 3c 68 32 3e 30 2e 30 20 55 73 69  /p>..<h2>0.0 Usi
00b0: 6e 67 20 41 20 50 72 65 2d 63 6f 6d 70 69 6c 65  ng A Pre-compile
00c0: 64 20 42 69 6e 61 72 79 3c 2f 68 32 3e 0a 0a 3c  d Binary</h2>..<
00d0: 70 3e 59 6f 75 20 63 61 6e 20 73 6b 69 70 20 73  p>You can skip s
00e0: 74 65 70 73 20 31 2e 30 20 61 6e 64 20 32 2e 30  teps 1.0 and 2.0
00f0: 20 62 65 6c 6f 77 20 62 79 20 64 6f 77 6e 6c 6f   below by downlo
0100: 61 64 69 6e 67 0a 61 20 3c 61 20 68 72 65 66 3d  ading.a <a href=
0110: 22 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73  "http://www.foss
0120: 69 6c 2d 73 63 6d 2e 6f 72 67 2f 64 6f 77 6e 6c  il-scm.org/downl
0130: 6f 61 64 2e 68 74 6d 6c 22 3e 70 72 65 2d 63 6f  oad.html">pre-co
0140: 6d 70 69 6c 65 64 20 62 69 6e 61 72 79 3c 2f 61  mpiled binary</a
0150: 3e 0a 61 70 70 72 6f 70 72 69 61 74 65 20 66 6f  >.appropriate fo
0160: 72 20 79 6f 75 72 20 70 6c 61 74 66 6f 72 6d 2e  r your platform.
0170: 20 20 49 66 20 79 6f 75 20 75 73 65 20 61 20 70    If you use a p
0180: 72 65 2d 63 6f 6d 70 69 6c 65 64 20 62 69 6e 61  re-compiled bina
0190: 72 79 0a 6a 75 6d 70 20 69 6d 6d 65 64 69 61 74  ry.jump immediat
01a0: 65 20 74 6f 20 73 74 65 70 20 33 2e 30 2e 3c 2f  e to step 3.0.</
01b0: 70 3e 0a 0a 3c 68 32 3e 31 2e 30 20 4f 62 74 61  p>..<h2>1.0 Obta
01c0: 69 6e 69 6e 67 20 54 68 65 20 53 6f 75 72 63 65  ining The Source
01d0: 20 43 6f 64 65 3c 2f 68 32 3e 0a 0a 3c 70 3e 46   Code</h2>..<p>F
01e0: 6f 73 73 69 6c 20 69 73 20 73 65 6c 66 2d 68 6f  ossil is self-ho
01f0: 73 74 69 6e 67 2c 20 73 6f 20 79 6f 75 20 63 61  sting, so you ca
0200: 6e 20 6f 62 74 61 69 6e 20 61 20 5a 49 50 20 61  n obtain a ZIP a
0210: 72 63 68 69 76 65 20 63 6f 6e 74 61 69 6e 69 6e  rchive containin
0220: 67 0a 61 20 73 6e 61 70 73 68 6f 74 20 6f 66 20  g.a snapshot of 
0230: 74 68 65 20 6c 61 74 65 73 74 20 76 65 72 73 69  the latest versi
0240: 6f 6e 20 64 69 72 65 63 74 6c 79 20 66 72 6f 6d  on directly from
0250: 20 66 6f 73 73 69 6c 27 73 20 6f 77 6e 20 66 6f   fossil's own fo
0260: 73 73 69 6c 0a 72 65 70 6f 73 69 74 6f 72 79 2e  ssil.repository.
0270: 20 20 46 6f 6c 6c 6f 77 20 74 68 65 73 65 20 73    Follow these s
0280: 74 65 70 73 3a 3c 2f 70 3e 0a 0a 3c 6f 6c 3e 0a  teps:</p>..<ol>.
0290: 3c 6c 69 3e 3c 70 3e 50 6f 69 6e 74 65 72 20 79  <li><p>Pointer y
02a0: 6f 75 72 20 77 65 62 20 62 72 6f 77 73 65 72 20  our web browser 
02b0: 61 74 0a 3c 61 20 68 72 65 66 3d 22 68 74 74 70  at.<a href="http
02c0: 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63  ://www.fossil-sc
02d0: 6d 2e 6f 72 67 2f 22 3e 0a 68 74 74 70 3a 2f 2f  m.org/">.http://
02e0: 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f  www.fossil-scm.o
02f0: 72 67 2f 3c 2f 61 3e 2e 20 20 43 6c 69 63 6b 20  rg/</a>.  Click 
0300: 6f 6e 20 74 68 65 20 22 4c 6f 67 69 6e 22 20 6d  on the "Login" m
0310: 65 6e 75 20 62 75 74 74 6f 6e 2e 3c 2f 70 3e 3c  enu button.</p><
0320: 2f 6c 69 3e 0a 0a 3c 6c 69 3e 3c 70 3e 4c 6f 67  /li>..<li><p>Log
0330: 20 69 6e 20 61 73 20 61 6e 6f 6e 79 6d 6f 75 73   in as anonymous
0340: 2e 20 20 54 68 65 20 70 61 73 73 77 6f 72 64 20  .  The password 
0350: 69 73 20 73 68 6f 77 6e 20 6f 6e 20 73 63 72 65  is shown on scre
0360: 65 6e 2e 0a 54 68 65 20 72 65 61 73 6f 6e 20 66  en..The reason f
0370: 6f 72 20 72 65 71 75 69 72 69 6e 67 20 74 68 69  or requiring thi
0380: 73 20 6c 6f 67 69 6e 20 69 73 20 74 6f 20 70 72  s login is to pr
0390: 65 76 65 6e 74 20 73 70 69 64 65 72 73 20 66 72  event spiders fr
03a0: 6f 6d 0a 77 61 6c 6b 69 6e 67 20 74 68 65 20 65  om.walking the e
03b0: 6e 74 69 72 65 20 77 65 62 73 69 74 65 2c 20 64  ntire website, d
03c0: 6f 77 6e 6c 6f 61 64 69 6e 67 20 5a 49 50 20 61  ownloading ZIP a
03d0: 72 63 68 69 76 65 73 0a 6f 66 20 65 76 65 72 79  rchives.of every
03e0: 20 68 69 73 74 6f 72 69 63 61 6c 20 76 65 72 73   historical vers
03f0: 69 6f 6e 2c 20 61 6e 64 20 74 68 65 72 65 62 79  ion, and thereby
0400: 20 73 6f 61 6b 69 6e 67 20 75 70 20 61 6c 6c 20   soaking up all 
0410: 6f 75 72 20 62 61 6e 64 77 69 64 74 68 2e 3c 2f  our bandwidth.</
0420: 70 3e 3c 2f 6c 69 3e 0a 0a 3c 6c 69 3e 3c 70 3e  p></li>..<li><p>
0430: 43 6c 69 63 6b 20 6f 6e 20 74 68 65 20 0a 3c 61  Click on the .<a
0440: 20 68 72 65 66 3d 22 68 74 74 70 3a 2f 2f 77 77   href="http://ww
0450: 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 67  w.fossil-scm.org
0460: 2f 66 6f 73 73 69 6c 2f 74 69 6d 65 6c 69 6e 65  /fossil/timeline
0470: 22 3e 54 69 6d 65 6c 69 6e 65 3c 2f 61 3e 20 6f  ">Timeline</a> o
0480: 72 0a 3c 61 20 68 72 65 66 3d 22 68 74 74 70 3a  r.<a href="http:
0490: 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d  //www.fossil-scm
04a0: 2e 6f 72 67 2f 66 6f 73 73 69 6c 2f 6c 65 61 76  .org/fossil/leav
04b0: 65 73 22 3e 4c 65 61 76 65 73 3c 2f 61 3e 20 6c  es">Leaves</a> l
04c0: 69 6e 6b 20 61 74 0a 74 68 65 20 74 6f 70 20 6f  ink at.the top o
04d0: 66 20 74 68 65 20 70 61 67 65 2e 3c 2f 70 3e 3c  f the page.</p><
04e0: 2f 6c 69 3e 0a 0a 3c 6c 69 3e 3c 70 3e 53 65 6c  /li>..<li><p>Sel
04f0: 65 63 74 20 61 20 76 65 72 73 69 6f 6e 20 6f 66  ect a version of
0500: 20 6f 66 20 66 6f 73 73 69 6c 20 79 6f 75 20 77   of fossil you w
0510: 61 6e 74 20 74 6f 20 64 6f 77 6e 6c 6f 61 64 2e  ant to download.
0520: 20 20 43 6c 69 63 6b 20 6f 6e 20 69 74 73 0a 6c    Click on its.l
0530: 69 6e 6b 2e 20 20 4e 6f 74 65 20 74 68 61 74 20  ink.  Note that 
0540: 79 6f 75 20 6d 75 73 74 20 73 75 63 63 65 73 73  you must success
0550: 66 75 6c 6c 79 20 6c 6f 67 20 69 6e 20 61 73 20  fully log in as 
0560: 22 61 6e 6f 6e 79 6d 6f 75 73 22 20 69 6e 20 73  "anonymous" in s
0570: 74 65 70 20 31 0a 61 62 6f 76 65 20 69 6e 20 6f  tep 1.above in o
0580: 72 64 65 72 20 74 6f 20 73 65 65 20 74 68 65 20  rder to see the 
0590: 6c 69 6e 6b 20 74 6f 20 74 68 65 20 64 65 74 61  link to the deta
05a0: 69 6c 65 64 20 76 65 72 73 69 6f 6e 20 69 6e 66  iled version inf
05b0: 6f 72 6d 61 74 69 6f 6e 2e 3c 2f 70 3e 3c 2f 6c  ormation.</p></l
05c0: 69 3e 0a 0a 3c 6c 69 3e 3c 70 3e 4f 6e 20 74 68  i>..<li><p>On th
05d0: 65 20 76 65 72 73 69 6f 6e 20 69 6e 66 6f 72 6d  e version inform
05e0: 61 74 69 6f 6e 20 70 61 67 65 2c 20 63 6c 69 63  ation page, clic
05f0: 6b 20 6f 6e 20 74 68 65 20 22 5b 64 65 74 61 69  k on the "[detai
0600: 6c 73 5d 22 20 68 79 70 65 72 6c 69 6e 6b 0a 74  ls]" hyperlink.t
0610: 68 61 74 20 61 70 70 65 61 72 73 20 72 69 67 68  hat appears righ
0620: 74 20 61 66 74 65 72 20 74 68 65 20 63 68 65 63  t after the chec
0630: 6b 2d 69 6e 20 63 6f 6d 6d 65 6e 74 20 61 74 20  k-in comment at 
0640: 74 68 65 20 74 6f 70 20 6f 66 20 74 68 65 20 70  the top of the p
0650: 61 67 65 2e 3c 2f 70 3e 0a 0a 3c 6c 69 3e 3c 70  age.</p>..<li><p
0660: 3e 46 69 6e 61 6c 6c 79 2c 20 63 6c 69 63 6b 20  >Finally, click 
0670: 6f 6e 20 74 68 65 0a 22 5a 69 70 20 41 72 63 68  on the."Zip Arch
0680: 69 76 65 22 20 6c 69 6e 6b 2e 20 20 54 68 69 73  ive" link.  This
0690: 20 6c 69 6e 6b 20 77 69 6c 6c 20 62 75 69 6c 64   link will build
06a0: 20 61 20 5a 49 50 20 61 72 63 68 69 76 65 20 6f   a ZIP archive o
06b0: 66 20 74 68 65 20 0a 63 6f 6d 70 6c 65 74 65 20  f the .complete 
06c0: 73 6f 75 72 63 65 20 63 6f 64 65 20 61 6e 64 20  source code and 
06d0: 64 6f 77 6e 6c 6f 61 64 20 69 74 20 74 6f 20 79  download it to y
06e0: 6f 75 72 20 62 72 6f 77 73 65 72 2e 0a 3c 2f 6f  our browser..</o
06f0: 6c 3e 0a 0a 3c 68 32 3e 32 2e 30 20 43 6f 6d 70  l>..<h2>2.0 Comp
0700: 69 6c 69 6e 67 3c 2f 68 32 3e 0a 0a 3c 70 3e 46  iling</h2>..<p>F
0710: 6f 6c 6c 6f 77 20 74 68 65 73 65 20 73 74 65 70  ollow these step
0720: 73 20 74 6f 20 63 6f 6d 70 69 6c 65 3a 3c 2f 70  s to compile:</p
0730: 3e 0a 0a 3c 6f 6c 3e 0a 3c 6c 69 20 76 61 6c 75  >..<ol>.<li valu
0740: 65 3d 22 36 22 3e 0a 3c 70 3e 43 72 65 61 74 65  e="6">.<p>Create
0750: 20 61 20 64 69 72 65 63 74 6f 72 79 20 74 6f 20   a directory to 
0760: 68 6f 6c 64 20 74 68 65 20 73 6f 75 72 63 65 20  hold the source 
0770: 63 6f 64 65 2e 20 20 54 68 65 6e 20 75 6e 7a 69  code.  Then unzi
0780: 70 20 74 68 65 0a 5a 49 50 20 61 72 63 68 69 76  p the.ZIP archiv
0790: 65 20 79 6f 75 20 64 6f 77 6e 6c 6f 61 64 65 64  e you downloaded
07a0: 20 69 6e 74 6f 20 74 68 61 74 20 64 69 72 65 63   into that direc
07b0: 74 6f 72 79 2e 20 20 59 6f 75 20 73 68 6f 75 6c  tory.  You shoul
07c0: 64 20 62 65 0a 69 6e 20 74 68 65 20 74 6f 70 2d  d be.in the top-
07d0: 6c 65 76 65 6c 20 66 6f 6c 64 65 72 20 6f 66 20  level folder of 
07e0: 74 68 61 74 20 64 69 72 65 63 74 6f 72 79 3c 2f  that directory</
07f0: 70 3e 3c 2f 6c 69 3e 0a 0a 3c 6c 69 3e 3c 70 3e  p></li>..<li><p>
0800: 3c 62 3e 28 4f 70 74 69 6f 6e 61 6c 3a 29 3c 2f  <b>(Optional:)</
0810: 62 3e 0a 45 64 69 74 20 74 68 65 20 4d 61 6b 65  b>.Edit the Make
0820: 66 69 6c 65 20 74 6f 20 73 65 74 20 69 74 20 75  file to set it u
0830: 70 20 6c 69 6b 65 20 79 6f 75 20 77 61 6e 74 2e  p like you want.
0840: 20 20 59 6f 75 20 70 72 6f 62 61 62 6c 79 20 64    You probably d
0850: 6f 20 6e 6f 74 0a 6e 65 65 64 20 74 6f 20 64 6f  o not.need to do
0860: 20 61 6e 79 74 68 69 6e 67 2e 20 20 44 6f 20 6e   anything.  Do n
0870: 6f 74 20 62 65 20 69 6e 74 69 6d 69 64 61 74 65  ot be intimidate
0880: 64 3a 20 20 54 68 65 72 65 20 61 72 65 20 6f 6e  d:  There are on
0890: 6c 79 20 35 0a 76 61 72 69 61 62 6c 65 73 20 69  ly 5.variables i
08a0: 6e 20 74 68 65 20 6d 61 6b 65 66 69 6c 65 20 74  n the makefile t
08b0: 68 61 74 20 63 61 6e 20 62 65 20 63 68 61 6e 67  hat can be chang
08c0: 65 64 2e 20 20 54 68 65 20 77 68 6f 6c 65 20 4d  ed.  The whole M
08d0: 61 6b 65 66 69 6c 65 0a 69 73 20 6f 6e 6c 79 20  akefile.is only 
08e0: 61 20 66 65 77 20 64 6f 7a 65 6e 20 6c 69 6e 65  a few dozen line
08f0: 73 20 6c 6f 6e 67 20 61 6e 64 20 6d 6f 73 74 20  s long and most 
0900: 6f 66 20 74 68 6f 73 65 20 6c 69 6e 65 73 20 61  of those lines a
0910: 72 65 20 63 6f 6d 6d 65 6e 74 73 2e 3c 2f 70 3e  re comments.</p>
0920: 0a 0a 3c 6c 69 3e 3c 70 3e 54 79 70 65 20 22 3c  ..<li><p>Type "<
0930: 62 3e 6d 61 6b 65 3c 2f 62 3e 22 0a 3c 2f 6f 6c  b>make</b>".</ol
0940: 3e 0a 0a 3c 68 32 3e 33 2e 30 20 49 6e 73 74 61  >..<h2>3.0 Insta
0950: 6c 6c 69 6e 67 3c 2f 68 32 3e 0a 0a 3c 6f 6c 3e  lling</h2>..<ol>
0960: 0a 3c 6c 69 20 76 61 6c 75 65 3d 22 39 22 3e 0a  .<li value="9">.
0970: 3c 70 3e 54 68 65 20 66 69 6e 69 73 68 65 64 20  <p>The finished 
0980: 62 69 6e 61 72 79 20 69 73 20 6e 61 6d 65 64 20  binary is named 
0990: 22 66 6f 73 73 69 6c 22 2e 20 20 50 75 74 20 74  "fossil".  Put t
09a0: 68 69 73 20 62 69 6e 61 72 79 20 69 6e 20 61 20  his binary in a 
09b0: 0a 64 69 72 65 63 74 6f 72 79 20 74 68 61 74 20  .directory that 
09c0: 69 73 20 73 6f 6d 65 77 68 65 72 65 20 6f 6e 20  is somewhere on 
09d0: 79 6f 75 72 20 50 41 54 48 20 65 6e 76 69 72 6f  your PATH enviro
09e0: 6e 6d 65 6e 74 20 76 61 72 69 61 62 6c 65 2e 0a  nment variable..
09f0: 49 74 20 64 6f 65 73 20 6e 6f 74 20 6d 61 74 74  It does not matt
0a00: 65 72 20 77 68 65 72 65 2e 3c 2f 70 3e 0a 0a 3c  er where.</p>..<
0a10: 6c 69 3e 0a 3c 70 3e 3c 62 3e 28 4f 70 74 69 6f  li>.<p><b>(Optio
0a20: 6e 61 6c 3a 29 3c 2f 62 3e 0a 54 6f 20 75 6e 69  nal:)</b>.To uni
0a30: 6e 73 74 61 6c 6c 2c 20 6a 75 73 74 20 64 65 6c  nstall, just del
0a40: 65 74 65 20 74 68 65 20 62 69 6e 61 72 79 2e 3c  ete the binary.<
0a50: 2f 70 3e 0a 3c 2f 6f 6c 3e 0a                    /p>.</ol>.