summaryrefslogtreecommitdiff
path: root/doc/en/install.en.xml
blob: 0b5ec080e93b7a512663ad29ee0171e8ca9f03a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<?xml version="1.0" encoding="UTF-8"?>

<!--

WeeChat documentation (english version)

Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org>

This manual 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 3 of the License, or
(at your option) any later version.

This manual 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, see <http://www.gnu.org/licenses/>.

-->

<chapter id="chapInstallation">
  <title>Installation</title>
  
  <para>
    This chapter explains how to install WeeChat.
  </para>
  
  <section id="secBinaryPackages">
    <title>Binary packages</title>
    
    <para>
      Binary packages are available for these distributions:
      <itemizedlist>
        <listitem>
          <para>
            Debian (or any Debian compatible distribution):
            <userinput>apt-get install weechat</userinput>
          </para>
        </listitem>
        <listitem>
          <para>
            Mandriva/RedHat (or any RPM compatible distribution):
            <userinput>
              rpm -i /path/to/weechat-x.y.z-1.i386.rpm
            </userinput>
          </para>
        </listitem>
        <listitem>
          <para>
            Gentoo :
            <userinput>emerge weechat</userinput>
          </para>
        </listitem>
      </itemizedlist>
      
      For other distributions, please look at your manual for
      installation instructions.
    </para>
    
  </section>
  
  <section id="secSourcePackage">
    <title>Source package</title>
    
    <para>
      WeeChat can be compiled with autotools or cmake.
    </para>

    <section id="secCompileWithAutotools">
      <title>Compile with Autotools</title>

      <para>
        In a console or a terminal:
<screen><prompt>$ </prompt><userinput>./configure</userinput>
<prompt>$ </prompt><userinput>make</userinput></screen>
      </para>
      <para>
        Then get root privileges and install WeeChat:
<screen><prompt>$ </prompt><userinput>su</userinput>
(enter root password)
<prompt># </prompt><userinput>make install</userinput></screen>
      </para>

    </section>

    <section id="secCompileWithCmake">
      <title>Compile with Cmake</title>

      <para>
        In a console or a terminal:
<screen><prompt>$ </prompt><userinput>mkdir build</userinput>
<prompt>$ </prompt><userinput>cd build</userinput>
<prompt>$ </prompt><userinput>cmake ..</userinput>
<prompt>$ </prompt><userinput>make</userinput></screen>
      </para>
      <para>
        Then get root privileges and install WeeChat:
<screen><prompt>$ </prompt><userinput>su</userinput>
(enter root password)
<prompt># </prompt><userinput>make install</userinput></screen>
      </para>

    </section>
    
  </section>
  
  <section id="secGITSources">
    <title>GIT sources</title>
    
    <para>
      Warning: GIT sources are for advanced users: it may not compile
      or not be stable. You're warned!
    </para>
    
    <para>
      To get GIT sources, issue this command:
<screen><prompt>$ </prompt><userinput>git-clone git://git.sv.gnu.org/weechat.git</userinput></screen>
    </para>
    
    <para>
      If you're using Autotools (and not cmake), execute this script:
      <userinput>./autogen.sh</userinput>
    </para>
    
    <para>
      Then follow instructions for source package
      (see <xref linkend="secSourcePackage" />)
    </para>
    
  </section>
  
</chapter>