aboutsummaryrefslogtreecommitdiffstats
path: root/sway/sway.1.txt
diff options
context:
space:
mode:
authorLibravatar Christoph Gysin <christoph.gysin@gmail.com>2015-12-02 12:47:34 +0200
committerLibravatar Christoph Gysin <christoph.gysin@gmail.com>2015-12-02 12:49:01 +0200
commit99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295 (patch)
tree2064357a24faf45ec40ef38475d6a81f13f5eb3f /sway/sway.1.txt
parentMerge pull request #291 from christophgysin/libs (diff)
downloadsway-99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295.tar.gz
sway-99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295.tar.zst
sway-99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295.zip
move manpages to subfolders
Diffstat (limited to 'sway/sway.1.txt')
-rw-r--r--sway/sway.1.txt89
1 files changed, 89 insertions, 0 deletions
diff --git a/sway/sway.1.txt b/sway/sway.1.txt
new file mode 100644
index 00000000..402b2d77
--- /dev/null
+++ b/sway/sway.1.txt
@@ -0,0 +1,89 @@
1/////
2vim:set 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
51You may run sway from an ongoing x11 session to run it within x. Otherwise, you
52can run sway on a tty and it will use your outputs directly.
53
54*Important note for nvidia users*: The proprietary nvidia driver does _not_ have
55support for Wayland as of 2015-08-17. Use nouveau.
56
57Commands
58--------
59
60If sway is currently running, you may run _sway [command]_ to send _command_ to
61the running instance of sway. The same commands you would use in the config file
62are valid here (see **sway**(5)). For compatibility reasons, you may also issue
63commands with **sway-msg**(1) or **i3-msg**(1) (or even with **i3**(1), probably).
64
65Configuration
66-------------
67
68If _-c_ is not specified, sway will look in several locations for your config
69file. The suggested location for your config file is ~/.config/sway/config.
70~/.sway/config will also work, and the rest of the usual XDG config locations
71are supported. At last, sway looks for a config file in a fallback directory,
72which is /etc/sway/ by default. A standard configuration file is installed at
73this location. If no sway config is found, sway will attempt to load an i3
74config from all the config locations i3 supports. If still nothing is found,
75you will receive an error.
76
77For information on the config file format, see **sway**(5).
78
79Authors
80-------
81
82Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
83source contributors. For more information about sway development, see
84<https://github.com/SirCmpwn/sway>.
85
86See Also
87--------
88
89**sway**(5) **swaymsg**(1) **swaygrab**(1)