.. meta::
   :description: The tlctl command inspects and controls the state of a
                 ThinLinc cluster, providing functionality to manage
                 sessions and view cluster load information when run on
                 a master machine.

.. raw:: pdf

   PageBreak

tlctl
=====

Synopsis
--------

**tlctl** [*options*] <*command*> [*args*]

Description
-----------

:program:`tlctl` can be used to inspect and control the state of a
ThinLinc cluster. Note that this command only works when executed on a
master machine in the ThinLinc cluster.

Options
-------

.. option:: --color=WHEN

   Show colored output. The *WHEN* argument defaults to :option:`auto`
   and can also be set to :option:`always` or :option:`never`.

   If :option:`auto` is used, colored output is enabled only when
   :program:`tlctl` has its standard output connected to a terminal.

.. option:: -h, --help

   Prints a short help text and exits.

.. option:: --version

   Prints the ThinLinc version and exits.

Commands
--------

:program:`tlctl-license`\ (8)
   Show license information.

:program:`tlctl-load`\ (8)
   Show cluster load information.

:program:`tlctl-session`\ (8)
   Manage sessions.
