.. _mod:linux:

``tbot.machine.linux`` Module
=============================

.. warning::

   This is the documentation for an old version of *tbot*.  Please head over to

      https://tbot.tools/modules/machine_linux.html

   for the latest docs!

``tbot.machine.linux``
----------------------
.. autoclass:: tbot.machine.linux.LinuxMachine
    :members:

.. autoclass:: tbot.machine.linux.Path
    :members:

.. autoclass:: tbot.machine.linux.Workdir
    :members:

Command Specials
^^^^^^^^^^^^^^^^
.. autoclass:: tbot.machine.linux.Env
.. autoclass:: tbot.machine.linux.F

.. py:data:: tbot.machine.linux.Pipe

    Special character for the ``|`` pipe to send command output
    to another command

    **Example**::

        m.exec0("dmesg", linux.Pipe, "grep", "usb0")

.. py:data:: tbot.machine.linux.Then

    Special character for the ``;`` separator to run multiple commands

    **Example**::

        m.exec0("sleep", "1", linux.Then, "date")

.. py:data:: tbot.machine.linux.Background

    Special character for the ``&`` separator to run a command in the background

    **Example**::

        m.exec0("daemon", linux.Background)

.. py:data:: tbot.machine.linux.OrElse

    Special character for the ``||`` separator to run a command if the
    first one failed

    **Example**::

        m.exec0("test", "-d", "/foo/bar", linux.OrElse, "mkdir", "-p", "/foo/bar")

.. py:data:: tbot.machine.linux.AndThen

    Special character for the ``&&`` separator to run a command if the
    first one succeeded

    **Example**::

        m.exec0("test", "-d", ".git", linux.AndThen, "git", "describe", "--tags")

.. autoclass:: tbot.machine.linux.Raw

Implementations
^^^^^^^^^^^^^^^
.. automodule:: tbot.machine.linux.lab.machine
.. autoclass:: tbot.machine.linux.LabHost
    :members:

.. automodule:: tbot.machine.linux.build.machine
.. autoclass:: tbot.machine.linux.BuildMachine
    :members:

.. automodule:: tbot.machine.linux.ssh.machine
.. autoclass:: tbot.machine.linux.SSHMachine
    :members:


``tbot.machine.linux.auth``
---------------------------
.. automodule:: tbot.machine.linux.auth
    :members:


``tbot.machine.linux.lab``
--------------------------
.. automodule:: tbot.machine.linux.lab.local
.. autoclass:: tbot.machine.linux.lab.LocalLabHost
    :members:

.. automodule:: tbot.machine.linux.lab.ssh
.. autoclass:: tbot.machine.linux.lab.SSHLabHost
    :members:


``tbot.machine.linux.build``
----------------------------
.. automodule:: tbot.machine.linux.build.toolchain

.. autoclass:: tbot.machine.linux.build.Toolchain
    :members:

.. autoclass:: tbot.machine.linux.build.EnvScriptToolchain
    :members:


``tbot.machine.linux.shell``
----------------------------
.. autoclass:: tbot.machine.linux.shell.Shell
    :members:

.. autoclass:: tbot.machine.linux.shell.Bash
    :members:

.. autoclass:: tbot.machine.linux.shell.Ash
    :members: