Skip to content

Commit

Permalink
treewide: run linter
Browse files Browse the repository at this point in the history
  • Loading branch information
fufexan committed Nov 6, 2024
1 parent 1b2ba38 commit 9569747
Show file tree
Hide file tree
Showing 32 changed files with 212 additions and 171 deletions.
6 changes: 3 additions & 3 deletions pages/Configuring/Binds.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ can also use `xev` or `wev` to find keycodes.

## Misc

### Workspace bindings on non-qwerty layouts
### Workspace bindings on non-qwerty layouts

Keys used for keybinds need to be accessible without any modifiers in your layout. For instance, the `French Azerty` layout uses `SHIFT+unmodified_key` to write `0-9` numbers. As such, the workspace keybinds for this layout need to use the names of the `unmodified_key`s, and will not work when using the `0-9` numbers.

Expand Down Expand Up @@ -200,7 +200,7 @@ bindrl = MOD, KEY, exec, amongus

Flags:

```
```plain
l -> locked, will also work 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.
Expand Down Expand Up @@ -359,7 +359,7 @@ Please note that this function will _only_ work with
## Submaps

Keybind submaps, also known as _modes_ or _groups_, allow you to activate a
separate set of keybinds. For example, if you want to enter a "resize" mode
separate set of keybinds. For example, if you want to enter a "resize" mode
which allows you to resize windows with the arrow keys, you can do it like this:

```ini
Expand Down
3 changes: 1 addition & 2 deletions pages/Configuring/Dispatchers.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ You have nine choices:
- Previous workspace: `previous`, or `previous_per_monitor`

- First available empty workspace: `empty`, suffix with `m` to only search
on monitor. and/or `n` to make it the *next* available empty workspace. e.g.
on monitor. and/or `n` to make it the _next_ available empty workspace. e.g.
`emptynm`

- Special Workspace: `special` or `special:name` for named special workspaces.
Expand Down Expand Up @@ -227,4 +227,3 @@ address:0x13371337 nomaxsize 0
address:0x13371337 opaque toggle
address:0x13371337 immediate unset
```

16 changes: 8 additions & 8 deletions pages/Configuring/Example-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,48 +9,48 @@ from a more tangible example.

### end_4

