.TH SWAYSOME "1" "January 2024" "2.1.0" "User Commands"
.
.
.SH NAME
swaysome \- improve multi-output handling on sway
.
.
.SH SYNOPSIS
.B swaysome
\fI\,[OPTIONS]\/\fR
\fI\,<COMMAND>\/\fR
.
.
.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\.
.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.
.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>`\.
.P
Here is a common use\-case for this:

.EX
\fBoutput\-1\fR:
    \fBworkspace group\fR 1:
        workspace \fB11\fR: chats
        workspace \fB12\fR: emails
\fBoutput\-2\fR:
    \fBworkspace group\fR 2:
        workspace \fB21\fR: IDE for first project
        workspace \fB22\fR: browser for first project
        workspace \fB23\fR: terminals for first project
    \fBworkspace group\fR 3:
        workspace \fB31\fR: IDE for second project
        workspace \fB32\fR: browser for second project
        workspace \fB33\fR: terminals for second project
.EE

.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\.
.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`)\.
.P
`swaysome` may also work with i3, but this is untested\.
.P
`swaysome` should be compatible with sworkstyle \fIhttps://lib\.rs/crates/sworkstyle\fR\. If this is broken, please report a bug\.
.
.
.SH USAGE
.P
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/*.conf

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
workspace `21` on the second one, both accessible with shortcut `$mod+1` when
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
.TP
init
Initialize the workspace groups for all the outputs
.TP
move
Move the focused container to another workspace on the same workspace group
.TP
move\-to\-group
Move the focused container to the same workspace index on another workspace group
.TP
focus
Focus to another workspace on the same workspace group
.TP
focus\-group
Focus to workspace group
.TP
focus\-all\-outputs
Focus to another workspace on all the outputs
.TP
next\-output
Move the focused container to the next output
.TP
prev\-output
Move the focused container to the previous output
.TP
workspace\-group\-next\-output
Move the focused workspace group to the next output
.TP
workspace\-group\-prev\-output
Move the focused workspace group to the previous output
.TP
next\-group
Move the focused container to the next group
.TP
prev\-group
Move the focused container to the previous group
.TP
rearrange\-workspaces
Rearrange already opened workspaces to the correct outputs, useful when plugging new monitors
.TP
help
Print this message or the help of the given subcommand(s)
.
.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
.
.
.SH "VERSION"
2.1.0
.
.
.SH "HOMEPAGE"
\fIhttps://gitlab.com/hyask/swaysome\fP
.sp
Please report any bug or feature requests on the bug tracker.
.
.
.SH AUTHORS
Florent 'Skia' Jacquet <\fIskia@hya.sk\fP>