clarify wording and fix broken links (#103)

This commit is contained in:
NotAShelf 2023-01-17 15:41:55 +03:00 committed by GitHub
parent 6e6e9a0712
commit 1f01e4bd3a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 18 deletions

View file

@ -27,7 +27,7 @@ bind=,Print,exec,grim
_For a complete mod list, see [Variables](../Variables/#variable-types)._ _For a complete mod list, see [Variables](../Variables/#variable-types)._
_The dispatcher list can be found in [Dispatchers](../Dispatchers)._ _The dispatcher list can be found in [Dispatchers](../Dispatchers/#list-of-dispatchers)._
## Uncommon syms / binding with a keycode ## Uncommon syms / binding with a keycode
@ -100,7 +100,7 @@ bind=SUPER,mouse_down,workspace,e-1
Useful for binding e.g. the lid close/open event: Useful for binding e.g. the lid close/open event:
```ini ```ini
# trigger when the switch is toggle # trigger when the switch is toggled
bindl=,switch:[switch name],exec,swaylock bindl=,switch:[switch name],exec,swaylock
# trigger when the switch is turning on # trigger when the switch is turning on
bindl=,switch:on:[switch name],exec,hyprctl keyword monitor "eDP-1, 2560x1600, 0x0, 1" bindl=,switch:on:[switch name],exec,hyprctl keyword monitor "eDP-1, 2560x1600, 0x0, 1"
@ -139,7 +139,7 @@ bindrl=MOD,KEY,exec,amongus
Flags: Flags:
```ini ```ini
l -> locked, aka. works also when an an input inhibitor (e.g. a lockscreen) is active l -> locked, aka. works also when an input inhibitor (e.g. a lockscreen) is active
r -> release, will trigger on release of a key r -> release, will trigger on release of a key
e -> repeat, will repeat when held. e -> repeat, will repeat when held.
m -> mouse, see below m -> mouse, see below
@ -206,7 +206,7 @@ bindr=ALT,Alt_L,exec,amongus
Yes, you heard this right, Hyprland does support global keybinds for ALL apps, Yes, you heard this right, Hyprland does support global keybinds for ALL apps,
including OBS, Discord, Firefox, etc. including OBS, Discord, Firefox, etc.
See the [`pass` dispatcher](./Dispatchers/#dispatchers) for keybinds. See the [`pass` dispatcher](./Dispatchers/#list-of-dispatchers) for keybinds.
Let's take OBS as an example: the "Start/Stop Recording" keybind is set to Let's take OBS as an example: the "Start/Stop Recording" keybind is set to
<key>SUPER</key> + <key>F10</key>, and you want to make it work globally. <key>SUPER</key> + <key>F10</key>, and you want to make it work globally.

View file

@ -1,4 +1,4 @@
As [previously mentioned](../Getting-Started/Quick-start/#wrapping-the-launcher-recommended), it's As [aforementioned](../Getting-Started/Master-Tutorial/#launching-hyprland-part-1), it's
useful using a wrapper to launch Hyprland. Whether you start Hyprland through TTY or a Display useful using a wrapper to launch Hyprland. Whether you start Hyprland through TTY or a Display
Manager, it is always suggested to use one. As such, you can pass certain environment Manager, it is always suggested to use one. As such, you can pass certain environment
variables to improve Wayland compatibility, or simply change certain aspects of your desktop. variables to improve Wayland compatibility, or simply change certain aspects of your desktop.
@ -59,6 +59,6 @@ To force GBM as a backend, set the following environment variables:
# Theming Related Variables # Theming Related Variables
- `GTK_THEME` - Set a GTK theme manually, for those who want to avoid appearance tools lxappearance or nwg-look - `GTK_THEME` - Set a GTK theme manually, for those who want to avoid appearance tools such as lxappearance or nwg-look
- `XCURSOR_THEME` - Set your cursor theme. The theme needs to be installed and readable by your user. - `XCURSOR_THEME` - Set your cursor theme. The theme needs to be installed and readable by your user.
- `XCURSOR_SIZE` - Set cursor size. See [here](../../FAQ/) for why you might want this variable set. - `XCURSOR_SIZE` - Set cursor size. See [here](../../FAQ/) for why you might want this variable set.

View file

@ -6,9 +6,11 @@ you need to just get things going. It does link to other pages where necessary.
{{< toc >}} {{< toc >}}
## Install Hyprland ## Install Hyprland
See [Installation](../Installation) and come back here once you install Hyprland. See [Installation](../Installation) and come back here once you have successfully
installed Hyprland.
Install `kitty` (default terminal emulator) Install `kitty` (default terminal emulator) terminal. This is available in most
distros' repositories.
## NVIDIA? ## NVIDIA?
_If not using an NVIDIA card, skip this step_ _If not using an NVIDIA card, skip this step_
@ -72,9 +74,12 @@ login manager! You might need to put the full path in it, as login managers are
usually not ran through the user account. usually not ran through the user account.
{{< hint type=important >}} {{< hint type=important >}}
It is highly recommended to copy the desktop file to e.g. `wrapped_hl.desktop` instead of editing Hyprland, by default on most distros, will place `hyprland.desktop` inside
the provided one, as many package managers will **overwrite** `/usr/share/wayland-sessions`. Login managers generally pick this file up and add
the desktop file on updates. a session to their settings. It is highly recommended to make a copy of this
desktop file and name it something like `hyprland-wrapped.desktop` The new desktop
file will also be picked up by login managers, and provide you an extra session with
the environment variables applied to your session.
{{< /hint >}} {{< /hint >}}
## Launching Hyprland, part 2 ## Launching Hyprland, part 2
@ -91,10 +96,11 @@ list:
- GDM → Works with the caveat of crashing Hyprland on the first launch - GDM → Works with the caveat of crashing Hyprland on the first launch
- ly → Works poorly - ly → Works poorly
## In hyprland ## In Hyprland
Hello, you're good to go with your adventure, technically. You're good to go with your adventure, technically.
Use <key>SUPER</key> + <key>Q</key> to launch kitty. Use <key>SUPER</key> + <key>Q</key> to launch kitty. If you wish to choose the
default terminal before you proceed, you can do so in `~/.config/hypr/hyprland.conf`.
If you want the best experience with less hassle googling, keep reading. If you want the best experience with less hassle googling, keep reading.
@ -120,9 +126,13 @@ about configuring Hyprland to your likings.
Cursors are a notorious pain to set up when you don't know how. See Cursors are a notorious pain to set up when you don't know how. See
[this FAQ entry](../../FAQ#how-do-i-change-me-mouse-cursor) [this FAQ entry](../../FAQ#how-do-i-change-me-mouse-cursor)
If your cursor does not appear, then see this FAQ entry](../../FAQ#me-cursor-no-render)
## Themes ## Themes
Since this is not a DE, you'll need to use stuff like `lxappearance` (GTK) Since this is not a full fledged Desktop Environment, you will need to use tools such as
and `qt6ct` / `qt5ct` (QT) `lxappearance` and `nwg-look` (recommended) for GTK, and `qt5ct` / `qt6ct` for their
respective QT versions. Some older applications may also require `qt4ct`.
## Force apps to use Wayland ## Force apps to use Wayland
A lot of apps will use Wayland by default. Chromium (and other browsers based on it or electron) A lot of apps will use Wayland by default. Chromium (and other browsers based on it or electron)
@ -132,4 +142,4 @@ where possible. Chromium-based browsers also may have a toggle in about:config.
For most electron apps, you should put the above in `~/.config/electron-flags.conf`. VSCode is known For most electron apps, you should put the above in `~/.config/electron-flags.conf`. VSCode is known
to not work with that though. to not work with that though.
You can check whether an app is running in xwayland or not with `hyprctl clients`. You can check whether an app is running in xwayland or not with `hyprctl clients`.

View file

@ -13,7 +13,7 @@ While it does infringe on Discord's ToS, it's relatively safe and doesn't rely o
## Spotify ## Spotify
Spotify does not follow window rules. This is because the client sets is class _after_ Spotify does not follow window rules. This is because the client sets its class _after_
the window has opened, thus making it "immune" to windowrules. An alternative to the window has opened, thus making it "immune" to windowrules. An alternative to
Spotify's GUI client is [spotify-tui](https://github.com/Rigellute/spotify-tui) which can be Spotify's GUI client is [spotify-tui](https://github.com/Rigellute/spotify-tui) which can be
launched in a terminal with a custom class. While limited in functionality, it is quite launched in a terminal with a custom class. While limited in functionality, it is quite