.. meta::
   :description: The tlctl license command displays license information
                 as currently measured by ThinLinc.

.. raw:: pdf

   PageBreak

tlctl license
=============

Synopsis
--------

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

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

:program:`tlctl license` displays license information as currently
measured by ThinLinc.

Note that if the licenses have recently been changed, the vsmserver
service may need to be restarted to ensure up-to-date information.

Options
-------

.. option:: -h, --help

   Prints a short help text and exits.

Commands
--------

**show**
   Show the current number of licenses in use, the total amount
   available, the hard limit, and the latest version of ThinLinc that
   the licenses are valid for.

**agreement**
   Show all subscription agreements found.

**usage** [*options*]
  Show peak license usage. If no options are specified, the peak usage
  of the past 30 days is shown.

  .. option:: --since=YYYY-MM-DD

     Show peak usage since the specified date. The date format must be
     YYYY-MM-DD.

  .. option:: --until=YYYY-MM-DD

     Show peak usage until specified date. Must be used in combination
     with the :option:`--since` option. If not specified, the current
     date is used.

  .. option:: --year=YYYY

     Show peak usage for the given year. Can be used in combination
     with the :option:`--month` option.

  .. option:: --month=MONTH

     Show peak usage for the given month. The month can be specified as
     a number between 1 and 12, or a month name, e.g. 'jan' or
     'january', and will target the most recent occurance of the month
     by default. Can be used in combination with the
     :option:`--year` option.
