.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PAPERSWAY 1p"
.TH PAPERSWAY 1p 2024-05-28 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
papersway \- PaperWM\-like scrollable tiling window management for Sway/i3wm
.SH VERSION
.IX Header "VERSION"
version 1.001
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpapersway\fR [\fB\-\-i3status\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is an implementation of PaperWM-like scrollable tiling window management
for Sway/i3wm.  If you like Sway/i3wm's commitments to stability, avoiding
scope creep etc. but dislike the window management model, papersway is an
alternative.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-i3status\fR 4
.IX Item "--i3status"
Start a background instance of \fBi3status\fR, filter and print its output.
.SH USAGE
.IX Header "USAGE"
Here we discuss how to integrate papersway into your existing Sway/i3wm
configuration file, usually found at \fI~/.config/sway/config\fR or
\&\fI~/.config/i3/config\fR, as appropriate.
.SS Activation
.IX Subsection "Activation"
The recommended way to activate papersway is by using it as your bar command:
.Sp
.Vb 2
\&    bar {
\&        status_command papersway \-\-i3status
\&
\&        # [ .. further bar options .. ]
\&    }
.Ve
.PP
This ensures that you can see a visual representation of your paper
workspaces, which will be useful while getting the hang of papersway.
.SS "Binding keys"
.IX Subsection "Binding keys"
Here are some sample bindings to get you started.
.Sp
.Vb 1
\&    set $mod Mod4
\&
\&    bindsym $mod+Left exec papersway\-msg focus left
\&    bindsym $mod+Down focus down
\&    bindsym $mod+Up focus up
\&    bindsym $mod+Right exec papersway\-msg focus right
\&
\&    bindsym $mod+Shift+Left exec papersway\-msg move left
\&    bindsym $mod+Shift+Down move down
\&    bindsym $mod+Shift+Up move up
\&    bindsym $mod+Shift+Right move exec papersway\-msg right
\&
\&    bindsym $mod+f exec papersway\-msg monocle toggle
\&    bindsym $mod+o exec papersway\-msg other column
\&
\&    bindsym $mod+a exec papersway\-msg fresh\-workspace
\&    bindsym $mod+n exec papersway\-msg fresh\-workspace send
\&    bindsym $mod+t exec papersway\-msg fresh\-workspace take
\&
\&    bindsym $mod+e exec papersway\-msg absorb_expel left
\&    bindsym $mod+r exec papersway\-msg absorb_expel right
\&
\&    bindsym $mod+minus exec papersway\-msg cols decr
\&    bindsym $mod+equal exec papersway\-msg cols incr
\&
\&    bindsym $mod+u exec papersway\-msg workspace prev
\&    bindsym $mod+i exec papersway\-msg workspace next
\&    bindsym $mod+Shift+u exec papersway\-msg move_workspace prev
\&    bindsym $mod+Shift+i exec papersway\-msg move_workspace next
\&
\&    bindsym $mod+c [con_mark=caffeinated] inhibit_idle none; \e
\&        inhibit_idle open, mark caffeinated
\&    bindsym $mod+Shift+c [con_mark=caffeinated] inhibit_idle none, \e
\&        mark \-\-toggle caffeinated
\&    for_window [con_mark=caffeinated] inhibit_idle open
.Ve
.PP
Delete any bindings you have for the \fIsplit\fR, \fIsplith\fR, \fIsplitv\fR,
\&\fIsplitt\fR, \fIlayout\fR, \fIfocus parent\fR and \fIfocus child\fR commands, to avoid
confusion (on the parts of both yourself and of papersway).
.SS "Other configuration"
.IX Subsection "Other configuration"
.IP \(bu 4
Set \fIfocus_wrapping\fR to \fIno\fR.
.IP \(bu 4
Leave \fIworkspace_layout\fR with its default value, \fIdefault\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<https://github.com/paperwm/PaperWM>, \fBi3status\fR\|(1), \fBsway\fR\|(5)
.SH AUTHOR
.IX Header "AUTHOR"
Sean Whitton <spwhitton@spwhitton.name>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2019\-2024 by Sean Whitton <spwhitton@spwhitton.name>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve