README.md

Documentation

Running xremap

You can choose between the following ways to run xremap. They are ordered by the easiest way first. Each method has pros and cons, it's worth checking out the pages before choosing.

• Running with sudo
• Running without sudo
• Running as a user service
• Running as a system service

Use cases

• Use modifier to trigger remap
• Use normal key as modifier
• Multi-purpose key (alias: tap-hold key)

Configuration file reference

• Configuration options
• Key names
• Actions
• Multi-purpose key (alias: tap-hold key)
• Press/release key

Experimental features

• Double tap
• Chords (simultaneous keys)
• FreeBSD

Troubleshooting

• Troubleshooting

Upgrade guide

• Upgrade to v.0.15.0