aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/Hyprland.1.rst
blob: 332d8266de3fde269b259e3402085da13c5841ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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 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`>

AUTHORS
=======

Vaxerski <`https://github.com/vaxerski`>