Skip to content

claui/compose

Repository files navigation

Compose

Compose is a tiny command-line utility for X11 or Wayland that helps you edit your Compose file to add multi-key sequences.

It uses uni behind the scenes to let you search for Unicode codepoints by name. For each match, it scaffolds a blank Compose line for you. You can then paste the line into your Compose file as a starting point to add the multi-key sequence.

For example:

$ compose hundred points
: "💯"   U1f4af # HUNDRED POINTS SYMBOL

Paste the output into your ~/.XCompose file, then add a multi-key sequence:

<Multi_key> <1> <0> <0> : "💯"   U1f4af # HUNDRED POINTS SYMBOL

Now you can type Multi 1 0 0 to produce the 💯 emoji.

Why?

This utility is for people who write and edit their own Compose files. If you don’t know what a Compose file is, this tool is probably not for you.

Prerequisites

To run this program, you need the following programs installed:

You’ll also need an X server or a Wayland compositor that supports Compose files.

Installation

Installing manually

Clone this repository to any directory you like.

Installing from the AUR

Direct your favorite AUR helper to the compose package.

Contributing to Compose

See CONTRIBUTING.md.

License

Copyright (c) 2024 Claudia Pellegrino

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. For a copy of the License, see LICENSE.