somewm-client Reference somewm-only
IPC command-line tool for controlling SomeWM. This is SomeWM's equivalent to AwesomeWM's awesome-client, but uses a different protocol and command set.
Usage
somewm-client <command> [arguments...]
General Commands
| Command | Description |
|---|
ping | Check if SomeWM is running |
version | Show SomeWM version |
eval <code> | Evaluate Lua code and return result |
Client Commands
Commands for window management. Client IDs are simple integers (1, 2, 3...) assigned when windows open. IDs increment but don't reuse within a session, and reset when the compositor restarts.
| Command | Description |
|---|
client list | List all clients (windows) |
client focus <id> | Focus client by ID |
client close <id> | Close client by ID |
client minimize <id> | Minimize client |
client maximize <id> | Maximize client |
client fullscreen <id> | Toggle fullscreen |
client floating <id> | Toggle floating |
client ontop <id> | Toggle always-on-top |
client sticky <id> | Toggle sticky (visible on all tags) |
Tag Commands
| Command | Description |
|---|
tag list | List all tags |
tag view <name> | View tag by name |
tag viewidx <n> | View tag by index (1-based) |
Screen Commands
| Command | Description |
|---|
screen list | List all screens |
screen focus <n> | Focus screen by index |
Commands for input device configuration.
| Command | Description |
|---|
input <property> | Get input property value |
input <property> <value> | Set input property value |
Available properties: tap_to_click, tap_and_drag, drag_lock, tap_3fg_drag, natural_scrolling, disable_while_typing, dwtp, left_handed, middle_button_emulation, scroll_method, scroll_button, scroll_button_lock, click_method, send_events_mode, accel_profile, accel_speed, tap_button_map, clickfinger_button_map, keyboard_repeat_rate, keyboard_repeat_delay, xkb_layout, xkb_variant, xkb_options, numlock
These commands set global input defaults. Per-device rules configured via awful.input.rules take priority over global settings. See awful.input Reference for details.
Screenshot Commands
| Command | Description |
|---|
screenshot | Take full screenshot |
screenshot <filename> | Save screenshot to file |
Session Commands
| Command | Description |
|---|
lock | Lock the session |
Examples
somewm-client ping
somewm-client client list
somewm-client client focus 1
somewm-client input tap_to_click 1
somewm-client eval "return client.focus and client.focus.name"
somewm-client tag viewidx 3
somewm-client lock
Exit Codes
| Code | Meaning |
|---|
| 0 | Success |
| 1 | Connection failed |
| 2 | Command failed |
| 3 | Invalid arguments |
See Also