Debian Codegraph @

upstream/debian-unstable/man1/xrandr.1

raw
1 .\"
2 .\" Copyright 2001 Keith Packard
3 .\"
4 .\" Permission to use, copy, modify, distribute, and sell this software and its
5 .\" documentation for any purpose is hereby granted without fee, provided that
6 .\" the above copyright notice appear in all copies and that both that
7 .\" copyright notice and this permission notice appear in supporting
8 .\" documentation, and that the name of Keith Packard not be used in
9 .\" advertising or publicity pertaining to distribution of the software without
10 .\" specific, written prior permission. Keith Packard makes no
11 .\" representations about the suitability of this software for any purpose. It
12 .\" is provided "as is" without express or implied warranty.
13 .\"
14 .\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 .\" EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 .\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 .\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
20 .\" PERFORMANCE OF THIS SOFTWARE.
21 .\"
22 .TH XRANDR 1 "xrandr 1.5.3" "X Version 11"
23 .SH NAME
24 xrandr \- primitive command line interface to RandR extension
25 .SH SYNOPSIS
26 .B "xrandr"
27 [\-\-help] [\-\-display \fIdisplay\fP]
28 [\-q] [\-v]
29 [\-\-verbose]
30 [\-\-dryrun]
31 [\-\-screen \fIsnum\fP]
32 [\-\-q1]
33 [\-\-q12]
34 [\-\-current]
35 [\-\-noprimary]
36 [\-\-panning \fIwidth\fPx\fIheight\fP[+\fIx\fP+\fIy\fP[/\fItrack_width\fPx\fItrack_height\fP+\fItrack_x\fP+\fItrack_y\fP[/\fIborder_left\fP/\fIborder_top\fP/\fIborder_right\fP/\fIborder_bottom\fP]]]]
37 [\-\-scale \fIx\fP[x\fIy\fP]]
38 [\-\-scale-from \fIw\fPx\fIh\fP]
39 [\-\-transform \fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP]
40 [\-\-primary]
41 [\-\-prop]
42 [\-\-fb \fIwidth\fPx\fIheight\fP]
43 [\-\-fbmm \fIwidth\fPx\fIheight\fP]
44 [\-\-dpi \fIdpi\fP]
45 [\-\-dpi \fIfrom-output\fP]
46 [\-\-newmode \fIname\fP \fImode\fP]
47 [\-\-rmmode \fIname\fP]
48 [\-\-addmode \fIoutput\fP \fIname\fP]
49 [\-\-delmode \fIoutput\fP \fIname\fP]
50 [\-\-output \fIoutput\fP]
51 [\-\-auto]
52 [\-\-mode \fImode\fP]
53 [\-\-preferred]
54 [\-\-pos \fIx\fPx\fIy\fP]
55 [\-\-rate \fIrate\fP]
56 [\-\-reflect \fIreflection\fP]
57 [\-\-rotate \fIorientation\fP]
58 [\-\-left\-of \fIoutput\fP\]
59 [\-\-right\-of \fIoutput\fP\]
60 [\-\-above \fIoutput\fP\]
61 [\-\-below \fIoutput\fP\]
62 [\-\-same-as \fIoutput\fP\]
63 [\-\-set \fIproperty\fP \fIvalue\fP]
64 [\-\-off]
65 [\-\-crtc \fIcrtc\fP]
66 [\-\-gamma \fIred\fP[:\fIgreen\fP:\fIblue\fP]]
67 [\-\-brightness \fIbrightness\fP]
68 [\-o \fIorientation\fP]
69 [\-s \fIsize\fP]
70 [\-r \fIrate\fP]
71 [\-x] [\-y]
72 [\-\-listproviders]
73 [\-\-setprovideroutputsource \fIprovider\fP \fIsource\fP]
74 [\-\-setprovideroffloadsink \fIprovider\fP \fIsink\fP]
75 [\-\-listmonitors]
76 [\-\-listactivemonitors]
77 [\-\-setmonitor \fIname\fP \fIgeometry\fP \fIoutputs\fP]
78 [\-\-delmonitor \fIname\fP]
79 .SH DESCRIPTION
80 .I Xrandr
81 is used to set the size, orientation and/or reflection of the outputs for a
82 screen. It can also set the screen size.
83
84 If invoked without any option, it will dump the state of the outputs,
85 showing the existing modes for each of them, with a '+' after the preferred
86 modes and a '*' after the current mode.
87
88 There are a few global options. Other options modify the last output that is
89 specified in earlier parameters in the command line. Multiple outputs may
90 be modified at the same time by passing multiple \-\-output options followed
91 immediately by their corresponding modifying options.
92 .IP \-\-help
93 Print out a summary of the usage and exit.
94 .IP "\-v, \-\-version"
95 Print out the RandR version reported by the X server and exit.
96 .IP \-\-verbose
97 Causes xrandr to be more verbose. When used with \-q (or without other
98 options), xrandr will display more information about the server state. Please
99 note that the gamma and brightness information are only approximations of the
100 complete color profile stored in the server. When
101 used along with options that reconfigure the system, progress will be
102 reported while executing the configuration changes.
103 .IP "\-q, \-\-query"
104 When this option is present, or when no configuration changes are requested,
105 xrandr will display the current state of the system.
106 .IP "\-\-dryrun"
107 Performs all the actions specified except that no changes are made.
108 .IP "\-\-nograb"
109 Apply the modifications without grabbing the screen. It avoids to block other
110 applications during the update but it might also cause some applications that
111 detect screen resize to receive old values.
112 .IP "\-d, \-\-display \fIname\fP"
113 This option selects the X display to use. Note this refers to the X
114 screen abstraction, not the monitor (or output).
115 .IP "\-\-screen \fIsnum\fP"
116 This option selects which screen to manipulate. Note this refers to the X
117 screen abstraction, not the monitor (or output).
118 .IP \-\-q1
119 Forces the usage of the RandR version 1.1 protocol, even if a higher version
120 is available.
121 .IP \-\-q12
122 Forces the usage of the RandR version 1.2 protocol, even if the display does
123 not report it as supported or a higher version is available.
124 .PP
125 .SH "RandR version 1.5 options"
126 .PP
127 Options for RandR 1.5 are used as a superset of the options for RandR 1.4.
128 .PP
129 .IP \-\-listmonitors
130 Report information about all defined monitors.
131 .IP \-\-listactivemonitors
132 Report information about currently active monitors.
133 .IP "\-\-setmonitor \fIname\fP \fIgeometry\fP \fIoutputs\fP"} {none|\fIoutput\fP,\fIoutput\fP,...}\n"
134 Define a new monitor with the given geometry and associated to the given outputs.
135 The output list is either the keyword \fBnone\fP or a comma-separated list of outputs.
136 The geometry is either the keyword \fBauto\fP, in which case the monitor
137 will automatically track the geometry of the associated outputs, or a manual specification
138 in the form
139 \fIw\fP/\fImmw\fPx\fIh\fP/\fImmh\fP+\fIx\fP+\fIy\fP
140 where w, h, x, y are in pixels and mmw, mmh are the physical dimensions of the monitor.
141 .IP "\-\-delmonitor \fIname\fP"
142 Delete the given user-defined monitor.
143 .PP
144 .SH "RandR version 1.4 options"
145 .PP
146 Options for RandR 1.4 are used as a superset of the options for RandR 1.3.
147 .IP \-\-listproviders
148 Report information about the providers available.
149 .IP "\-\-setprovideroutputsource \fIprovider\fP \fIsource\fP"
150 Set \fIsource\fP as the source of display output images for \fIprovider\fP.
151 This is only possible if \fIsource\fP and \fIprovider\fP have the \fBSource
152 Output\fR and \fBSink Output\fR capabilities, respectively.
153 If \fIsource\fP is \fB0x0\fP, then \fIprovider\fP is disconnected from its
154 current output source.
155 .IP "\-\-setprovideroffloadsink \fIprovider\fP \fIsink\fP"
156 Set \fIprovider\fP as a render offload device for \fIsink\fP.
157 This is only possible if \fIprovider\fP and \fIsink\fP have the \fBSource
158 Offload\fR and \fBSink Offload\fR capabilities, respectively.
159 If \fIsink\fP is \fB0x0\fP, then \fIprovider\fP is disconnected from its current
160 render offload sink.
161 .PP
162 .SH "RandR version 1.3 options"
163 .PP
164 Options for RandR 1.3 are used as a superset of the options for RandR 1.2.
165 .PP
166 .IP \-\-current
167 Return the current screen configuration, without polling for hardware changes.
168 .IP \-\-noprimary
169 Don't define a primary output.
170 .PP
171 .B "Per-output options"
172 .IP "\-\-panning \fIwidth\fPx\fIheight\fP[+\fIx\fP+\fIy\fP[/\fItrack_width\fPx\fItrack_height\fP+\fItrack_x\fP+\fItrack_y\fP[/\fIborder_left\fP/\fIborder_top\fP/\fIborder_right\fP/\fIborder_bottom\fP]]]"
173 This option sets the panning parameters. As soon as panning is
174 enabled, the CRTC position can change with every pointer move.
175 The first four parameters specify the total panning area, the next four the
176 pointer tracking area (which defaults to the same area). The last four
177 parameters specify the border and default to 0. A width or height set to zero
178 disables panning on the according axis. You typically have to set the screen
179 size with \fI--fb\fP simultaneously.
180 .IP "\-\-transform \fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP"
181 Specifies a transformation matrix to apply on the output.
182 A bilinear filter is selected automatically unless the \-\-filter parameter is
183 also specified.
184 The mathematical form corresponds to:
185 .RS
186 .RS
187 a b c
188 .br
189 d e f
190 .br
191 g h i
192 .RE
193 The transformation is based on homogeneous coordinates. The matrix multiplied
194 by the coordinate vector of a pixel of the output gives the transformed
195 coordinate vector of a pixel in the graphic buffer. More precisely, the vector
196 .RI "(x y)"
197 of the output pixel is extended to 3 values
198 .RI "(x y w),"
199 with 1 as the w coordinate and multiplied against the matrix. The final device
200 coordinates of the pixel are then calculated with the so-called homogenic
201 division by the transformed w coordinate. In other words, the device
202 coordinates
203 .RI "(x' y')"
204 of the transformed pixel are:
205 .RS
206 x' = (ax + by + c) / w' and
207 .br
208 y' = (dx + ey + f) / w' ,
209 .br
210 with w' = (gx + hy + i) .
211 .RE
212 Typically, \fIa\fP and
213 \fIe\fP corresponds to the scaling on the X and Y axes, \fIc\fP and \fIf\fP
214 corresponds to the translation on those axes, and \fIg\fP, \fIh\fP, and \fIi\fP
215 are respectively 0, 0 and 1. The matrix can also be used to express more
216 complex transformations such as keystone correction, or rotation. For a
217 rotation of an angle T, this formula can be used:
218 .RS
219 cos T -sin T 0
220 .br
221 sin T cos T 0
222 .br
223 0 0 1
224 .RE
225 As a special argument, instead of
226 passing a matrix, one can pass the string \fInone\fP, in which case the default
227 values are used (a unit matrix without filter).
228 .RE
229 .IP "\-\-filter \fIfiltermode\fP"
230 Chooses the scaling filter method to be applied when the screen is scaled or
231 transformed.
232 Can be either 'bilinear' or 'nearest'.
233 .IP "\-\-scale \fIx\fP[x\fIy\fP]"
234 Changes the dimensions of the output picture.
235 If the \fIy\fP value is omitted, the \fIx\fP value will be used for both dimensions.
236 Values larger than 1 lead to a compressed screen (screen dimension bigger
237 than the dimension of the output mode), and values less than 1 lead to
238 a zoom in on the output.
239 This option is actually a shortcut version of the \fI\-\-transform\fP option.
240 .IP "\-\-scale-from \fIw\fPx\fIh\fP"
241 Specifies the size in pixels of the area of the framebuffer to be displayed on
242 this output.
243 This option is actually a shortcut version of the \fI\-\-transform\fP option.
244 .IP \-\-primary
245 Set the output as primary.
246 It will be sorted first in Xinerama and RANDR geometry requests.
247 .PP
248 .SH "RandR version 1.2 options"
249 These options are only available for X server supporting RandR version 1.2
250 or newer.
251 .IP "\-\-prop, \-\-properties"
252 This option causes xrandr to display the contents of properties for each
253 output. \-\-verbose also enables \-\-prop.
254 .IP "\-\-fb \fIwidth\fPx\fIheight\fP"
255 Reconfigures the screen to the specified size. All configured monitors must
256 fit within this size. When this option is not provided, xrandr computes the
257 smallest screen size that will hold the set of configured outputs; this
258 option provides a way to override that behaviour.
259 .IP "\-\-fbmm \fIwidth\fPx\fIheight\fP"
260 Sets the value reported as physical size of the X screen as a whole
261 (union of all configured monitors). In configurations with multiple
262 monitors with different DPIs, the value has no physical meaning, but
263 it may be used by some legacy clients which do not support RandR
264 version 1.2 to compute a reference font scaling. Normally,
265 xrandr resets the reported physical size values to keep the DPI constant.
266 This overrides that computation. Default DPI value is 96.
267 .IP "\-\-dpi \fIdpi\fP"
268 .IP "\-\-dpi \fIfrom-output\fP"
269 This also sets the value reported as physical size of the X screen as a whole
270 (union of all configured monitors). In configurations with multiple
271 monitors with different DPIs, the value has no physical meaning, but
272 it may be used by some legacy clients which do not support RandR
273 version 1.2 to compute a reference font scaling. This option uses either
274 the specified DPI value, or the DPI of the given output, to compute an appropriate
275 physical size using whatever pixel size will be set. Typical values are
276 the default (96 DPI), the DPI of the only monitor in single-monitor
277 configurations, or the DPI of the primary monitor in multi-monitor
278 configurations.
279 .IP "\-\-newmode \fIname\fP \fImode\fP"
280 New modelines can be added to the server and then associated with outputs.
281 This option does the former. The \fImode\fP is specified using the ModeLine
282 syntax for xorg.conf: clock hdisp hsyncstart hsyncend htotal vdisp vsyncstart
283 vsyncend vtotal \fIflags\fP. \fIflags\fP can be zero or more of +HSync,
284 -HSync, +VSync, -VSync, Interlace, DoubleScan, CSync, +CSync, -CSync. Several
285 tools permit to compute the usual modeline from a height, width, and refresh
286 rate, for instance you can use \fBcvt\fR.
287 .IP "\-\-rmmode \fIname\fP"
288 This removes a mode from the server if it is otherwise unused.
289 .IP "\-\-addmode \fIoutput\fP \fIname\fP"
290 Add a mode to the set of valid modes for an output.
291 .IP "\-\-delmode \fIoutput\fP \fIname\fP"
292 Remove a mode from the set of valid modes for an output.
293 .PP
294 .B "Per-output options"
295 .IP "\-\-output \fIoutput\fP"
296 Selects an output to reconfigure. Use either the name of the output or the
297 XID.
298 .IP \-\-auto
299 For connected but disabled outputs, this will enable them using their
300 first preferred mode (or, something close to 96dpi if they have no preferred
301 mode). For disconnected but enabled outputs, this will disable them.
302 .IP "\-\-mode \fImode\fP"
303 This selects a mode. Use either the name or the XID for \fImode\fP
304 .IP "\-\-preferred"
305 This selects the same mode as \-\-auto, but it doesn't automatically enable or
306 disable the output.
307 .IP "\-\-pos \fIx\fPx\fIy\fP"
308 Position the output within the screen using pixel coordinates. In case reflection
309 or rotation is applied, the translation is applied after the effects.
310 .IP "\-\-rate \fIrate\fP"
311 This marks a preference for refresh rates close to the specified value, when
312 multiple modes have the same name, this will select the one with the nearest
313 refresh rate.
314 .IP "\-\-reflect \fIreflection\fP"
315 Reflection can be one of 'normal' 'x', 'y' or 'xy'. This causes the output
316 contents to be reflected across the specified axes.
317 .IP "\-\-rotate \fIrotation\fP"
318 Rotation can be one of 'normal', 'left', 'right' or 'inverted'. This causes
319 the output contents to be rotated in the specified direction. 'right' specifies
320 a clockwise rotation of the picture and 'left' specifies a counter-clockwise
321 rotation.
322 .IP "\-\-left\-of, \-\-right\-of, \-\-above, \-\-below, \-\-same-as \fIanother-output\fP"
323 Use one of these options to position the output relative to the position of
324 another output. This allows convenient tiling of outputs within the screen.
325 The position is always computed relative to the new position of the other
326 output, so it is not valid to say \-\-output a \-\-left\-of b \-\-output
327 b \-\-left\-of a.
328 .IP "\-\-set \fIproperty\fP \fIvalue\fP"
329 Sets an output property. Integer properties may be specified as a valid
330 (see \-\-prop) comma-separated list of decimal or hexadecimal (with a leading 0x) values.
331 Atom properties may be set to any of the valid atoms (see \-\-prop).
332 String properties may be set to any value.
333 .IP "\-\-off"
334 Disables the output.
335 .IP "\-\-crtc \fIcrtc\fP"
336 Uses the specified crtc (either as an index in the list of CRTCs or XID).
337 In normal usage, this option is not required as xrandr tries to make
338 sensible choices about which crtc to use with each output. When that fails
339 for some reason, this option can override the normal selection.
340 .IP "\-\-gamma \fIred\fP[:\fIgreen\fP:\fIblue\fP]"
341 Set the specified floating point values as gamma correction on the crtc
342 currently attached to this output.
343 If green and blue are not specified, the red value will be used
344 for all three components.
345 Note that you cannot get two different values
346 for cloned outputs (i.e.: which share the same crtc) and that switching an output to another crtc doesn't change
347 the crtc gamma corrections at all.
348 .IP "\-\-brightness \fIbrightness\fP"
349 Multiply the gamma values on the crtc currently attached to the output to
350 specified floating value. Useful for overly bright or overly dim outputs.
351 However, this is a software only modification, if your hardware has support to
352 actually change the brightness, you will probably prefer to use \fBxbacklight\fR.
353 .PP
354 .SH "RandR version 1.1 options"
355 These options are available for X servers supporting RandR version 1.1 or
356 older. They are still valid for newer X servers, but they don't interact
357 sensibly with version 1.2 options on the same command line.
358 .IP "\-s, \-\-size \fIsize-index\fP or \-\-size \fIwidth\fPx\fIheight\fP"
359 This sets the screen size, either matching by size or using the index into
360 the list of available sizes.
361 .IP "\-r, \-\-rate, \-\-refresh \fIrate\fP"
362 This sets the refresh rate closest to the specified value.
363 .IP "\-o, \-\-orientation \fIrotation\fP"
364 This specifies the orientation of the screen,
365 and can be one of normal, inverted, left or right.
366 .IP \-x
367 Reflect across the X axis.
368 .IP \-y
369 Reflect across the Y axis.
370 .SH EXAMPLES
371 Sets an output called LVDS to its preferred mode, and on its right put an
372 output called VGA to preferred mode of a screen which has been physically rotated clockwise:
373 .RS
374 xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA --auto --rotate left --right-of LVDS
375 .RE
376 .PP
377 Forces to use a 1024x768 mode on an output called VGA:
378 .RS
379 xrandr --newmode "1024x768" 63.50 1024 1072 1176 1328 768 771 775 798 -hsync +vsync
380 .br
381 xrandr --addmode VGA 1024x768
382 .br
383 xrandr --output VGA --mode 1024x768
384 .RE
385 .PP
386 Enables panning on a 1600x768 desktop while displaying 1024x768 mode on an output called VGA:
387 .RS
388 xrandr --fb 1600x768 --output VGA --mode 1024x768 --panning 1600x0
389 .RE
390 .PP
391 Have one small 1280x800 LVDS screen showing a small version of a huge 3200x2000 desktop, and have a
392 big VGA screen display the surrounding of the mouse at normal size.
393 .RS
394 xrandr --fb 3200x2000 --output LVDS --scale 2.5x2.5 --output VGA --pos 0x0 --panning 3200x2000+0+0/3200x2000+0+0/64/64/64/64
395 .RE
396 .PP
397 Displays the VGA output in trapezoid shape so that it is keystone corrected
398 when the projector is slightly above the screen:
399 .RS
400 xrandr --fb 1024x768 --output VGA --transform 1.24,0.16,-124,0,1.24,0,0,0.000316,1
401 .RE
402 .SH "SEE ALSO"
403 Xrandr(3), cvt(1), xkeystone(1), xbacklight(1)
404 .SH AUTHORS
405 Keith Packard,
406 Open Source Technology Center, Intel Corporation.
407 and
408 Jim Gettys,
409 Cambridge Research Laboratory, HP Labs, HP.