git.oblomov.eu Git - xorg/xrandr/blob - xrandr.man

   1 .\"
   2 .\" Copyright 2001 Keith Packard.\"
   3 .\" Permission to use, copy, modify, distribute, and sell this software and its
   4 .\" documentation for any purpose is hereby granted without fee, provided that
   5 .\" the above copyright notice appear in all copies and that both that
   6 .\" copyright notice and this permission notice appear in supporting
   7 .\" documentation, and that the name of Keith Packard not be used in
   8 .\" advertising or publicity pertaining to distribution of the software without
   9 .\" specific, written prior permission.  Keith Packard makes no
  10 .\" representations about the suitability of this software for any purpose.  It
  11 .\" is provided "as is" without express or implied warranty.
  12 .\"
  13 .\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  14 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  15 .\" EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  16 .\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  17 .\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  18 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  19 .\" PERFORMANCE OF THIS SOFTWARE.
  20 .\"
  21 .\"
  22 .\" $XFree86: xc/programs/xrandr/xrandr.man,v 1.6 2003/06/12 14:12:39 eich Exp $
  23 .\"
  24 .TH XRANDR __appmansuffix__ __vendorversion__
  25 .SH NAME
  26 xrandr \- primitive command line interface to RandR extension
  27 .SH SYNOPSIS
  28 .B "xrandr"
  29 [\-help]  [\-display \fIdisplay\fP]
  30 [\-q] [\-v]
  31 [\-\-verbose]
  32 [\-\-screen \fIsnum\fP]
  33 .br
  34 .B RandR version 1.2 options
  35 .br
  36 [\-\-prop]
  37 [\-\-fb <width>x<height>]
  38 [\-\-fbmm <width>x<height>]
  39 [\-\-dpi <dpi>]
  40 .br
  41 .B Per-output options
  42 .br
  43 [\-\-output <output>]
  44 [\-\-auto]
  45 [\-\-mode <mode>]
  46 [\-\-preferred]
  47 [\-\-pos <x>x<y>]
  48 [\-\-rate <rate>]
  49 [\-\-reflect \fIreflection\fP]
  50 [\-\-rotate \fIorientation\fP]
  51 [\-\-left\-of <output>\]
  52 [\-\-right\-of <output>\]
  53 [\-\-above <output>\]
  54 [\-\-below <output>\]
  55 [\-\-same-as <output>\]
  56 [\-\-set <property> <value>]
  57 [\-\-off]
  58 [\-\-crtc <crtc>]
  59 [\-\-newmode <name> \fImode\fP]
  60 [\-\-rmmode <name>]
  61 [\-\-addmode <output> <name>]
  62 [\-\-delmode <output> <name>]
  63 .br
  64 .B RandR version 1.0 and version 1.1 options
  65 .br
  66 [\-o \fIorientation\fP]
  67 [\-s \fIsize\fP]
  68 [\-x] [\-y]
  69 .SH DESCRIPTION
  70 .I Xrandr
  71 is used to set the size, orientation and/or reflection of the outputs for a
  72 screen. It can also set the screen size.
  73 There are a few global options; the rest modify a particular output and
  74 follow the specification of that output on the command line.
  75 .IP \-\-help
  76 Print out a summary of the usage and exit.
  77 .IP \-v
  78 Print out the RandR version reported by the X server and exit.
  79 .IP \-\-verbose
  80 causes xrandr to be more verbose. When used with \-q (or without other
  81 options), xrandr will display more information about the server state. When
  82 used along with options that reconfigure the system, progress will be
  83 reported while executing the configuration changes.
  84 .IP \-q
  85 When this option is present, or when no configuration changes are requested,
  86 xrandr will display the current state of the system.
  87 .IP "\-screen \fIsnum\fP"
  88 This option selects which screen to manipulate. Note this refers to the X
  89 screen abstraction, not the monitor (or output).
  90 .SH "RandR version 1.2 options"
  91 These options are only available for X server supporting RandR version 1.2
  92 or newer.
  93 .IP \-\-prop
  94 This option causes xrandr to display the contents of properties for each
  95 output. \-\-verbose also enables \-\-prop.
  96 .IP "\-\-fb <width>x<height>"
  97 Reconfigures the screen to the specified size. All configured monitors must
  98 fit within this size. When this option is not provided, xrandr computes the
  99 smallest screen size that will hold the set of configured outputs; this
 100 option provides a way to override that behaviour.
 101 .IP "\-\-fbmm <width>x<height>"
 102 Sets the reported values for the physical size of the screen. Normally,
 103 xrandr resets the reported physical size values to keep the DPI constant.
 104 This overrides that computation.
 105 .IP "\-\-dpi <dpi>"
 106 This also sets the reported physical size values of the screen, it uses the
 107 specified DPI value to compute an appropriate physical size using whatever
 108 pixel size will be set.
 109 .PP
 110 .B "Per-output options"
 111 .IP "\-\-output <output>"
 112 Selects an output to reconfigure. Use either the name of the output or the
 113 XID.
 114 .IP \-\-auto
 115 For connected but disabled outputs, this will enable them using their
 116 preferred mode (or, something close to 96dpi if they have no preferred
 117 mode). For disconnected but enabled outputs, this will disable them.
 118 .IP "\-\-mode <mode>"
 119 This selects a mode. Use either the name or the XID for <mode>
 120 .IP "\-\-preferred"
 121 This selects the same mode as \-\-auto, but it doesn't automatically enable or
 122 disable the output.
 123 .IP "\-\-pos <x>x<y>"
 124 Position the output within the screen using pixel coordinates.
 125 .IP "\-\-rate <rate>"
 126 This marks a preference for refresh rates close to the specified value, when
 127 multiple modes have the same name, this will select the one with the nearest
 128 refresh rate.
 129 .IP "\-\-reflect \fIreflection\fP"
 130 Reflection can be one of 'normal' 'x', 'y' or 'xy'. This causes the output
 131 contents to be reflected across the specified axes.
 132 .IP "\-\-rotate \fIrotation\fP"
 133 Rotation can be one of 'normal', 'left', 'right' or 'inverted'. This causes
 134 the output contents to be rotated in the specified direction.
 135 .IP "\-\-left\-of, \-\-right\-of, \-\-above, \-\-below, \-\-same-as <another output>"
 136 Use one of these options to position the output relative to the position of
 137 another output. This allows convenient tiling of outputs within the screen.
 138 The position is always computed relative to the new position of the other
 139 output, so it is not valid to say \-\-output a \-\-left\-of b \-\-output
 140 b \-\-left\-of a.
 141 .IP "\-\-set <property> <value>"
 142 Sets an output property. Integer properties may be specified as a valid
 143 (see \-\-prop) decimal or hexadecimal (with a leading 0x) value. Atom properties
 144 may be set to any of the valid atoms (see \-\-prop). String properties may be
 145 set to any value.
 146 .IP "\-\-off"
 147 Disables the output.
 148 .IP "\-\-crtc <crtc>"
 149 Uses the specified crtc (either as an index in the list of CRTCs or XID).
 150 In normal usage, this option is not required as xrandr tries to make
 151 sensible choices about which crtc to use with each output. When that fails
 152 for some reason, this option can override the normal selection.
 153 .IP "\-\-newmode <name> \fImode\fP"
 154 New modelines can be added to the server and then associated with outputs.
 155 This option does the former. The \fImode\fP is specified using the ModeLine
 156 syntax for xorg.conf: hdisp hsyncstart hsyncend htotal vdisp vsyncstart
 157 vsyncend vtotal \fIflags\fP. \fIflags\fP can be zero or more of +HSync,
 158 -HSync, +VSync, -VSync, Interlace, DoubleScan, CSync, +CSync, -CSync.
 159 .IP "\-\-rmmode <name>"
 160 This removes a mode from the server if it is otherwise unused.
 161 .IP "\-\-addmode <output> <name>"
 162 Add a mode to the set of valid modes for an output.
 163 .IP "\-\-delmode <output> <name>"
 164 Remove a mode from the set of valid modes for an output.
 165 .PP
 166 .SH "RandR version 1.1 options"
 167 These options are available for X servers supporting RandR version 1.1 or
 168 older. They are still valid for newer X servers, but they don't
 169 .IP "\-s <size index> or \-s <width>x<height>"
 170 This sets the screen size, either matching by size or using the index into
 171 the list of available sizes.
 172 .IP "\-o \fIrotation\fP"
 173 This specifies the orientation of the screen,
 174 and can be one of normal, inverted, left or right.
 175 .IP \-x
 176 Reflect across the X axis.
 177 .IP \-y
 178 Reflect across the Y axis.
 179 .SH "SEE ALSO"
 180 Xrandr(3)
 181 .SH AUTHORS
 182 Keith Packard,
 183 Open Source Technology Center, Intel Corporation.
 184 and
 185 Jim Gettys,
 186 Cambridge Research Laboratory, HP Labs, HP.