Skip to content

Latest commit

 

History

History
211 lines (155 loc) · 3.41 KB

api.md

File metadata and controls

211 lines (155 loc) · 3.41 KB

(api)=

API Reference

:::{warning}

All APIs are considered experimental and subject to break pre-1.0. They can and will break between versions.

:::

Server Object

.. autoapiclass:: Server
    :members:
    :inherited-members:
    :private-members:
    :show-inheritance:
    :member-order: bysource

Session Object

.. autoapiclass:: Session
    :members:
    :inherited-members:
    :private-members:
    :show-inheritance:
    :member-order: bysource

Window Object

.. autoapiclass:: Window
    :members:
    :inherited-members:
    :private-members:
    :show-inheritance:
    :member-order: bysource

Pane Object

.. autoapiclass:: Pane
    :members:
    :inherited-members:
    :private-members:
    :show-inheritance:
    :member-order: bysource

Internals

.. autodata:: libtmux.common.TMUX_MIN_VERSION

.. autodata:: libtmux.common.TMUX_MAX_VERSION

.. autoapiclass:: libtmux.common.TmuxRelationalObject
    :members:

.. autoapiclass:: libtmux.common.TmuxMappingObject
    :members:

.. autoapiclass:: libtmux.common.EnvironmentMixin
    :members:

.. autoapiclass:: libtmux.common.tmux_cmd

.. automethod:: libtmux.common.which

.. automethod:: libtmux.common.get_version

.. automethod:: libtmux.common.has_version

.. automethod:: libtmux.common.has_gt_version

.. automethod:: libtmux.common.has_gte_version

.. automethod:: libtmux.common.has_lt_version

.. automethod:: libtmux.common.has_lte_version

.. automethod:: libtmux.common.has_minimum_version

.. automethod:: libtmux.common.handle_option_error

.. automethod:: libtmux.common.get_libtmux_version

Exceptions

.. autoexception:: libtmux.exc.LibTmuxException

.. autoexception:: libtmux.exc.TmuxCommandNotFound

.. autoexception:: libtmux.exc.VersionTooLow

.. autoexception:: libtmux.exc.TmuxSessionExists

.. autoexception:: libtmux.exc.BadSessionName

.. autoexception:: libtmux.exc.OptionError

.. autoexception:: libtmux.exc.UnknownOption

.. autoexception:: libtmux.exc.InvalidOption

.. autoexception:: libtmux.exc.AmbiguousOption

Test tools

.. automethod:: libtmux.test.retry

.. automethod:: libtmux.test.retry_until

.. automethod:: libtmux.test.get_test_session_name

.. automethod:: libtmux.test.get_test_window_name

.. automethod:: libtmux.test.temp_session

.. automethod:: libtmux.test.temp_window

.. autoapiclass:: libtmux.test.EnvironmentVarGuard

Environmental variables

(LIBTMUX_TMUX_FORMAT_SEPARATOR)=

tmux format separator

LIBTMUX_TMUX_FORMAT_SEPARATOR can be used to override the default string used to split tmux(1)'s formatting information.

If you find any compatibility problems with the default, or better yet find a string copacetic many environments and tmux releases, note it at tmux-python#355.