summaryrefslogtreecommitdiff
path: root/doc/en/user/install.en.xml
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2008-11-05 18:28:25 +0100
committerSebastien Helleu <flashcode@flashtux.org>2008-11-05 18:28:25 +0100
commita17065492fe46089dadb7b22437d913e3b39a443 (patch)
tree7d657d061cee10e50b5d56a9a45448208ffd6b9c /doc/en/user/install.en.xml
parenta6c4e4ed7644c52cb228cb4aa9b2e6cd6b21883b (diff)
downloadweechat-a17065492fe46089dadb7b22437d913e3b39a443.zip
Split doc into 2 docs: user and developer guide
Diffstat (limited to 'doc/en/user/install.en.xml')
-rw-r--r--doc/en/user/install.en.xml137
1 files changed, 137 insertions, 0 deletions
diff --git a/doc/en/user/install.en.xml b/doc/en/user/install.en.xml
new file mode 100644
index 000000000..54b6e7001
--- /dev/null
+++ b/doc/en/user/install.en.xml
@@ -0,0 +1,137 @@
+<?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 many distributions, including:
+ <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>
+
+ Some additional packages may be useful, like weechat-plugins.
+
+ 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>