view doc/man/irccd.1.in @ 0:1158cffe5a5e

Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 2a6ac6daceee
line wrap: on
line source

.\"
.\" 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 IRCCD 1
.Os
.Sh NAME
.Nm irccd
.Nd an IRC client daemon
.Sh SYNOPSIS
.Nm
.Op Fl f
.Op Fl v
.Op Fl c Ar config
.Sh DESCRIPTION
The irccd program aims to provide an IRC client that acts as a daemon.
.Pp
The features are listed below:
.Bl -bullet
.It
Connect to one or more servers,
.It
Use different identities for each servers,
.It
Manageable by UNIX or Internet sockets (both TCP and UDP),
.It
Highly extensible with Lua plugins,
.El
.Pp
The application run as daemon and wait for events in both IRC servers
or from the irccdctl(1) utility.
.Pp
For instance, when IRC events happen, it calls Lua functions from plugins to
execute specific actions. Example: someone join the channel, the
.Nm irccd
daemon will notify all plugins that a specific user joined.
.Pp
But it is also possible to use irccdctl(1) to control
.Nm irccd .
For instance, you may want at any time to change the nick of the irccd daemon,
is it possible with one command.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl f
Do not run as a daemon.
.It Fl c Ar config
A path to a config file.
.It Fl v
Be more verbose.
.El
.\" SEE ALSO
.Sh SEE ALSO
.Xr irccdctl 1 ,
.Xr irccd.conf 5
.\" AUTHORS
.Sh AUTHORS
irccd was written by David Demelier <markand@malikania.fr>