mirror/swaysome
1
0
Fork 0
mirror of https://gitlab.com/hyask/swaysome.git synced 2025-12-10 07:44:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Greatly improve the man page

Browse source
This commit is contained in:
Skia 2024-02-16 16:55:46 +01:00
parent 83c454cd6a
commit a399d827de
1 changed files with 75 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

128
swaysome.1
View file

@ -1,8 +1,8 @@
.TH SWAYSOME "1" "January 2024" "2.1.0" "User Commands" .TH SWAYSOME "1" "Feb 2024" "2.1.0" "User Commands"
. .
. .
.SH NAME .SH NAME
swaysome \- improve multi-output handling on sway swaysome - improve multi-output handling on sway
. .
. .
.SH SYNOPSIS .SH SYNOPSIS
@ -12,110 +12,132 @@ swaysome \- improve multi-output handling on sway
. .
. .
.SH DESCRIPTION .SH DESCRIPTION
Swaysome helps you configure sway to work a bit more like AwesomeWM (\fIhttps://awesomewm\.org/\fR). This means that \fBworkspaces\fR are namespaced in what are called \fBworkspace groups\fR, and \fBworkspace groups\fR can be moved around the differents outputs easily\. \fBswaysome\fR helps you configure \fBsway\fR to work a bit more
like \fBAwesomeWM\fR (\fIhttps://awesomewm\.org/\fR). This means that
"\fBworkspaces\fR" are namespaced in what are called "\fBworkspace groups\fR",
and "\fBworkspace groups\fR" can be moved around the differents outputs easily.
.P .P
For example, with workspace `11` on the first output, and workspace `21` on the second output, triggering the `swaysome focus 1` shortcut to get workspace `1` would lead you to workspace `11` if your focus is on the first output, and workspace `21` is the focus is on the second one. For example, with workspace 11 on the first output, and workspace 21 on the
second output, triggering the `swaysome focus 1` shortcut to get workspace
1 would lead you to workspace 11 if your focus is on the first output, and
workspace 21 is the focus is on the second one.
.P .P
By default, `swaysome init` will create a \fBworkspace group\fR per active output, but you may create other groups while working, by either triggering `swaysome focus\-group <new\-number>` and opening a new window, or sending an existing window to it first with `swaysome move\-to\-group <new\-number>`\. By default, `swaysome init` will create a \fBworkspace group\fR per active
output, but you may create other groups while working, by either triggering
`swaysome focus-group <new-number>` and opening a new window, or sending an
existing window to it first with `swaysome move-to-group <new-number>`.
.P .P
Here is a common use\-case for this: Here is a common use-case for this:
.EX .EX
\fBoutput\-1\fR: \fBoutput-1\fR:
\fBworkspace group\fR 1: \fBworkspace group 1\fR:
workspace \fB11\fR: chats workspace 11: chats
workspace \fB12\fR: emails workspace 12: emails
\fBoutput\-2\fR: \fBoutput-2\fR:
\fBworkspace group\fR 2: \fBworkspace group 2\fR:
workspace \fB21\fR: IDE for first project workspace 21: IDE for first project
workspace \fB22\fR: browser for first project workspace 22: browser for first project
workspace \fB23\fR: terminals for first project workspace 23: terminals for first project
\fBworkspace group\fR 3: \fBworkspace group 3\fR:
workspace \fB31\fR: IDE for second project workspace 31: IDE for second project
workspace \fB32\fR: browser for second project workspace 32: browser for second project
workspace \fB33\fR: terminals for second project workspace 33: terminals for second project
.EE .EE
.P .P
That way, when `output\-2` is focused on \fBworkspace group\fR 2, be it workspace `21` or `22`, the quick `$mod+<number>` (bound to `swaysome focus <number>`) shortcut won't leave \fBworkspace group\fR 2, allowing you to open multiple projects in parallel without the hassle of manually remembering how to namespace them\. That way, when \fBoutput-2\fR is focused on \fBworkspace group 2\fR, be
it workspace 21 or 22, the quick `$mod+<number>` (bound to `swaysome focus
<number>`) shortcut won't leave \fBworkspace group 2\fR, allowing you to open
multiple projects in parallel without the hassle of manually remembering how to
namespace them.
.P .P
In that situation, suppose you plug in a new output, `output\-3`, you may then want to focus \fBworkspace group 3\fR to send it to `output\-3`: this is simply done by typing the shortcuts `$mod+Alt+3` (`swaysome focus\-group 3`) then `$mod+Alt+o` (`swaysome workspace\-group\-next\-output`)\. In that situation, suppose you plug in a new output, `output-3`, you may then
want to focus \fBworkspace group 3\fR to send it to `output-3`: this is simply
done by typing the shortcuts `$mod+Alt+3` (`swaysome focus-group 3`) then
`$mod+Alt+o` (`swaysome workspace-group-next-output`)\.
.P .P
`swaysome` may also work with i3, but this is untested\. \fBswaysome\fR may also work with \fBi3\fR, but this is untested. Patches welcome if needed.
.P .P
`swaysome` should be compatible with sworkstyle \fIhttps://lib\.rs/crates/sworkstyle\fR\. If this is broken, please report a bug\. \fBswaysome\fR should be compatible with \fBsworkstyle\fR (\fIhttps://lib\.rs/crates/sworkstyle\fR).
If this is broken, please report a bug.
. .
. .
.SH USAGE .SH USAGE
.P .P
Copy the \fBswaysome.conf\fR file in \fB~/.config/sway/config.d/swaysome.conf\fR. If you installed \fBswaysome\fR from your distribution's package manager, it
should have provided your system with the default configuration file. In that
case, you can just include from your \fBsway\fR configuration by appending the
following to it:
Then append your \fBsway\fR configuration with this: include /etc/sway/config.d/swaysome.conf
include ~/.config/sway/config.d/*.conf Otherwise, if installing by any other way, copy the \fBswaysome.conf\fR file
in \fB~/.config/sway/config.d/swaysome.conf\fR, then append your \fBsway\fR
configuration with this:
include ~/.config/sway/config.d/sway.conf
On next startup of `sway`, you should end-up with workspaces from `1` to `0`, On next startup of `sway`, you should end-up with workspaces from `1` to `0`,
prefixed with a screen index, giving you workspace `11` on the first screen, and prefixed with a screen index, giving you workspace `11` on the first screen, and
workspace `21` on the second one, both accessible with shortcut `$mod+1` when workspace `21` on the second one, both accessible with shortcut `$mod+1` when
focused on the right output. focused on the right output.
The `init` command simply walks through every screen to initialize a prefixed
workspace. It does it backwards so that you end-up focused on the first screen,
as usual.
. .
. .
.SH COMMANDS .SH COMMANDS
.TP .TP
init \fBinit\fR \fIINDEX\fR
Initialize the workspace groups for all the outputs Initialize the workspace groups for all the outputs on workspace \fIINDEX\fR.
This command simply walks through every screen to initialize a prefixed
workspace. It does it backwards so that you end-up focused on the first screen,
as usual.
.TP .TP
move \fBmove\fR \fIINDEX\fR
Move the focused container to another workspace on the same workspace group Move the focused container to workspace \fIINDEX\fR (stay in the same workspace group)
.TP .TP
move\-to\-group \fBmove-to-group\fR \fIINDEX\fR
Move the focused container to the same workspace index on another workspace group Move the focused container to workspace group \fIINDEX\fR (keep the same workspace index)
.TP .TP
focus \fBfocus\fR \fIINDEX\fR
Focus to another workspace on the same workspace group Focus to workspace \fIINDEX\fR (stay in the same workspace group)
.TP .TP
focus\-group \fBfocus-group\fR \fIINDEX\fR
Focus to workspace group Focus to workspace group \fIINDEX\fR (keep the same workspace index)
.TP .TP
focus\-all\-outputs \fBfocus-all-outputs\fR \fIINDEX\fR
Focus to another workspace on all the outputs Focus to workspace \fIINDEX\fR on all the outputs at once (not bound by default)
.TP .TP
next\-output \fBnext-output\fR
Move the focused container to the next output Move the focused container to the next output
.TP .TP
prev\-output \fBprev-output\fR
Move the focused container to the previous output Move the focused container to the previous output
.TP .TP
workspace\-group\-next\-output \fBworkspace-group-next-output\fR
Move the focused workspace group to the next output Move the focused workspace group to the next output
.TP .TP
workspace\-group\-prev\-output \fBworkspace-group-prev-output\fR
Move the focused workspace group to the previous output Move the focused workspace group to the previous output
.TP .TP
next\-group \fBnext-group\fR
Move the focused container to the next group Move the focused container to the next group
.TP .TP
prev\-group \fBprev-group\fR
Move the focused container to the previous group Move the focused container to the previous group
.TP .TP
rearrange\-workspaces \fBrearrange-workspaces\fR
Rearrange already opened workspaces to the correct outputs, useful when plugging new monitors Rearrange already opened workspaces to the correct outputs, useful when plugging new monitors
.TP .TP
help \fBhelp\fR
Print this message or the help of the given subcommand(s) Print this message or the help of the given subcommand(s)
. .
. .
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-h\fR, \fB\-\-help\fR \fB-h\fR, \fB--help\fR
Print help Print help
.TP .TP
\fB\-V\fR, \fB\-\-version\fR \fB-V\fR, \fB--version\fR
Print version Print version
. .
. .