tobias/waybar
1
0
Fork 0
mirror of https://github.com/rad4day/Waybar.git synced 2023-12-21 10:22:59 +01:00
Code Issues Packages Projects Releases Wiki Activity
0.9.21
waybar/man/waybar-sway-workspaces.5.scd

155 lines
4.5 KiB
Plaintext
Raw Permalink Normal View History

Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
waybar-sway-workspaces(5)
# NAME
waybar - sway workspaces module
# DESCRIPTION
The *workspaces* module displays the currently used workspaces in Sway.
# CONFIGURATION
Addressed by *sway/workspaces*
*all-outputs*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to false, workspaces will only be shown on the output they are on. If set to true all workspaces will be shown on every output.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*format*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: string ++
default: {value} ++
The format, how information should be displayed.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*format-icons*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: array ++
Based on the workspace name and state, the corresponding icon gets selected. See *icons*.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*disable-scroll*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to false, you can scroll to cycle through workspaces. If set to true this behaviour is disabled.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
Add option for no workspace switch on click In sway/workspaces, just like disable-scroll turns on/off the ability to change workspaces by scrolling the mouse add disable-click that turns on/off the ability to change workspaces by clicking.
2020-08-12 12:38:48 +02:00
*disable-click*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to false, you can click to change workspace. If set to true this behaviour is disabled.
Add option for no workspace switch on click In sway/workspaces, just like disable-scroll turns on/off the ability to change workspaces by scrolling the mouse add disable-click that turns on/off the ability to change workspaces by clicking.
2020-08-12 12:38:48 +02:00
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*smooth-scrolling-threshold*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: double ++
Threshold to be used when scrolling.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*disable-scroll-wraparound*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to false, scrolling on the workspace indicator will wrap around to the first workspace when reading the end, and vice versa. If set to true this behavior is disabled.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*enable-bar-scroll*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to false, you can't scroll to cycle throughout workspaces from the entire bar. If set to true this behaviour is enabled.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*disable-markup*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to true, button label will escape pango markup.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*current-only*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: false ++
If set to true. Only focused workspaces will be shown.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*persistent_workspaces*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: json (see below) ++
default: empty ++
Lists workspaces that should always be shown, even when non existent
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
feat: update man
2020-04-12 18:35:41 +02:00
*on-update*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: string ++
Command to execute when the module is updated.
feat: update man
2020-04-12 18:35:41 +02:00
Add a configuration entry to disable auto_back_and_forth on Sway workspaces
2021-02-02 21:58:26 +01:00
*disable-auto-back-and-forth*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
Whether to disable *workspace_auto_back_and_forth* when clicking on workspaces. If this is set to *true*, clicking on a workspace you are already on won't do anything, even if *workspace_auto_back_and_forth* is enabled in the Sway configuration.
sway/workspaces: sort by the "num" property provided by sway, configurable whether numeric workspace names come first Sway provides the workspace "num" property which is an integer number of the workspace, i.e., workspace "3" -> 3 and also "3dev" -> "3". This commit uses this property to sort the workspaces, which makes sense when persistent workspaces or all-output is specified. This commit also adds a new configuration option, whether the numeric workspaces come in front or after workspaces that have non-numeric name.
2020-05-05 09:08:05 +02:00
sway,feat: allow alphabetical sort for users who do not utilize any form of "workspace prev/next" commands, it can be very handle to sort the workspaces alphabetically. this commit adds a new "alphabetical_sort" to the `sway/workspaces` module which allows the module to alway sort workspaces alphabetically. this docs are updated to warn the user of the implications involved. Signed-off-by: Louis DeLosSantos <louis.delos@gmail.com>
2023-01-02 23:03:28 +01:00
*alphabetical_sort*: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
Whether to sort workspaces alphabetically. Please note this can make "swaymsg workspace prev/next" move to workspaces inconsistent with the ordering shown in Waybar.
sway,feat: allow alphabetical sort for users who do not utilize any form of "workspace prev/next" commands, it can be very handle to sort the workspaces alphabetically. this commit adds a new "alphabetical_sort" to the `sway/workspaces` module which allows the module to alway sort workspaces alphabetically. this docs are updated to warn the user of the implications involved. Signed-off-by: Louis DeLosSantos <louis.delos@gmail.com>
2023-01-02 23:03:28 +01:00
sway: warp-on-scroll toggle
2023-06-07 15:25:59 +02:00
warp-on-scroll: ++
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
typeof: bool ++
default: true ++
If set to false, you can scroll to cycle through workspaces without mouse warping being enabled. If set to true this behaviour is disabled.
sway: warp-on-scroll toggle
2023-06-07 15:25:59 +02:00
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
# FORMAT REPLACEMENTS
refactor(workspaces): default value unstripped, fix man
2020-04-06 12:42:04 +02:00
*{value}*: Name of the workspace, as defined by sway.
*{name}*: Number stripped from workspace value.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
*{icon}*: Icon, as defined in *format-icons*.
*{index}*: Index of the workspace.
Add output port of workspace to template
2023-06-26 11:01:50 +02:00
*{output}*: Output where the workspace is located.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
# ICONS
Additional to workspace name matching, the following *format-icons* can be set.
- *default*: Will be shown, when no string matches is found.
- *urgent*: Will be shown, when workspace is flagged as urgent
- *focused*: Will be shown, when workspace is focused
feat: format-icon for persistent workspaces
2020-04-04 21:13:25 +02:00
- *persistent*: Will be shown, when workspace is persistent one.
add high-priority-named optiion
2023-07-20 21:56:15 +02:00
- *high-priority-named*: Icons by names will be shown always for that workspaces, independent by state.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
Fix typo: persistant -> persistent
2019-08-31 19:57:44 +02:00
# PERSISTENT WORKSPACES
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
Fix typo: persistant -> persistent
2019-08-31 19:57:44 +02:00
Each entry of *persistent_workspace* names a workspace that should always be shown.
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
Associated with that value is a list of outputs indicating *where* the workspace should be shown,
an empty list denoting all outputs.
```
"sway/workspaces": {
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
"persistent_workspaces": {
"3": [], // Always show a workspace with name '3', on all outputs if it does not exists
"4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exists
"5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exists
}
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
}
```
n.b.: the list of outputs can be obtained from command line using *swaymsg -t get_outputs*
# EXAMPLES
```
"sway/workspaces": {
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
"disable-scroll": true,
"all-outputs": true,
"format": "{name}: {icon}",
"format-icons": {
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
add high-priority-named optiion
2023-07-20 21:56:15 +02:00
"high-priority-named": [ "1", "2" ],
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:33:02 +02:00
"urgent": "",
"focused": "",
"default": ""
}
Add waybar-sway-workspaces(5)
2019-08-26 19:08:06 +02:00
}
```
# Style
- *#workspaces button*
- *#workspaces button.visible*
- *#workspaces button.focused*
- *#workspaces button.urgent*
Fix typo: persistant -> persistent
2019-08-31 19:57:44 +02:00
- *#workspaces button.persistent*
sway/workspaces added current_output CSS class to buttons. All workspace buttons that are visible on the same output as the current waybar can be styled with the `current_output` css class. This is really only useful in combination with the `"all-outputs": true`. Then the workspaces that are on the current output can be styled differently than the workspace on other outputs, while all are visible in the waybar.
2020-05-04 16:16:09 +02:00
- *#workspaces button.current_output*
Add missing * in man page
2020-08-13 21:11:55 +02:00
- *#workspaces button#sway-workspace-${name}*
Reference in New Issue Copy Permalink