netevent(1)

🦋 Name 🦋

okay so bestie, meet netevent from the netevent Manual — it's the icon for showing, sharing, and cloning evdev event devices. literally the whole vibe is event devices, but make them shareable 💅.

🌈 SYNOPSIS 🌈

netevent show DEVICE [COUNT]

netevent cat [OPTIONS] DEVICE

netevent create [OPTIONS] DEVICE

netevent daemon [OPTIONS] SOCKETNAME

netevent command SOCKETNAME COMMAND

✨ OPTIONS ✨

Some options can be used on multiple commands.

🌟 All subcommands 🌟

• -h, --help — show a short usage message.
• -V, --version — show the netevent version string.

🎀 netevent create 🎀

• --duplicates=MODE — change how duplicate devices are treated. MODE can be:
  • reject — the default. If a device with an already existing ID is received, treat this as an error and exit.
  • resume — assume the source was restarted and is sending the same device again. Currently this does not verify whether that's actually the case.
  • replace — remove the previous device and replace it with the new one. Since resume does not verify the device, this is the preferred mode if the destination event device node does not need to be persistent.
• --listen=SOCKETNAME — rather than reading from stdin, listen on the specified unix (or abstract if prefixed with "@") socket.
• --connect — used together with --listen, this causes netevent to first try to connect to the socket. If successful, it'll pass events through to the instance it connected to. Otherwise, if --daemonize was also specified, it'll fork off a new instance to which it connects first. If --daemonize was not specified, it'll return an error code.
• --on-close=end|accept — when using --listen, this option decides how to proceed after a client disconnects. The default is to accept a new client and resume according to the configured --duplicates mode. Alternatively, end can be used to cause the main loop to exit successfully.
• --daemonize — run as a background daemon. When using --listen it may also be desirable to run netevent in the background.

💫 netevent cat and netevent create 💫

• -l, --legacy — use a netevent 1 compatible protocol.
• --no-legacy — use a netevent 2 compatible protocol. This is the default.

🫶 netevent cat and netevent show 🫶

• -g, --grab — grab the input device to prevent it from also firing events on the system. This is the default.
• -G, --no-grab — do not grab the input device.

🧚 netevent daemon 🧚

• -s, --source=FILE — run commands from the specified file. Can be specified multiple times. This can be used to fully setup the daemon with outputs, devices and hotkeys. See the DAEMON COMMANDS section for details.

👑 DAEMON COMMANDS 👑

• action set EVENT COMMAND — queue a command when an event occurs. The command can contain semicolons to execute multiple commands. Multiple parameters will be concatenated with a space.

The following events currently exist:

• output-changed — executed on a use command or when an output device fails and a fallback is being activated.
• write-changed — executed whenever the write-events command is used.
• grab-changed — executed whenever the grab-devices command is used.
• device-lost — executed whenever a device we are reading from disappears.

These commands are executed immediately after such an event has occurred. Note that there's nothing preventing you from building an endless loop by adding event-triggering commands in this place, so, just don't. 😭

• action remove EVENT — remove a command bound to an event.
• nop — nothing. Bind as hotkey to ignore an event and be explicit about it.
• grab-devices on|off|toggle — set the grabbing state. Controls whether events are also fired locally.
• write-events on|off|toggle — set the writing state. Controls whether events are passed to the current output.
• grab on|off|toggle — deprecated. This is the old command which has been superseded by the pair grab-devices and write-events.
• use OUTPUT — set the current output.
• output add [--resume] OUTPUT_NAME OUTPUT_SPEC — add a new output. OUTPUT_NAME can be an arbitrary name used later for output remove or use commands. OUTPUT_SPEC can currently be either a file/fifo, a command to pipe to when prefixed with exec:, or the name of a unix or abstract socket when using unix:/path or unix:@abstractName. See the examples above.

If the --resume parameter is provided, assume the destination already knows all the existing devices and do not recreate them.

• output remove OUTPUT_NAME — remove an existing output.
• output use OUTPUT_NAME — long version of use OUTPUT_NAME.
• exec COMMAND — execute a command. Mostly useful for hotkeys.
• exec& COMMAND — execute a command in the background.
• source FILE — execute daemon commands from a file.
• quit — cause the daemon to quit.
• hotkey add DEVICE_NAME EVENT COMMAND — add a hotkey to an existing device. DEVICE is the name used when adding the device via device add. EVENT is an event specification of the form TYPE:CODE:VALUE, as printed out by netevent show. COMMAND is a daemon command to be executed when the event is read.
• hotkey remove DEVICE_NAME EVDENT — remove a hotkey for an event on a device. yes bestie, it literally says EVDENT in the original, and I'm keeping it exactly 💀.
• device add DEVICE_NAME EVENT_DEVICE_FILE — register an evdev device.
• device remove DEVICE_NAME — remove an evdev device.
• device rename DEVICE_NAME NEW_NAME — rename a device. Useful when adding output of which the devices should have a recognizable name.
• device reset-name DEVICE_NAME — reset a device's name to its default.
• device set-persistent DEVICE_NAME BOOL — change whether a device's removal should be announced to the outputs.
• info — show current inputs, outputs, devices and hotkeys.

🌸 DAEMON ENVIRONMENT VARIABLES 🌸

The daemon will maintain the following environment variables to provide some information to commands executed via an exec hotkey:

• NETEVENT_OUTPUT_NAME — this will contain the name of the output currently in use.
• NETEVENT_GRABBING — this will be "1" if the daemon is currently grabbing, or "0" if it is not. Note that with multiple input devices, failure to grab an input device will cause this variable to be in an undefined state. 🫠
• NETEVENT_WRITING — this will be "1" if the daemon is currently writing, or "0" if it is not.

🌈 KNOWN INTERACTIONS WITH X11 🌈

When using the synaptics X11 driver, it can be configured to grab event devices, which will prevent netevent from grabbing them. You may need to change the GrabEventDevice option in your xorg.conf.

💀 BUGS 💀

Please report bugs to via <https://github.com/Blub/netevent/issues>. 🐛

💜 Author 💜

Wolfgang Bumiller

---

okay that's the whole page, bestie 🎀 footer check: it's just netevent(1), the netevent Manual name is folded up top, and this copy has no separate version or date stamp, so no date to give you. byeeeeee 💅✨