Mercurial > irccd
changeset 55:fe9854a09ee7
Misc: switch CRLF -> LF
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 29 Feb 2016 23:25:22 +0100 |
parents | 0fb398c747e0 |
children | aa6117d8d3c5 |
files | doc/html/api/module/Irccd.File/method/close.md doc/procs/20.options.md doc/procs/30.options.md win32/CMakeLists.txt |
diffstat | 4 files changed, 156 insertions(+), 156 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/api/module/Irccd.File/method/close.md Mon Feb 29 23:10:48 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/close.md Mon Feb 29 23:25:22 2016 +0100 @@ -1,5 +1,5 @@ ---- -method: close -summary: "Force close of the file, automatically called when object is collected." -synopsis: "File.prototype.close()" ---- +--- +method: close +summary: "Force close of the file, automatically called when object is collected." +synopsis: "File.prototype.close()" +---
--- a/doc/procs/20.options.md Mon Feb 29 23:10:48 2016 +0100 +++ b/doc/procs/20.options.md Mon Feb 29 23:25:22 2016 +0100 @@ -1,83 +1,83 @@ -Irccd configuration file (irccd.conf) -===================================== - -This file describes how to add new options in the irccd configuration file. - -# Current options - -## general - - - **uid**: (string or number) the user id to use (Optional, default: none), - - **gid**: (string or number) the group id to use (Optional, default: none), - - **foreground**: (bool) set to true to not daemonize (Optional, default: false), - - **pidfile**: (string) path to a file where to store the irccd pid (Optional, default: none). - -## logs - - - **verbose**: (bool) be verbose (Optional, default: false), - - **type**: (string) which kind of logging, console, file or syslog (Optional, default: console). - -The options for **file** type: - - - **path-logs**: (string) path to the normal messages, - - **path-errors**: (string) path to the error messages. - -## identity - - - **name**: (id) the identity unique id, - - **nickname**: (string) the nickname (Optional, default: irccd), - - **realname**: (string) the realname (Optional, default: IRC Client daemon), - - **username**: (string) the username name (Optional, default: irccd), - - **ctcp-version**: (string) what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon), - - **ctcp-autoreply**: (bool) enable auto CTCP VERSION reply, (Optional, default: true). - -## server - - - **name**: (id) the unique id, - - **host**: (string) the server address, - - **port**: (int) the server port (Optional, default: 6667), - - **identity**: (string) an identity to use (Optional, default: irccd's default), - - **password**: (string) an optional password (Optional, default: none), - - **auto-rejoin**: (bool) auto rejoin a channel after being kicked (Optional, default: false), - - **join-invite**: (bool) join channels upon invitation (Optional, default: false), - - **channels**: (list) list of channels to auto join, (Optional, default: empty), - - **command-char**: (string) the prefix for invoking special commands (Optional, default: !), - - **ssl**: (bool) enable or disable SSL (Optional, default: false), - - **ssl-verify**: (bool) verify the SSL certificates (Optional, default: true), - - **reconnect**: (bool) enable reconnection after failure (Optional, default: true), - - **reconnect-tries**: (int) number of tries before giving up. A value of 0 means indefinitely (Optional, default: 0), - - **reconnect-timeout**: (int) number of seconds to wait before retrying (Optional, default: 30). - -## plugins - -No options. - -## transport - - - **type**: (string) type of listener "ip" or "unix" - -The options for **ip** type: - - - **port**: (int) port number, - - **address**: (string) address to bind or "*" for any (Optional, default: *), - - **family**: (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4). - -The options for **unix** type: - - - **path**: (string) the file path to the socket. - -## rule - - - **servers**, (list) a list of servers that will match the rule (Optional, default: empty), - - **channels**, (list) a list of channel (Optional, default: empty), - - **plugins**, (list) which plugins (Optional, default: empty), - - **events**, (list) which events (e.g onCommand, onMessage, ...) (Optional, default: empty), - - **action**, (string) set to **accept** or **drop**. - -# Add a new option - - 1. Update this file, - 2. Open irccd/config.cpp and load your option into the appropriate function, - 3. Update doc/html/guide/04-irccd/01-config.md, - 4. Update doc/examples/irccd.conf, - 5. Update doc/man/irccd.conf.5.in. +Irccd configuration file (irccd.conf) +===================================== + +This file describes how to add new options in the irccd configuration file. + +# Current options + +## general + + - **uid**: (string or number) the user id to use (Optional, default: none), + - **gid**: (string or number) the group id to use (Optional, default: none), + - **foreground**: (bool) set to true to not daemonize (Optional, default: false), + - **pidfile**: (string) path to a file where to store the irccd pid (Optional, default: none). + +## logs + + - **verbose**: (bool) be verbose (Optional, default: false), + - **type**: (string) which kind of logging, console, file or syslog (Optional, default: console). + +The options for **file** type: + + - **path-logs**: (string) path to the normal messages, + - **path-errors**: (string) path to the error messages. + +## identity + + - **name**: (id) the identity unique id, + - **nickname**: (string) the nickname (Optional, default: irccd), + - **realname**: (string) the realname (Optional, default: IRC Client daemon), + - **username**: (string) the username name (Optional, default: irccd), + - **ctcp-version**: (string) what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon), + - **ctcp-autoreply**: (bool) enable auto CTCP VERSION reply, (Optional, default: true). + +## server + + - **name**: (id) the unique id, + - **host**: (string) the server address, + - **port**: (int) the server port (Optional, default: 6667), + - **identity**: (string) an identity to use (Optional, default: irccd's default), + - **password**: (string) an optional password (Optional, default: none), + - **auto-rejoin**: (bool) auto rejoin a channel after being kicked (Optional, default: false), + - **join-invite**: (bool) join channels upon invitation (Optional, default: false), + - **channels**: (list) list of channels to auto join, (Optional, default: empty), + - **command-char**: (string) the prefix for invoking special commands (Optional, default: !), + - **ssl**: (bool) enable or disable SSL (Optional, default: false), + - **ssl-verify**: (bool) verify the SSL certificates (Optional, default: true), + - **reconnect**: (bool) enable reconnection after failure (Optional, default: true), + - **reconnect-tries**: (int) number of tries before giving up. A value of 0 means indefinitely (Optional, default: 0), + - **reconnect-timeout**: (int) number of seconds to wait before retrying (Optional, default: 30). + +## plugins + +No options. + +## transport + + - **type**: (string) type of listener "ip" or "unix" + +The options for **ip** type: + + - **port**: (int) port number, + - **address**: (string) address to bind or "*" for any (Optional, default: *), + - **family**: (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4). + +The options for **unix** type: + + - **path**: (string) the file path to the socket. + +## rule + + - **servers**, (list) a list of servers that will match the rule (Optional, default: empty), + - **channels**, (list) a list of channel (Optional, default: empty), + - **plugins**, (list) which plugins (Optional, default: empty), + - **events**, (list) which events (e.g onCommand, onMessage, ...) (Optional, default: empty), + - **action**, (string) set to **accept** or **drop**. + +# Add a new option + + 1. Update this file, + 2. Open irccd/config.cpp and load your option into the appropriate function, + 3. Update doc/html/guide/04-irccd/01-config.md, + 4. Update doc/examples/irccd.conf, + 5. Update doc/man/irccd.conf.5.in.
--- a/doc/procs/30.options.md Mon Feb 29 23:10:48 2016 +0100 +++ b/doc/procs/30.options.md Mon Feb 29 23:25:22 2016 +0100 @@ -1,24 +1,24 @@ -Irccdctl configuration file (irccdctl.conf) -=========================================== - -This file describes how to add new options in the irccdctl configuration file. - -# Current options - -## general - - - **verbose**: (bool) enable verbose message (Optional, default: false). - -## connect - - - **type**: (string) type of listener "ip" or "unix". - -The options for **internet** type: - - - **host**: (string) host to connect, - - **port**: (int) port number, - - **family**: (string) internet family: ipv6 or ipv4 (Optional, default: ipv4). - -The options for **unix** type: - - - **path**: (string) the file path to the socket. +Irccdctl configuration file (irccdctl.conf) +=========================================== + +This file describes how to add new options in the irccdctl configuration file. + +# Current options + +## general + + - **verbose**: (bool) enable verbose message (Optional, default: false). + +## connect + + - **type**: (string) type of listener "ip" or "unix". + +The options for **internet** type: + + - **host**: (string) host to connect, + - **port**: (int) port number, + - **family**: (string) internet family: ipv6 or ipv4 (Optional, default: ipv4). + +The options for **unix** type: + + - **path**: (string) the file path to the socket.
--- a/win32/CMakeLists.txt Mon Feb 29 23:10:48 2016 +0100 +++ b/win32/CMakeLists.txt Mon Feb 29 23:25:22 2016 +0100 @@ -1,44 +1,44 @@ -# -# CMakeLists.txt -- CMake build system for irccd -# -# Copyright (c) 2013-2015 David Demelier <markand@malikania.fr> -# -# Permission to use, copy, modify, and/or distribute this software for any -# purpose with or without fee is hereby granted, provided that the above -# copyright notice and this permission notice appear in all copies. -# -# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -# - -# -# Copy MinGW runtimes into the WITH_BINDIR directory and then put them in the Qt IFW installer hierarchy so that -# they are also installed. -# -if (IRCCD_64BITS) - set(ARCH "amd64") - set(LIBGCC libgcc_s_seh-1.dll) -else () - set(ARCH "x86") - set(LIBGCC libgcc_s_dw2-1.dll) -endif () - -set( - FILES - ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/libeay32.dll - ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/libstdc++-6.dll - ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/libwinpthread-1.dll - ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/ssleay32.dll - ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/${LIBGCC} -) - -install(FILES ${FILES} DESTINATION ${WITH_BINDIR}) - -if (IRCCD_PACKAGE) - file(COPY ${FILES} DESTINATION ${CMAKE_BINARY_DIR}/installer/packages/base/data/${WITH_BINDIR}) -endif () +# +# CMakeLists.txt -- CMake build system for irccd +# +# Copyright (c) 2013-2015 David Demelier <markand@malikania.fr> +# +# Permission to use, copy, modify, and/or distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +# + +# +# Copy MinGW runtimes into the WITH_BINDIR directory and then put them in the Qt IFW installer hierarchy so that +# they are also installed. +# +if (IRCCD_64BITS) + set(ARCH "amd64") + set(LIBGCC libgcc_s_seh-1.dll) +else () + set(ARCH "x86") + set(LIBGCC libgcc_s_dw2-1.dll) +endif () + +set( + FILES + ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/libeay32.dll + ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/libstdc++-6.dll + ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/libwinpthread-1.dll + ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/ssleay32.dll + ${CMAKE_CURRENT_SOURCE_DIR}/${ARCH}/${LIBGCC} +) + +install(FILES ${FILES} DESTINATION ${WITH_BINDIR}) + +if (IRCCD_PACKAGE) + file(COPY ${FILES} DESTINATION ${CMAKE_BINARY_DIR}/installer/packages/base/data/${WITH_BINDIR}) +endif ()