summaryrefslogtreecommitdiffstats
path: root/sway
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
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')
-rw-r--r--sway/CMakeLists.txt3
-rw-r--r--sway/sway.1.txt89
-rw-r--r--sway/sway.5.txt220
3 files changed, 312 insertions, 0 deletions
diff --git a/sway/CMakeLists.txt b/sway/CMakeLists.txt
index 49ed24e7..aa553492 100644
--- a/sway/CMakeLists.txt
+++ b/sway/CMakeLists.txt
@@ -46,3 +46,6 @@ install(
46 DESTINATION ${FALLBACK_CONFIG_DIR} 46 DESTINATION ${FALLBACK_CONFIG_DIR}
47 COMPONENT configuration 47 COMPONENT configuration
48) 48)
49
50add_manpage(sway 1)
51add_manpage(sway 5)
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)
diff --git a/sway/sway.5.txt b/sway/sway.5.txt
new file mode 100644
index 00000000..24467d22
--- /dev/null
+++ b/sway/sway.5.txt
@@ -0,0 +1,220 @@
1/////
2vim:set ts=4 sw=4 tw=82 noet:
3/////
4sway (5)
5========
6
7Name
8----
9sway - configuration file and commands
10
11Description
12-----------
13
14A sway configuration file is a list of sway commands that are executed by sway on
15startup. These commands usually consist of setting your preferences and setting
16key bindings. An example config is likely present in /etc/sway/config for you to
17check out.
18
19All of these commands may be issued at runtime through **sway-msg**(1).
20
21Commands
22--------
23
24**bindsym** <key combo> <command>::
25 Binds _key combo_ to execute _command_ when pressed. You may use XKB key
26 names here (**xev**(1) is a good tool for discovering them). An example
27 bindsym command would be _bindsym Mod1+Shift+f exec firefox_, which would
28 execute Firefox if the alt, shift, and F keys are pressed together. Any
29 valid sway 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** <enable|disable|toggle>::
42 Make focused view floating, non-floating, or the opposite of what it is now.
43
44**floating_modifier** <modifier>::
45 When the _modifier_ key is held down, you may use left click to drag floating
46 windows, and right click to resize them. Unlike i3, this modifier may also be
47 used to resize and move windows that are tiled.
48
49**focus** <direction>::
50 Direction may be one of _up_, _down_, _left_, _right_, or _parent_. The
51 directional focus commands will move the focus in that direction. The parent
52 focus command will change the focus to the parent of the currently focused
53 container, which is useful, for example, to open a sibling of the parent
54 container, or to move the entire container around.
55
56**focus** output <direction|name>::
57 Direction may be one of _up_, _down_, _left_, _right_. The directional focus
58 commands will move the focus to the output in that direction. When name is
59 given the focus is changed to the output with that name.
60
61**focus** mode_toggle::
62 Toggles focus between floating view and tiled view.
63
64**focus_follows_mouse** <yes|no>::
65 If set to _yes_, the currently focused view will change as you move your
66 mouse around the screen to the view that ends up underneath your mouse.
67
68**fullscreen**::
69 Toggles fullscreen status for the focused view.
70
71**for_window** <criteria> <command>::
72 Whenever a window that matches _criteria_ appears, run list of commands. See
73 **Criteria** section below.
74
75**gaps** edge_gaps <on|off|toggle>::
76 Whether or not to add gaps between views and workspace edges if amount of
77 inner gap is not zero. When _no_, no gap is added where the view is aligned to
78 the workspace edge, effectively creating gaps only between views.
79
80**gaps** <amount>::
81 Sets default _amount_ pixels as the gap between each view, and around each
82 workspace.
83
84**gaps** <inner|outer> <amount>::
85 Sets default _amount_ pixels as the _inner_ or _outer_ gap, where the former
86 affects spacing between views and the latter affects the space around each
87 workspace.
88
89**gaps** <inner|outer> <all|workspace|current> <set|plus|minus> <amount>::
90 Changes the gaps for the _inner_ or _outer_ gap. _all_ changes the gaps for
91 all views or workspace, _workspace_ changes gaps for all views in current
92 workspace (or current workspace), and _current_ changes gaps for the current
93 view or workspace.
94
95**kill**::
96 Closes the currently focused view.
97
98**layout** <mode>::
99 Sets the layout mode of the focused container. _mode_ can be one of _splith_,
100 _splitv_, or _toggle split_.
101
102**mode** <mode_name>::
103 Switches to the given mode_name. the default mode is simply _default_. To
104 create a new mode in config append _{_ to this command, the following lines
105 will be keybinds for that mode, and _}_ on its own line to close the block.
106
107**move** <left|right|up|down>::
108 Moves the focused container _left_, _right_, _up_, or _down_.
109
110**move** <container|window> to workspace <name>::
111 Moves the focused container to the workspace identified by _name_.
112 _name_ may be a special workspace name. See **workspace**.
113
114**move** <container|window|workspace> to output <name|direction>::
115 Moves the focused container or workspace to the output identified by _name_ or
116 _direction_. _direction_ may be one of _up_, _down_, _left_, _right_.
117
118**mouse_warping** <output|none>::
119 When _output_: place mouse at center of newly focused window when changing
120 output. When _none_: don't move mouse.
121
122**output** <name> <resolution|res> <WIDTHxHEIGHT>::
123 Configures the specified output to use the given resolution.
124
125**output** <name> <position|pos> <X,Y>::
126 Configures the specified output to be arranged at the given position.
127
128**output** <name> <background|bg> <file> <mode>::
129 Sets the wallpaper for the given output to the specified file, using the given
130 scaling mode (one of "stretch", "fill", "fit", "center", "tile").
131
132**output** <name> disable::
133 Disables the specified output.
134
135**NOTES FOR THE OUTPUT COMMAND**::
136 You may combine output commands into one, like so:
137 +
138 output HDMI-A-1 res 1920x1080 pos 1920,0 bg ~/wallpaper.png stretch
139 +
140 You can get a list of output names like so:
141 +
142 swaymsg -t get_outputs
143 +
144 You may also match any output by using the output name "*". Be sure to add
145 this output config after the others, or it will be matched instead of the
146 others.
147
148**reload**::
149 Reloads the sway config file without restarting sway.
150
151**resize** <shrink|grow> <width|height> <amount>::
152 Resizes the currently focused container or view by _amount_. _amount_ can be
153 specified as "n px" or "n ppt" or "n px or n ppt".
154
155**seamless_mouse** <on|off>::
156 Change output seamlessly when pointer touches edge of output. Outputs need to
157 be configured with perfectly aligned adjacent positions for this option to
158 have any effect.
159
160**set** <name> <value>::
161 Creates a substitution for _value_ that can be used with $_name_ in other
162 commands.
163
164**split** <vertical|v|horizontal|h>::
165 Splits the current container, vertically or horizontally.
166
167**splith**::
168 Equivalent to **split horizontal**.
169
170**splitv**::
171 Equivalent to **split vertical**.
172
173**sticky** <enable|disable|toggle>::
174 If enabled and the windows is floating it will always be present on the active
175 workspace on that output.
176
177**workspace** <name>::
178 Switches to the specified workspace.
179
180**workspace** <prev|next>::
181 Switches to the next workspace on the current output or on the next output
182 if currently on the last workspace.
183
184**workspace** <prev_on_output|next_on_output>::
185 Switches to the next workspace on the current output.
186
187**workspace** <name> output <output>::
188 Specifies that the workspace named _name_ should appear on the specified
189 _output_.
190
191Criteria
192--------
193
194A criteria is a string in the form of e.g.:
195
196 [class="[Rr]egex.*" title="some title"]
197
198The string contains one or more (space separated) attribute/value pairs and they
199are used by some commands filter which views to execute actions on. All attributes
200must match for the criteria string to match.
201
202Currently supported attributes:
203
204**class**::
205 Compare value against the window class. Can be a regular expression. If value
206 is _focused_ then the window class must be the same as that of the currently
207 focused window.
208
209**id**::
210 Compare value against the app id. Can be a regular expression.
211
212**title**::
213 Compare against the window title. Can be a regular expression. If value is
214 _focused_ then the window title must be the same as that of the currently
215 focused window.
216
217**workspace**::
218 Compare against the workspace name for this view. Can be a regular expression.
219 If value is _focused_ then all the views on the currently focused workspace
220 matches.