comparison doc/src/irccd.md @ 709:1b04ffb2b35e

CMake: switch to GNUInstallDirs, closes #873 @1h
author David Demelier <markand@malikania.fr>
date Sat, 07 Jul 2018 10:59:19 +0200
parents 0dd4fb9dfcc8
children ebe561276c33
comparison
equal deleted inserted replaced
708:0dd4fb9dfcc8 709:1b04ffb2b35e
31 31
32 The following directories are searched in the specified order for configuration 32 The following directories are searched in the specified order for configuration
33 files. For example, the files `irccd.conf` and `irccdctl.conf` will be searched 33 files. For example, the files `irccd.conf` and `irccdctl.conf` will be searched
34 there. 34 there.
35 35
36 - \(W) `%APPDATA%/irccd/config` 36 - \(W) %APPDATA%/irccd/config
37 - \(U) `${XDG_CONFIG_HOME}/irccd` 37 - \(U) ${XDG\_CONFIG\_HOME}/irccd
38 - \(U) `${HOME}/.config/irccd` (if `XDG_CONFIG_HOME` is not set) 38 - \(U) ${HOME}/.config/irccd (if XDG\_CONFIG\_HOME is not set)
39 - `installation-directory/etc` 39 - CMAKE\_INSTALL\_SYSCONFDIR/irccd
40 40
41 Examples: 41 Examples:
42 42
43 - `/home/john/.config/irccd/irccd.conf` 43 - /home/john/.config/irccd/irccd.conf
44 - `/usr/local/etc/irccd.conf` 44 - /usr/local/etc/irccd.conf
45 - `C:/Program Files/irccd/etc/irccd.conf` 45 - C:/Program Files/irccd/etc/irccd/irccd.conf
46 - `C:/Users/john/AppData/irccd/config` 46 - C:/Users/john/AppData/irccd/config
47 47
48 # Plugins 48 # Plugins
49 49
50 These directories are searched in the following order to load plugins when they 50 These directories are searched in the following order to load plugins when they
51 are not specified by full paths. 51 are not specified by full paths.
52 52
53 - current working directory 53 - current working directory
54 - \(W) `%APPDATA%/irccd/share/plugins` 54 - \(W) %APPDATA%/irccd/share/plugins
55 - \(U) `${XDG_DATA_HOME}/irccd/plugins` 55 - \(U) ${XDG\_DATA\_HOME}/irccd/plugins
56 - \(U) `${HOME}/.local/share/irccd/plugins` (if `XDG_DATA_HOME` is not set) 56 - \(U) ${HOME}/.local/share/irccd/plugins (if XDG\_DATA\_HOME is not set)
57 - \(W) `installation-directory/share/plugins` 57 - CMAKE\_INSTALL\_LIBDIR/irccd (both native and Javascript)
58 - \(U) `installation-directory/share/irccd/plugins`
59 58
60 Examples: 59 Examples:
61 60
62 - `/home/john/.local/share/irccd/plugins/ask.js` 61 - /home/john/.local/share/irccd/plugins/ask.js
63 - `/usr/local/share/irccd/plugins/ask.js` 62 - /usr/local/lib/irccd/plugins/ask.js
64 - `C:/Users/john/AppDAta/irccd/share/plugins/ask.js` 63 - C:/Users/john/AppData/irccd/share/plugins/ask.js
65 - `C:/Program Files/irccd/share/plugins/ask.js` 64 - C:/Program Files/irccd/lib/irccd/plugins/ask.js
66 65
67 # Templates and formatting 66 # Templates and formatting
68 67
69 Plugins can be configured using a powerful template syntax, this allows editing 68 Plugins can be configured using a powerful template syntax, this allows editing
70 the plugin messages to override them. 69 the plugin messages to override them.