Mercurial > irccd
changeset 512:b8da1d8c2a72
Docs: use ``` as fenced code blocks
line wrap: on
line diff
--- a/doc/html/api/module/Irccd.Directory/Irccd.Directory.prototype.constructor.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Directory/Irccd.Directory.prototype.constructor.md Fri Oct 20 11:43:36 2017 +0200 @@ -19,7 +19,7 @@ ## Example -````javascript +```javascript try { var d = new Irccd.Directory("/usr/share/games"); @@ -29,7 +29,7 @@ } catch (e) { // Use the error } -```` +```
--- a/doc/html/api/module/Irccd.Logger/index.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Logger/index.md Fri Oct 20 11:43:36 2017 +0200 @@ -20,9 +20,9 @@ ## Example -````javascript +```javascript function onLoad() { Irccd.Logger.info("This is an example"); } -```` +```
--- a/doc/html/api/module/Irccd.Plugin/index.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Plugin/index.md Fri Oct 20 11:43:36 2017 +0200 @@ -23,14 +23,14 @@ <div class="panel panel-info"> <div class="panel-heading">~/.config/irccd/irccd.conf</div> <div class="panel-body"> -````ini +```ini [plugin.xyz] foo = true baz = "hello" [paths.xyz] config = "/etc/xyz" -```` +``` </div> </div>
--- a/doc/html/api/module/Irccd.Server/Irccd.Server.list.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Server/Irccd.Server.list.md Fri Oct 20 11:43:36 2017 +0200 @@ -8,7 +8,7 @@ ## Example -````javascript +```javascript var table = Irccd.Server.list(); for (var name in table) { @@ -16,4 +16,4 @@ /* Use server */ } -```` +```
--- a/doc/html/api/module/Irccd.Server/Irccd.Server.prototype.constructor.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Server/Irccd.Server.prototype.constructor.md Fri Oct 20 11:43:36 2017 +0200 @@ -24,7 +24,7 @@ ## Example -````javascript +```javascript var s = new Irccd.Server({ name: "localhost", host: "localhost", @@ -32,4 +32,4 @@ ssl: true, sslVerify: false }); -```` +```
--- a/doc/html/api/module/Irccd.Timer/Irccd.Timer.prototype.constructor.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Timer/Irccd.Timer.prototype.constructor.md Fri Oct 20 11:43:36 2017 +0200 @@ -11,11 +11,11 @@ ## Example -````javascript +```javascript /* Execute an action every 1 second */ var t = new Irccd.Timer(Irccd.Timer.Repeat, 1000, function () { /* Do your action */ }); t.start(); -```` +```
--- a/doc/html/api/module/Irccd.Util/Irccd.Util.format.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd.Util/Irccd.Util.format.md Fri Oct 20 11:43:36 2017 +0200 @@ -15,12 +15,12 @@ Replaces the keyword `message` and formats it bold and red. -````javascript +```javascript function onMessage(server, channel, origin, message) { var s = Irccd.Util.format("@{red,default,bold}#{message}@{}", { message: message }) } -```` +``` ## Security @@ -32,12 +32,12 @@ is terribly dangerous: </div> <div class="panel-body"> -````javascript +```javascript function onMessage(server, channel, origin, message) { server.message(channel, Irccd.Util.format("@{red}" + message + "@{}"); } -```` +``` If a user sends a message like `${HOME}`, it will prints the user home directory, which is a high security issue if you have environment variables with passwords. @@ -49,11 +49,11 @@ **Correct code**: Instead, always use a literal string using a replacement with the user input: </div> <div class="panel-body"> -````javascript +```javascript function onMessage(server, channel, origin, message) { server.message(channel, Irccd.Util.format("@{red}#{message}@{}", { message: message }); } -```` +``` </div> </div>
--- a/doc/html/api/module/Irccd/index.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/api/module/Irccd/index.md Fri Oct 20 11:43:36 2017 +0200 @@ -22,7 +22,7 @@ ## Example -````javascript +```javascript var Logger = Irccd.Logger; function onLoad() @@ -31,4 +31,4 @@ Logger.info("Minor: " + Irccd.version.minor); Logger.info("Patch: " + Irccd.version.patch); } -```` +```
--- a/doc/html/build/build-from-sources.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/build/build-from-sources.md Fri Oct 20 11:43:36 2017 +0200 @@ -24,12 +24,12 @@ When you're ready, extract the **irccd-x.y.z.tar.gz** where **x.y.z** is the current version. Go to that directory, then type the following commands: -````nohighlight +```nohighlight $ mkdir _build_ $ cd _build_ $ cmake .. $ make $ sudo make install -```` +``` This is the quick way of compiling and installing. It's also possible to set some options to customize the build.
--- a/doc/html/build/build-options.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/build/build-options.md Fri Oct 20 11:43:36 2017 +0200 @@ -11,9 +11,9 @@ You can disable JavaScript support. -````nohighlight +```nohighlight $ cmake .. -DWITH_JS=Off -```` +``` ## Disabling SSL @@ -23,17 +23,17 @@ **Warning**: this is not recommended. </div> -````nohighlight +```nohighlight $ cmake .. -DWITH_SSL=Off -```` +``` ## Disabling all documentation You can disable all the documentation. -````nohighlight +```nohighlight $ cmake .. -DWITH_DOCS=Off -```` +``` See below to disable only specific parts of the documentation. @@ -41,17 +41,17 @@ By default if Pandoc is available, the HTML documentation is built, you can disable it. -````nohighlight +```nohighlight $ cmake .. -DWITH_HTML=Off -```` +``` ## Disabling man pages You can disable installation of manuals. -````nohighlight +```nohighlight $ cmake .. -DWITH_MAN=Off -```` +``` ## Installation path @@ -62,9 +62,9 @@ To change this, use the following: -````nohighlight +```nohighlight $ cmake .. -DCMAKE_INSTALL_PREFIX=/opt/some/directory -```` +``` ## Manual pages path @@ -72,6 +72,6 @@ For example, on FreeBSD the typical use would be: -````nohighlight +```nohighlight $ cmake .. -DWITH_MANDIR=/usr/local/man -```` +```
--- a/doc/html/dev/plugin-javascript-introduction.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/dev/plugin-javascript-introduction.md Fri Oct 20 11:43:36 2017 +0200 @@ -52,14 +52,14 @@ Example: -````javascript +```javascript info = { author: "David Demelier <markand@malikania.fr>", license: "ISC", summary: "A FPS game for IRC", version: "0.0.0.0.0.0.1" }; -```` +``` # Plugin creation @@ -83,9 +83,9 @@ It has the following signature: -````javascript +```javascript function onMessage(server, origin, channel, message) -```` +``` The parameters are defined as following: @@ -109,12 +109,12 @@ So the only thing to do is the following: -````javascript +```javascript function onMessage(server, origin, channel, message) { server.message(channel, message) } -```` +``` That's it! @@ -155,19 +155,19 @@ **Example** -````javascript +```javascript function onCommand() { if (something_is_wrong) Irccd.Logger.warning("error condition") } -```` +``` This will output to the irccd log something like: -````nohighlight +```nohighlight plugin foo: error condition -```` +``` [onMessage]: @baseurl@api/event/onMessage.html [server-api]: @baseurl@api/module/Irccd.Server/index.html
--- a/doc/html/dev/socket-commands.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/dev/socket-commands.md Fri Oct 20 11:43:36 2017 +0200 @@ -21,14 +21,14 @@ ## Example -````json +```json { "command": "server-cnotice", "server": "myserver", "channel": "#staff", "message": "please be quiet" } -```` +``` ## server-connect @@ -52,14 +52,14 @@ ## Example -````json +```json { "command": "server-connect", "name": "myserver", "host": "localhost", "nickname": "edouard" } -```` +``` ## server-disconnect @@ -74,12 +74,12 @@ ## Example -````json +```json { "command": "server-disconnect", "server": "myserver" } -```` +``` ## server-info @@ -92,12 +92,12 @@ ## Example -````json +```json { "command": "server-info", "server": "myserver" } -```` +``` ## Responses @@ -125,14 +125,14 @@ ## Example -````json +```json { "command": "server-invite", "server": "myserver", "target": "edouard", "channel": "#staff" } -```` +``` ## server-join @@ -147,13 +147,13 @@ ## Example -````json +```json { "command": "server-join", "server": "myserver", "channel": "#games" } -```` +``` ## server-kick @@ -169,7 +169,7 @@ ## Example -````json +```json { "command": "server-kick", "server": "myserver", @@ -177,7 +177,7 @@ "channel": "#staff", "reason": "please be nice" } -```` +``` ## server-list @@ -189,11 +189,11 @@ ## Example -````json +```json { "command": "server-list" } -```` +``` ## Responses @@ -213,14 +213,14 @@ ## Example -````json +```json { "command": "server-me", "server": "myserver", "channel": "#staff", "message": "like that" } -```` +``` ## server-message @@ -235,14 +235,14 @@ ## Example -````json +```json { "command": "server-message", "server": "myserver", "target": "#staff", "message": "this channel is nice" } -```` +``` ## server-mode @@ -256,13 +256,13 @@ ## Example -````json +```json { "command": "server-mode", "server": "myserver", "mode": "mode" } -```` +``` ## server-nick @@ -276,13 +276,13 @@ ## Example -````json +```json { "command": "server-nick", "server": "myserver", "nickname": "edouard" } -```` +``` ## server-notice @@ -297,14 +297,14 @@ ## Example -````json +```json { "command": "server-notice", "server": "myserver", "target": "edouard", "message": "hello dude" } -```` +``` ## server-part @@ -321,14 +321,14 @@ ## Example -````json +```json { "command": "server-part", "server": "myserver", "channel": "#staff", "reason": "the reason" } -```` +``` ## server-reconnect @@ -343,12 +343,12 @@ ## Example -````json +```json { "command": "server-reconnect", "server": "myserver" } -```` +``` ## server-topic @@ -363,23 +363,23 @@ ## Example -````json +```json { "command": "server-topic", "server": "myserver", "channel": "#staff", "topic": "the new topic" } -```` +``` ## server-umode Change your irccd user mode for the specified server. -````json +```json { "command": "umode", "server": "the server name", "mode": "the mode" } -```` +```
--- a/doc/html/dev/socket-protocol.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/dev/socket-protocol.md Fri Oct 20 11:43:36 2017 +0200 @@ -19,7 +19,7 @@ <div class="alert alert-success" role="alert"> **Example**: two commands issued -````json +```json { "param1": "value1" } @@ -28,7 +28,7 @@ "param1": "value1" } -```` +``` </div> <div class="alert alert-warning" role="alert"> @@ -47,22 +47,22 @@ <div class="alert alert-success" role="alert"> **Example**: command issued with no errors -````json +```json { "command": "server-message", "status": "ok" } -```` +``` </div> <div class="alert alert-danger" role="alert"> **Example**: command issued with errors -````json +```json { "command": "server-message", "status": "error", "error": "server xyz not found" } -```` +``` </div>
--- a/doc/html/irccd/configuring.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccd/configuring.md Fri Oct 20 11:43:36 2017 +0200 @@ -39,12 +39,12 @@ **Example** -````ini +```ini [general] pidfile = "/var/run/irccd/pid" uid = "nobody" gid = 1002 -```` +``` # The logs section @@ -66,13 +66,13 @@ **Example** -````ini +```ini [logs] type = file verbose = true path-logs = "/var/log/irccd/log.txt" path-errors = "/var/log/irccd/errors.txt" -```` +``` # The format section @@ -92,12 +92,12 @@ **Example** -````ini +```ini [format] debug = "%H:%M debug: #{message}" info = "%H:%M info: #{message}" warning = "%H:%M warning: #{message}" -```` +``` # The identity section @@ -118,7 +118,7 @@ **Example** -````ini +```ini [identity] name = "default" nickname = "jean" @@ -127,7 +127,7 @@ name = "development" nickname = "unstable" username = "un" -```` +``` # The server section @@ -156,13 +156,13 @@ **Example** -````ini +```ini [server] name = "local" host = "localhost" port = 6667 channels = ( "#staff", "#club:secret" ) -```` +``` # The paths section @@ -182,7 +182,7 @@ **Example** -````ini +```ini # # Common for all plugins. # @@ -202,7 +202,7 @@ # [paths.hangman] config = "/etc/hangman" -```` +``` # The plugins section @@ -217,11 +217,11 @@ **Example** -````ini +```ini [plugins] history = "" myplugin = /tmp/myplugin.js -```` +``` The `history` plugin will be searched while `myplugin` will be load from **/tmp/myplugin.js**. @@ -259,13 +259,13 @@ **Example of internet transports** -````ini +```ini [transport] type = "ip" address = "*" family = ( "ipv4", "ipv6" ) port = 9999 -```` +``` This will let you controlling irccd on port 9999 with both IPv4 and IPv6 families. @@ -276,11 +276,11 @@ **Example of unix transports** -````ini +```ini [transport] type = "unix" path = "/tmp/irccd.sock" -```` +``` This will let you controlling irccd on path **/tmp/irccd.sock**, the file is automatically deleted when irccd starts, but not when it stops. @@ -303,25 +303,25 @@ This first rule disable the plugin reboot on **all** servers and channels. -````ini +```ini [rule] plugins = "reboot" action = drop -```` +``` This rule enable the reboot plugin again on the server **localhost**, channel **#staff**. -````ini +```ini [rule] servers = "localhost" channels = "#staff" plugins = "reboot" action = accept -```` +``` # Full example of configuration file -````ini +```ini # Add a transport that bind only to IPv6. [transport] type = ip @@ -359,7 +359,7 @@ [plugins] ask = "" # Search ask myplugin = /path/to/myplugin.js # Use absolute path -```` +``` [cfgdir]: @baseurl@irccd/paths.html [cp]: @baseurl@misc/common-patterns-and-formatting.html
--- a/doc/html/irccd/usage.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccd/usage.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,9 +9,9 @@ ## Synopsis -````nohighlight +```nohighlight $ irccd [options...] -```` +``` ## Options
--- a/doc/html/irccdctl/command/help.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/help.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl help subject -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl help server-message -```` +```
--- a/doc/html/irccdctl/command/plugin-config.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/plugin-config.md Fri Oct 20 11:43:36 2017 +0200 @@ -15,12 +15,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl plugin-config plugin [variable] [value] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl plugin-config ask -```` +```
--- a/doc/html/irccdctl/command/plugin-info.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/plugin-info.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl plugin-info name -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl plugin-info ask -```` +```
--- a/doc/html/irccdctl/command/plugin-list.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/plugin-list.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,6 +9,6 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl plugin-list -```` +```
--- a/doc/html/irccdctl/command/plugin-load.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/plugin-load.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl plugin-load plugin -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl load ask -```` +```
--- a/doc/html/irccdctl/command/plugin-reload.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/plugin-reload.md Fri Oct 20 11:43:36 2017 +0200 @@ -10,12 +10,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl plugin-reload name -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl plugin-reload logger -```` +```
--- a/doc/html/irccdctl/command/plugin-unload.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/plugin-unload.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl plugin-unload name -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl plugin-unload logger -```` +```
--- a/doc/html/irccdctl/command/rule-add.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/rule-add.md Fri Oct 20 11:43:36 2017 +0200 @@ -11,9 +11,9 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl rule-add [options] accept|drop -```` +``` Available options: @@ -25,7 +25,7 @@ ## Example -````nohighlight +```nohighlight $ irccdctl rule-add -p hangman drop $ irccdctl rule-add -s localhost -c #games -p hangman accept -```` +```
--- a/doc/html/irccdctl/command/rule-edit.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/rule-edit.md Fri Oct 20 11:43:36 2017 +0200 @@ -23,13 +23,13 @@ ## Usage -````nohighlight +```nohighlight usage: irccdctl rule-edit [options] index -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl rule-edit -p hangman 0 $ irccdctl rule-edit -S localhost -c #games -p hangman 1 -```` +```
--- a/doc/html/irccdctl/command/rule-list.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/rule-list.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,6 +9,6 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl rule-list -```` +```
--- a/doc/html/irccdctl/command/rule-move.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/rule-move.md Fri Oct 20 11:43:36 2017 +0200 @@ -13,13 +13,13 @@ ## Usage -````nohighlight +```nohighlight irccdctl rule-move source destination -```` +``` ## Example -````nohighlight +```nohighlight irccdctl rule-move 0 5 irccdctl rule-move 4 3 -```` +```
--- a/doc/html/irccdctl/command/server-cmode.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-cmode.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-cmode server channel mode -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-cmode freenode #staff +t -```` +```
--- a/doc/html/irccdctl/command/server-cnotice.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-cnotice.md Fri Oct 20 11:43:36 2017 +0200 @@ -10,12 +10,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-cnotice server channel message -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-cnotice freenode #staff "Don't flood" -```` +```
--- a/doc/html/irccdctl/command/server-connect.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-connect.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,9 +9,9 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-connect [options] name host port -```` +``` Available options: @@ -24,7 +24,7 @@ ## Example -````nohighlight +```nohighlight $ irccdctl server-connect -n jean example irc.example.org $ irccdctl server-connect --ssl example irc.example.org 6697 -```` +```
--- a/doc/html/irccdctl/command/server-disconnect.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-disconnect.md Fri Oct 20 11:43:36 2017 +0200 @@ -11,12 +11,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-disconnect [server] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-disconnect localhost -```` +```
--- a/doc/html/irccdctl/command/server-invite.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-invite.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-invite server nickname channel -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-invite freenode xorg62 #staff -```` +```
--- a/doc/html/irccdctl/command/server-join.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-join.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,13 +9,13 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-join server channel [password] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-join freenode #test $ irccdctl server-join freenode #private-club secret -```` +```
--- a/doc/html/irccdctl/command/server-kick.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-kick.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-kick server target channel [reason] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl kick freenode jean #staff "Stop flooding" -```` +```
--- a/doc/html/irccdctl/command/server-list.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-list.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,6 +9,6 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-list -```` +```
--- a/doc/html/irccdctl/command/server-me.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-me.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-me server target message -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-me freenode #staff "going back soon" -```` +```
--- a/doc/html/irccdctl/command/server-message.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-message.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-message server target message -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-message freenode #staff "Hello from irccd" -```` +```
--- a/doc/html/irccdctl/command/server-mode.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-mode.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ **Usage** -````nohighlight +```nohighlight $ server-mode server mode -```` +``` **Example** -````nohighlight +```nohighlight $ irccdctl server-mode +i -```` +```
--- a/doc/html/irccdctl/command/server-nick.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-nick.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-nick server nickname -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-nick freenode david -```` +```
--- a/doc/html/irccdctl/command/server-notice.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-notice.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-notice server target message -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-notice freenode jean "I know you are here." -```` +```
--- a/doc/html/irccdctl/command/server-part.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-part.md Fri Oct 20 11:43:36 2017 +0200 @@ -14,13 +14,13 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-part server channel [reason] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-part freenode #staff $ irccdctl server-part freenode #botwar "too noisy" -```` +```
--- a/doc/html/irccdctl/command/server-reconnect.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-reconnect.md Fri Oct 20 11:43:36 2017 +0200 @@ -11,13 +11,13 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-reconnect [server] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-reconnect $ irccdctl server-reconnect wanadoo -```` +```
--- a/doc/html/irccdctl/command/server-topic.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/server-topic.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,12 +9,12 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl server-topic server channel topic -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl server-topic freenode #wmfs "This is the best channel" -```` +```
--- a/doc/html/irccdctl/command/watch.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/command/watch.md Fri Oct 20 11:43:36 2017 +0200 @@ -12,13 +12,13 @@ ## Usage -````nohighlight +```nohighlight $ irccdctl watch [-f|--format native|json] -```` +``` ## Example -````nohighlight +```nohighlight $ irccdctl watch $ irccdctl watch -f json -```` +```
--- a/doc/html/irccdctl/configuring.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/configuring.md Fri Oct 20 11:43:36 2017 +0200 @@ -17,10 +17,10 @@ **Example** -````ini +```ini [general] verbose = true -```` +``` # The connect section @@ -44,21 +44,21 @@ **Example for internet transports** -````ini +```ini [connect] type = "internet" host = "localhost" port = "9999" family = "ipv6" -```` +``` **Example for unix transports** -````ini +```ini [connect] type = "unix" path = "/tmp/irccd.sock" -```` +``` # The alias section @@ -72,11 +72,11 @@ Example: -````ini +```ini [alias.present] say-hello = ( "server-message", "localhost", "#staff", "hello world!" ) warning = ( "server-me", "localhost", "#staff", "is a bot") -```` +``` This example defines an alias `present` that will: @@ -99,11 +99,11 @@ Example: -````ini +```ini [alias.present] say-hello = ( "server-message", "%0", "%1", "hello world!" ) warning = ( "server-me", "%0", "%1", "is a bot") -```` +``` Now, the `present` alias will except two arguments from the command line when the user invokes `irccdctl present`. Thus if you want to use this alias on the
--- a/doc/html/irccdctl/usage.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/irccdctl/usage.md Fri Oct 20 11:43:36 2017 +0200 @@ -9,7 +9,7 @@ ## Synopsis -````nohighlight +```nohighlight usage: irccdctl plugin-config plugin [variable] [value] irccdctl plugin-info plugin irccdctl plugin-list @@ -36,15 +36,15 @@ irccdctl server-topic server channel topic irccdctl watch [-f|--format json|native] -```` +``` ## Syntax The general syntax for running an irccdctl command is: -````nohighlight +```nohighlight irccdctl commandname arg1 arg2 arg3 ... argn -```` +``` You can have the online documentation by typing `irccdctl help commandname`. @@ -53,12 +53,12 @@ Some shells may discard arguments if they begins with a hash. For instance, `bash` will not understand the following command: -````nohighlight +```nohighlight $ irccdctl server-join localhost #staff -```` +``` Instead, enclose the arguments with quotes -````nohighlight +```nohighlight $ irccdctl server-join localhost "#staff" -```` +```
--- a/doc/html/misc/common-patterns-and-formatting.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/misc/common-patterns-and-formatting.md Fri Oct 20 11:43:36 2017 +0200 @@ -118,9 +118,9 @@ For instance, using the **logger** plugin, it's possible to customize the pattern to use when someone joins a channel like that: -````nohighlight +```nohighlight #{origin} joined #{channel} -```` +``` The keyword **#{origin}** will be substituted to the nickname and **#{channel}** to the channel name.
--- a/doc/html/misc/configuration-syntax.md Thu Oct 19 13:03:31 2017 +0200 +++ b/doc/html/misc/configuration-syntax.md Fri Oct 20 11:43:36 2017 +0200 @@ -27,13 +27,13 @@ ## Example -````ini +```ini @include "rules.conf" @include "servers.conf" [mysection] myoption = "1" -```` +``` # The list construct @@ -47,20 +47,20 @@ <div class="panel panel-success"> <div class="panel-heading">**Example:** two servers defined in a rule</div> <div class="panel-body"> -````ini +```ini [rule] servers = ( "server1", "server2" ) -```` +``` </div> </div> <div class="panel panel-success"> <div class="panel-heading">**Example:** only one server</div> <div class="panel-body"> -````ini +```ini [rule] servers = "only-one-server" -```` +``` </div> </div>