build: link nums only when BT is enabled (ref #27)
[mldonkey.git] / distrib / Install.txt
blob29330f533967ddda60bd6990fbe3cd28a6bbadf2
1 Installation
2 ==================
4 -If you want to get up and running quickly and easily-
6 Compile mldonkey without GUI support
7 You have to have zlib, zlib-dev and m4 packages installed.
8 For gd-made statistics libgd2-dev should be installed.
10 Mldonkey/> ./configure
11 Mldonkey/> make
13 There is no additional 'make install' command. Copy the file 'mlnet'
14 (this is MLdonkey) to the folder where you've choosen to run MLdonkey.
16 Start 'mlnet'
18 Mlnet/> ./mlnet
19 Leave the terminal window open. MLdonkey is now running.
21 Open a browser and type in the URL http://localhost:4080 <enter>.
22 A web-based interface to MLdonkey appears. Certain ports enabling inbound
23 routing on your firewall/router need to be opened to fully use MLdonkey.
24 The Options tab in the web interface shows the ports.
26 Downloaded files will be found in the sub-directory incoming/, while
27 files to be shared should be in a sub-directory called shared/.
29 -You're done!-
31 Some goodies (make_torrent, ed2k_hash) come with mldonkey, you can also
32 compile them using the additionnal command:
34 Mldonkey/> make utils
36 ==================
37 There are additional ways besides the web interface to control Mlnet(MLdonkey).
38 - Compiling support for the 'mlgui' application while compiling MLdonkey
39   is one. This requires additional libraries, which, depending on your platform
40   and skill, may be easy or not so easy to add. The 'mlnet' application functions
41   fine without the GUI.
42 - Other applications are written by third-parties and available for specific
43   platforms. These vary in stability and functionality.
44   One example is Sancho: http://sancho-gui.sourceforge.net/
46 Compiling mldonkey with mldonkey_gui support:
47 -------------------
49 You have now two options to compile mldonkey:
50 - Individually install Objective-Caml 3.08.4, LablGTK 1.2.7 and/or LablGTK-2.4.0.
51   Then, you can compile mldonkey. The instructions are given below at '1)'.
52 - If you want to install ocaml and lablgtk only to compile mldonkey. You must
53   have a good internet access (you want mldonkey after all :). You must have
54   "wget" installed. Then, run:
56 ./configure --enable-batch
58 The configure script will download ocaml and lablgtk, compile and install them
59 locally so that they can be used to compile mldonkey. Steps below can be skipped
60 now. Be patient. OCaml and lablgtk tools take a while to compile and install.
62 Note: At least 70 M of free disk space is required on the partition where mldonkey
63 is compiled.
65 ------------------------------------------------------------------------
66 1) Installing required tools: Objective-Caml 3.10.2 and LablGTK
68  1.1) Objective-Caml 3.10.2 (from http://caml.inria.fr/pub/distrib/ocaml-3.10)
70     ~/tmp> wget http://caml.inria.fr/distrib/ocaml-3.10/ocaml-3.10.2.tar.gz
71     ~/tmp> tar zxf ocaml-3.10.2.tar.gz
72     ~/tmp> cd ocaml-3.10.2
74     ~/tmp/ocaml-3.10.2> ./configure
75     ~/tmp/ocaml-3.10.2> make world.opt
76     ~/tmp/ocaml-3.10.2> make install
78  1.2.1) LablGTK 1.2.7 for GTK1
79       (from http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html)
81     ~/tmp> wget http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/dist/lablgtk-1.2.7.tar.gz
82     ~/tmp> tar zxf lablgtk-1.2.7.tar.gz
83     ~/tmp> cd lablgtk-1.2.7
84     ~/tmp/lablgtk-1.2.7> make configure
85     ~/tmp/lablgtk-1.2.7> make
86     ~/tmp/lablgtk-1.2.7> make opt
87     ~/tmp/lablgtk-1.2.7> make install
89  1.2.2) LablGTK-2.10.1 for GTK2
90       (from http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html)
92     ~/tmp> wget http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/dist/lablgtk-2.10.1.tar.gz
93     ~/tmp> tar zxf lablgtk-2.10.1.tar.gz
94     ~/tmp> cd lablgtk-2.10.1
95     ~/tmp/lablgtk-2.10.1> ./configure
96     ~/tmp/lablgtk-2.10.1> make world
97     ~/tmp/lablgtk-2.10.1> make install
99 2) Compiling mldonkey with GUI:
101     To build GTK1 newgui: ./configure --enable-gui=newgui1
102     To build GTK1 oldgui: ./configure --enable-gui=oldgui
103       - note: oldgui does not compile with OCaml >= 3.10
104     To build GTK2 GUI:    ./configure --enable-gui[=newgui2]
105     lablgtk-1.2.7 and lablgtk-2.10.1 can both be installed at the same time.
107     ~/tmp/mldonkey> make
109   You should now have 'mlnet' (the daemon with all network support)
110   and 'mlgui' (the interface) No 'make install' is provided. 
112   You can disable all other p2p networks using the --disable-multinet option
113    with ./configure. Only edonkey support (including Overnet/Kademlia)
114    will then be compiled.
116 ------------------------------------------------------------------------
118 NOTES:
119 ------
120 To compile on MinGW read this guide:
121 http://mldonkey.sourceforge.net/Windows