From a936a7e3db45a06143849d6a5fbacf4cb9ec1a98 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Mon, 9 Feb 2026 11:56:27 +0000 Subject: [PATCH] add help mds --- x32-help.md | 194 +++++++++++++++++++++++++++++++++++++++++++++++++++ xair-help.md | 126 +++++++++++++++++++++++++++++++++ 2 files changed, 320 insertions(+) create mode 100644 x32-help.md create mode 100644 xair-help.md diff --git a/x32-help.md b/x32-help.md new file mode 100644 index 0000000..8081168 --- /dev/null +++ b/x32-help.md @@ -0,0 +1,194 @@ +```console +Usage: x32-cli [flags] + +A CLI to control Behringer X32 mixers. + +Flags: + -h, --help Show context-sensitive help. + -H, --host="mixer.local" The host of the X32 device ($X32_CLI_HOST). + -P, --port=10023 The port of the X32 device ($X32_CLI_PORT). + -T, --timeout=100ms Timeout for OSC operations ($X32_CLI_TIMEOUT). + -L, --loglevel="warn" Log level for the CLI ($X32_CLI_LOGLEVEL). + -v, --version Print x32-cli version information and quit + +Commands: + completion (c) Generate shell completion scripts. + +Raw + raw Send raw OSC messages to the mixer. + +Main + main mute Get or set the mute state of the Main L/R output. + main fader Get or set the fader level of the Main L/R output. + main fadein Fade in the Main L/R output over a specified duration. + main fadeout Fade out the Main L/R output over a specified duration. + main eq on Get or set the EQ on/off state of the Main L/R output. + main eq gain Get or set the gain of the specified EQ band. + main eq freq Get or set the frequency of the specified EQ band. + main eq q Get or set the Q factor of the specified EQ band. + main eq type Get or set the type of the specified EQ band. + main comp on Get or set the compressor on/off state of the Main L/R + output. + main comp mode Get or set the compressor mode of the Main L/R output. + main comp threshold Get or set the compressor threshold of the Main L/R + output. + main comp ratio Get or set the compressor ratio of the Main L/R output. + main comp mix Get or set the compressor mix level of the Main L/R + output. + main comp makeup Get or set the compressor makeup gain of the Main L/R + output. + main comp attack Get or set the compressor attack time of the Main L/R + output. + main comp hold Get or set the compressor hold time of the Main L/R + output. + main comp release Get or set the compressor release time of the Main L/R + output. + +MainMono + mainmono mute Get or set the mute state of the Main Mono output. + mainmono fader Get or set the fader level of the Main Mono output. + mainmono fadein Fade in the Main Mono output over a specified + duration. + mainmono fadeout Fade out the Main Mono output over a specified + duration. + mainmono eq on Get or set the EQ on/off state of the Main Mono + output. + mainmono eq gain Get or set the gain of the specified EQ band. + mainmono eq freq Get or set the frequency of the specified EQ band. + mainmono eq q Get or set the Q factor of the specified EQ band. + mainmono eq type Get or set the type of the specified EQ band. + mainmono comp on Get or set the compressor on/off state of the Main + Mono output. + mainmono comp mode Get or set the compressor mode of the Main Mono + output. + mainmono comp threshold Get or set the compressor threshold of the Main + Mono output. + mainmono comp ratio Get or set the compressor ratio of the Main Mono + output. + mainmono comp mix Get or set the compressor mix level of the Main + Mono output. + mainmono comp makeup Get or set the compressor makeup gain of the Main + Mono output. + mainmono comp attack Get or set the compressor attack time of the Main + Mono output. + mainmono comp hold Get or set the compressor hold time of the Main + Mono output. + mainmono comp release Get or set the compressor release time of the Main + Mono output. + +Matrix + matrix mute Get or set the mute state of the Matrix + output. + matrix fader Get or set the fader level of the Matrix + output. + matrix fadein Fade in the Matrix output over a specified + duration. + matrix fadeout Fade out the Matrix output over a specified + duration. + matrix eq on Get or set the EQ on/off state of the Matrix + output. + matrix eq gain Get or set the gain of the specified EQ band. + matrix eq freq Get or set the frequency of the specified EQ + band. + matrix eq q Get or set the Q factor of the specified EQ + band. + matrix eq type Get or set the type of the specified EQ band. + matrix comp on Get or set the compressor on/off state of the + Matrix output. + matrix comp mode Get or set the compressor mode of the Matrix + output. + matrix comp threshold Get or set the compressor threshold of the + Matrix output. + matrix comp ratio Get or set the compressor ratio of the Matrix + output. + matrix comp mix Get or set the compressor mix level of the + Matrix output. + matrix comp makeup Get or set the compressor makeup gain of the + Matrix output. + matrix comp attack Get or set the compressor attack time of the + Matrix output. + matrix comp hold Get or set the compressor hold time of the + Matrix output. + matrix comp release Get or set the compressor release time of the + Matrix output. + +Strip + strip mute Get or set the mute state of the strip. + strip fader Get or set the fader level of the strip. + strip fadein Fade in the strip over a specified duration. + strip fadeout Fade out the strip over a specified duration. + strip send Get or set the send level for a specific bus. + strip name Get or set the name of the strip. + strip gate on Get or set the gate on/off state of the strip. + strip gate mode Get or set the gate mode of the strip. + strip gate threshold Get or set the gate threshold of the strip. + strip gate range Get or set the gate range of the strip. + strip gate attack Get or set the gate attack time of the strip. + strip gate hold Get or set the gate hold time of the strip. + strip gate release Get or set the gate release time of the strip. + strip eq on Get or set the EQ on/off state of the strip. + strip eq gain Get or set the gain of the EQ band. + strip eq freq Get or set the frequency of the EQ band. + strip eq q Get or set the Q factor of the EQ band. + strip eq type Get or set the type of the EQ band. + strip comp on Get or set the compressor on/off state of the + strip. + strip comp mode Get or set the compressor mode of the strip. + strip comp threshold Get or set the compressor threshold of the + strip. + strip comp ratio Get or set the compressor ratio of the strip. + strip comp mix Get or set the compressor mix of the strip. + strip comp makeup Get or set the compressor makeup gain of the + strip. + strip comp attack Get or set the compressor attack time of the + strip. + strip comp hold Get or set the compressor hold time of the + strip. + strip comp release Get or set the compressor release time of the + strip. + +Bus + bus mute Get or set the mute state of the bus. + bus fader Get or set the fader level of the bus. + bus fadein Fade in the bus over a specified duration. + bus fadeout Fade out the bus over a specified duration. + bus name Get or set the name of the bus. + bus eq on Get or set the EQ on/off state of the bus. + bus eq mode Get or set the EQ mode of the bus (peq, geq or + teq). + bus eq gain Get or set the gain of the EQ band. + bus eq freq Get or set the frequency of the EQ band. + bus eq q Get or set the Q factor of the EQ band. + bus eq type Get or set the type of the EQ band (lcut, lshv, + peq, veq, hshv, hcut). + bus comp on Get or set the compressor on/off state of the + bus. + bus comp mode Get or set the compressor mode of the bus (comp, + exp). + bus comp threshold Get or set the compressor threshold of the bus + (in dB). + bus comp ratio Get or set the compressor ratio of the bus. + bus comp mix Get or set the compressor mix level of the bus + (in %). + bus comp makeup Get or set the compressor makeup gain of the bus + (in dB). + bus comp attack Get or set the compressor attack time of the bus + (in ms). + bus comp hold Get or set the compressor hold time of the bus + (in ms). + bus comp release Get or set the compressor release time of the + bus (in ms). + +Headamp + headamp gain Get or set the gain of the headamp. + headamp phantom Get or set the phantom power state of the headamp. + +Snapshot + snapshot list List all snapshots. + snapshot name Get or set the name of a snapshot. + snapshot save Save the current mixer state to a snapshot. + snapshot load Load a mixer state from a snapshot. + snapshot delete Delete a snapshot. + +Run "x32-cli --help" for more information on a command. +``` diff --git a/xair-help.md b/xair-help.md new file mode 100644 index 0000000..400d4c7 --- /dev/null +++ b/xair-help.md @@ -0,0 +1,126 @@ +```console +Usage: xair-cli [flags] + +A CLI to control Behringer X-Air mixers. + +Flags: + -h, --help Show context-sensitive help. + -H, --host="mixer.local" The host of the X-Air device ($XAIR_CLI_HOST). + -P, --port=10024 The port of the X-Air device ($XAIR_CLI_PORT). + -T, --timeout=100ms Timeout for OSC operations ($XAIR_CLI_TIMEOUT). + -L, --loglevel="warn" Log level for the CLI ($XAIR_CLI_LOGLEVEL). + -v, --version Print xair-cli version information and quit + +Commands: + completion (c) Generate shell completion scripts. + +Raw + raw Send raw OSC messages to the mixer. + +Main + main mute Get or set the mute state of the Main L/R output. + main fader Get or set the fader level of the Main L/R output. + main fadein Fade in the Main L/R output over a specified duration. + main fadeout Fade out the Main L/R output over a specified duration. + main eq on Get or set the EQ on/off state of the Main L/R output. + main eq gain Get or set the gain of the specified EQ band. + main eq freq Get or set the frequency of the specified EQ band. + main eq q Get or set the Q factor of the specified EQ band. + main eq type Get or set the type of the specified EQ band. + main comp on Get or set the compressor on/off state of the Main L/R + output. + main comp mode Get or set the compressor mode of the Main L/R output. + main comp threshold Get or set the compressor threshold of the Main L/R + output. + main comp ratio Get or set the compressor ratio of the Main L/R output. + main comp mix Get or set the compressor mix level of the Main L/R + output. + main comp makeup Get or set the compressor makeup gain of the Main L/R + output. + main comp attack Get or set the compressor attack time of the Main L/R + output. + main comp hold Get or set the compressor hold time of the Main L/R + output. + main comp release Get or set the compressor release time of the Main L/R + output. + +Strip + strip mute Get or set the mute state of the strip. + strip fader Get or set the fader level of the strip. + strip fadein Fade in the strip over a specified duration. + strip fadeout Fade out the strip over a specified duration. + strip send Get or set the send level for a specific bus. + strip name Get or set the name of the strip. + strip gate on Get or set the gate on/off state of the strip. + strip gate mode Get or set the gate mode of the strip. + strip gate threshold Get or set the gate threshold of the strip. + strip gate range Get or set the gate range of the strip. + strip gate attack Get or set the gate attack time of the strip. + strip gate hold Get or set the gate hold time of the strip. + strip gate release Get or set the gate release time of the strip. + strip eq on Get or set the EQ on/off state of the strip. + strip eq gain Get or set the gain of the EQ band. + strip eq freq Get or set the frequency of the EQ band. + strip eq q Get or set the Q factor of the EQ band. + strip eq type Get or set the type of the EQ band. + strip comp on Get or set the compressor on/off state of the + strip. + strip comp mode Get or set the compressor mode of the strip. + strip comp threshold Get or set the compressor threshold of the + strip. + strip comp ratio Get or set the compressor ratio of the strip. + strip comp mix Get or set the compressor mix of the strip. + strip comp makeup Get or set the compressor makeup gain of the + strip. + strip comp attack Get or set the compressor attack time of the + strip. + strip comp hold Get or set the compressor hold time of the + strip. + strip comp release Get or set the compressor release time of the + strip. + +Bus + bus mute Get or set the mute state of the bus. + bus fader Get or set the fader level of the bus. + bus fadein Fade in the bus over a specified duration. + bus fadeout Fade out the bus over a specified duration. + bus name Get or set the name of the bus. + bus eq on Get or set the EQ on/off state of the bus. + bus eq mode Get or set the EQ mode of the bus (peq, geq or + teq). + bus eq gain Get or set the gain of the EQ band. + bus eq freq Get or set the frequency of the EQ band. + bus eq q Get or set the Q factor of the EQ band. + bus eq type Get or set the type of the EQ band (lcut, lshv, + peq, veq, hshv, hcut). + bus comp on Get or set the compressor on/off state of the + bus. + bus comp mode Get or set the compressor mode of the bus (comp, + exp). + bus comp threshold Get or set the compressor threshold of the bus + (in dB). + bus comp ratio Get or set the compressor ratio of the bus. + bus comp mix Get or set the compressor mix level of the bus + (in %). + bus comp makeup Get or set the compressor makeup gain of the bus + (in dB). + bus comp attack Get or set the compressor attack time of the bus + (in ms). + bus comp hold Get or set the compressor hold time of the bus + (in ms). + bus comp release Get or set the compressor release time of the + bus (in ms). + +Headamp + headamp gain Get or set the gain of the headamp. + headamp phantom Get or set the phantom power state of the headamp. + +Snapshot + snapshot list List all snapshots. + snapshot name Get or set the name of a snapshot. + snapshot save Save the current mixer state to a snapshot. + snapshot load Load a mixer state from a snapshot. + snapshot delete Delete a snapshot. + +Run "xair-cli --help" for more information on a command. +```