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