enum_of to_string l keys each value of l by its name.

mk_enum name ~doc ~docv l is the optional flag --name accepting an enum of choices defined by l. The term appends the choice list to doc.

logical_targets is each logical direction keyed by its name.

logical_leaves ~next ~prev is logical_targets with the doc string of each direction between the name and the direction.

spatial_targets is each spatial direction keyed by its name.

direction_targets is logical_targets and spatial_targets combined.

int_delta is the required leading DELTA positional: an absolute value (6) or a signed offset (-2).

float_delta is the required leading DELTA positional: an absolute value (0.55) or a signed offset (-0.05).

tag_arg is the required leading TAGS positional: indices, ranges, a bitmask, or the literal occupied.

tag_set is the required leading TAGS positional: indices, ranges, or a bitmask.

occupied_flag is the --occupied flag used to restrict tag operations.

policy_flag is the --take flag as a tag policy, Keep when absent.

follow_flag is the --follow flag, used to signal focus moves with the manipulated object.

swap_terms mk is the command and bind term pair of one swap leaf. mk builds the command from the target, the policy, and the follow flag.

case_flag is the -i / --ignore-case flag for a window match; regex patterns match case-insensitively when set.

device_pattern_flag is the --name REGEX flag for a PCRE regex on the input device name.

output_name_arg is the required leading OUTPUT_NAME positional.

output_flag is the optional --output NAME filter flag.

output_query mk is mk over the --output NAME option.

extent_conv converts an extent argument.

keybind_arg is the required trailing KEYBIND positional: modifiers, keysym, and/or button.

An optional --mode MODE flag naming the keymap mode a binding belongs to; None means the default mode.

mode_name_arg is the required MODE positional.

color_arg is the required trailing COLOR positional.

index_arg ~doc is the required trailing INDEX positional.

index_args ~doc is the required trailing INDEX list positional.

warp_flag is the exclusive flag pair --warp and --no-warp. The flag overrides the warp on focus configuration for one command.

pattern_term is title_flag, app_id_flag, identifier_flag, and case_flag in a Pattern.t. Each criterion is a PCRE regex. Will error if no flag is given.

setting_scope_term is the target scope of a setting command: the bare form for the selected tags on the focused output, --output NAME for every tag on one named output, and --all for every tag on every output. The term rejects the two flags together.

window_match_term is pattern_term, invert_flag, and scope_term in a Window_match.t. It rejects an empty pattern.

window_match_any_term is window_match_term, but it permits an empty pattern. Such a match selects every window in the scope.

target_any_window_term is window_match_any_term, and --all/--cycle to control the match selection.

target_one_window_term is window_match_any_term, and --cycle to control the match selection.

target_one_output_term is the output match flags, and --cycle to control the match selection. An empty pattern is the focused output.

target_any_output_term is target_one_output_term, and --all to act on every match.

tags_flag is the --tags TAGS option: indices, ranges, a bitmask, or the literal occupied.

presentation_flag is the exclusive flag group --float, --tile, --fullscreen, --windowed, --maximize, and --fake-fullscreen; it is None when the command line holds none of them.

extent_pos i ~docv ~doc is the required extent positional at i.

resize_to_flag is the --resize-to W,H option. Each half is a pixel size or a percentage of the usable area. The term rejects a list that does not hold two values.

move_to_flag is the --move-to X,Y option. Each half is a pixel offset from the top-left of the usable area, or a percentage of it. The term rejects a list that does not hold two values.

bool_state_flag name ~doc ~docv is the optional flag --name. The flag takes enabled or disabled.

accel_profile_flag is the --accel-profile flag accepting only valid profile names.

accel_speed_flag is the --accel-speed flag taking a speed in the range of -1.0 to 1.0.

button_map_flag name ~doc is the --name flag accepting a valid button map.

drag_lock_flag is the --drag-lock flag accepting a drag lock setting.

three_finger_drag_flag is the --three-finger-drag flag accepting a valid three finger drag setting.

click_method_flag is the --click-method flag accepting a valid click method.

natural_scroll_flag is the --natural-scroll flag to enable or disable natural scrolling.

left_handed_flag is the --left-handed flag to enable or disable left handed button layout.

middle_emulation_flag is the --middle-emulation flag to enable or disable middle-button emulation.

scroll_factor_flag is the --scroll-factor flag to set the scroll factor.

scroll_method_flag is the --scroll-method flag accepting a valid scroll method.

scroll_button_flag is the --scroll-button flag accepting a valid scroll button.

send_events_flag is the --send-events flag accepting a valid send event.

touchpad_rule is the set of flags that make up a touchpad rule with a non-empty set of settings.

mouse_rule is the set of flags that make up a mouse rule with a non-empty set of settings.

sticky_flag is the --sticky flag accepting a valid sticky scope.

label_arg is the required trailing LABEL positional.

swallow_flag is the --swallow flag accepting a valid role.

label_as_flag is the --label-as flag accepting a valid label.

scratchpad_flag is the --scratchpad flag accepting a group name.

spawn_position_flag is the --spawn-position flag accepting a valid position.

spawn_focus_flag is the --spawn-focus flag changes focus on spawn.

dispatch_command_ref is the function behind every command leaf.

dispatch_stream_ref is the function behind every subscribe leaf.

group ?exits ?man ?man_xrefs ?version ?default ~name ~doc cmds is a command that groups the subcommands cmds. Cmdliner evaluates default when the command line names no subcommand. The fallback term renders the group's help.

run_term term is the evaluation term of cmd without the command wrapper. It sends term's request body to oxbow, prints any reply, and exits by the outcome. Use it as the ?default of a command group.

cmd ~name ~doc term is a command that, when evaluated, sends term's request body to oxbow, prints any reply, and exits by the outcome.

stream_cmd ~name ~doc term is a command that streams subscribe events for term's kinds and output filter to stdout, one JSON line each, and exits by the outcome.

command_term term maps the term's command into a Command body.

bind_term term composes term's command with the to KEYBIND suffix and wraps the result in Keymap (Bind { keybind; command }).

cmd_pair ?bind ~name ~doc term is the cmd and bind_cmd pair of one leaf. bind replaces term on the bind side.

group_pair ?extra ?default ~name ~doc pairs is the cmd and bind_cmd pair of one group parent. extra appends the query-only leaves to the cmd side. default sets the bare-form term of the group.

render_event line renders line as key=value pairs. Is line unchanged if not valid JSON.

render_lines ?fields ~expand json formats a record reply as an aligned table. One column per key, one row per item. fields selects and orders the columns. Without expand, scalar cells cap at 15 characters. A reply with no rows prints as raw JSON.

query_term ?render query maps the query into a Query body. render formats the JSON reply for display. The term adds a --json flag. With --json, or without render, oxctl prints the raw JSON reply.

const_leaves l is the cmd_pair of each constant leaf in l: a name, a doc, and a fixed command.