aboutsummaryrefslogtreecommitdiffstats
path: root/sway/sway.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'sway/sway.1.txt')
-rw-r--r--sway/sway.1.txt109
1 files changed, 0 insertions, 109 deletions
diff --git a/sway/sway.1.txt b/sway/sway.1.txt
deleted file mode 100644
index 17fc13da..00000000
--- a/sway/sway.1.txt
+++ /dev/null
@@ -1,109 +0,0 @@
1/////
2vim:set ft=asciidoc ts=4 sw=4 tw=82 noet:
3/////
4:quotes.~:
5
6sway (1)
7========
8
9Name
10----
11sway - SirCmpwn's Wayland window manager
12
13Synopsis
14--------
15'sway' [options] [command]
16
17Options
18-------
19
20*-h, --help*::
21 Show help message and quit.
22
23*-c, \--config* <config>::
24 Specifies a config file.
25
26*-C, \--validate*::
27 Check the validity of the config file, then exit.
28
29*-d, --debug*::
30 Enables full logging, including debug information.
31
32*-v, \--version*::
33 Show the version number and quit.
34
35*-V, --verbose*::
36 Enables more verbose logging.
37
38*--get-socketpath*::
39 Gets the IPC socket path and prints it, then exits.
40
41Description
42-----------
43
44sway was created to fill the need of an i3-like window manager for Wayland. The
45upstream i3 developers have no intention of porting i3 to Wayland, and projects
46proposed by others ended up as vaporware. Many thanks to the i3 folks for
47providing such a great piece of software, so good that your users would rather
48write an entirely new window manager from scratch that behaved _exactly_ like i3
49rather than switch to something else.
50
51Launch sway directly from a tty or via your favorite Wayland-compatible login
52manager.
53
54Commands
55--------
56
57If sway is currently running, you may run _sway [command]_ to send _command_ to
58the running instance of sway. The same commands you would use in the config file
59are valid here (see **sway**(5)). For compatibility reasons, you may also issue
60commands with **swaymsg**(1) or **i3-msg**(1) (or even with **i3**(1), probably).
61
62Configuration
63-------------
64
65The path to a config file can be given via the _-c_ parameter, else
66sway searches for it in the following locations:
67- ~/.sway/config
68- $XDG_CONFIG_HOME/sway/config (suggested location)
69- ~/.i3/config
70- $XDG_CONFIG_HOME/i3/config (XDG_HOME )
71- /etc/sway/config
72- /etc/i3/config
73
74In /etc/sway/config the standard config file is installed.
75An error is raised when no config file is found.
76
77To write your own configuration, it's suggested that you copy the default config file to
78the location of your choosing and start there.
79
80For information on the config file format, see **sway**(5).
81
82Environment
83-----------
84
85The following environment variables have an effect on sway:
86
87*SWAY_CURSOR_THEME*::
88 Specifies the name of the cursor theme to use.
89
90*SWAY_CURSOR_SIZE*::
91 Specifies the size of the cursor to use.
92
93*SWAYSOCK*::
94 Specifies the path to the sway IPC socket.
95
96*XKB_DEFAULT_RULES*, *XKB_DEFAULT_MODEL*, *XKB_DEFAULT_LAYOUT*, *XKB_DEFAULT_VARIANT*, *XKB_DEFAULT_OPTIONS*::
97 Configures the xkb keyboard settings. See xkeyboard-config(7).
98
99Authors
100-------
101
102Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
103source contributors. For more information about sway development, see
104<https://github.com/swaywm/sway>.
105
106See Also
107--------
108
109**sway**(5) **swaymsg**(1) **swaygrab**(1) **sway-input**(5) **sway-bar**(5)