.. _TLP: https://linrunner.de/en/tlp/tlp.html

.. _TLP git repo: https://github.com/linrunner/TLP

.. _tlp-portage: git://github.com/dywisor/tlp-portage.git

.. _Layman - Gentoo Wiki: https://wiki.gentoo.org/wiki/Layman

.. _tpacpi-bat: https://github.com/teleshoes/tpacpi-bat

.. _upstream documentation: https://www.linrunner.de/en/tlp/docs/tlp-configuration.html

.. _eselect/repository - Gentoo Wiki: https://wiki.gentoo.org/wiki/Eselect/Repository

============= tlp-portage

Overlay for installing TLP_ on Gentoo/Funtoo/... systems.

Setup Instructions

The following commands ($ <command...>) should be run as root. It is assumed that your package manager is sys-apps/portage.

#. Add the tlp-portage repository

#. Option A: manage repo using eselect-repository

  #. Install eselect-repository and git::

        $ emerge -a --no-replace app-eselect/eselect-repository dev-vcs/git

  See also `eselect/repository - Gentoo Wiki`_.

  #. If it doesn't already exist, create the ``repos.conf`` directory as configured by the ``REPOS_CONF`` variable in ``/etc/eselect/repository.conf``::

        $ mkdir -p /etc/portage/repos.conf

  #. Add the *tlp-portage* overlay with eselect-repository::

        $ eselect repository add tlp git https://github.com/dywisor/tlp-portage

  #. Download the repo::

        $ emerge --sync tlp

#. OR Option B: manage repo with layman

  #. Install layman

     #. Enable the git USE flag for layman::

        $ mkdir /etc/portage/package.use
        $ echo "app-portage/layman git" >> /etc/portage/package.use/layman

     #. Install layman::

        $ emerge -a --noreplace ">=app-portage/layman-2"

     See also `Layman - Gentoo Wiki`_.

  #. layman versions prior to ``2.1.0``: make sure that ``/etc/portage/make.conf`` has the following line::

        source /var/lib/layman/make.conf

     If you've just installed layman, simply run::

        $ echo "source /var/lib/layman/make.conf" >> /etc/portage/make.conf

  #. Add the *tlp-portage* overlay with layman::

        $ wget "https://raw.github.com/dywisor/tlp-portage/maint/layman.xml" -O /etc/layman/overlays/tlp.xml
        $ layman -f -a tlp

#. stable arch only (amd64, x86): unmask TLP:

.. code::

  $ mkdir /etc/portage/package.accept_keywords
  $ echo "app-laptop/tlp" > /etc/portage/package.accept_keywords/tlp

unmask sys-power/linux-x86-power-tools or sys-apps/linux-misc-apps:

.. code::

  $ echo "sys-power/linux-x86-power-tools" >> /etc/portage/package.accept_keywords/tlp

#. (optional) install/build kernel modules

This is required for ThinkPad advanced battery functions.

• Thinkpads up to the Sandy Bridge generation (T420, X220 et al.)::

  $ emerge -a app-laptop/tp_smapi

• Thinkpads beginning with the Sandy Bridge Generation (T420, X220 et al.)::

  $ emerge -a sys-power/acpi_call

#. (optional) choose USE flags, for example::

  $ echo "app-laptop/tlp tlp-suggests" > /etc/portage/package.use/tlp

See USE flags_ below for a full listing.

#. Install TLP::

  $ emerge -a app-laptop/tlp

#. Edit TLP's configuration file /etc/tlp.conf

In contrast to other distributions, you have to enable TLP explicitly by setting TLP_ENABLE=1.

See the upstream documentation_ for details.

.. Note::

  Beginning with TLP 1.3, the configuration file format and handling
  has changed, users upgrading from TLP 1.2 should review their configuration.

#. Enable the TLP service

OpenRC::

  $ rc-update add tlp default

systemd::

  $ systemctl enable tlp.service

systemd-rfkill should be masked as it conflicts with RESTORE_DEVICE_STATE_ON_STARTUP/DEVICES_TO_{EN,DIS}ABLE_ON_STARTUP::

  $ systemctl mask systemd-rfkill.socket systemd-rfkill.service

Users of systemd prior to v227 need to mask systemd-rfkill@ instead::

  $ systemctl mask [email protected]

power-profiles-daemon must be masked as it conflicts with TLP as a whole::

  $ systemctl mask power-profiles-daemon.service

#. Reboot your system to apply the new settings (alternatively, you could reload the udev rules and start TLP)

#. You might want to run tlp-stat to see if everything is OK so far

USE flags

.. table:: USE flags accepted by app-laptop/tlp

+--------------+--------------+---------+--------------------------------------+ | flag | recommended | default | description | +==============+==============+=========+======================================+ | tlp-suggests | yes | yes | install all optional dependencies | +--------------+--------------+---------+--------------------------------------+ | rdw | - | no | install TLP's radio device wizard | +--------------+--------------+---------+--------------------------------------+ | bluetooth | - | no | install optional bluetooth | | | | | dependencies (bluez) | +--------------+--------------+---------+--------------------------------------+ | tpacpi-\ | yes | yes | use the bundled version of | | bundled | | | tpacpi-bat_ | | | | | | | | | | Deselecting this flag | | | | | disqualifies you from getting \ | | | | | support upstream | +--------------+--------------+---------+--------------------------------------+

Random notes / FAQ

Kernel config considerations

The following kernel options should be set to y:

• CONFIG_PM
• CONFIG_PM_RUNTIME (Linux < 3.19 only)
• CONFIG_DMIID
• CONFIG_POWER_SUPPLY
• CONFIG_ACPI_AC
• CONFIG_SENSORS_CORETEMP
• CONFIG_X86_MSR