# HG changeset patch # User David Demelier # Date 1456818771 -3600 # Node ID 92b0be5ce4b0cc77254585563069719e01c575d5 # Parent d914cffaa469fff82c18f9c82b9081afdc68fd9f# Parent 6aeecf87f684f7f2e20213a96e8ecc71d8b02101 Merge from stable-2 diff -r d914cffaa469 -r 92b0be5ce4b0 CHANGES.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CHANGES.md Tue Mar 01 08:52:51 2016 +0100 @@ -0,0 +1,7 @@ +IRC Client Daemon CHANGES +========================= + +irccd 2.0.0 2016-03-01 +---------------------- + + - Initial 2.0.0 release. diff -r d914cffaa469 -r 92b0be5ce4b0 cmake/IrccdOptions.cmake --- a/cmake/IrccdOptions.cmake Tue Feb 23 12:59:58 2016 +0100 +++ b/cmake/IrccdOptions.cmake Tue Mar 01 08:52:51 2016 +0100 @@ -54,12 +54,6 @@ # WITH_TEST_IRCPORT Which IRC server port to use for tests (default: 6667) # -# -# Options for developers: -# -# WITH_WEB Set to true to use the HTML template for official irccd website. -# - # Manual pages on Windows are pretty useless. if (WIN32) set(DEFAULT_MAN "No") @@ -80,7 +74,7 @@ option(WITH_SYSTEMD "Install systemd service" ${DEFAULT_SYSTEMD}) option(WITH_DOCS "Enable building of all documentation" On) option(WITH_HTML "Enable building of HTML documentation" On) -option(WITH_DOXYGEN "Enable doxygen" On) +option(WITH_DOXYGEN "Enable doxygen" Off) option(WITH_MAN "Install man pages" ${DEFAULT_MAN}) # Build options for all plugins. @@ -98,8 +92,6 @@ set(WITH_TEST_IRCHOST "127.0.0.1" CACHE STRING "IRC host for tests") set(WITH_TEST_IRCPORT 6667 CACHE STRING "IRC port for test") -option(WITH_WEB "Use HTML template for official website" Off) - # --------------------------------------------------------- # Installation paths # --------------------------------------------------------- diff -r d914cffaa469 -r 92b0be5ce4b0 cmake/IrccdPackage.cmake --- a/cmake/IrccdPackage.cmake Tue Feb 23 12:59:58 2016 +0100 +++ b/cmake/IrccdPackage.cmake Tue Mar 01 08:52:51 2016 +0100 @@ -18,7 +18,7 @@ set(CPACK_SOURCE_PACKAGE_FILE_NAME "irccd-${IRCCD_VERSION}") set(CPACK_SOURCE_GENERATOR TXZ ZIP) -set(CPACK_SOURCE_IGNORE_FILES .hg .hgignore) +set(CPACK_SOURCE_IGNORE_FILES "/[.]hg" "/CMakeLists[.]txt[.]user") # # Define the binary package name. @@ -28,6 +28,12 @@ if (WIN32) set(PKGSYS "Windows") set(PKGSUFFIX "exe") + + if (IRCCD_64BITS) + set(PKGTARGETDIR "C:/Program Files/irccd-${IRCCD_VERSION}") + else () + set(PKGTARGETDIR "C:/Program Files (x86)/irccd-${IRCCD_VERSION}") + endif () endif () if (IRCCD_64BITS) diff -r d914cffaa469 -r 92b0be5ce4b0 cmake/IrccdVersion.cmake --- a/cmake/IrccdVersion.cmake Tue Feb 23 12:59:58 2016 +0100 +++ b/cmake/IrccdVersion.cmake Tue Mar 01 08:52:51 2016 +0100 @@ -21,7 +21,19 @@ set(IRCCD_VERSION_MINOR "0") set(IRCCD_VERSION_PATCH "0") set(IRCCD_VERSION "${IRCCD_VERSION_MAJOR}.${IRCCD_VERSION_MINOR}.${IRCCD_VERSION_PATCH}") -set(IRCCD_RELEASE_DATE "2015-12-17") + +# +# Irccd release date. +# ------------------------------------------------------------------- +# +# IRCCD_RELEASE_DATE_YEAR 4 digits +# IRCCD_RELEASE_DATE_MONTH 2 digits (01 = January) +# IRCCD_RELEASE_DATE_DAY 2 digits (01 = first day of month) +# +set(IRCCD_RELEASE_DATE_YEAR 2016) +set(IRCCD_RELEASE_DATE_MONTH 03) +set(IRCCD_RELEASE_DATE_DAY 01) +set(IRCCD_RELEASE_DATE "${IRCCD_RELEASE_DATE_YEAR}-${IRCCD_RELEASE_DATE_MONTH}-${IRCCD_RELEASE_DATE_DAY}") # All plugins. set( diff -r d914cffaa469 -r 92b0be5ce4b0 cmake/function/IrccdDefineHtml.cmake --- a/cmake/function/IrccdDefineHtml.cmake Tue Feb 23 12:59:58 2016 +0100 +++ b/cmake/function/IrccdDefineHtml.cmake Tue Mar 01 08:52:51 2016 +0100 @@ -63,10 +63,6 @@ set(base ${CMAKE_BINARY_DIR}/docs) endif () - if (WITH_WEB) - set(ARGS web:1) - endif () - if (HTML_OUTPUT) # # First signature. @@ -98,7 +94,7 @@ ${resources_SOURCE_DIR}/template.html docs-resources ARGS ${HTML_ARGS} - VARIABLE baseurl:${baseurl} doc:1 ${ARGS} + VARIABLE baseurl:${baseurl} FROM markdown TO html5 STANTALONE MAKE_DIRECTORY ) @@ -132,7 +128,7 @@ ${resources_SOURCE_DIR}/template.html docs-resources ARGS ${HTML_ARGS} - VARIABLE baseurl:${baseurl} standalone:1 doc:1 ${ARGS} + VARIABLE baseurl:${baseurl} FROM markdown TO html5 STANTALONE MAKE_DIRECTORY ) diff -r d914cffaa469 -r 92b0be5ce4b0 cmake/installer/config/config.xml.in --- a/cmake/installer/config/config.xml.in Tue Feb 23 12:59:58 2016 +0100 +++ b/cmake/installer/config/config.xml.in Tue Mar 01 08:52:51 2016 +0100 @@ -5,7 +5,7 @@ IRC Client Daemon Setup Malikania Projects http://projects.malikania.fr/irccd - Irccd + Irccd @IRCCD_VERSION@ true - @CMAKE_INSTALL_PREFIX@ - \ No newline at end of file + @PKGTARGETDIR@ + diff -r d914cffaa469 -r 92b0be5ce4b0 doc/examples/CMakeLists.txt --- a/doc/examples/CMakeLists.txt Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/examples/CMakeLists.txt Tue Mar 01 08:52:51 2016 +0100 @@ -21,12 +21,12 @@ if (IRCCD_RELOCATABLE) add_custom_command( OUTPUT - ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccd.conf - ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccdctl.conf + ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccd.conf.sample + ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccdctl.conf.sample COMMAND - ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/irccd.conf ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccd.conf + ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/irccd.conf ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccd.conf.sample COMMAND - ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/irccdctl.conf ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccdctl.conf + ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/irccdctl.conf ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccdctl.conf.sample DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/irccd.conf ${CMAKE_CURRENT_SOURCE_DIR}/irccdctl.conf @@ -35,8 +35,8 @@ add_custom_target( docs-examples DEPENDS - ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccd.conf - ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccdctl.conf + ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccd.conf.sample + ${CMAKE_BINARY_DIR}/fakeroot/${WITH_CONFDIR}/irccdctl.conf.sample SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/irccd.conf ${CMAKE_CURRENT_SOURCE_DIR}/irccdctl.conf diff -r d914cffaa469 -r 92b0be5ce4b0 doc/examples/irccd.conf --- a/doc/examples/irccd.conf Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/examples/irccd.conf Tue Mar 01 08:52:51 2016 +0100 @@ -19,7 +19,7 @@ # # [plugins] # abc = # This will search for abc -# ask = /tmp/ask.lua # This use /tmp/ask.lua to load the plugin +# ask = /tmp/ask.js # This use /tmp/ask.js to load the plugin [plugins] history = "" diff -r d914cffaa469 -r 92b0be5ce4b0 doc/html/api/module/Irccd.File/method/close.md --- a/doc/html/api/module/Irccd.File/method/close.md Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/html/api/module/Irccd.File/method/close.md Tue Mar 01 08:52:51 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()" +--- diff -r d914cffaa469 -r 92b0be5ce4b0 doc/html/api/module/Irccd.Plugin/index.md --- a/doc/html/api/module/Irccd.Plugin/index.md Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/html/api/module/Irccd.Plugin/index.md Tue Mar 01 08:52:51 2016 +0100 @@ -7,6 +7,39 @@ This module let you manage plugins. +## Constants + +The following properties are defined: + + - **cachePath**: (string) the path to the cache directory, + - **configPath**: (string) the path to the configuration directory, + - **dataPath**: (string) the path to the data directory. + +## Configuration + +An additional property `config` is defined with all options set in the appropriate `[plugin.]` from the user +configuration file. + +### Example + +If the configuration file configures the plugin **xyz**: + +
+
~/.config/irccd/irccd.conf
+
+````ini +[plugin.xyz] +foo = true +baz = "hello" +```` +
+
+ +Then `Irccd.Plugin.config` will have the following properties: + + - **foo**: (string) set to "true", + - **baz**: (string) set to "hello". + ## Functions - [info](function/info.html) diff -r d914cffaa469 -r 92b0be5ce4b0 doc/html/guide/07-socket/03-messages.md --- a/doc/html/guide/07-socket/03-messages.md Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/html/guide/07-socket/03-messages.md Tue Mar 01 08:52:51 2016 +0100 @@ -2,4 +2,159 @@ The following messages are broadcasted to the clients on specific events. -**Coming soon** +Events are very close to the [JavaScript events][events], refer to the documentation for more information. + +### onChannelMode + +#### Properties + + - **event**: (string) "onChannelMode", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel, + - **mode**: (string) the mode, + - **argument**: (string) the argument. + +### onChannelNotice + +#### Properties + + - **event**: (string) "onChannelNotice", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel, + - **message**: (string) the notice. + +### onConnect + +#### Properties + + - **event**: (string) "onConnect", + - **server**: (string) the server id. + +### onInvite + +#### Properties + + - **event**: (string) "onInvite" + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel. + +### onJoin + +#### Properties + + - **event**: (string) "onJoin", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel. + +### onKick + +#### Properties + + - **event**: (string) "onKick", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel, + - **target**: (string) the target, + - **reason**: (string) the reason. + +### onMessage + +#### Properties + + - **event**: (string) "onMessage", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel, + - **message**: (string) the message. + +### onMe + +#### Properties + + - **event**: (string) "onMe", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **target**: (string) the target, + - **message**: (string) the message. + +### onMode + +#### Properties + + - **event**: (string) "onMode", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **mode**: (string) the mode. + +### onNames + +#### Properties + + - **event**: (string) "onNames", + - **server**: (string) the server id, + - **channel**: (string) the channel, + - **names**: (string list) the list of names. + +### onNick + +#### Properties + + - **event**: (string) "onNick", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **nickname**: (string) the new nickname. + +### onNotice + +#### Properties + + - **event**: (string) "onNotice", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **message**: (string) the message. + +### onPart + +#### Properties + + - **event**: (string) "onPart", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel, + - **reason**: (string) the reason. + +### onQuery + +#### Properties + + - **event**: (string) "onQuery", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **message**: (string) the message. + +### onTopic + +#### Properties + + - **event**: (string) "onTopic", + - **server**: (string) the server id, + - **origin**: (string) the originator, + - **channel**: (string) the channel, + - **topic**: (string) the topic. + +### onWhois + +#### Properties + + - **event**: (string) "onWhois", + - **server**: (string) the server id, + - **nickname**: (string) the nickname, + - **username**: (string) the username, + - **host**: (string) the hostname, + - **realname**: (string) the realname. + +[events]: @baseurl@/api/index.html diff -r d914cffaa469 -r 92b0be5ce4b0 doc/html/resources/CMakeLists.txt --- a/doc/html/resources/CMakeLists.txt Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/html/resources/CMakeLists.txt Tue Mar 01 08:52:51 2016 +0100 @@ -28,7 +28,6 @@ css/bootstrap.min.css css/doc.css css/doc-guide.css - css/irccd.css css/tomorrow.css ) diff -r d914cffaa469 -r 92b0be5ce4b0 doc/html/resources/css/irccd.css --- a/doc/html/resources/css/irccd.css Tue Feb 23 12:59:58 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -/* - * irccd.css -- style for irccd website - */ - -/* - -.color-primary-0 { color: #2C4E68 } -.color-primary-1 { color: #6C879B } -.color-primary-2 { color: #45667F } -.color-primary-3 { color: #183953 } -.color-primary-4 { color: #072338 } - -*/ - -body { - padding-top: 70px; - padding-bottom: 20px; -} - -pre { - background-color: #ffffff; -} - -.jumbotron { - background-color: #F5F5F5; -} - -.navbar { - background-color: #2C4E68; - border-color: #183953; -} - -.navbar .navbar-toggle { - border-color: #183953; -} - -.navbar .navbar-brand { - color: rgba(255, 255, 255, 0.9); -} - -.navbar .navbar-text { - color: rgba(255, 255, 255, 0.9); -} - -.navbar .navbar-link { - color: rgba(255, 255, 255, 0.9); -} - -.navbar .navbar-nav>li>a { - color: rgba(255, 255, 255, 0.9); -} - -.navbar .navbar-collapse { - border-color: #183953; -} - -.sidebar { - margin-top: 50px; -} diff -r d914cffaa469 -r 92b0be5ce4b0 doc/html/resources/template.html --- a/doc/html/resources/template.html Tue Feb 23 12:59:58 2016 +0100 +++ b/doc/html/resources/template.html Tue Mar 01 08:52:51 2016 +0100 @@ -13,14 +13,7 @@ - -$if(web)$ - -$endif$ - -$if(doc)$ -$endif$ $if(guide)$ @@ -34,51 +27,8 @@ -$if(web)$ - +
-$if(home)$ - -
-
-

IRC Client Daemon

-

Irccd is an IRC bot written in C++14 and Javascript. It is fast, light, powerful, scalable.

-

Download now »

-
-
-$endif$ -$endif$ - -$if(doc)$ -
-$endif$ -$if(general)$ -
-$endif$ - -$if(doc)$
@@ -209,11 +160,6 @@ $endif$
-$endif$ - -$if(general)$ -$body$ -$endif$