diff options
author | 2018-05-11 20:58:34 -0400 | |
---|---|---|
committer | 2018-05-11 21:03:43 -0400 | |
commit | 432256ad84af0b6ef62ff92fe3248d2ce8ceffd4 (patch) | |
tree | 066fa73134aa168f00d5403657371ce2b83921e5 /sway/sway.1.txt | |
parent | Wire up scdoc and rewrite sway(1) (diff) | |
download | sway-432256ad84af0b6ef62ff92fe3248d2ce8ceffd4.tar.gz sway-432256ad84af0b6ef62ff92fe3248d2ce8ceffd4.tar.zst sway-432256ad84af0b6ef62ff92fe3248d2ce8ceffd4.zip |
Add sway(5)
Diffstat (limited to 'sway/sway.1.txt')
-rw-r--r-- | sway/sway.1.txt | 109 |
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 | ///// | ||
2 | vim:set ft=asciidoc 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 | *-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 | |||
41 | Description | ||
42 | ----------- | ||
43 | |||
44 | sway was created to fill the need of an i3-like window manager for Wayland. The | ||
45 | upstream i3 developers have no intention of porting i3 to Wayland, and projects | ||
46 | proposed by others ended up as vaporware. Many thanks to the i3 folks for | ||
47 | providing such a great piece of software, so good that your users would rather | ||
48 | write an entirely new window manager from scratch that behaved _exactly_ like i3 | ||
49 | rather than switch to something else. | ||
50 | |||
51 | Launch sway directly from a tty or via your favorite Wayland-compatible login | ||
52 | manager. | ||
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 compatibility reasons, you may also issue | ||
60 | commands with **swaymsg**(1) or **i3-msg**(1) (or even with **i3**(1), probably). | ||
61 | |||
62 | Configuration | ||
63 | ------------- | ||
64 | |||
65 | The path to a config file can be given via the _-c_ parameter, else | ||
66 | sway 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 | |||
74 | In /etc/sway/config the standard config file is installed. | ||
75 | An error is raised when no config file is found. | ||
76 | |||
77 | To write your own configuration, it's suggested that you copy the default config file to | ||
78 | the location of your choosing and start there. | ||
79 | |||
80 | For information on the config file format, see **sway**(5). | ||
81 | |||
82 | Environment | ||
83 | ----------- | ||
84 | |||
85 | The 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 | |||
99 | Authors | ||
100 | ------- | ||
101 | |||
102 | Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open | ||
103 | source contributors. For more information about sway development, see | ||
104 | <https://github.com/swaywm/sway>. | ||
105 | |||
106 | See Also | ||
107 | -------- | ||
108 | |||
109 | **sway**(5) **swaymsg**(1) **swaygrab**(1) **sway-input**(5) **sway-bar**(5) | ||