aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Drew DeVault <sir@cmpwn.com>2017-10-14 15:50:35 -0400
committerLibravatar Drew DeVault <sir@cmpwn.com>2017-10-16 21:03:46 -0400
commitbfc5150328d15197c4cce34eb9e3e492e2966c1a (patch)
tree8765ea2fc4720cbda14b85da8d0ef2aeacdff2ea
parentMerge pull request #1397 from johalun/manpages (diff)
downloadsway-bfc5150328d15197c4cce34eb9e3e492e2966c1a.tar.gz
sway-bfc5150328d15197c4cce34eb9e3e492e2966c1a.tar.zst
sway-bfc5150328d15197c4cce34eb9e3e492e2966c1a.zip
Merge pull request #1400 from madblobfish/manpages
Various manpage edits
-rw-r--r--sway/sway-bar.5.txt10
-rw-r--r--sway/sway-input.5.txt6
-rw-r--r--sway/sway-security.7.txt19
-rw-r--r--sway/sway.1.txt23
-rw-r--r--sway/sway.5.txt32
5 files changed, 46 insertions, 44 deletions
diff --git a/sway/sway-bar.5.txt b/sway/sway-bar.5.txt
index 29487662..99238952 100644
--- a/sway/sway-bar.5.txt
+++ b/sway/sway-bar.5.txt
@@ -11,8 +11,8 @@ sway-bar - bar configuration file and commands
11Description 11Description
12----------- 12-----------
13 13
14Sway allows for configuration of swaybar within the sway configuation file. 14Sway allows configuring swaybar in the sway configuration file.
15Swaybar commands must be used inside a _bar { }_ block in the config. 15Swaybar commands must be used inside a _bar { }_ block in the config file.
16 16
17 17
18Commands 18Commands
@@ -77,15 +77,15 @@ codes in this manner.
77 77
78**activate_button** <button>:: 78**activate_button** <button>::
79 Sets the button to be used for the _activate_ (primary click) tray item 79 Sets the button to be used for the _activate_ (primary click) tray item
80 event. By default is BTN_LEFT (0x110). 80 event. The default is BTN_LEFT (0x110).
81 81
82**context_button** <button>:: 82**context_button** <button>::
83 Sets the button to be used for the _context menu_ (right click) tray item 83 Sets the button to be used for the _context menu_ (right click) tray item
84 event. By default is BTN_RIGHT (0x111). 84 event. The default is BTN_RIGHT (0x111).
85 85
86**secondary_button** <button>:: 86**secondary_button** <button>::
87 Sets the button to be used for the _secondary_ (middle click) tray item 87 Sets the button to be used for the _secondary_ (middle click) tray item
88 event. By default is BTN_MIDDLE (0x112). 88 event. The default is BTN_MIDDLE (0x112).
89 89
90**tray_output** none|all|<name>:: 90**tray_output** none|all|<name>::
91 Sets the output that the tray will appear on or none. Unlike i3bar, swaybar 91 Sets the output that the tray will appear on or none. Unlike i3bar, swaybar
diff --git a/sway/sway-input.5.txt b/sway/sway-input.5.txt
index f44a3179..f0c8f87c 100644
--- a/sway/sway-input.5.txt
+++ b/sway/sway-input.5.txt
@@ -12,8 +12,8 @@ Description
12----------- 12-----------
13 13
14Sway allows for configuration of libinput devices within the sway configuration file. 14Sway allows for configuration of libinput devices within the sway configuration file.
15sway-input commands must be used inside a _input { }_ block in the config. 15sway-input commands must be used inside an _input { }_ block in the config.
16To obtain a list of available devices identifier, run **swaymsg -t get_inputs**. 16To obtain a list of available device identifiers, run **swaymsg -t get_inputs**.
17 17
18Commands 18Commands
19-------- 19--------
@@ -32,7 +32,7 @@ Commands
32 32
33**input** <identifier> events <enabled|disabled|disabled_on_external_mouse>:: 33**input** <identifier> events <enabled|disabled|disabled_on_external_mouse>::
34 Enables or disables send_events for specified input device. 34 Enables or disables send_events for specified input device.
35 (Disabling send_events disables the input device) 35 (Disabling send_events disables the input device)
36 36
37**input** <identifier> left_handed <enabled|disabled>:: 37**input** <identifier> left_handed <enabled|disabled>::
38 Enables or disables left handed mode for specified input device. 38 Enables or disables left handed mode for specified input device.
diff --git a/sway/sway-security.7.txt b/sway/sway-security.7.txt
index aee3793c..c8d6758c 100644
--- a/sway/sway-security.7.txt
+++ b/sway/sway-security.7.txt
@@ -15,8 +15,8 @@ Security Overview
15figured out yet. The following man page is provisional. 15figured out yet. The following man page is provisional.
16 16
17Securing sway requires careful configuration of your environment, the sort that's 17Securing sway requires careful configuration of your environment, the sort that's
18usually best suited to a distro maintainer who wants to ship a secure sway 18usually best suited to a distribution maintainer who wants to ship a secure sway
19environment in their distro. Sway provides a number of means of securing it but 19environment in their distribution. Sway provides a number of means of securing it but
20you must make a few changes external to sway first. 20you must make a few changes external to sway first.
21 21
22Configuration of security features is limited to files in the security directory 22Configuration of security features is limited to files in the security directory
@@ -31,7 +31,7 @@ Environment security
31-------------------- 31--------------------
32 32
33LD_PRELOAD is a mechanism designed to ruin the security of your system. There are 33LD_PRELOAD is a mechanism designed to ruin the security of your system. There are
34a number of strategies for dealing with this but they all suck a little. In order 34a number of strategies for dealing with this, but they all suck a little. In order
35of most practical to least practical: 35of most practical to least practical:
36 36
371. Only run important programs via exec. Sway's exec command will ensure that 371. Only run important programs via exec. Sway's exec command will ensure that
@@ -50,8 +50,7 @@ compromised by LD_PRELOAD. It probably isn't, but you can be sure by setting
50permit LD_PRELOAD for it (and will also run it as root, which sway will shortly 50permit LD_PRELOAD for it (and will also run it as root, which sway will shortly
51drop). You could also statically link sway itself. 51drop). You could also statically link sway itself.
52 52
53Note that LD_LIBRARY_PATH has all of the same problems, and all of the same 53Note that LD_LIBRARY_PATH has all of these problems, and the same solutions.
54solutions.
55 54
56Read your log 55Read your log
57------------- 56-------------
@@ -93,16 +92,16 @@ policies. These features are:
93 Permission to take screenshots or record the screen. 92 Permission to take screenshots or record the screen.
94 93
95By default, no permissions are granted (though saner defaults are provided in 94By default, no permissions are granted (though saner defaults are provided in
96/etc/sway/config.d/security). You can use the following config commands to control 95/etc/sway/config.d/security). You can use the following configuration options to control
97a program's access: 96a program's access:
98 97
99**permit** <executable> <features...>:: 98**permit** <executable> <features...>::
100 Permits <executable> to use <features> (each feature seperated by a space). 99 Permits <executable> to use <features> (each feature separated by a space).
101 <executable> may be * to affect the default policy, or the full path to the 100 <executable> may be * to affect the default policy, or the full path to the
102 executable file. 101 executable file.
103 102
104**reject** <executable> <features...>:: 103**reject** <executable> <features...>::
105 Disallows <executable> from using <features> (each feature seperated by a space). 104 Disallows <executable> from using <features> (each feature separated by a space).
106 <executable> may be * to affect the default policy, or the full path to the 105 <executable> may be * to affect the default policy, or the full path to the
107 executable file. 106 executable file.
108 107
@@ -154,7 +153,7 @@ a commands block and fill it with policies:
154 } 153 }
155 154
156For example, you could do this to limit the use of the focus command to just 155For example, you could do this to limit the use of the focus command to just
157binding and critiera: 156binding and criteria:
158 157
159 commands { 158 commands {
160 focus binding criteria 159 focus binding criteria
@@ -210,7 +209,7 @@ You can also control which IPC events can be raised with an events block:
210 } 209 }
211 } 210 }
212 211
213The following commands are vaild within an ipc events block: 212The following commands are valid within an IPC events block:
214 213
215**binding** <enabled|disabled>:: 214**binding** <enabled|disabled>::
216 Controls keybinding notifications (disabled by default). 215 Controls keybinding notifications (disabled by default).
diff --git a/sway/sway.1.txt b/sway/sway.1.txt
index 4a1aef99..14ab9f49 100644
--- a/sway/sway.1.txt
+++ b/sway/sway.1.txt
@@ -62,16 +62,19 @@ commands with **swaymsg**(1) or **i3-msg**(1) (or even with **i3**(1), probably)
62Configuration 62Configuration
63------------- 63-------------
64 64
65If _-c_ is not specified, sway will look in several locations for your config 65The path to a config file can be given via the _-c_ parameter, else
66file. The suggested location for your config file is ~/.config/sway/config. 66sway searches for it in the following locations:
67~/.sway/config will also work, and the rest of the usual XDG config locations 67- ~/.sway/config
68are supported. If no sway config is found, sway will attempt to load an i3 68- $XDG_CONFIG_HOME/sway/config (suggested location)
69config from all the config locations i3 supports. Sway looks for a config file in 69- ~/.i3/config
70a fallback directory as a last resort, which is /etc/sway/ by default. A standard 70- $XDG_CONFIG_HOME/i3/config (XDG_HOME )
71configuration file is installed at this location. If still nothing is found, 71- /etc/sway/config
72you will receive an error. 72- /etc/i3/config
73 73
74To write your own config, it's suggested that you copy the default config file to 74In /etc/sway/config the standard config file is installed.
75An error is raised when no config file is found.
76
77To write your own configuration, it's suggested that you copy the default config file to
75the location of your choosing and start there. 78the location of your choosing and start there.
76 79
77For information on the config file format, see **sway**(5). 80For information on the config file format, see **sway**(5).
diff --git a/sway/sway.5.txt b/sway/sway.5.txt
index 731394dd..750254c8 100644
--- a/sway/sway.5.txt
+++ b/sway/sway.5.txt
@@ -73,7 +73,7 @@ They are expected to be used with **bindsym** or at runtime through **swaymsg**(
73**focus** output <direction|name>:: 73**focus** output <direction|name>::
74 Direction may be one of _up_, _down_, _left_, _right_. The directional focus 74 Direction may be one of _up_, _down_, _left_, _right_. The directional focus
75 commands will move the focus to the output in that direction. When name is 75 commands will move the focus to the output in that direction. When name is
76 given the focus is changed to the output with that name. 76 given, the focus is changed to the output with that name.
77 77
78**focus** mode_toggle:: 78**focus** mode_toggle::
79 Toggles focus between floating view and tiled view. 79 Toggles focus between floating view and tiled view.
@@ -148,7 +148,7 @@ They are expected to be used with **bindsym** or at runtime through **swaymsg**(
148 through the windows in the scratchpad. 148 through the windows in the scratchpad.
149 149
150**split** <vertical|v|horizontal|h|toggle|t>:: 150**split** <vertical|v|horizontal|h|toggle|t>::
151 Splits the current container, vertically or horizontally. If toggled then the 151 Splits the current container, vertically or horizontally. If toggled, then the
152 current container is split opposite to the parent container. 152 current container is split opposite to the parent container.
153 153
154**splith**:: 154**splith**::
@@ -185,10 +185,10 @@ or triggered at runtime.
185 185
186**client**.<color_class> <border> <background> <text> <indicator> <child_border>:: 186**client**.<color_class> <border> <background> <text> <indicator> <child_border>::
187 The client commands control the colors of the view borders and title bars. All 187 The client commands control the colors of the view borders and title bars. All
188 of the client commands _require_ five color values. (The one exception is 188 client commands _require_ five color values. (The one exception is
189 **client.background** which _requires_ one color value.) If you only want to 189 **client.background** which _requires_ one color value.) If you only want to
190 specify a subset, supply default colors for all the others. Colors must be 190 specify a subset, supply default colors for all the others. Colors must be
191 defined in hex. i.e. _#rrggbb_ or _#rrggbbaa_ when including the alpha 191 defined in hex. i.e. _#rrggbb_ or _#rrggbbaa_, when including the alpha
192 channel. 192 channel.
193 + 193 +
194 The command tokens are: 194 The command tokens are:
@@ -258,7 +258,7 @@ The default colors are:
258 Uses the container dimensions as default. 258 Uses the container dimensions as default.
259 -1 x -1 will remove any restriction on dimensions. 259 -1 x -1 will remove any restriction on dimensions.
260 0 x 0 has the same behavior as not setting any value. 260 0 x 0 has the same behavior as not setting any value.
261 If in conflict this option has precedence over floating_minimum_size. 261 If in conflict, this option has precedence over floating_minimum_size.
262 262
263**floating_minimum_size** <width> x <height>:: 263**floating_minimum_size** <width> x <height>::
264 Specifies the minimum dimensions of floating windows. 264 Specifies the minimum dimensions of floating windows.
@@ -338,8 +338,8 @@ The default colors are:
338 338
339**mode** <mode_name>:: 339**mode** <mode_name>::
340 Switches to the given mode_name. The default mode is simply _default_. To 340 Switches to the given mode_name. The default mode is simply _default_. To
341 create a new mode in config append _{_ to this command, the following lines 341 create a new mode append _{_ to this command, the following lines
342 will be keybinds for that mode, and _}_ on its own line to close the block. 342 will be keybindings for that mode, and _}_ on its own line to close the block.
343 343
344**mouse_warping** <output|none>:: 344**mouse_warping** <output|none>::
345 When _output_: place mouse at center of newly focused window when changing 345 When _output_: place mouse at center of newly focused window when changing
@@ -352,7 +352,7 @@ The default colors are:
352**output** <name> <resolution|res> <WIDTHxHEIGHT>:: 352**output** <name> <resolution|res> <WIDTHxHEIGHT>::
353 Configures the specified output to use the given resolution. 353 Configures the specified output to use the given resolution.
354 + 354 +
355 _Note_: sway does not currently support modesetting. Your output's native 355 _Note_: sway does not currently support setting the output mode. Your output's native
356 resolution will be used and the screen will be scaled from the resolution 356 resolution will be used and the screen will be scaled from the resolution
357 specified to your native resolution. 357 specified to your native resolution.
358 358
@@ -399,12 +399,12 @@ The default colors are:
399 399
400**unmark** <identifier>:: 400**unmark** <identifier>::
401 **Unmark** will remove _identifier_ from the list of current marks on a window. If 401 **Unmark** will remove _identifier_ from the list of current marks on a window. If
402 no _identifier_ is specified then **unmark** will remove all marks. 402 no _identifier_ is specified, then **unmark** will remove all marks.
403 403
404**workspace** [number] <name>:: 404**workspace** [number] <name>::
405 Switches to the specified workspace. The string "number" is optional. The 405 Switches to the specified workspace. The string "number" is optional. The
406 worspace _name_, if unquoted, may not contain the string "output", as sway 406 workspace _name_, if unquoted, may not contain the string "output", as sway
407 will assume that the command is moving a worspace to an output, as described 407 will assume that the command is moving a workspace to an output, as described
408 below. 408 below.
409 409
410**workspace** <prev|next>:: 410**workspace** <prev|next>::
@@ -438,9 +438,9 @@ A criteria is a string in the form of e.g.:
438 438
439 [class="[Rr]egex.*" title="some title"] 439 [class="[Rr]egex.*" title="some title"]
440 440
441The string contains one or more (space separated) attribute/value pairs and they 441The string contains one or more (space separated) attribute/value pairs. They
442are used by some commands filter which views to execute actions on. All attributes 442are used by some commands to choose which views to execute actions on. All attributes
443must match for the criteria string to match. 443must match for the criteria to match.
444 444
445Criteria may be used with either the **for_window** or **assign** commands to 445Criteria may be used with either the **for_window** or **assign** commands to
446specify operations to perform on new views. A criteria may also be used to 446specify operations to perform on new views. A criteria may also be used to
@@ -460,7 +460,7 @@ Currently supported attributes:
460 460
461**class**:: 461**class**::
462 Compare value against the window class. Can be a regular expression. If value 462 Compare value against the window class. Can be a regular expression. If value
463 is _focused_ then the window class must be the same as that of the currently 463 is _focused_, then the window class must be the same as that of the currently
464 focused window. 464 focused window.
465 465
466**con_id**:: 466**con_id**::
@@ -485,7 +485,7 @@ Currently supported attributes:
485 485
486**workspace**:: 486**workspace**::
487 Compare against the workspace name for this view. Can be a regular expression. 487 Compare against the workspace name for this view. Can be a regular expression.
488 If value is _focused_ then all the views on the currently focused workspace 488 If the value is _focused_, then all the views on the currently focused workspace
489 matches. 489 matches.
490 490
491See Also 491See Also