.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "KGB-BOT 1p"
.TH KGB-BOT 1p "2024-01-01" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
kgb\-bot \- an IRC bot helping collaborative work
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
kgb-bot [\-\-config \fIfile\fR] [\-\-foreground] [\-\-simulate \fIfile\fR]
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-\-config \fIfile\fR" 4
.IX Item "--config file"
Specify configuration file to load. Default is \fI/etc/kgb\-bot/kgb.conf\fR.
.IP "\-\-config\-dir \fIdirectory\fR" 4
.IX Item "--config-dir directory"
Specify directory with configuration files to load. All files like \fI*.conf\fR
are loaded, in alphabetical order. Default is \fI/etc/kgb\-bot/kgb.conf.d\fR.
.IP "\-\-foreground" 4
.IX Item "--foreground"
Do not detach from console, print log messages to \s-1STDERR\s0 and do not become a
daemon, useful for debugging.
.IP "\-\-simulate \fIfile\fR" 4
.IX Item "--simulate file"
Do not connect to \s-1IRC.\s0 Instead, output each notification line to the given
\&\fIfile\fR, like:
.Sp
.Vb 3
\&    #chan repo user branch revision module changed\-paths
\&    #chan repo commit message line 1
\&    #chan repo commit message line 2
.Ve
.Sp
There are no colour codes in the output, unless \fB\-\-simulate\-color\fR is also
given.
.IP "\-\-simulate\-color" 4
.IX Item "--simulate-color"
Include color codes in the file used by \fB\-\-simulate\fR.
.IP "\-\-debug" 4
.IX Item "--debug"
Log additional debugging information
.SS "webhook_request \fIrequest\fP \fIresponse\fP \fIdirmatch\fP"
.IX Subsection "webhook_request request response dirmatch"
Handler for webhook \s-1HTTP\s0 request.
.PP
This handler only processes the \s-1HTTP\s0 part, parsing \s-1URI\s0 parameters and \s-1POST\s0
contents.
.PP
The actual processing and \s-1IRC\s0 notification is done via an appropriate
\&\f(CW\*(C`gitlab_webhook_*\*(C'\fR event, asynchronously.
.SS "gitlab_webhook_push"
.IX Subsection "gitlab_webhook_push"
Handle a gitlab webhook call for the \f(CW\*(C`push\*(C'\fR event (branch update).
.PP
Expects the body of the \s-1POST\s0 request (decoded, as a hash reference) in \fI\s-1ARG0\s0\fR
and all the request parameters in \fI\s-1ARG1\s0\fR.
.PP
The request is expected to conform to the GitLab webhook documentation at
<https://salsa.debian.org/help/user/project/integrations/webhooks.md#push\-events>.
.PP
The request parameters should look like the result of the \s-1CGI\s0's \fBparam()\fR method.
.PP
Supported parameters (?param=value&param=value2...)
.IP "channel" 4
.IX Item "channel"
The name of the channel to post notifications to. Leading hash sign is optional
and should be URL-encoded if present (%23).
.IP "network" 4
.IX Item "network"
The name of the \s-1IRC\s0 network, servicing the channel. Supported networks are
configured by the bot's admin.
.IP "private" 4
.IX Item "private"
A boolean flag, indicating that the notifications shouldn't also be posted to
the \f(CW\*(C`#commits\*(C'\fR channel on Freenode.
.IP "use_color" 4
.IX Item "use_color"
A boolean flag enabling colors. Defaults to true.
.IP "rev_prefix" 4
.IX Item "rev_prefix"
Optional text to prepend to the commit \s-1ID.\s0
.IP "use_irc_notices" 4
.IX Item "use_irc_notices"
If true, \s-1IRC\s0 notification uses \f(CW\*(C`notice\*(C'\fR messages, instead of \f(CW\*(C`privmsg\*(C'\fR.
Defaults to \f(CW1\fR.
.Sp
\&\f(CW\*(C`notice\*(C'\fR messages are usually less intrusive.
.IP "squash_threshold \fInumber\fR" 4
.IX Item "squash_threshold number"
For \fIpush\fR events, limit the commit notifications to the given \fInumber\fR. If a
branch update contains more commits, the usual notifications are replaced by a
single notification about the number of the pushed commits.
.Sp
\&\fBDefault\fR: 20