Mercurial > irccd
changeset 884:54496ac51649 release-3.0
doc: fix default configuration files, closes #2249
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Fri, 30 Aug 2019 21:03:00 +0200 |
| parents | e88eac94aba4 |
| children | cb7532847b08 |
| files | doc/examples/irccd.conf.sample doc/examples/irccdctl.conf.sample man/irccd-templates.7 man/irccd.conf.5 |
| diffstat | 4 files changed, 88 insertions(+), 16 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/examples/irccd.conf.sample Thu Aug 15 22:36:04 2019 +0200 +++ b/doc/examples/irccd.conf.sample Fri Aug 30 21:03:00 2019 +0200 @@ -8,10 +8,18 @@ # [plugins] # abc = "" # This will search for abc # ask = /tmp/ask.js # This use /tmp/ask.js to load the plugin +# +# Specific options for plugins are stored in a dedicated section: +# +# [plugin.hangman] +# collaborative = false +# +# See corresponding manual pages for plugins. # Section transport: -# You can use transport to wait for any input you want. Unix and internet sockets are supported. Unix are used -# for file based socket while internet bind to standard address plus a specific port. +# You can use transport to wait for any input you want. UNIX and internet +# sockets are supported. UNIX are used for file based sockets while internet +# bind to standard address plus a specific port. # # For internet sockets: # @@ -19,9 +27,10 @@ # type = "ip" # port = "1234" # (int) port number, # address = "*" # (string) address to bind or "*" for any (Optional, default: *), -# family = ( "ipv4", "ipv6" ) # (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4). +# ipv6 = true # (bool) enable IPv6 (Optional, default: true), +# ipv4 = true # (bool )enable IPv4 (Optional, default: true). # -# For unix sockets: +# For UNIX sockets: # # [transport] # type = "unix" @@ -31,16 +40,14 @@ type = "ip" address = "*" port = "5980" -family = ( "ipv4", "ipv6" ) # Section server: -# List of server you want to connect to. A server may use an identity to -# set the username, nickname and so on. A server is registered with a +# List of server you want to connect to. A server is registered with a # unique id that is needed for irccdctl(1). # # [server] # name = "id" # (id) the unique id, -# host = "chat.foo.com" # (string) the server address, +# hostname = "chat.foo.com" # (string) the server address, # port = "4321" # (int) the server port (Optional, default: 6667), # nickname = "foo" # (string) the nickname (Optional, default: irccd), # username = "bar" # (string) the realname (Optional, default: IRC Client daemon), @@ -52,17 +59,13 @@ # channels = "" # (list) list of channels to auto join, (Optional, default: empty), # command-char = "!" # (string) the prefix for invoking special commands (Optional, default: !), # ssl = false # (bool) enable or disable SSL (Optional, default: false), -# ssl-verify = false # (bool) verify the SSL certificates (Optional, default: true), # auto-reconnect = true # (bool) enable reconnection after failure (Optional, default: true), # auto-reconnect-timeout = 5 # (int) number of seconds to wait before retrying (Optional, default: 30). [server] -identity = "default" name = "localhost" -host = "localhost" +hostname = "localhost" port = 6667 -reconnect-timeout = 60 -reconnect-tries = 20 # Section rule: # Add one or more rules to filter IRC events. @@ -71,6 +74,7 @@ # 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), +# origins = "" # (list) nicknames to match (Optional, default: empty) # action = "" # (string) set to **accept** or **drop**. # # Block plugin hangman everywhere. @@ -86,3 +90,60 @@ # channels = "#games" # plugins = "hangman" # action = accept + +# Section paths: +# This section stores default paths mostly for plugins. For each plugin the +# string "plugin/NAME" is appended. +# +# This section is optional and default values are used instead. +# +# [paths] +# cache = "/var/cache" # (string) data files written by the plugin. +# data = "/share/ # (string) data files provided by the user. +# config = "/etc/" # (string) additional configuration from the user. +# +# To override paths per plugins: +# +# [paths.hangman] +# cache = "/var" + +# Section logs: +# Define where to store logs. Syslog, file and console are supported. +# +# This section is optional, by default console is used. +# +# Common options: +# +# [logs] +# verbose = false # (bool) be verbose. +# +# For syslog: +# +# [logs] +# type = "syslog" +# +# For files: +# +# [logs] +# path-logs # (string) Path to the normal messages, +# path-errors # (string) Path to the error messages. + +# Section templates: +# This section defines how irccd should format messages for logs and plugins. +# The syntax is described in details in the irccd-templates(7) manual page. +# Also, check corresponding information in plugin manual pages for more +# details. +# +# This section is optional, default values are used instead. +# +# To format general messages: +# +# [templates] +# debug = "DD #{messages} # (string) debug messages. +# info = "II #{messages} # (string) information messages. +# warning = "WW #{messages} # (string) warning messages. +# +# To format specific plugins: +# +# [templates.hangman] +# win = "you win!"
--- a/doc/examples/irccdctl.conf.sample Thu Aug 15 22:36:04 2019 +0200 +++ b/doc/examples/irccdctl.conf.sample Fri Aug 30 21:03:00 2019 +0200 @@ -8,7 +8,6 @@ # [general] # verbose = false # (bool) enable verbose message (Optional, default: false). - [general] # Section connect: @@ -32,3 +31,16 @@ type = "ip" host = "localhost" port = "5980" + +# Section alias: +# This section defines aliases to be used with irccdctl(1). Create a section +# per alias and add any command you need. You may use %n as placeholders for +# arguments to be provided on the command line. +# +# The option name has no meaning and is only there as self documentation. +# +# [alias.cycle] +# leave = ( "server-part", "%0", "%1", "coming back soon" ) +# join = ( "server-join", "%0", "%1" ) +# +# Use this alias with: irccdctl cycle wanadoo "#games"