diff options
-rw-r--r-- | CMakeLists.txt | 26 | ||||
-rw-r--r-- | README.md | 1 | ||||
-rw-r--r-- | sway.1.txt | 82 | ||||
-rw-r--r-- | sway.5.txt | 90 |
4 files changed, 199 insertions, 0 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 27839b1d..9a49c169 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt | |||
@@ -43,3 +43,29 @@ INSTALL( | |||
43 | FILES ${PROJECT_SOURCE_DIR}/config | 43 | FILES ${PROJECT_SOURCE_DIR}/config |
44 | DESTINATION /etc/sway/ | 44 | DESTINATION /etc/sway/ |
45 | ) | 45 | ) |
46 | |||
47 | ADD_CUSTOM_COMMAND(OUTPUT ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sway.1 | ||
48 | COMMAND a2x --no-xmllint --doctype manpage --format manpage | ||
49 | -D ${CMAKE_RUNTIME_OUTPUT_DIRECTORY} ${CMAKE_CURRENT_SOURCE_DIR}/sway.1.txt | ||
50 | DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/sway.1.txt | ||
51 | ) | ||
52 | |||
53 | ADD_CUSTOM_COMMAND(OUTPUT ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sway.5 | ||
54 | COMMAND a2x --no-xmllint --doctype manpage --format manpage | ||
55 | -D ${CMAKE_RUNTIME_OUTPUT_DIRECTORY} ${CMAKE_CURRENT_SOURCE_DIR}/sway.5.txt | ||
56 | DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/sway.5.txt | ||
57 | ) | ||
58 | |||
59 | ADD_CUSTOM_TARGET(man ALL | ||
60 | DEPENDS ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sway.1 | ||
61 | DEPENDS ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sway.5) | ||
62 | |||
63 | INSTALL( | ||
64 | FILES ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sway.1 | ||
65 | DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1 | ||
66 | ) | ||
67 | |||
68 | INSTALL( | ||
69 | FILES ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/sway.5 | ||
70 | DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man5 | ||
71 | ) | ||
@@ -31,6 +31,7 @@ Dependencies: | |||
31 | * cmake | 31 | * cmake |
32 | * [wlc](https://github.com/Cloudef/wlc) | 32 | * [wlc](https://github.com/Cloudef/wlc) |
33 | * xwayland | 33 | * xwayland |
34 | * asciidoc | ||
34 | 35 | ||
35 | Compiling: | 36 | Compiling: |
36 | 37 | ||
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) | ||
diff --git a/sway.5.txt b/sway.5.txt new file mode 100644 index 00000000..9f92dfe8 --- /dev/null +++ b/sway.5.txt | |||
@@ -0,0 +1,90 @@ | |||
1 | ///// | ||
2 | vim:set ts=4 sw=4 tw=82 noet: | ||
3 | ///// | ||
4 | sway (5) | ||
5 | ======== | ||
6 | |||
7 | Name | ||
8 | ---- | ||
9 | sway - configuration file and commands | ||
10 | |||
11 | Description | ||
12 | ----------- | ||
13 | |||
14 | A sway configuration file is a list of sway commands that are exected by sway on | ||
15 | startup. These commands usually consist of setting your preferences and setting | ||
16 | key bindings. An example config is likely present in /etc/sway/config for you to | ||
17 | check out. | ||
18 | |||
19 | All of these commands may be issued at runtime through **sway-msg**(1). | ||
20 | |||
21 | Commands | ||
22 | -------- | ||
23 | |||
24 | **bindsym** <key combo> <command>:: | ||
25 | Binds _key combo_ to execute _command_ when pressed. You may use XKB key names | ||
26 | here (**xev**(1) is a good tool for discovering them). An example bindsym | ||
27 | command would be _bindsym Mod1+Shift+f exec firefox_, which would execute | ||
28 | Firefox if the alt, shift, and F keys are pressed together. Any valid sway | ||
29 | command is eligible to be bound to a key combo. | ||
30 | |||
31 | **exec** <shell command>:: | ||
32 | Executes _shell command_ with sh. | ||
33 | |||
34 | **exec_always** <shell command>:: | ||
35 | Like exec, but the shell command will be executed _again_ after *reload* or | ||
36 | *restart* is executed. | ||
37 | |||
38 | **exit**:: | ||
39 | Exit sway and end your Wayland session. | ||
40 | |||
41 | **floating** toggle:: | ||
42 | Toggles the "floating" status of the focused view. | ||
43 | |||
44 | **focus** <direction>:: | ||
45 | Direction may be one of _up_, _down_, _left_, _right_, or _parent_. The | ||
46 | directional focus commands will move the focus in that direction. The parent | ||
47 | focus command will change the focus to the parent of the currently focused | ||
48 | container, which is useful, for example, to open a sibling of the parent | ||
49 | container, or to move the entire container around. | ||
50 | |||
51 | **focus_follows_mouse** <yes|no>:: | ||
52 | If set to _yes_, the currently focused view will change as you move your | ||
53 | mouse around the screen to the view that ends up underneath your mouse. | ||
54 | |||
55 | **kill**:: | ||
56 | Closes the currently focused view. | ||
57 | |||
58 | **layout** <mode>:: | ||
59 | Sets the layout mode of the focused container. _mode_ can be one of _splith_, | ||
60 | _splitv_, or _toggle split_. | ||
61 | |||
62 | **reload**:: | ||
63 | Reloads the sway config file without restarting sway. | ||
64 | |||
65 | **set** <name> <value>:: | ||
66 | Creates a substitution for _value_ that can be used with $_name_ in other | ||
67 | commands. | ||
68 | |||
69 | **split** <vertical|horizontal>:: | ||
70 | Splits the current container, vertically or horiziontally. The letters "h" and | ||
71 | "v" can be used instead of the full words "vertical" or "horizontal". | ||
72 | |||
73 | **splith**:: | ||
74 | Equivalent to **split horizontal**. | ||
75 | |||
76 | **splitv**:: | ||
77 | Equivalent to **split vertical**. | ||
78 | |||
79 | **fullscreen**: | ||
80 | Toggles fullscreen status for the focused view. | ||
81 | |||
82 | **workspace** <name>: | ||
83 | Switches to the specified workspace. | ||
84 | |||
85 | **workspace** <prev_on_output|next_on_output>: | ||
86 | Switches to the next workspace on the current output. | ||
87 | |||
88 | **workspace** <name> output <output>:: | ||
89 | Specifies that the workspace named _name_ should appear on the specified | ||
90 | _output_. | ||