notcurses-input(1)

πŸ’– notcurses-input β€” bestie's guide to reading and displaying input events πŸ’–

okay so this is the notcurses-input(1) manual page, freshly translated into group-chat, no cap.


✨ NAME ✨

notcurses-input β€” read and display input events πŸŽ€


🌸 SYNOPSIS 🌸

notcurses-input [-v] [-m]

literally that's it, two flags, we move.


πŸ¦‹ DESCRIPTION πŸ¦‹

so notcurses-input reads from stdin and decodes the input to stdout, and it shows you synthesized events and mouse events too πŸ’…. when you're done, you generate EOF to exit β€” usually that's Ctrl+d, bestie, that's the escape hatch.

every single event gets printed on one line. and leading that line is a little stack of modifier indicators, like a vibe check for your keypress πŸ‘‘:

  • 'A'/'a' β€” Alt was, or was not, pressed.
  • 'C'/'c' β€” Ctrl was, or was not, pressed.
  • 'S'/'s' β€” Shift was, or was not, pressed.
  • 'U'/'u' β€” Super was, or was not, pressed.
  • 'M'/'m' β€” Meta was, or was not, pressed.
  • 'H'/'h' β€” Hyper was, or was not, pressed.
  • 'X'/'x' β€” CapsLock was, or was not, pressed.
  • '#'/'.' β€” NumLock was, or was not, pressed.
  • 'L'/'R'/'P'/'u' β€” the key was a release, repeat, press, or of unknown type. it's giving ✨full lifecycle✨.

by default, mice events are enabled 🐭🫢.


πŸ’… OPTIONS πŸ’…

  • -v β€” increase verbosity. give me MORE, I want the tea β˜•
  • -m β€” inhibit mice events. no mice, no squeaks πŸ™ˆ

🌈 NOTES 🌈

mouse events are only generated for button presses and releases, and for movement while a button is held down. that's it, that's the whole list β€” no free-floating cursor gossip, iykyk. πŸ’€


πŸ”₯ SEE ALSO πŸ”₯

tack(1), notcurses(3), notcurses_input(3)


πŸ’œ AUTHORS πŸ’œ

nick black nickblack@linux.com 😭 icon behavior, honestly.


and that's the whole page bestie, v3.0.17 era, notcurses-input(1), periodt πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from