From 18dbeae48307a6b17fc12861349f834e07f29d3f Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 16 Jan 2023 18:14:45 +0300 Subject: [PATCH] clarify wording and fix broken links --- pages/Configuring/Binds.md | 8 +++--- pages/Configuring/Environment-variables.md | 4 +-- pages/Getting Started/Master-Tutorial.md | 32 ++++++++++++++-------- pages/Useful Utilities/App-Clients.md | 2 +- 4 files changed, 28 insertions(+), 18 deletions(-) diff --git a/pages/Configuring/Binds.md b/pages/Configuring/Binds.md index 4b2306d7..6cd4cae8 100644 --- a/pages/Configuring/Binds.md +++ b/pages/Configuring/Binds.md @@ -27,7 +27,7 @@ bind=,Print,exec,grim _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 @@ -100,7 +100,7 @@ bind=SUPER,mouse_down,workspace,e-1 Useful for binding e.g. the lid close/open event: ```ini -# trigger when the switch is toggle +# trigger when the switch is toggled bindl=,switch:[switch name],exec,swaylock # trigger when the switch is turning on bindl=,switch:on:[switch name],exec,hyprctl keyword monitor "eDP-1, 2560x1600, 0x0, 1" @@ -139,7 +139,7 @@ bindrl=MOD,KEY,exec,amongus Flags: ```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 e -> repeat, will repeat when held. 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, 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 SUPER + F10, and you want to make it work globally. diff --git a/pages/Configuring/Environment-variables.md b/pages/Configuring/Environment-variables.md index 36e0ed75..49294ac7 100644 --- a/pages/Configuring/Environment-variables.md +++ b/pages/Configuring/Environment-variables.md @@ -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 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. @@ -59,6 +59,6 @@ To force GBM as a backend, set the following environment 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_SIZE` - Set cursor size. See [here](../../FAQ/) for why you might want this variable set. diff --git a/pages/Getting Started/Master-Tutorial.md b/pages/Getting Started/Master-Tutorial.md index 88bccd86..4ab61c79 100644 --- a/pages/Getting Started/Master-Tutorial.md +++ b/pages/Getting Started/Master-Tutorial.md @@ -6,9 +6,11 @@ you need to just get things going. It does link to other pages where necessary. {{< toc >}} ## 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? _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. {{< hint type=important >}} -It is highly recommended to copy the desktop file to e.g. `wrapped_hl.desktop` instead of editing -the provided one, as many package managers will **overwrite** -the desktop file on updates. +Hyprland, by default on most distros, will place `hyprland.desktop` inside +`/usr/share/wayland-sessions`. Login managers generally pick this file up and add +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 >}} ## Launching Hyprland, part 2 @@ -91,10 +96,11 @@ list: - GDM → Works with the caveat of crashing Hyprland on the first launch - ly → Works poorly -## In hyprland -Hello, you're good to go with your adventure, technically. +## In Hyprland +You're good to go with your adventure, technically. -Use SUPER + Q to launch kitty. +Use SUPER + Q 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. @@ -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 [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 -Since this is not a DE, you'll need to use stuff like `lxappearance` (GTK) -and `qt6ct` / `qt5ct` (QT) +Since this is not a full fledged Desktop Environment, you will need to use tools such as +`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 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 to not work with that though. -You can check whether an app is running in xwayland or not with `hyprctl clients`. \ No newline at end of file +You can check whether an app is running in xwayland or not with `hyprctl clients`. diff --git a/pages/Useful Utilities/App-Clients.md b/pages/Useful Utilities/App-Clients.md index 90554f76..469046a3 100644 --- a/pages/Useful Utilities/App-Clients.md +++ b/pages/Useful Utilities/App-Clients.md @@ -13,7 +13,7 @@ While it does infringe on Discord's ToS, it's relatively safe and doesn't rely o ## 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 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