aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/Hyprland.1.rst
diff options
context:
space:
mode:
authorBlake Lee <[email protected]>2022-07-15 20:04:17 -0400
committerBlake Lee <[email protected]>2022-07-15 20:04:17 -0400
commit310a8397003146e416e06d777e8404ea469f02bd (patch)
tree709e4f947e9a3eae1efc9fb5efaa598f7f49fa04 /docs/Hyprland.1.rst
parentb2650928eac06e3181ad07efe6ec55b2550f89b8 (diff)
downloadHyprland-310a8397003146e416e06d777e8404ea469f02bd.tar.gz
Hyprland-310a8397003146e416e06d777e8404ea469f02bd.zip
docs: add man pages
Diffstat (limited to 'docs/Hyprland.1.rst')
-rw-r--r--docs/Hyprland.1.rst75
1 files changed, 75 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`>