eventdctl(1)

control utility for eventd

Build version: 0.25.0 - v0.25.0

Name

eventdctl — control utility for eventd

Synopsis

eventdctl [OPTIONS...] {command} [command arguments...]

Description

eventdctl is the control utility for eventd(1).

Options

-s, --socket=socket

eventd control socket

-a, --auto-spawn

Spawn eventd if needed

It will pass the --private-socket option to eventd with the socket specified to the eventdctl --socket option.

-S, --system

Talk to system eventd

It will use /run instead of $XDG_RUNTIME_DIR. Only has effect for the default socket.

It is the default if $XDG_RUNTIME_DIR is unset.

-V, --version

Print version

-h, --help

Show help options

Commands

version

Query the eventd version.

start

Start eventd if needed.

It can take the option --argv0 which means that the first argument is the command to call. If not specified, eventdctl will search for eventd in PATH.

All the remaining arguments are passed to eventd.

stop

Quit eventd.

reload

Make eventd reload its configuration.

flags sub-command

Control the eventd flags (see eventd.conf(5))

add flag

Add flag to eventd.

remove flag

Remove flag from eventd.

reset

Reset eventd flags.

list

Query current eventd flags.

These commands are for the relay plugin, listed here as it is considered a core plugin.

relay connect server

Tell the plugin to connect to the specified server.

server may be any server configured as a relay (see eventd.conf(5)).

relay disconnect server

Tell the plugin to disconnect from the specified server.

server may be any server configured as a relay (see eventd.conf(5)).

relay status server

Ask the plugin for the server status.

relay list

Ask the plugin for the list of servers.

Exit status

0

The command was successful.

With the start command, it will return 0 if eventd is already started.

1

Failed to parse command line paramaters.

10

Impossible to connect to eventd. May be returned if no eventd is started or if our started eventd exited early.

11

eventd invocation faild. Either with the start command, or the --auto-spawn option.

20

Command error. No command passed, unknown command or missing command argument.

21

Plugin error. No plugin or no control command support in plugin.

30

Plugin command error. The plugin command is unknown, or miss an argument.

31

Plugin command execution error. The command could not succeed, see eventdctl output for details.

50 to 59

This range is reserved for plugin-specific statuses.

These exit statuses are for the relay plugin, listed here as it is considered a core plugin.

status: 50

The plugin has no servers in its list.

status server: 50

The server has no address to connect to. Can only happen for a server using DiscoverName= (see eventd.conf(5)).

status server: 51

The server is not connected

list: 50

The plugin has no servers in its list.

See Also

eventd core man pages
eventd(1)

eventd daemon command-line options

eventdctl(1)

eventdctl (control tool) command-line options

eventd.conf(5)

eventd configuration

Contains information about all the event configuration

Plugins distributed with eventd will use the same scheme: eventd-plugin-name for their additional eventd command-line options, eventdctl-plugin-name for their additional eventdctl command-line options, eventd-plugin-name.conf for their configuration,

Plugins man pages