Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

typo in man page example #517

Open
paoloose opened this issue Jun 11, 2023 · 0 comments · May be fixed by #518
Open

typo in man page example #517

paoloose opened this issue Jun 11, 2023 · 0 comments · May be fixed by #518

Comments

@paoloose
Copy link

Hey, hope you are doing well

There is an example in the man page about using : followed by the control modifier:

keyd/docs/keyd.scdoc

Lines 170 to 187 in 2338f11

```
[main]
capslock = layer(capslock)
[capslock:C]
j = down
```
will cause _capslock_ to behave as _control_, except in the case of _control+j_, which will
emit _down_. This makes it trivial to define custom modifiers which don't interfere with
one another.
Note that bindings are not affected by the modifiers of the layer in which they
are defined. Thus *capslock+j* will produce an unmodified *down* keypress, while
*shift+control+j* will produce *shift+down* as expected.

However, I believe you meant to say:

- will cause _capslock_ to behave as _control_, except in the case of _control+j_, which will
+ will cause _capslock_ to behave as _control_, except in the case of _capslock+j_, which will
  emit _down_. This makes it trivial to define custom modifiers which don't interfere with 
  one another. 
  
  Note that bindings are not affected by the modifiers of the layer in which they 
  are defined. Thus *capslock+j* will produce an unmodified *down* keypress, while 
- *shift+control+j* will produce *shift+down* as expected. 
+ *control+capslock+j* will produce *control+down* as expected.

I will create a PR with these changes. Feel free to close it if you intended something else.
@paoloose paoloose linked a pull request Jun 11, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix typo in keyd.scdoc example paoloose/keyd
1 participant
@paoloose