Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linux-surface/surface-dtx-daemon

Linux User-Space Detachment System (DTX) Daemons for the Surface ACPI Driver.
https://github.com/linux-surface/surface-dtx-daemon

linux linux-surface

Last synced: 2 months ago
JSON representation

Linux User-Space Detachment System (DTX) Daemons for the Surface ACPI Driver.

Awesome Lists containing this project

README 

        
# Linux DTX Daemon for Surface Books



![CI](https://github.com/linux-surface/surface-dtx-daemon/workflows/CI/badge.svg)



Linux User-Space Detachment System (DTX) Daemon for the Surface ACPI Driver (and Surface Books).

Currently, only the Surface Book 2 and 3 are supported, due to lack of driver-support on the Surface Book 1.

This may change in the future.



## About this Package



This package contains two daemons.

A system daemon (`surface-dtx-daemon`) and a per-user daemon (`surface-dtx-userd`):



- The system daemon allows proper clipboard detachment on the Surface Book 2 and 3. It allows you to run commands before the clipboard is unlocked, after it has been re-attached, or when the unlocking-process has been aborted (e.g. by pressing the detach-button a second time).

See the configuration section below for details.

Furthermore, this daemon provides a d-bus interface via which you can query the current device mode (i.e. if the device is in tablet-, laptop- or studio-mode).



- The per-user daemon is responsible for desktop-notifications, i.e. it notifies you when the clipboard can be physically detached (i.e. the latch holding it in place is unlocked), and when the re-attachment process has been completed, i.e. indicating when it is fully usable again after re-attachment.

Running this daemon is completely optional, i.e. if you don't want any notifications, you are free to simply not run it.



The split into two daemons is required as notifications can only be sent on a per-user basis.



## Installation



If you have a Debian (Ubuntu, ...) based distribution, have a look at the [releases page][releases] for official packages.

Official Arch Linux packages can be found in the AUR (`surface-dtx-daemon`).

After installation, you may want to:

- enable the systemd service for the system daemon using `systemctl enable surface-dtx-daemon.service`.

- enable the systemd service for the per-user daemon using `systemctl enable --user surface-dtx-userd.service`.



Alternatively, you can build these packages yourself, using the provided `PKGBUILD` (Arch Linux) or `makedeb.sh` script in the respective `pkg` subdirectories.



## Configuration



The main configuration files can be found under



- `/etc/surface-dtx/surface-dtx-daemon.conf` for the system daemon configuration, and

- `/etc/surface-dtx/surface-dtx-userd.conf` for the per-user daemon configuration.



Here you can specify the handler-scripts for supported events and other options.

All options are explained in these files, the configuration language is TOML, default attach and detach handler scripts are included. 



Furthermore, a per-user configuration for the user daemon can also be created under `$XDG_CONFIG_HOME/surface-dtx/surface-dtx-userd.conf` (if not set, `$XDG_CONFIG_HOME` defaults to `.config`).



## Building a Package from Source



### Arch Linux



Simply install `surface-dtx-daemon` from AUR or have a look at its PKGBUILD.



### Debian/Ubuntu



Use the `makedeb` script provided under `pkg/deb`, i.e. run

```

./pkg/deb/makedeb

```

from the root project directory.

You may need to install the `build-essential` and `devscripts` packages beforehand.

The final package will be in the `pkg/deb` directory.



[releases]: https://github.com/linux-surface/surface-dtx-daemon/releases