aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/hyprctl.1.rst
diff options
context:
space:
mode:
authorBlake Lee <[email protected]>2022-07-18 18:56:46 -0400
committerBlake Lee <[email protected]>2022-07-18 18:56:46 -0400
commita312f8e0ac683e1bd61d499f267845f8510b9881 (patch)
tree7c3e2862e23fa4ffd6dfb35ce689d141101d933f /docs/hyprctl.1.rst
parent88506d428485e25b609d90cd46da16d5ccf4a317 (diff)
downloadHyprland-a312f8e0ac683e1bd61d499f267845f8510b9881.tar.gz
Hyprland-a312f8e0ac683e1bd61d499f267845f8510b9881.zip
replace `rst2man` with `pandoc`
Diffstat (limited to 'docs/hyprctl.1.rst')
-rw-r--r--docs/hyprctl.1.rst123
1 files changed, 57 insertions, 66 deletions
diff --git a/docs/hyprctl.1.rst b/docs/hyprctl.1.rst
index 42606bd4..4db0807e 100644
--- a/docs/hyprctl.1.rst
+++ b/docs/hyprctl.1.rst
@@ -1,130 +1,121 @@
-=======
-hyprctl
-=======
+:title: hyprctl(1)
+:author: Vaxerski <*https://github.com/vaxerski*>
-----------------------------------------------------------------
-Utility for controlling parts of Hyprland from a CLI or a script
-----------------------------------------------------------------
+NAME
+====
-:Date: 15 Jul 2022
-:Copyright: Copyright (c) 2022, vaxerski
-:Version: 0.7.1beta
-:Manual section: 1
-:Manual group: hyprctl
+hyprctl - Utility for controlling parts of Hyprland from a CLI or a script
SYNOPSIS
========
-``hyprctl`` [(opt)flags] [command] [(opt)args]
+**hyprctl** [*(opt)flags*] [**command**] [*(opt)args*]
DESCRIPTION
===========
-``hyprctl`` is a utility for controlling some parts of the compositor from a CLI or a script.
-
-COMMANDS
-========
-
-Control
-
- ``dispatch``
+**hyprctl** is a utility for controlling some parts of the compositor from a CLI or a script.
- Call a dispatcher with an argument.
+CONTROL COMMANDS
+================
- An argument must be present.
- For dispatchers without parameters it can be anything.
+**dispatch**
- Returns: `ok` on success, and an error message on failure.
+ Call a dispatcher with an argument.
- Examples:
+ An argument must be present.
+ For dispatchers without parameters it can be anything.
- ``hyprctl`` `dispatch exec kitty`
+ Returns: *ok* on success, and an error message on failure.
- ``hyprctl`` `dispatch pseudo x`
+ Examples:
+ **hyprctl** *dispatch exec kitty*
- ``keyword``
+ **hyprctl** *dispatch pseudo x*
- Set a config keyword dynamically.
+**keyword**
- Returns: `ok` on success, and an error message on failure.
+ Set a config keyword dynamically.
- Examples:
+ Returns: *ok* on success, and an error message on failure.
- ``hyprctl`` `keyword bind SUPER,0,pseudo`
+ Examples:
+ **hyprctl** *keyword bind SUPER,0,pseudo*
- ``hyprctl`` `keyword general:border_size 10`
+ **hyprctl** *keyword general:border_size 10*
- ``reload``
+**reload**
- Force a reload of the config file.
+ Force a reload of the config file.
- ``kill``
+**kill**
- Enter kill mode, where you can kill an app by clicking on it.
- You can exit by pressing ESCAPE.
+ Enter kill mode, where you can kill an app by clicking on it.
+ You can exit by pressing ESCAPE.
-Info
+INFO COMMANDS
+=============
- ``version``
+**version**
- Prints the Hyprland version, flags, commit and branch of build.
+ Prints the Hyprland version, flags, commit and branch of build.
- ``monitors``
+**monitors**
- Lists all the outputs with their properties.
+ Lists all the outputs with their properties.
- ``workspaces``
+**workspaces**
- Lists all workspaces with their properties.
+ Lists all workspaces with their properties.
- ``clients``
+**clients**
- Lists all windows with their properties.
+ Lists all windows with their properties.
- ``devices``
+**devices**
- Lists all connected input devices.
+ Lists all connected input devices.
- ``activewindow``
+**activewindow**
- Returns the active window name.
+ Returns the active window name.
- ``layers``
+**layers**
- Lists all the layers.
+ Lists all the layers.
- ``splash``
+**splash**
- Returns the current random splash.
+ Returns the current random splash.
OPTIONS
=======
---batch
+**--batch**
+
Specify a batch of commands to execute.
Example:
+ **hyprctl** *--batch "keyword general:border_size 2 ; keyword general:gaps_out 20"*
- ``hyprctl`` `--batch "keyword general:border_size 2 ; keyword general:gaps_out 20"`
+ *;* separates the commands.
- `;` separates the commands.
+**-j**
--j
Outputs information in JSON.
BUGS
====
-Submit bug reports and feature requests online at:
-
- <`https://github.com/hyprwm/hyprctl/issues`>
+Submit bug reports and request features online at:
+ <*https://github.com/hyprwm/Hyprland/issues*>
SEE ALSO
========
-Sources at: <`https://github.com/hyprwm/hyprctl`>
+Sources at: <*https://github.com/hyprwm/Hyprland*>
-AUTHORS
-=======
+COPYRIGHT
+=========
-Vaxerski <`https://github.com/vaxerski`>
+Copyright (c) 2022, vaxerski