1KGB-CLIENT(1)         User Contributed Perl Documentation        KGB-CLIENT(1)
2
3
4

NAME

6       kgb-client - relay commits to KGB servers
7

SYNOPSIS

9       kgb-client --conf /path/to/config [other-option ...]
10       kgb-client --uri http://some.server:port/service --password password
11       --repo-id repository --repository svn|git|cvs --timeout timeout-in-
12       seconds --single-line-commits off|forced|auto --use-irc-notices
13       --web-link template --short-url-service service --status-dir directory
14       --[no]-use-color --message-template template --batch-messages --dry-run
15       kgb-client option... /svn/repo revision
16       kgb-client option... old-rev new-rev ref-name
17       kgb-client option... $CVSROOT "%p"
18       kgb-client option... --fake
19       kgb-client option... --relay-msg message...
20       kgb-client --help
21       kgb-client --man
22

DESCRIPTION

24       kgb-client is the client counterpart of kgb-bot(1). It is intended to
25       be used as a hook in your version control system, executed after the
26       repository gets updated. It analyzes the commit(s) and then relays the
27       information to the KGB server, which will show it on IRC.
28

CONFIGURATION

30       --conf configuration file
31           Specifies the path to kgb-client configuration file.
32
33       Configuration options (except --conf, --fake and --relay-msg) may be
34       specified both in the configuration file and on the command line.
35       Usually you want to have all the options in a configuration file,
36       because having passwords on the command line is insecure. The
37       configuration file also gives more control, for example it supports
38       multiple servers and multiple ways of detection of branch and module
39       names.
40
41       See kgb-client.conf(5) for available configuration options. Unless
42       noted otherwise, all the options in the configuration file can also be
43       used on command line, prefixing them with two dashes. E.g. "repo-id"
44       becomes "--repo-id".
45
46       Options given on the command line take precedence over configuration
47       file.
48

FAKE COMMIT MODE

50       If invoked with the --fake option, kgb-client will send a fake commit
51       to the servers. This is useful for testing client-server communication
52       independently from VCS setup.
53

MESSAGE RELAY MODE

55       When the --relay-msg option is given, there is no repository to be
56       inspected. Instead, the non-option command line arguments are passed
57       verbatim to the bot to display on IRC. This can be used for real-time
58       notification about other events like bug submissions etc.
59

SUPPORTED VERSION CONTROL SYSTEMS

61   Subversion
62       Installation requires calling kgb-client with two command line
63       arguments, like this:
64
65           /path/to/kgb-client "$REPOS" "$REV"
66
67       path to the subversion repository
68           This is the physical path to the Subversion repository. Something
69           like /srv/svn/my-repo
70
71       revision
72           This is the revision number of the commit, that has triggered the
73           hook.
74
75       Both these arguments are supplied to the standard Subversion post-
76       commit hooks.
77
78   Git
79       kgb-client shall be installed as a post-receive hook. Something along
80       the following shall do:
81
82           #!/bin/sh
83           exec /path/to/kgb-client --conf /path/to.conf ...
84
85       By default, kgb-client will read the reflog information from standard
86       input as any standard Git post-receive hook. See --git-reflog option if
87       something else is wanted.
88
89       There are other ways to give kgb-client information about Git reflog,
90       mostly useful when debugging on in unusual situations. See
91       App::KGB::Client::Git.
92
93       The following settings can be configured via git-config(1):
94
95       conf
96       web-link
97
98   CVS
99       kgb-client shall be installed in the loginfo file in the "CVSROOT"
100       module of the CVS repository. It shall be given two arguments -- the
101       repository root, and the directory in which the changes are being made.
102
103       For example:
104
105           ALL /path/to/kgb-client --conf /path/to.conf ... "$CVSROOT" "%p"
106

SEE ALSO

108       kgb-client.conf(5)
109       App::KGB::Client
110       App::KGB::Client::Subversion
111       App::KGB::Client::Git
112       App::KGB::Client::CVS
113
114
115
116perl v5.32.1                      2021-01-26                     KGB-CLIENT(1)
Impressum