Hyprland/docs/hyprctl.1.rst

122 lines
2.0 KiB
ReStructuredText
Raw Normal View History

2022-07-19 01:56:46 +03:00
:title: hyprctl(1)
:author: Vaxerski <*https://github.com/vaxerski*>
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
NAME
====
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
hyprctl - Utility for controlling parts of Hyprland from a CLI or a script
2022-07-16 03:04:17 +03:00
SYNOPSIS
========
2022-07-19 01:56:46 +03:00
**hyprctl** [*(opt)flags*] [**command**] [*(opt)args*]
2022-07-16 03:04:17 +03:00
DESCRIPTION
===========
2022-07-19 01:56:46 +03:00
**hyprctl** is a utility for controlling some parts of the compositor from a CLI or a script.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
CONTROL COMMANDS
================
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**dispatch**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Call a dispatcher with an argument.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
An argument must be present.
For dispatchers without parameters it can be anything.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Returns: *ok* on success, and an error message on failure.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Examples:
**hyprctl** *dispatch exec kitty*
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**hyprctl** *dispatch pseudo x*
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**keyword**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Set a config keyword dynamically.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Returns: *ok* on success, and an error message on failure.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Examples:
**hyprctl** *keyword bind SUPER,0,pseudo*
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**hyprctl** *keyword general:border_size 10*
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**reload**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Force a reload of the config file.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**kill**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Enter kill mode, where you can kill an app by clicking on it.
You can exit by pressing ESCAPE.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
INFO COMMANDS
=============
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**version**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Prints the Hyprland version, flags, commit and branch of build.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**monitors**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Lists all the outputs with their properties.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**workspaces**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Lists all workspaces with their properties.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**clients**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Lists all windows with their properties.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**devices**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Lists all connected input devices.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**activewindow**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Returns the active window name.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**layers**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Lists all the layers.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**splash**
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Returns the current random splash.
2022-07-16 03:04:17 +03:00
OPTIONS
=======
2022-07-19 01:56:46 +03:00
**--batch**
2022-07-16 03:04:17 +03:00
Specify a batch of commands to execute.
Example:
2022-07-19 01:56:46 +03:00
**hyprctl** *--batch "keyword general:border_size 2 ; keyword general:gaps_out 20"*
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
*;* separates the commands.
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
**-j**
2022-07-16 03:04:17 +03:00
Outputs information in JSON.
BUGS
====
2022-07-19 01:56:46 +03:00
Submit bug reports and request features online at:
<*https://github.com/hyprwm/Hyprland/issues*>
2022-07-16 03:04:17 +03:00
SEE ALSO
========
2022-07-19 01:56:46 +03:00
Sources at: <*https://github.com/hyprwm/Hyprland*>
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
COPYRIGHT
=========
2022-07-16 03:04:17 +03:00
2022-07-19 01:56:46 +03:00
Copyright (c) 2022, vaxerski