'\" t
.\" Title: irk
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot
.\" Date: 02/17/2024
.\" Manual: Commands
.\" Source: irker
.\" Language: English
.\"
.TH "IRK" "1" "02/17/2024" "irker" "Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
irk \- test program for irkerd
.SH "SYNOPSIS"
.HP \w'\fBirk\fR\ 'u
\fBirk\fR [\fItarget\fR] [\fImessage\ text\fR]
.SH "DESCRIPTION"
.PP
irk
is a simple test program for
\fBirkerd\fR(8)\&. It will construct a simple JSON object and pass it to the daemon running on localhost\&.
.SH "OPTIONS"
.PP
irk
takes the following options:
.PP
target
.RS 4
Which server and channel to join to announced the message\&. If not prefixed with "irc:", it will prefix "irc://chat\&.freenode\&.net/" to the argument before passing it directly to irkerd\&. This argument is passed as the "to" parameter in the JSON object\&.
.RE
.PP
message
.RS 4
Which message to send to the target specified above\&. If the string "\-", the message will be read from standard input, with newlines stripped\&.
.RE
.SH "LIMITATIONS"
.PP
irk
has no commandline usage and may be riddled with bugs\&.
.PP
irk
doesn\*(Aqt know how to talk to your favorite VCS\&. You will generally want to use
\fBirkerhook\fR(1)
instead
.PP
irk
has also all the limitations of
irkerd\&.
.SH "SEE ALSO"
.PP
\fBirkerhook\fR(1),
.SH "AUTHOR"
.PP
Eric S\&. Raymond
\&. See the project page at
\m[blue]\fBhttp://www\&.catb\&.org/~esr/irker\fR\m[]
for updates and other resources, including an installable repository hook script\&.