![](https://github.com/end-4/dots-hyprland/assets/97237370/5e081770-0f1e-45c4-ad9c-3d19f488cd85)
![end-4/dots-hyprland screenshot](https://github.com/end-4/dots-hyprland/assets/97237370/5e081770-0f1e-45c4-ad9c-3d19f488cd85)

[https://github.com/end-4/dots-hyprland](https://github.com/end-4/dots-hyprland)

### Stephan Raabe (ML4W)

![](https://i.ibb.co/6ydHNt9/screenshot-29-1.png)
![mylinuxforwork/dotfiles screenshot](https://i.ibb.co/6ydHNt9/screenshot-29-1.png)

[https://github.com/mylinuxforwork/dotfiles](https://github.com/mylinuxforwork/dotfiles)

### fufexan

![](https://user-images.githubusercontent.com/36706276/192147190-cf9cf4df-94cb-4a3b-b9d8-137ed0c2538f.png)
![fufexan/dotfiles screenshot](https://user-images.githubusercontent.com/36706276/192147190-cf9cf4df-94cb-4a3b-b9d8-137ed0c2538f.png)

[https://github.com/fufexan/dotfiles](https://github.com/fufexan/dotfiles)

### linuxmobile

![](https://i.ibb.co/kGrhpKd/68747470733a2f2f692e696d6775722e636f6d2f553173336a69372e706e67.png)
![linuxmobile/hyprland-dots screenshot](https://i.ibb.co/kGrhpKd/68747470733a2f2f692e696d6775722e636f6d2f553173336a69372e706e67.png)

[https://github.com/linuxmobile/hyprland-dots](https://github.com/linuxmobile/hyprland-dots)

### flick0

![](https://raw.githubusercontent.com/flick0/dotfiles/aurora/assets/fetch.png)
![flick0/dotfiles screenshot](https://raw.githubusercontent.com/flick0/dotfiles/aurora/assets/fetch.png)

[https://github.com/flick0/dotfiles](https://github.com/flick0/dotfiles)

### iamverysimp1e

![](https://github.com/iamverysimp1e/dots/raw/main/ScreenShots/HyprLand/Rice1.png)
![iamverysimp1e/dots screenshot](https://github.com/iamverysimp1e/dots/raw/main/ScreenShots/HyprLand/Rice1.png)

[https://github.com/iamverysimp1e/dots](https://github.com/iamverysimp1e/dots)

### notusknot

![](https://github.com/notusknot/dotfiles-nix/raw/main/pics/screenshot.png)
![notusknot/dotfiles-nix screenshot](https://github.com/notusknot/dotfiles-nix/raw/main/pics/screenshot.png)

[https://github.com/notusknot/dotfiles-nix](https://github.com/notusknot/dotfiles-nix)

### coffebar

![](https://github.com/coffebar/dotfiles/raw/6a5d595c594f108cd10219df08d338e98e1d2d7d/screenshot.png)
![coffebar/dotfiles screenshot](https://github.com/coffebar/dotfiles/raw/6a5d595c594f108cd10219df08d338e98e1d2d7d/screenshot.png)

[https://github.com/coffebar/dotfiles](https://github.com/coffebar/dotfiles)
5 changes: 3 additions & 2 deletions pages/Configuring/Keywords.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ three_param_keyword = A, B, # OK
## Executing

You can execute a shell script on:

- startup of the compositor
- every time the config is reloaded.
- shutdown of the compositor
Expand Down Expand Up @@ -96,8 +97,8 @@ Remember to use the name of the `Tablet` and not `Tablet Pad` or `Tablet tool`.
Additional properties only present in per-device configs:

- `enabled` -> (only for mice / touchpads / touchdevices / keyboards)
- enables / disables the device (connects / disconnects from the on-screen cursor)
- default: Enabled
- enables / disables the device (connects / disconnects from the on-screen cursor)
- default: Enabled

Example config section:

Expand Down
22 changes: 12 additions & 10 deletions pages/Configuring/Monitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,17 @@ Leaving the name empty will define a fallback rule to use when no other rules
match.

There are a few special values for the resolutions:

- `preferred` - use the display's preferred size and refresh rate.
- `highres` - use the highest supported resolution.
- `highrr` - use the highest supported refresh rate.

Position also has a few special values:

- `auto` - let Hyprland decide on a position. By default, it places each new monitor to the right of existing ones.
- `auto-right/left/up/down` - place the monitor to the right/left, above or below other monitors.

***Please Note:*** While specifying a monitor direction for your first monitor is allowed, this does nothing and it will
_**Please Note:**_ While specifying a monitor direction for your first monitor is allowed, this does nothing and it will
be positioned at (0,0). Also the direction is always from the center out, so you can specify `auto-up` then `auto-left`,
but the left monitors will just be left of the origin and above the origin. You can also specify duplicate directions and
monitors will continue to go in that direction.
Expand Down Expand Up @@ -231,15 +233,15 @@ monitor = eDP-1, 2880x1800@90, 0x0, 1, transform, 1

Transform list:

```
0 -> normal (no transforms)
1 -> 90 degrees
2 -> 180 degrees
3 -> 270 degrees
4 -> flipped
5 -> flipped + 90 degrees
6 -> flipped + 180 degrees
7 -> flipped + 270 degrees
```plain
0 -> normal (no transforms)
1 -> 90 degrees
2 -> 180 degrees
3 -> 270 degrees
4 -> flipped
5 -> flipped + 90 degrees
6 -> flipped + 180 degrees
7 -> flipped + 270 degrees
```

## Default workspace
Expand Down
6 changes: 3 additions & 3 deletions pages/Configuring/Multi-GPU.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For this case, the writer is taking the example of their laptop.
Upon running `lspci | grep -E 'VGA|3D'`, One can list all the video devices
available.

```
```plain
01:00.0 VGA compatible controller: NVIDIA Corporation TU117M [GeForce GTX 1650 Mobile / Max-Q] (rev a1)
06:00.0 VGA compatible controller: Advanced Micro Devices, Inc. [AMD/ATI] Cezanne [Radeon Vega Series / Radeon Vega Mobile Series] (rev c6)
```
Expand All @@ -29,7 +29,7 @@ Here it is clear that 2 GPUs are available, the dedicated NVIDIA GTX 1650 Mobile

Now, run `ls -l /dev/dri/by-path`

```
```plain
total 0
lrwxrwxrwx 1 root root 8 Jul 14 15:45 pci-0000:01:00.0-card -> ../card0
lrwxrwxrwx 1 root root 13 Jul 14 15:45 pci-0000:01:00.0-render -> ../renderD128
Expand Down Expand Up @@ -64,7 +64,7 @@ required.
If instead you would like to use another GPU, or the wrong GPU is picked by default,
set `AQ_DRM_DEVICES` to a `:`-separated list of card paths, e.g.

```
```plain
env = AQ_DRM_DEVICES,/dev/dri/card0:/dev/dri/card1
```

Expand Down
13 changes: 8 additions & 5 deletions pages/Configuring/Uncommon-tips-&-tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Uncommon tips & tricks
The easiest way to accomplish this is to set this using XKB settings, for
example:

```
```ini
input {
kb_layout = us,cz
kb_variant = ,qwerty
Expand Down Expand Up @@ -69,21 +69,22 @@ submap = reset

## Remap Caps-Lock to Ctrl

```
```ini
input {
kb_options = ctrl:nocaps
}
```

## Swap Caps-Lock and Escape

```
```ini
input {
kb_options = caps:swapescape
}
```

## Set F13-F24 as usual function keys

By default, F13-F24 are mapped by xkb as various "XF86" keysyms. These cause binding
issues in many programs. One example is OBS Studio, which does not detect the XF86
keysyms as usable keybindings, making you unable to use them for binds. This option
Expand All @@ -94,15 +95,17 @@ This option was only added recently to `xkeyboard-config`. Please ensure you are
2.43 or greater for this option to do anything.
{{< /callout >}}

```
```ini
input {
kb_options = fkeys:basic_13-24
}
```

## Minimize windows using special workspaces
## Minimize windows using special workspaces

This approach uses special workspaces to mimic the "minimize window" function, by using a single keybind to toggle the minimized state.
Note that one keybind can only handle one window.

```ini
bind = $mod, S, togglespecialworkspace, magic
bind = $mod, S, movetoworkspace, +0
Expand Down
1 change: 1 addition & 0 deletions pages/Configuring/Using-hyprctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ To disable:
```sh
hyprctl seterror disable
```

### notify

Sends a notification using the built-in Hyprland notification system.
Expand Down
8 changes: 4 additions & 4 deletions pages/Configuring/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ _Subcategory `group:groupbar:`_
| name | description | type | default |
| --- | --- | --- | --- |
| enabled | enables groupbars | bool | true |
| font_family | font used to display groupbar titles, use `misc:font_family` if not specified | string | [[Empty]] |
| font_family | font used to display groupbar titles, use `misc:font_family` if not specified | string | [\[Empty]] |
| font_size | font size of groupbar title | int | 8 |
| gradients | enables gradients | bool | true |
| height | height of the groupbar | int | 14 |
Expand All @@ -369,7 +369,7 @@ _Subcategory `group:groupbar:`_
| disable_splash_rendering | disables the Hyprland splash rendering. (requires a monitor reload to take effect) | bool | false |
| col.splash | Changes the color of the splash text (requires a monitor reload to take effect). | color | 0xffffffff |
| font_family | Set the global default font to render the text including debug fps/notification, config error messages and etc., selected from system fonts. | string | Sans |
| splash_font_family | Changes the font used to render the splash text, selected from system fonts (requires a monitor reload to take effect). | string | [[Empty]] |
| splash_font_family | Changes the font used to render the splash text, selected from system fonts (requires a monitor reload to take effect). | string | [\[Empty]] |
| force_default_wallpaper | Enforce any of the 3 default wallpapers. Setting this to `0` or `1` disables the anime background. `-1` means "random". [-1/0/1/2] | int | -1 |
| vfr | controls the VFR status of Hyprland. Heavily recommended to leave enabled to conserve resources. | bool | true |
| vrr | controls the VRR (Adaptive Sync) of your monitors. 0 - off, 1 - on, 2 - fullscreen only [0/1/2] | int | 0 |
Expand All @@ -381,8 +381,8 @@ _Subcategory `group:groupbar:`_
| animate_mouse_windowdragging | If true, will animate windows being dragged by mouse, note that this can cause weird behavior on some curves | bool | false |
| disable_autoreload | If true, the config will not reload automatically on save, and instead needs to be reloaded with `hyprctl reload`. Might save on battery. | bool | false |
| enable_swallow | Enable window swallowing | bool | false |
| swallow_regex | The *class* regex to be used for windows that should be swallowed (usually, a terminal). To know more about the list of regex which can be used [use this cheatsheet](https://github.com/ziishaned/learn-regex/blob/master/README.md). | str | \[\[Empty\]\] |
| swallow_exception_regex | The *title* regex to be used for windows that should *not* be swallowed by the windows specified in swallow_regex (e.g. wev). The regex is matched against the parent (e.g. Kitty) window's title on the assumption that it changes to whatever process it's running. | str | \[\[Empty\]\] |
| swallow_regex | The _class_ regex to be used for windows that should be swallowed (usually, a terminal). To know more about the list of regex which can be used [use this cheatsheet](https://github.com/ziishaned/learn-regex/blob/master/README.md). | str | \[\[Empty\]\] |
| swallow_exception_regex | The _title_ regex to be used for windows that should _not_ be swallowed by the windows specified in swallow_regex (e.g. wev). The regex is matched against the parent (e.g. Kitty) window's title on the assumption that it changes to whatever process it's running. | str | \[\[Empty\]\] |
| focus_on_activate | Whether Hyprland should focus an app that requests to be focused (an `activate` request) | bool | false |
| mouse_move_focuses_monitor | Whether mouse moving into a different monitor should focus it | bool | true |
| render_ahead_of_time | [Warning: buggy] starts rendering _before_ your monitor displays a frame in order to lower latency | bool | false |
Expand Down
2 changes: 1 addition & 1 deletion pages/Configuring/Window-Rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ It is not possible to `float` (or any other of the static rules) a window based
| monitor \[id\] | sets the monitor on which a window should open. `id` can be either id or name (either e.g. `1` or e.g. `DP-1`) |
| workspace \[w\] | sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../Dispatchers#workspaces)). You can also make \[w\] to `unset`, will unset all previous workspace rules applied to this window. You can also add `silent` after the workspace to make the window open silently. |
| noinitialfocus | disables the initial focus to the window |
| pin | pins the window (i.e. show it on all workspaces) *note: floating only* |
| pin | pins the window (i.e. show it on all workspaces) _note: floating only_ |
| unset | removes all previously set rules for the given parameters. Please note it has to match EXACTLY. |
| nomaxsize | removes max size limitations. Especially useful with windows that report invalid max sizes (e.g. winecfg) |
| stayfocused | forces focus on the window as long as it's visible |
Expand Down
27 changes: 14 additions & 13 deletions pages/Configuring/Workspace-Rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,20 @@ Selectors have props separated by a space. No spaces are allowed inside props
themselves.

Props:
- `r[A-B]` - ID range from A to B inclusive
- `s[bool]` - Whether the workspace is special or not
- `n[bool]`, `n[s:string]`, `n[e:string]` - named actions. `n[bool]` ->
whether a workspace is a named workspace, `s` and `e` are starts and ends
with respectively
- `m[monitor]` - Monitor selector
- `w[(flags)A-B]`, `w[(flags)X]` - Prop for window counts on the workspace.
A-B is an inclusive range, X is a specific number. Flags can be omitted.
It can be `t` for tiled-only, `f` for floating-only, `g` to count groups
instead of windows, and `v` to count only visible windows.
- `f[-1]`, `f[0]`, `f[1]`, `f[2]` - fullscreen state of the workspace. `-1`: no
fullscreen, `0`: fullscreen, `1`: maximized, `2`, fullscreen without
fullscreen state sent to the window.

- `r[A-B]` - ID range from A to B inclusive
- `s[bool]` - Whether the workspace is special or not
- `n[bool]`, `n[s:string]`, `n[e:string]` - named actions. `n[bool]` ->
whether a workspace is a named workspace, `s` and `e` are starts and ends
with respectively
- `m[monitor]` - Monitor selector
- `w[(flags)A-B]`, `w[(flags)X]` - Prop for window counts on the workspace.
A-B is an inclusive range, X is a specific number. Flags can be omitted.
It can be `t` for tiled-only, `f` for floating-only, `g` to count groups
instead of windows, and `v` to count only visible windows.
- `f[-1]`, `f[0]`, `f[1]`, `f[2]` - fullscreen state of the workspace. `-1`: no
fullscreen, `0`: fullscreen, `1`: maximized, `2`, fullscreen without
fullscreen state sent to the window.

### Syntax

Expand Down
2 changes: 0 additions & 2 deletions pages/Connect/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@ These are the links to official Hyprland-related spaces or profiles:

Twitter: [twitter.com/hyprwm](https://twitter.com/hyprwm)


## Spaces

Discord: [discord.gg/hQ9XvMUjjr](https://discord.gg/hQ9XvMUjjr)<br/>
Matrix: `#hyprland:matrix.vaxry.net`


## Other

hyprland.org git instance: [code.hyprland.org](https://code.hyprland.org/)<br/>
Expand Down
4 changes: 2 additions & 2 deletions pages/Contributing and Debugging/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ that you can copy to your .vscode/ folder in the repo root.
With that, you can build in debug, go to the debugging tab and hit
`(gdb) Launch`.

*note:* You probably want to set `watchdog_timeout = 0` in the debug {} section
_note:_ You probably want to set `watchdog_timeout = 0` in the debug {} section
of your config. Otherwise Hyprland will notice its hanging when you hit a
breakpoint and it will crash after you continue out of it.

Expand Down Expand Up @@ -78,7 +78,7 @@ If you want proper LSP support in an editor that doesn't automatically set it
up, use clangd. You'll probably notice there will be a bunch of warnings
because we haven't generated compile commands, to do this run:

```
```sh
cmake -S . -B build/ -G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
```

Expand Down
12 changes: 8 additions & 4 deletions pages/Crashes and Bugs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ Report an issue on GitHub or on the Discord server.
1. Build Hyprland in debug (`make debug`).
2. Start Hyprland and get it to crash.
3. In a tty or terminal, do `coredumpctl debug Hyprland`.
- If gdb asks you for symbols, say `y`.
- If it asks about paging, say `c`.
- If gdb asks you for symbols, say `y`.
- If it asks about paging, say `c`.
4. Once you get to `(gdb)`, start file logging with `set logging on`.
- For a specific file, use `set logging file output.log`.
- For a specific file, use `set logging file output.log`.
5. Run `bt -full`, then `exit` once finished, and attach the output.

## Obtaining a trace log
Expand Down Expand Up @@ -152,7 +152,11 @@ we can render to) and put it on your screen (via the gpu) instead of a window.
Freezes, glitches, and others, can be caused by issues with Hyprland's communication with DRM, the driver
or kernel. In those cases, a DRM log is helpful.

_Please note, these logs are EXTREMELY verbose. Please reproduce your bug(s) ASAP to avoid getting a 1GB log_
{{< callout >}}

Please note, these logs are EXTREMELY verbose. Please reproduce your bug(s) ASAP to avoid getting a 1GB log.

{{< /callout >}}

```sh
echo 0x19F | sudo tee /sys/module/drm/parameters/debug # cnables verbose drm logging
Expand Down
Loading

0 comments on commit 9569747

Please sign in to comment.