]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/extra/README
Update documentation links.
[user/henk/code/inspircd.git] / src / modules / extra / README
1 This directory stores modules which require external libraries to compile.
2 For example, m_regex_pcre requires the PCRE libraries.
3
4 To compile any of these modules first ensure you have the required dependencies
5 (read the online documentation at https://docs.inspircd.org/) and then symlink
6 the .cpp file from this directory into the parent directory (src/modules/).
7
8 Alternatively, use the command: ./configure --enable-extras=m_extra.cpp, which will
9 automatically take care of symlinking the module of that name and any headers it needs
10 from the extras directory. You can also use ./configure --list-extras to see what
11 modules are available, and whether they are enabled or not. You still are responsible
12 for resolving any external dependencies however (ie, PCRE, MySQL, GnuTLS, etc).
13
14 NOTE: Some modules require you to copy other dependencies too, such as a related header.
15 If you get missing header errors when building these modules, check that the header is
16 not within modules/extra before checking for external dependencies.