tuxedo-tomte(1)

NAME
tuxedo-tomte - Manages fixes for TUXEDO notebooks

SYNOPSIS
tuxedo-tomte <COMMAND> [NAME...]

DESCRIPTION

tuxedo-tomte is a little helper that provides services, updates and fixes for TUXEDO devices in the background. It does not send any information, telemetry data or similar stuff anywhere!

Many but not all options require administrative privileges.

COMMANDS

The following commands are understood:

list
    Lists all available fixes with name, module version and whether it is active, blocked and required for this system.

status
    Same as 'list'.

versions
    Lists all available fixes with name, package version (if available), module version and whether it is active, blocked and required for this system.

description <MODULE>
    Shows a small description about the fix.

configure <MODULE>|all
    Configures the specified module or fix if possible. That means, it is not already installed, blocked and designed to fix something on this system.

    If all is used then all possible fixes will be installed.

    To see which modules can be installed use

        tomte list

    Does nothing if DONT_CONFIGURE is set.

    Requires administrative privileges.

reconfigure <MODULE>|all
    Configures the specified module or fix even if it is already installed.

    It will not do anything if it is blocked or not designed to work on this system.

    If all is used then all possible fixes will be reconfigured.

    To see which modules can be installed use

        tomte list

    Does nothing if DONT_CONFIGURE is set.

    Requires administrative privileges.

block <MODULE>|all
    Prevents the module from being installed or updated.

    Already installed modules will not be upgraded or deleted except for packages which are managed by the systems package manager.

    Requires administrative privileges.

    Modules marked as prerequisite can't be blocked.

unblock <MODULE>|all
    Allows the module to be automatically installed or upgraded by Tomte if it is required by this system.

    Requires administrative privileges.

remove <MODULE>
    Removes the named module independent from selected mode (AUTOMATIC, UPGRADES_ONLY and DONT_CONFIGURE).

    After removing the module it should be blocked with

        tomte block <MODULE>

    or the module will be installed again automatically if the chosen mode is set to AUTOMATIC.

    Requires administrative privileges.

    At this moment removal only works on some of the modules.

loglevel <desired loglevel>
    Prints the currently used loglevel if used without arguments.

    Changes to desired loglevel where loglevel is a number from 0 to 2, where 2 is the highest loglevel used for debugging. It is not recommended to use this level for continuous operation as it produces a very large amount of data.

CONFIGURATION MODES
    Requires administrative privileges.

    There are three configuration modes: AUTOMATIC, UPDATES_ONLY and DONT_CONFIGURE.

    The modes are set by

        sudo tomte <MODE>

    The modes can also be set manually by creating an empty file with the name of the configuration mode in /etc/tomte/ as e.g.

        sudo touch /etc/tomte/AUTOMATIC

    or

        sudo touch /etc/tomte/UPDATES_ONLY

    or

        sudo touch /etc/tomte/DONT_CONFIGURE

AUTOMATIC
    This is the default mode. Everything will be installed/updated/removed automatically by Tomte.

UPDATES_ONLY
    Only updates will be handled automatically by Tomte.

No modules will be installed or removed without user intervention.

DONT_CONFIGURE
    Nothing will be configured by Tomte.

Useful if you want to create the file before installing Tomte to avoid Tomte to make any unwanted changes to the system or to set Tomte on hold after having the configuration you want.

TUXEDO FAI INSTALLATION
    Everything will be installed automatically. After a FAI installation, the system should be ready to go. If new fixes should become necessary, these will be installed automatically.

INSTALLATION ON VANILLA SYSTEM
    Everything will be installed automatically. It might take a few minutes until everything is installed. Messages will appear on the desktop.

    Interrupting the installation might damage the system.

    If the files AUTOMATIC, UPDATES_ONLY or DONT_CONFIGURE are created in /etc/tomte/ then the installation will act accordingly.

INSTALLATION WITHOUT MODIFICATIONS
    If creating a file /etc/tomte/DONT_CONFIGURE and installing Tomte afterwards, Tomte will configure only the TUXEDO repositories and mirrors. To find out which fixes are available to the system

              tomte list

    Then to install a required fix

              tomte configure <MODULE>

POSSIBLE WORKFLOW
    Just install Tomte , it will take care of all the fixes your system requires and it also installs the TUXEDO kernel which brings all the required drivers.

    If you don't want Tomte to make any modifications on your system or you want to keep your specific kernel, you could create the file DONT_CONFIGURE in /etc/tomte/ and Tomte will not make any modifications on the system, except for the required repositories and Debian mirrors.

    Afterwards you could list the required fixes with

              tomte list

    block the fixes you don't want on your system with

              sudo tomte block <MODULE>

    and set the Tomte installation mode to AUTOMATIC or UPDATES_ONLY with

              sudo tomte AUTOMATIC

    or

              sudo tomte UPDATES_ONLY

    Alternatively you could install the fixes you want manually by using

              sudo tomte configure <MODULE>

FILES

/etc/tomte/tomte.cfg
    The Tomte configuration file.

/var/log/tomte/tomte.log
    The Tomte logfile.

/etc/tomte/DONT_CONFIGURE
    File, if present, inhibits Tomte to configure anything except for the prerequisite modules.

/etc/tomte/UPDATES_ONLY
    File, if present, makes Tomte to allow updates only.

/etc/tomte/AUTOMATIC
    File, if present, lets Tomte configure everything automatically.