diff options
Diffstat (limited to 'sway.1.txt')
-rw-r--r-- | sway.1.txt | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/sway.1.txt b/sway.1.txt new file mode 100644 index 00000000..36586e1d --- /dev/null +++ b/sway.1.txt | |||
@@ -0,0 +1,84 @@ | |||
1 | ///// | ||
2 | vim:set ts=4 sw=4 tw=82 noet: | ||
3 | ///// | ||
4 | :quotes.~: | ||
5 | |||
6 | sway (1) | ||
7 | ======== | ||
8 | |||
9 | Name | ||
10 | ---- | ||
11 | sway - SirCmpwn's Wayland window manager | ||
12 | |||
13 | Synopsis | ||
14 | -------- | ||
15 | 'sway' [options] [command] | ||
16 | |||
17 | Options | ||
18 | ------- | ||
19 | |||
20 | *-c, \--config* <config>:: | ||
21 | Specifies a config file. | ||
22 | |||
23 | *-C, \--validate*:: | ||
24 | Check the validity of the config file, then exit. | ||
25 | |||
26 | *-d, --debug*:: | ||
27 | Enables full logging, including debug information. | ||
28 | |||
29 | *-v, \--version*:: | ||
30 | Show the version number and quit. | ||
31 | |||
32 | *-V, --verbose*:: | ||
33 | Enables more verbose logging. | ||
34 | |||
35 | *--get-socketpath*:: | ||
36 | Gets the IPC socket path and prints it, then exits. | ||
37 | |||
38 | Description | ||
39 | ----------- | ||
40 | |||
41 | sway was created to fill the need of an i3-like window manager for Wayland. The | ||
42 | upstream i3 developers have no intention of porting i3 to Wayland, and projects | ||
43 | proposed by others ended up as vaporware. Many thanks to the i3 folks for | ||
44 | providing such a great piece of software, so good that your users would rather | ||
45 | write an entirely new window manager from scratch that behaved _exactly_ like i3 | ||
46 | rather than switch to something else. | ||
47 | |||
48 | You may run sway from an ongoing x11 session to run it within x. Otherwise, you | ||
49 | can run sway on a tty and it will use your outputs directly. | ||
50 | |||
51 | *Important note for nvidia users*: The proprietary nvidia driver does _not_ have | ||
52 | support for Wayland as of 2015-08-17. Use nouveau. | ||
53 | |||
54 | Commands | ||
55 | -------- | ||
56 | |||
57 | If sway is currently running, you may run _sway [command]_ to send _command_ to | ||
58 | the running instance of sway. The same commands you would use in the config file | ||
59 | are valid here (see **sway**(5)). For compatability reasons, you may also issue | ||
60 | commands with **sway-msg**(1) or **i3-msg**(1) (or even with **i3**(1), probably). | ||
61 | |||
62 | Configuration | ||
63 | ------------- | ||
64 | |||
65 | If _-c_ is not specified, sway will look in several locations for your config | ||
66 | file. The default one is provided at /etc/sway/config. The suggested location for | ||
67 | your config file is ~/.config/sway/config. ~/.sway/config will also work, and the | ||
68 | rest of the usual XDG config locations are supported. If no sway config is found, | ||
69 | sway will attempt to load an i3 config from all the config locations i3 supports. | ||
70 | If still nothing is found, you will receive an error. | ||
71 | |||
72 | For information on the config file format, see **sway**(5). | ||
73 | |||
74 | Authors | ||
75 | ------- | ||
76 | |||
77 | Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open | ||
78 | source contributors. For more information about sway development, see | ||
79 | <https://github.com/SirCmpwn/sway>. | ||
80 | |||
81 | See Also | ||
82 | -------- | ||
83 | |||
84 | **sway**(5) | ||