Skip to content

Commit

Permalink
Update man page
Browse files Browse the repository at this point in the history
  • Loading branch information
rvaiya committed Jan 10, 2022
1 parent a1cf3cd commit 2de8d4e
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@ E.G

keyd-application-mapper

You will probably want to put `keyd-application-mapper -d` in your
initialization.
You will probably want to put `keyd-application-mapper -d` somewhere in your
display server initialization logic (e.g ~/.xinitrc).

Window class names are discoverable with `keyd-application-mapper -m`.
See the man page for more details.
Expand Down
Binary file modified keyd.1.gz
Binary file not shown.
27 changes: 25 additions & 2 deletions man.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Every subsequent section of the file corresponds to a layer and has the form:

Where `<type>` is either a valid modifier set (see *MODIFIERS*) or "layout".

Each line within a layer is a mapping of the form:
Each line within a layer is a binding of the form:

<key> = <action>|<keyseq>

Expand Down Expand Up @@ -144,7 +144,7 @@ for the duration of the corresponding key stroke.

## Layouts

The *layout* is a special kind of layer from which mappings are drawn if no
The *layout* is a special kind of layer from which bindings are drawn if no
other layers are active. By default all keys are mapped to themselves within a
layout. Every config has at least one layout called *main*, but additional
layouts may be defined and subsequently activated using the `layout()` action.
Expand Down Expand Up @@ -222,6 +222,20 @@ control, which means the following:

will cause capslock to behave as meta and alt when held.

**NOTE**: While it is technically possible to use individual modifier key codes
like `rightalt` and `rightcontrol` as target sequences, the user is strongly
encouraged to avoid these as they can produce unintuitive results when paired
with their layer counterparts. To this end, it is best to think of modifiers
as just a another kind of layer.

Thus instead of:

meta = rightcontrol

one should do:

meta = layer(control)

### Lookup Rules

In order to achieve this (un)holy union, the following lookup rules are used:
Expand Down Expand Up @@ -510,6 +524,15 @@ of \` will thus produce A-tab instead of M-\`.
# Map e to €
e = macro(compose c =)

# Example 6

# Tapping both shift keys will activate capslock.

[shift]

leftshift = capslock
rightshift = capslock

# AUTHOR

Written by Raheman Vaiya (2017-).
Expand Down

0 comments on commit 2de8d4e

Please sign in to comment.