spectrumctl(8)

NAME
spectrumctl - util to control spectrum instances

SYNOPSIS
spectrumctl [options] operation

DESCRIPTION
spectrumctl is a small tool written in python which can be used to control instances of the spectrum XMPP transport. spectrum only handles one legacy network per instance, so you need more than one spectrum instance if you want support for more than one legacy network. By default, spectrumctl acts on all transports defined in /etc/spectrum/.

OPERATIONS

start, stop, restart
    Start, stop or restart given spectrum instances (all of them per default).

list
    Show a list of spectrum configurations (and their corresponding instances with PID if running)

reload
    Reload given spectrum configurations. This just causes spectrum to reopen its log-files, it does not change any runtime configuration.

stats
    Print current usage statistics. Note: This option requires the xmpppy library for python.

help
    Show the help message, alias for --help.

OPTIONS
-c FILE, --config=FILE
    Only act on transport configured in FILE (ignored for list)

-d DIR, --config-dir=DIR
    Act on all transports configured in DIR (default: /etc/spectrum)

-q, --quiet
    Do not print any output (ignored for list)

-h, --help
    show a help message and exit

--version
    show program's version number and exit

Options for action "list":

    --status=STATUS
        Only show transports with given status. Valid values are "running", "stopped" and "unknown"

    --machine-readable
        Output data as comma-seperated values.

Options for action "start":

    --su=SU
        Start spectrum as this user (default: spectrum). Overrides the SPECTRUM_USER environment variable. If neither --su nor SPECTRUM_USER is specified, the user defaults to spectrum.

    --no-daemon
        Do not start spectrum as daemon.

    --debug
        Start spectrum in debug mode. Currently this just sets the maximum size of the core files to unlimited.

ENVIRONMENT
The behaviour of spectrumctl can be influenced by the following environment variables:

SPECTRUM_PATH
    Path where the spectrum binary is located. If omitted, spectrum is assumed to be in your PATH.

SPECTRUM_USER
    The user with which spectrum is started. Overridden by the --su command line option. If neither --su nor SPECTRUM_USER is specified, the user defaults to spectrum.

AUTHORS
Copyright © 2009-2010 by Spectrum engineers:

    • Jan Kaluza <hanzz@soc.pidgin.im>
    • Mathias Ertl <mati@fsinf.at>
    • Paul Aurich <paul@darkrain42.org>

License GPLv3+: GNU GPL version 3 or later. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

See http://gnu.org/licenses/gpl.html for more information.

SEE ALSO
spectrum(1), spectrum.cfg(5)

For more information, see the spectrum homepage at http://spectrum.im/

BUGS
Please submit bugs to our issue tracker at github: http://github.com/hanzz/spectrum/issues