docs: add man pages

This commit is contained in:
Blake Lee 2022-07-15 20:04:17 -04:00
parent b2650928ea
commit 310a839700
No known key found for this signature in database
GPG Key ID: 87157C329108F09E
3 changed files with 208 additions and 0 deletions

View File

@ -124,6 +124,8 @@ install:
cp ./assets/wall_4K.png ${PREFIX}/share/hyprland
cp ./assets/wall_8K.png ${PREFIX}/share/hyprland
rst2man ./docs/hyprctl.1.rst | gzip -c > /usr/share/man/man1/hyprctl.1.gz
rst2man ./docs/Hyprland.1.rst | gzip -c > /usr/share/man/man1/Hyprland.1.gz
uninstall:
rm -f ${PREFIX}/share/wayland-sessions/hyprland.desktop

75
docs/Hyprland.1.rst Normal file
View File

@ -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`>

131
docs/hyprctl.1.rst Normal file
View File

@ -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`>