.\"
.\" Copyright (c) 2013-2016 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 1
.Os
.Sh NAME
.Nm irccdctl
.Nd irccd controller utility
.\" SYNOPSIS
.Sh SYNOPSIS
This is the list of commands supported by
.Ns Nm
utility:
.Pp
.\" HELP
.Nm
.Cm help
.Ar topic
.\" WATCH
.Nm
.Cm watch
.Op Ar options
.Pp
.\" PLUGIN-INFO
.Nm
.Cm plugin-info
.Ar name
.\" PLUGIN-list
.Nm
.Cm plugin-list
.\" PLUGIN-LOAD
.Nm
.Cm plugin-load
.Ar name
.\" PLUGIN-RELOAD
.Nm
.Cm plugin-reload
.Ar name
.\" PLUGIN-UNLOAD
.Nm
.Cm plugin-unload
.Ar name
.Pp
.\" SERVER-CMODE
.Nm
.Cm server-cmode
.Ar server
.Ar channel
.Ar mode
.\" SERVER-CNOTICE
.Nm
.Cm server-cnotice
.Ar server
.Ar channel
.Ar message
.\" SERVER-CONNECT
.Nm
.Cm server-connect
.Op Ar options
.Ar name
.Ar host
.Op Ar port
.\" SERVER-DISCONNECT
.Nm
.Cm server-disconnect
.Op Ar server
.\" SERVER-INFO
.Nm
.Cm server-info
.Ar server
.\" SERVER-INVITE
.Nm
.Cm server-invite
.Ar server
.Ar target
.Ar channel
.\" SERVER-JOIN
.Nm
.Cm server-join
.Ar server
.Ar channel
.Op Ar password
.\" SERVER-KICK
.Nm
.Cm server-kick
.Ar server
.Ar nickname
.Ar channel
.Op Ar reason
.\" SERVER-LIST
.Nm
.Cm server-list
.\" SERVER-ME
.Nm
.Cm server-me
.Ar server
.Ar target
.Ar message
.\" SERVER-MESSAGE
.Nm
.Cm server-message
.Ar server
.Ar target
.Ar message
.\" SERVER-MODE
.Nm
.Cm server-mode
.Ar server
.Ar mode
.\" SERVER-NICK
.Nm
.Cm server-nick
.Ar server
.Ar newnickname
.\" SERVER-NOTICE
.Nm
.Cm server-notice
.Ar server
.Ar nickname
.Ar message
.\" SERVER-PART
.Nm
.Cm server-part
.Ar server
.Ar channel
.\" SERVER-RECONNECT
.Nm
.Cm server-reconnect
.Op Ar name
.\" SERVER-TOPIC
.Nm
.Cm server-topic
.Ar server
.Ar channel
.Ar topic
.\" DESCRIPTION
.Sh DESCRIPTION
The
.Nm irccdctl
utility provides serveral options to manipulate a running
irccd instance.
.Pp
It uses sockets to do a basic IPC messaging with irccd, you can use unix
or internet domain sockets.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl c Ar config
A path to a config file.
.It Fl t, Fl -type Ar domain
The domain to use, specify internet or unix.
.It Fl v
Be more verbose.
.El
.\" INTERNET OPTIONS
.Pp
The following options are available for
.Fl t Ar ip, ipv6 :
.Bl -tag -width indent
.It Fl h, Fl -host
The hostname to connect.
.It Fl p, Fl -port
The port to use.
.El
.\" UNIX OPTIONS
.Pp
The following options are available for
.Fl t Ar unix :
.Bl -tag -width indent
.It Fl P, Fl -part Ar path
The path to the unix socket.
.El
.\" EXAMPLES
.Sh EXAMPLES
.Bl -tag -width 0n
.It Sy Example 1 Show help
.Bd -literal -offset 2n
$ irccdctl help server-message
.Ed
.El
.Bl -tag -width 0n
.It Sy Example 2 Sending a message
.Pp
.Bd -literal -offset 2n
$ irccdctl server-message localhost #staff "Hello World"
.Ed
.It Sy Example 3 Connect to a Unix socket to join a channel
.Pp
.Bd -literal -offset 2n
$ irccdctl -t unix -P /tmp/foo.sock server-join localhost #foo
.Ed
.El
.\" SEE ALSO
.Sh SEE ALSO
.Xr irccd 1 ,
.Xr irccdctl.conf 5
.\" BUGS
.Sh BUGS
Be careful when using channel names, some shells (i.e bash) ignore the #
character. In that case, quote the command like this:
.Bd -literal -offset 2n
$ irccdctl join localhost "#bar"
.Ed
.\" AUTHORS
.Sh AUTHORS
irccdctl was written by David Demelier <markand@malikania.fr>