diff options
author | Blake Lee <[email protected]> | 2022-07-15 20:04:17 -0400 |
---|---|---|
committer | Blake Lee <[email protected]> | 2022-07-15 20:04:17 -0400 |
commit | 310a8397003146e416e06d777e8404ea469f02bd (patch) | |
tree | 709e4f947e9a3eae1efc9fb5efaa598f7f49fa04 /docs | |
parent | b2650928eac06e3181ad07efe6ec55b2550f89b8 (diff) | |
download | Hyprland-310a8397003146e416e06d777e8404ea469f02bd.tar.gz Hyprland-310a8397003146e416e06d777e8404ea469f02bd.zip |
docs: add man pages
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Hyprland.1.rst | 75 | ||||
-rw-r--r-- | docs/hyprctl.1.rst | 131 |
2 files changed, 206 insertions, 0 deletions
diff --git a/docs/Hyprland.1.rst b/docs/Hyprland.1.rst new file mode 100644 index 00000000..78b2cda0 --- /dev/null +++ b/docs/Hyprland.1.rst @@ -0,0 +1,75 @@ +======== +Hyprland +======== + +--------------------------------- +Dynamic tiling Wayland compositor +--------------------------------- + +:Date: 15 Jul 2022 +:Copyright: Copyright (c) 2022, vaxerski +:Version: 0.7.1beta +:Manual section: 1 +:Manual group: HYPRLAND + +SYNOPSIS +======== + +``Hyprland`` [arg [...]]. + +DESCRIPTION +=========== + +``Hyprland`` is a dynamic tiling Wayland compositor based on +wlroots that doesn't sacrifice on its looks. + +NOTICE +====== + +Hyprland is still in pretty early development compared to some other Wayland compositors. + +Although Hyprland is pretty stable, it may have some bugs. + +CONFIGURATION +============= + +For configuration information please see <`https://github.com/hyprwm/Hyprland/wiki`>. + +LAUNCHING +========= + +You can launch Hyprland by either going into a TTY and executing ``Hyprland``, or with a login manager. + +`IMPORTANT`: Do `not` launch ``Hyprland`` with `root` permissions (don't `sudo`) + +Login managers are not officially supported, but here's a short compatibility list: + + * SDDM -> Works flawlessly. + * GDM -> Works with the caveat of crashing `Hyprland` on the first launch. + * ly -> Works with minor issues and/or caveats. + +OPTIONS +======= + +-h, --help + Show this help message. + +-c, --config + Specify config file to use. + +BUGS +==== + +Submit bug reports and feature requests online at: + + <`https://github.com/hyprwm/Hyprland/issues`> + +SEE ALSO +======== + +Sources at: <`https://github.com/hyprwm/Hyprland`> + +AUTHORS +======= + +Vaxerski <`https://github.com/vaxerski`> diff --git a/docs/hyprctl.1.rst b/docs/hyprctl.1.rst new file mode 100644 index 00000000..3b1e68fa --- /dev/null +++ b/docs/hyprctl.1.rst @@ -0,0 +1,131 @@ +======= +hyprctl +======= + +---------------------------------------------------------------- +Utility for controlling parts of Hyprland from a CLI or a script +---------------------------------------------------------------- + +:Date: 15 Jul 2022 +:Copyright: Copyright (c) 2022, vaxerski +:Version: 0.7.1beta +:Manual section: 1 +:Manual group: hyprctl + +SYNOPSIS +======== + +``hyprctl`` [(opt)flags] [command] [(opt)args] + +DESCRIPTION +=========== + +``hyprctl`` is a utility for controlling some parts of the compositor from a CLI or a script. +If you install with make install, or any package, it should automatically be installed. + +COMMANDS +======== + +Control + + ``dispatch`` + + Call a keybinding dispatcher with an argument. + + An argument must be present. + For dispatchers without parameters it can be anything. + + Returns: `ok` on success, and an error message on failure. + + Examples: + + ``hyprctl`` `dispatch exec kitty` + + ``hyprctl`` `dispatch pseudo x` + + ``keyword`` + + Call a config keyword dynamically. + + Returns: `ok` on success, and an error message on failure. + + Examples: + + ``hyprctl`` `keyword bind SUPER,0,pseudo` + + ``hyprctl`` `keyword general:border_size 10` + + ``reload`` + + Force a reload of the config file. + + ``kill`` + + Enter kill mode, where you can kill an app by clicking on it. + You can exit with ESCAPE. + +Info + + ``version`` + + Prints the hyprland version, meaning flags, commit and branch of build. + + ``monitors`` + + Lists all the outputs with their properties. + + ``workspaces`` + + Lists all workspaces with their properties. + + ``clients`` + + Lists all windows with their properties. + + ``devices`` + + Lists all connected keyboards and mice. + + ``activewindow`` + + Gets the active window name. + + ``layers`` + + Lists all the layers. + + ``splash`` + + Prints the current random splash. + +OPTIONS +======= + +--batch + Specify a batch of commands to execute. + + Example: + + ``hyprctl`` `--batch "keyword general:border_size 2 ; keyword general:gaps_out 20"` + + `;` separates the commands. + +-j + Outputs information in JSON. + +BUGS +==== + +Submit bug reports and feature requests online at: + + <`https://github.com/hyprwm/hyprctl/issues`> + +SEE ALSO +======== + +Sources at: <`https://github.com/hyprwm/hyprctl`> + +AUTHORS +======= + +Vaxerski <`https://github.com/vaxerski`> |