Merge pull request #379 from volitank/main

docs: add man pages

Makefile

@@ -9,6 +9,8 @@ PKGS = wlroots wayland-server xcb xkbcommon libinput
 CFLAGS += $(foreach p,$(PKGS),$(shell pkg-config --cflags $(p)))
 LDLIBS += $(foreach p,$(PKGS),$(shell pkg-config --libs $(p)))
 
+DATE=$(shell date "+%d %b %Y")
+
 xdg-shell-protocol.h:
 	$(WAYLAND_SCANNER) server-header \
 		$(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
@@ -124,6 +126,7 @@ install:
 	cp ./assets/wall_4K.png ${PREFIX}/share/hyprland
 	cp ./assets/wall_8K.png ${PREFIX}/share/hyprland
 
+	make man
 
 uninstall:
 	rm -f ${PREFIX}/share/wayland-sessions/hyprland.desktop
@@ -148,3 +151,20 @@ config:
 	cd subprojects/wlroots && ninja -C build/
 
 	cd subprojects/wlroots && ninja -C build/ install
+
+man:
+	pandoc ./docs/Hyprland.1.rst \
+		--standalone \
+		--variable=header:"Hyprland User Manual" \
+		--variable=date:"${DATE}" \
+		--variable=section:1 \
+		--from rst \
+		--to man | gzip -c > /usr/share/man/man1/Hyprland.1.gz
+
+	pandoc ./docs/hyprctl.1.rst \
+		--standalone \
+		--variable=header:"hyprctl User Manual" \
+		--variable=date:"${DATE}" \
+		--variable=section:1 \
+		--from rst \
+		--to man | gzip -c > /usr/share/man/man1/hyprctl.1.gz

docs/Hyprland.1.rst

@@ -0,0 +1,58 @@
+:title: Hyprland
+:author: Vaxerski <*https://github.com/vaxerski*>
+
+NAME
+====
+
+Hyprland - Dynamic tiling Wayland compositor
+
+SYNOPSIS
+========
+
+**Hyprland** [*arg [...]*].
+
+DESCRIPTION
+===========
+
+**Hyprland** is a dynamic tiling Wayland compositor based on
+wlroots that doesn't sacrifice on its looks.
+
+You can launch Hyprland by either going into a TTY and
+executing **Hyprland**, or with a login manager.
+
+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*>.
+
+OPTIONS
+=======
+
+**-h**, **--help**
+    Show command usage.
+
+**-c**, **--config**
+    Specify config file to use.
+
+BUGS
+====
+
+Submit bug reports and request features online at:
+    <*https://github.com/hyprwm/Hyprland/issues*>
+
+SEE ALSO
+========
+
+Sources at: <*https://github.com/hyprwm/Hyprland*>
+
+COPYRIGHT
+=========
+
+Copyright (c) 2022, vaxerski

docs/hyprctl.1.rst

@@ -0,0 +1,121 @@
+:title: hyprctl(1)
+:author: Vaxerski <*https://github.com/vaxerski*>
+
+NAME
+====
+
+hyprctl - Utility for controlling parts of Hyprland from a CLI or a script
+
+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.
+
+CONTROL COMMANDS
+================
+
+**dispatch**
+
+    Call a 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**
+
+    Set 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 by pressing ESCAPE.
+
+INFO COMMANDS
+=============
+
+**version**
+
+    Prints the Hyprland version, 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 input devices.
+
+**activewindow**
+
+    Returns the active window name.
+
+**layers**
+
+    Lists all the layers.
+
+**splash**
+
+    Returns 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 request features online at:
+    <*https://github.com/hyprwm/Hyprland/issues*>
+
+SEE ALSO
+========
+
+Sources at: <*https://github.com/hyprwm/Hyprland*>
+
+COPYRIGHT
+=========
+
+Copyright (c) 2022, vaxerski