irctk

libircclient binding for scripts
git clone https://a3nm.net/git/irctk/
Log | Files | Refs | README

commit 09ed4ce7b7318d5f9b4c8d3341feca27a7dd5690
parent 3d8474d68c7cbbf6b5065e1384066e975542691e
Author: Antoine Amarilli <a3nm@a3nm.net>
Date:   Mon, 27 Aug 2018 02:22:36 +0200

packaging clarifications in README

- libircclient 1.9
- libssl1.0-dev at the latest
- clarify that debian libircclient is not compiled with SSL support

Diffstat:
README | 31++++++++++++++++++++-----------
1 file changed, 20 insertions(+), 11 deletions(-)

diff --git a/README b/README @@ -24,11 +24,15 @@ quickly, either in the shell or in your favourite programming language. == 2. Installation == -You will need the libircclient library (version >= 1.8 with SSL support) to -compile and run irctk, as well as libssl-dev. On Debian Jessie and later, -sufficiently recent versions can be installed with: +You will need the libircclient library (version >= 1.8) to compile and run +irctk. On Debian jessie and later, sufficiently recent versions can be installed +with: - sudo apt-get install libircclient1 libircclient-dev libssl-dev + sudo apt-get install libircclient1 libircclient-dev + +However, these versions are compiled without SSL support, so irctk will not +support SSL. If you wish to use SSL, you need to compile libircclient yourself +(explained below). You can then compile irctk by issuing "make". Install irctk by yourself in a location of your PATH if you want to use it as "irctk", otherwise replace @@ -39,13 +43,18 @@ necessary, and how to install irctk without requiring root privileges. === 2.1. Compiling libircclient === -If you need to install libircclient manually, get libircclient-1.8 from +First, if you want support for SSL, you need to install the OpenSSL library and +header files. You need to use OpenSSL version 1.0.2, *not* OpenSSL version 1.1. +On Debian stretch and later, you can do so by running: + + sudo apt-get install libssl1.0-dev + +Second, you should get the latest libircclient (currently libircclient-1.9) from <http://sourceforge.net/projects/libircclient/>, compile it and install it (this -requires the package libssl-dev on Debian, and of course make, a C compiler, -etc., which you can get on Debian systems by installing e.g. the package -build-essential): +requires of course make, a C compiler, etc., which you can get on Debian systems +by installing e.g. the package build-essential). Then run: - ./configure --enable-openssl --enable-shared + ./configure -enable-openssl --enable-shared make sudo make install @@ -59,11 +68,11 @@ explained, without the "sudo" command. Then, issue (in the libircclient folder): Now go back to the irctk folder, add at the end of the CFLAGS line the following, adjusting for the location of the libircclient folder: - -I/where/you/put/libircclient-1.8/include + -I/where/you/put/libircclient-1.9/include Compile with "make", and now run irctk with the following invocation: - LD_LIBRARY_PATH="/where/you/put/libircclient-1.8/src/:$LD_LIBRARY_PATH" ./irctk + LD_LIBRARY_PATH="/where/you/put/libircclient-1.9/src/:$LD_LIBRARY_PATH" ./irctk == 3. How to use ==