.\"
.\" Copyright (c) 2013-2017 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.
.\"
.Dd @MONTH@ @DAY@, @YEAR@
.Dt IRCCDCTL.CONF 5
.Os
.Sh NAME
.Nm irccdctl.conf
.Nd irccdctl configuration file
.Sh DESCRIPTION
The file
.Nm irccdctl.conf
contains all parameters for the application
.Nm irccdctl .
.Pp
The irccdctl.conf file is .ini based syntax, it supports sections enclosed
between brackets where one or more options lives.
.\" SYNTAX
.Sh SYNTAX
The usual syntax is:
.Bd -literal -offset indent
[foo]
option = value

[bar]
name = "long string enclosed between quotes"
.Pp
.Ed
Comments starts by # or can be written at an end of a line.
.Pp
Note that quotes are needed if the value has more that one word, if not the
value will be truncated at the first space found.
.Pp
Multiple options on the same line are
.Em not
supported.
.\" CONFIGURATION
.Sh CONFIGURATION
This section shows all available sections with the options allowed for them.
.\" GENERAL
.Ss general
This section covers general options.
.Pp
.Bl -tag -width PARAMETERXXX -compact
.It verbose
(bool) enable verbose message (Optional, default: false)
.El
.Pp
.\" CONNECT
.Ss connect
This section covers the sockets to connect to an irccd(1) instance. You must
set this only once.
.Pp
.Bl -tag -width PARAMETERXXX -compact
.It type
(string) connection type: "ip" or "unix".
.It password
(string) an authentication password (Optional, default: none).
.El
.Pp
The following parameters are available for type "ip":
.Pp
.Bl -tag -width PARAMETERXXX -compact -offset indent
.It host
(string) host to connect,
.It port
(int) port number,
.It family
(string) internet family: ipv6 or ipv4 (Optional, default: ipv4).
.El
.Pp
The following parameters are available for type "unix":
.Pp
.Bl -tag -width PARAMETERXXX -compact -offset indent
.It path
(string) the file path to the socket.
.El
.\" ALIAS
.Ss alias
The alias section can be used to define custom user commands.
.Pp
To define an alias, just add a new section named
.Nm alias.name
where name is your desired alias name.
.Pp
Then, add any option you like to execute commands you want. The option name is
ignored and serves as auto-documentation only.
.Pp
Example:
.Bd -literal
[alias.present]
say-hello = ( "server-message", "localhost", "#staff", "hello world!" )
warning = ( "server-me", "localhost", "#staff", "is a bot")
.Ed
.Pp
.Nm Placeholders
.Pp
Sometimes, you want to pass parameters to your alias. The placeholder syntax
allows you to define where your command line arguments will be replaced before
being sent to irccd.
.Pp
The syntax uses `%n` where **n** is an integer starting from 0.
.Pp
Example:
.Bd -literal
[alias.present]
say-hello = ( "server-message", "%0", "%1", "hello world!" )
warning = ( "server-me", "%0", "%1", "is a bot")
.Ed
.\" FILES
.Sh FILES
The default config file is located at
.Em @CMAKE_INSTALL_PREFIX@/@WITH_CONFDIR@/irccdctl.conf
.Pp
The user defined file follow the XDG standard and is usually
.Em $HOME/.config/irccd/irccdctl.conf .
If the XDG variable is not set, we use that path.
.\" SEE ALSO
.Sh SEE ALSO
.Xr irccdctl 1
.\" AUTHORS
.Sh AUTHORS
irccd was written by David Demelier <markand@malikania.fr>