/hid-apple-plugboard

Customizable key mappings for Apple and Macbook keyboards.

Primary LanguageCGNU General Public License v2.0GPL-2.0

hid-apple-plugboard

Customizable key mappings for Apple and Macbook keyboards.

enigma-plugboard

Functionality

  • Support key mappings in normal layer.
  • fn key can be mapped to another key and vice versa.
  • Support key mappings in fn layer.
  • Support key mappings in numlock layer.
  • Support various media key mode and numlock mode.
  • Support device specific fn key mappings as the original module supported.
  • Support numlock quirks as the original module supported.
  • Support devices as the original module supported.

Configuration

Configuration was done with config.h.

You can read the file to find descriptions and examples.

Installation via package manager (recommended)

You are recommended to create a package with your own configurations/modifications then install with the package manager.

You can find the examples provided as follows.

Arch Linux:

Installation via DKMS

  1. Install module via DKMS
sudo dkms add .
sudo dkms build hid-apple-plugboard/5.0.0
sudo dkms install hid-apple-plugboard/5.0.0
  1. Override original hid-apple module

You will need to create /etc/depmod.d/hid-apple-plugboard.conf to override the original module.

override hid_apple * extra
  1. Reboot or reload the kernel module

The new kernel will be effective after reboot.

Moreover, you can reload the module for immediate use.

sudo modprobe -r hid-apple; sudo modprobe hid-apple

Goal

Simple, minimal and readable. Easily customizable for power user.

Acknowledgement

The kernel module was based on Linux 5.0 hid-apple module licensed under GPLv2.

The DKMS module and makefile was based on hid-apple-patched by free5lot and other contributors licensed under GPLv2.

Enigma plugboard photo by Bob Lord licensed under GFDL or CC-BY-SA-3.0 via Wikimedia Commons.

License

GPLv2