diff options
Diffstat (limited to 'sway/sway-output.5.scd')
-rw-r--r-- | sway/sway-output.5.scd | 55 |
1 files changed, 43 insertions, 12 deletions
diff --git a/sway/sway-output.5.scd b/sway/sway-output.5.scd index 69f529fe..7d088d5d 100644 --- a/sway/sway-output.5.scd +++ b/sway/sway-output.5.scd | |||
@@ -24,7 +24,7 @@ must be separated by one space. For example: | |||
24 | 24 | ||
25 | # COMMANDS | 25 | # COMMANDS |
26 | 26 | ||
27 | *output* <name> mode|resolution|res [--custom] <WIDTHxHEIGHT>[@<RATE>Hz] | 27 | *output* <name> mode|resolution|res [--custom] <width>x<height>[@<rate>Hz] |
28 | Configures the specified output to use the given mode. Modes are a | 28 | Configures the specified output to use the given mode. Modes are a |
29 | combination of width and height (in pixels) and a refresh rate that your | 29 | combination of width and height (in pixels) and a refresh rate that your |
30 | display can be configured to use. For a list of available modes for each | 30 | display can be configured to use. For a list of available modes for each |
@@ -40,6 +40,16 @@ must be separated by one space. For example: | |||
40 | 40 | ||
41 | output HDMI-A-1 mode 1920x1080@60Hz | 41 | output HDMI-A-1 mode 1920x1080@60Hz |
42 | 42 | ||
43 | *output* <name> modeline <clock> <hdisplay> <hsync_start> <hsync_end> <htotal> <vdisplay> <vsync_start> <vsync_end> <vtotal> <hsync> <vsync> | ||
44 | Configures the specified output to use the given modeline. It can be | ||
45 | generated using *cvt*(1) and *gtf*(1) commands. See *xorg.conf*(5). | ||
46 | Only supported on DRM backend. | ||
47 | |||
48 | Example: | ||
49 | |||
50 | output HDMI-A-1 modeline 173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync | ||
51 | |||
52 | |||
43 | *output* <name> position|pos <X> <Y> | 53 | *output* <name> position|pos <X> <Y> |
44 | Places the specified output at the specific position in the global | 54 | Places the specified output at the specific position in the global |
45 | coordinate space. The cursor may only be moved between immediately | 55 | coordinate space. The cursor may only be moved between immediately |
@@ -62,13 +72,11 @@ must be separated by one space. For example: | |||
62 | 72 | ||
63 | *output* <name> scale <factor> | 73 | *output* <name> scale <factor> |
64 | Scales the specified output by the specified scale _factor_. An integer is | 74 | Scales the specified output by the specified scale _factor_. An integer is |
65 | recommended, but fractional values are also supported. If a fractional | 75 | recommended, but fractional values are also supported. You may be better |
66 | value are specified, be warned that it is not possible to faithfully | 76 | served by setting an integer scale factor and adjusting the font size of |
67 | represent the contents of your windows - they will be rendered at the next | 77 | your applications to taste. HiDPI isn't supported with Xwayland clients |
68 | highest integer scale factor and downscaled. You may be better served by | 78 | (windows will blur). A fractional scale may be slightly adjusted to match |
69 | setting an integer scale factor and adjusting the font size of your | 79 | requirements of the protocol. |
70 | applications to taste. HiDPI isn't supported with Xwayland clients (windows | ||
71 | will blur). | ||
72 | 80 | ||
73 | *output* <name> scale_filter linear|nearest|smart | 81 | *output* <name> scale_filter linear|nearest|smart |
74 | Indicates how to scale application buffers that are rendered at a scale | 82 | Indicates how to scale application buffers that are rendered at a scale |
@@ -109,12 +117,20 @@ must be separated by one space. For example: | |||
109 | Enables or disables the specified output (all outputs are enabled by | 117 | Enables or disables the specified output (all outputs are enabled by |
110 | default). | 118 | default). |
111 | 119 | ||
120 | As opposed to the _power_ command, the output will lose its current | ||
121 | workspace and windows. | ||
122 | |||
112 | *output* <name> toggle | 123 | *output* <name> toggle |
113 | Toggle the specified output. | 124 | Toggle the specified output. |
114 | 125 | ||
115 | *output* <name> dpms on|off | 126 | *output* <name> power on|off|toggle |
116 | Enables or disables the specified output via DPMS. To turn an output off | 127 | Turns on or off the specified output. |
117 | (ie. blank the screen but keep workspaces as-is), one can set DPMS to off. | 128 | |
129 | As opposed to the _enable_ and _disable_ commands, the output keeps its | ||
130 | current workspaces and windows. | ||
131 | |||
132 | *output* <name> dpms on|off|toggle | ||
133 | Deprecated. Alias for _power_. | ||
118 | 134 | ||
119 | *output* <name> max_render_time off|<msec> | 135 | *output* <name> max_render_time off|<msec> |
120 | Controls when sway composites the output, as a positive number of | 136 | Controls when sway composites the output, as a positive number of |
@@ -142,11 +158,26 @@ must be separated by one space. For example: | |||
142 | Enables or disables adaptive synchronization (often referred to as Variable | 158 | Enables or disables adaptive synchronization (often referred to as Variable |
143 | Refresh Rate, or by the vendor-specific names FreeSync/G-Sync). | 159 | Refresh Rate, or by the vendor-specific names FreeSync/G-Sync). |
144 | 160 | ||
145 | Adaptive sync allows clients to submit frames a little to late without | 161 | Adaptive sync allows clients to submit frames a little too late without |
146 | having to wait a whole refresh period to display it on screen. Enabling | 162 | having to wait a whole refresh period to display it on screen. Enabling |
147 | adaptive sync can improve latency, but can cause flickering on some | 163 | adaptive sync can improve latency, but can cause flickering on some |
148 | hardware. | 164 | hardware. |
149 | 165 | ||
166 | *output* <name> render_bit_depth 8|10 | ||
167 | Controls the color channel bit depth at which frames are rendered; the | ||
168 | default is currently 8 bits per channel. | ||
169 | |||
170 | Setting higher values will not have an effect if hardware and software lack | ||
171 | support for such bit depths. Successfully increasing the render bit depth | ||
172 | will not necessarily increase the bit depth of the frames sent to a display. | ||
173 | An increased render bit depth may provide smoother rendering of gradients, | ||
174 | and screenshots which can more precisely store the colors of programs | ||
175 | which display high bit depth colors. | ||
176 | |||
177 | Warnings: this can break screenshot/screencast programs which have not been | ||
178 | updated to work with different bit depths. This command is experimental, | ||
179 | and may be removed or changed in the future. | ||
180 | |||
150 | # SEE ALSO | 181 | # SEE ALSO |
151 | 182 | ||
152 | *sway*(5) *sway-input*(5) | 183 | *sway*(5) *sway-input*(5) |