Mercurial > irccd

comparison doc/src/build.md @ 607:bb9771fb5f44

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: rework documentation - Change directories, - Remove handwritten manual pages.
author David Demelier <markand@malikania.fr>
date Fri, 08 Dec 2017 20:11:22 +0100
parents
children 2007a37d7e1a
comparison
equal deleted inserted replaced
606:4f5f306d13ac 607:bb9771fb5f44
1 % building from sources
2 % David Demelier
3 % 2017-12-08
4
5 You should use the irccd version provided by your package manger if possible. If
6 irccd is not available, you can build it from sources.
7
8 # Requirements
9
10 To build from sources, you need the following installed on your system:
11
12 - [CMake](http://www.cmake.org),
13 - [OpenSSL](https://www.openssl.org) (Optional) for connecting with SSL,
14 - [Pandoc](http://pandoc.org) (Optional) for building the documentation,
15 - At least **GCC 5.1** or **clang 3.4**
16
17 **Warning**: don't even try to compile with GCC 4.x, it will not work due to
18 missing C++14 features.
19
20 # Running the build
21
22 When you're ready, extract the **irccd-x.y.z.tar.gz** where **x.y.z** is the
23 current version. Go to that directory, then type the following commands:
24
25 $ mkdir _build_
26 $ cd _build_
27 $ cmake ..
28 $ make
29 $ sudo make install
30
31 This is the quick way of compiling and installing. It's also possible to set
32 some options to customize the build. See below.
33
34 # Customizing the build
35
36 You can configure some features when compiling irccd.
37
38 ## Disabling JavaScript
39
40 You can disable JavaScript support.
41
42 $ cmake .. -DWITH_JS=Off
43
44 ## Disabling SSL
45
46 You can disable OpenSSL support, it is automatically unset if OpenSSL is not
47 found.
48
49 **Warning**: this is not recommended.
50
51 $ cmake .. -DWITH_SSL=Off
52
53 ## Disabling all documentation
54
55 You can disable all the documentation.
56
57 $ cmake .. -DWITH_DOCS=Off
58
59 See below to disable only specific parts of the documentation.
60
61 ## Disabling HTML documentation
62
63 By default if Pandoc is available, the HTML documentation is built, you can
64 disable it.
65
66 $ cmake .. -DWITH_HTML=Off
67
68 ## Disabling man pages
69
70 You can disable installation of manuals.
71
72 $ cmake .. -DWITH_MAN=Off
73
74 ## Installation path
75
76 Sometimes, you may need to install irccd over other place, for that, you can
77 specify the prefix where to install files.
78
79 On Unix systems, it's usually **/usr/local** and **C:/Program Files/Irccd** on
80 Windows.
81
82 To change this, use the following:
83
84 $ cmake .. -DCMAKE_INSTALL_PREFIX=/opt/some/directory
85
86 ## Manual pages path
87
88 By default, irccd use **${CMAKE_INSTALL_PREFIX}/share/man** for manual pages.
89
90 For example, on FreeBSD the typical use would be:
91
92 $ cmake .. -DWITH_MANDIR=/usr/local/man