diff options
| author | 2020-01-13 15:00:18 +0100 | |
|---|---|---|
| committer | 2020-01-13 15:02:01 +0100 | |
| commit | 421c54477638ad334abab02cd5d35cbc36fee4a5 (patch) | |
| tree | fa483c667751cb3ed8260e6039af19a7d34f79b9 | |
| parent | f64ab5a072122cd0d1c01eb28091e49b26dbfdbf (diff) | |
| download | xkbcat-421c54477638ad334abab02cd5d35cbc36fee4a5.tar.gz xkbcat-421c54477638ad334abab02cd5d35cbc36fee4a5.zip | |
Readme: Text improvements, build badge with date
| -rw-r--r-- | readme.markdown | 41 |
1 files changed, 22 insertions, 19 deletions
diff --git a/readme.markdown b/readme.markdown index 0a77a46..97f1337 100644 --- a/readme.markdown +++ b/readme.markdown @@ -1,14 +1,15 @@ -# xkbcat [](https://travis-ci.org/anko/xkbcat) +# xkbcat [](https://travis-ci.org/anko/xkbcat) -X11 keylogger with simple output format: one line on `stdout` per key event. +Simple X11 keylogger. -Great as a data source for keyboard heatmaps, layout comparisons or -screencasting applications. - -<100 lines of modern C. Doesn't need `sudo`. + - Simple output format: one line on `stdout` per key event. + - Simple to audit: <100 lines of modern C. + - Simple to run: Does not need `sudo`. ## Examples +### Keypresses only + Given no flags, `xkbcat` prints only keypresses, one per line. Here's the output when I type "Hi": @@ -16,6 +17,8 @@ output when I type "Hi": h i +### Keypresses and key-ups + With key-ups enabled (`xkbcat -up`), the format changes to show them: + Shift_L @@ -27,9 +30,6 @@ With key-ups enabled (`xkbcat -up`), the format changes to show them: Lines starting `+` are key-downs; `-` are key-ups. -Left- and right-positioned modifier keys are recognised separately. The F-keys -work too, as do most media keys like `XF86AudioLowerVolume`. - ## Compilation Just `make`. @@ -45,21 +45,24 @@ Flags you can pass (all optional): - `-up`: also prepend key-ups (default: don't) - `-help`: print usage hints and exit -Then just type as you would usually. Interrupt signal (`C-c`) to end. +Then just use your computer as usual. Interrupt signal (`C-c`) to quit. ## Related programs -If you need to log keys across a whole Linux system (also in the -framebuffer—not just in X11), try [keysniffer][1]. It works via a kernel -module, and needs `sudo`. +### Other keyloggers + + - If you need to log keys across a whole Linux system (also in the + framebuffer—not just in X11), try [keysniffer][1]. It works via a kernel + module, and needs `sudo`. + - If you want to see what characters the user actually typed (with modifier + keys, backspace, etc resolved into text), [`xspy`][2] or [`logkeys`][3] + might be better for you. -If you want to see what characters the user actually typed (with modifier keys, -backspace, etc resolved into text), [`xspy`][2] or [`logkeys`][3] might be -better for you. +### Programs that work well together with `xkbcat` -If you want to add timestamps to each line for logging purposes, I recommend -piping to the [moreutils package][4]'s `ts`. [These answers][5] feature -various other tools good for the purpose. + - If you want to add timestamps to each line for logging purposes, I recommend + piping to the [moreutils package][4]'s `ts`. [These answers][5] feature + various other tools good for the purpose. ## Versioning |
