271 lines
11 KiB
Diff
271 lines
11 KiB
Diff
|
From 977275a13be0687efc3db1fd3763174ff1256210 Mon Sep 17 00:00:00 2001
|
||
|
|
From: Eric Piel <E.A.B.Piel@tudelft.nl>
|
||
|
|
Date: Sun, 10 Aug 2008 23:28:25 +0200
|
||
|
|
Subject: [PATCH] update the manpage
|
||
|
|
|
||
|
|
Describe all the options supported, including: --dryrun, -display,
|
||
|
|
--q1, --q12, and --rate for 1.1
|
||
|
|
Describe all short and long version of the option.
|
||
|
|
Use the usual man style for the option arugments.
|
||
|
|
Move the four --*mode options out of the output section as they are
|
||
|
|
independant of an output.
|
||
|
|
Mention cvt for computing modelines.
|
||
|
|
Gives some examples.
|
||
|
|
---
|
||
|
|
xrandr.man | 143 +++++++++++++++++++++++++++++++++++++----------------------
|
||
|
|
1 files changed, 90 insertions(+), 53 deletions(-)
|
||
|
|
|
||
|
|
diff --git a/xrandr.man b/xrandr.man
|
||
|
|
index c6bbd42..ac29367 100644
|
||
|
|
--- a/xrandr/xrandr.man
|
||
|
|
+++ b/xrandr/xrandr.man
|
||
|
|
@@ -29,42 +29,46 @@ xrandr \- primitive command line interface to RandR extension
|
||
|
|
[\-help] [\-display \fIdisplay\fP]
|
||
|
|
[\-q] [\-v]
|
||
|
|
[\-\-verbose]
|
||
|
|
+[\-\-dryrun]
|
||
|
|
[\-\-screen \fIsnum\fP]
|
||
|
|
+[\-\-q1]
|
||
|
|
+[\-\-q12]
|
||
|
|
.br
|
||
|
|
.B RandR version 1.2 options
|
||
|
|
.br
|
||
|
|
[\-\-prop]
|
||
|
|
-[\-\-fb <width>x<height>]
|
||
|
|
-[\-\-fbmm <width>x<height>]
|
||
|
|
-[\-\-dpi <dpi>]
|
||
|
|
+[\-\-fb \fIwidth\fPx\fIheight\fP]
|
||
|
|
+[\-\-fbmm \fIwidth\fPx\fIheight\fP]
|
||
|
|
+[\-\-dpi \fIdpi\fP]
|
||
|
|
+[\-\-newmode \fIname\fP \fImode\fP]
|
||
|
|
+[\-\-rmmode \fIname\fP]
|
||
|
|
+[\-\-addmode \fIoutput\fP \fIname\fP]
|
||
|
|
+[\-\-delmode \fIoutput\fP \fIname\fP]
|
||
|
|
.br
|
||
|
|
.B Per-output options
|
||
|
|
.br
|
||
|
|
-[\-\-output <output>]
|
||
|
|
+[\-\-output \fIoutput\fP]
|
||
|
|
[\-\-auto]
|
||
|
|
-[\-\-mode <mode>]
|
||
|
|
+[\-\-mode \fImode\fP]
|
||
|
|
[\-\-preferred]
|
||
|
|
-[\-\-pos <x>x<y>]
|
||
|
|
-[\-\-rate <rate>]
|
||
|
|
+[\-\-pos \fIx\fPx\fIy\fP]
|
||
|
|
+[\-\-rate \fIrate\fP]
|
||
|
|
[\-\-reflect \fIreflection\fP]
|
||
|
|
[\-\-rotate \fIorientation\fP]
|
||
|
|
-[\-\-left\-of <output>\]
|
||
|
|
-[\-\-right\-of <output>\]
|
||
|
|
-[\-\-above <output>\]
|
||
|
|
-[\-\-below <output>\]
|
||
|
|
-[\-\-same-as <output>\]
|
||
|
|
-[\-\-set <property> <value>]
|
||
|
|
+[\-\-left\-of \fIoutput\fP\]
|
||
|
|
+[\-\-right\-of \fIoutput\fP\]
|
||
|
|
+[\-\-above \fIoutput\fP\]
|
||
|
|
+[\-\-below \fIoutput\fP\]
|
||
|
|
+[\-\-same-as \fIoutput\fP\]
|
||
|
|
+[\-\-set \fIproperty\fP \fIvalue\fP]
|
||
|
|
[\-\-off]
|
||
|
|
-[\-\-crtc <crtc>]
|
||
|
|
-[\-\-newmode <name> \fImode\fP]
|
||
|
|
-[\-\-rmmode <name>]
|
||
|
|
-[\-\-addmode <output> <name>]
|
||
|
|
-[\-\-delmode <output> <name>]
|
||
|
|
+[\-\-crtc \fIcrtc\fP]
|
||
|
|
.br
|
||
|
|
.B RandR version 1.0 and version 1.1 options
|
||
|
|
.br
|
||
|
|
[\-o \fIorientation\fP]
|
||
|
|
[\-s \fIsize\fP]
|
||
|
|
+[\-r \fIrate\fP]
|
||
|
|
[\-x] [\-y]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.I Xrandr
|
||
|
|
@@ -79,57 +83,83 @@ There are a few global options. Other options modify the last output that is
|
||
|
|
specified in earlier parameters in the command line. Multiple outputs may
|
||
|
|
be modified at the same time by passing mutiple \-\-output options followed
|
||
|
|
immediately by their corresponding modifying options.
|
||
|
|
-.IP \-\-help
|
||
|
|
+.IP \-help
|
||
|
|
Print out a summary of the usage and exit.
|
||
|
|
-.IP \-v
|
||
|
|
+.IP "\-v, \-\-version"
|
||
|
|
Print out the RandR version reported by the X server and exit.
|
||
|
|
.IP \-\-verbose
|
||
|
|
-causes xrandr to be more verbose. When used with \-q (or without other
|
||
|
|
+Causes xrandr to be more verbose. When used with \-q (or without other
|
||
|
|
options), xrandr will display more information about the server state. When
|
||
|
|
used along with options that reconfigure the system, progress will be
|
||
|
|
reported while executing the configuration changes.
|
||
|
|
-.IP \-q
|
||
|
|
+.IP "\-q, \-\-query"
|
||
|
|
When this option is present, or when no configuration changes are requested,
|
||
|
|
-xrandr will display the current state of the system.
|
||
|
|
-.IP "\-screen \fIsnum\fP"
|
||
|
|
+xrandr will display the current state of the system.
|
||
|
|
+.IP "\-\-dryrun"
|
||
|
|
+Performs all the actions specified excepted that not changes are made.
|
||
|
|
+.IP "\-d, \-display \fIname\fP"
|
||
|
|
+This option selects the X display to use. Note this refers to the X
|
||
|
|
+screen abstraction, not the monitor (or output).
|
||
|
|
+.IP "\-\-screen \fIsnum\fP"
|
||
|
|
This option selects which screen to manipulate. Note this refers to the X
|
||
|
|
screen abstraction, not the monitor (or output).
|
||
|
|
+.IP \-\-q1
|
||
|
|
+Forces the usage of the RandR version 1.1 protocol, even if a higher version
|
||
|
|
+is available.
|
||
|
|
+.IP \-\-q12
|
||
|
|
+Forces the usage of the RandR version 1.2 protocol, even the display does not
|
||
|
|
+report it as supported or a higher version is available.
|
||
|
|
.SH "RandR version 1.2 options"
|
||
|
|
These options are only available for X server supporting RandR version 1.2
|
||
|
|
or newer.
|
||
|
|
-.IP \-\-prop
|
||
|
|
+.IP "\-\-prop, \-\-properties"
|
||
|
|
This option causes xrandr to display the contents of properties for each
|
||
|
|
output. \-\-verbose also enables \-\-prop.
|
||
|
|
-.IP "\-\-fb <width>x<height>"
|
||
|
|
+.IP "\-\-fb \fIwidth\fPx\fIheight\fP"
|
||
|
|
Reconfigures the screen to the specified size. All configured monitors must
|
||
|
|
fit within this size. When this option is not provided, xrandr computes the
|
||
|
|
smallest screen size that will hold the set of configured outputs; this
|
||
|
|
option provides a way to override that behaviour.
|
||
|
|
-.IP "\-\-fbmm <width>x<height>"
|
||
|
|
+.IP "\-\-fbmm \fIwidth\fPx\fIheight\fP"
|
||
|
|
Sets the reported values for the physical size of the screen. Normally,
|
||
|
|
xrandr resets the reported physical size values to keep the DPI constant.
|
||
|
|
This overrides that computation.
|
||
|
|
-.IP "\-\-dpi <dpi>"
|
||
|
|
+.IP "\-\-dpi \fIdpi\fP"
|
||
|
|
This also sets the reported physical size values of the screen, it uses the
|
||
|
|
specified DPI value to compute an appropriate physical size using whatever
|
||
|
|
pixel size will be set.
|
||
|
|
+.IP "\-\-newmode \fIname\fP \fImode\fP"
|
||
|
|
+New modelines can be added to the server and then associated with outputs.
|
||
|
|
+This option does the former. The \fImode\fP is specified using the ModeLine
|
||
|
|
+syntax for xorg.conf: hdisp hsyncstart hsyncend htotal vdisp vsyncstart
|
||
|
|
+vsyncend vtotal \fIflags\fP. \fIflags\fP can be zero or more of +HSync,
|
||
|
|
+-HSync, +VSync, -VSync, Interlace, DoubleScan, CSync, +CSync, -CSync. Several
|
||
|
|
+tools permit to compute the usual modeline from a heigh, width, and refresh
|
||
|
|
+rate, for instance you can use \fBcvt\fR.
|
||
|
|
+.IP "\-\-rmmode \fIname\fP"
|
||
|
|
+This removes a mode from the server if it is otherwise unused.
|
||
|
|
+.IP "\-\-addmode \fIoutput\fP \fIname\fP"
|
||
|
|
+Add a mode to the set of valid modes for an output.
|
||
|
|
+.IP "\-\-delmode \fIoutput\fP \fIname\fP"
|
||
|
|
+Remove a mode from the set of valid modes for an output.
|
||
|
|
.PP
|
||
|
|
.B "Per-output options"
|
||
|
|
-.IP "\-\-output <output>"
|
||
|
|
+.IP "\-\-output \fIoutput\fP"
|
||
|
|
Selects an output to reconfigure. Use either the name of the output or the
|
||
|
|
XID.
|
||
|
|
.IP \-\-auto
|
||
|
|
For connected but disabled outputs, this will enable them using their
|
||
|
|
preferred mode (or, something close to 96dpi if they have no preferred
|
||
|
|
mode). For disconnected but enabled outputs, this will disable them.
|
||
|
|
-.IP "\-\-mode <mode>"
|
||
|
|
-This selects a mode. Use either the name or the XID for <mode>
|
||
|
|
+.IP "\-\-mode \fImode\fP"
|
||
|
|
+This selects a mode. Use either the name or the XID for \fImode\fP
|
||
|
|
.IP "\-\-preferred"
|
||
|
|
This selects the same mode as \-\-auto, but it doesn't automatically enable or
|
||
|
|
disable the output.
|
||
|
|
-.IP "\-\-pos <x>x<y>"
|
||
|
|
-Position the output within the screen using pixel coordinates.
|
||
|
|
-.IP "\-\-rate <rate>"
|
||
|
|
+.IP "\-\-pos \fIx\fPx\fIy\fP"
|
||
|
|
+Position the output within the screen using pixel coordinates. In case reflection
|
||
|
|
+or rotation is applied, the translation is applied after the effects.
|
||
|
|
+.IP "\-\-rate \fIrate\fP"
|
||
|
|
This marks a preference for refresh rates close to the specified value, when
|
||
|
|
multiple modes have the same name, this will select the one with the nearest
|
||
|
|
refresh rate.
|
||
|
|
@@ -138,54 +168,61 @@ Reflection can be one of 'normal' 'x', 'y' or 'xy'. This causes the output
|
||
|
|
contents to be reflected across the specified axes.
|
||
|
|
.IP "\-\-rotate \fIrotation\fP"
|
||
|
|
Rotation can be one of 'normal', 'left', 'right' or 'inverted'. This causes
|
||
|
|
-the output contents to be rotated in the specified direction.
|
||
|
|
-.IP "\-\-left\-of, \-\-right\-of, \-\-above, \-\-below, \-\-same-as <another output>"
|
||
|
|
+the output contents to be rotated in the specified direction. 'right' specifies
|
||
|
|
+a clockwise rotation of the picture and 'left' specifies a counter-clockwise
|
||
|
|
+rotation.
|
||
|
|
+.IP "\-\-left\-of, \-\-right\-of, \-\-above, \-\-below, \-\-same-as \fIanother-output\fP"
|
||
|
|
Use one of these options to position the output relative to the position of
|
||
|
|
another output. This allows convenient tiling of outputs within the screen.
|
||
|
|
The position is always computed relative to the new position of the other
|
||
|
|
output, so it is not valid to say \-\-output a \-\-left\-of b \-\-output
|
||
|
|
b \-\-left\-of a.
|
||
|
|
-.IP "\-\-set <property> <value>"
|
||
|
|
+.IP "\-\-set \fIproperty\fP \fIvalue\fP"
|
||
|
|
Sets an output property. Integer properties may be specified as a valid
|
||
|
|
(see \-\-prop) decimal or hexadecimal (with a leading 0x) value. Atom properties
|
||
|
|
may be set to any of the valid atoms (see \-\-prop). String properties may be
|
||
|
|
set to any value.
|
||
|
|
.IP "\-\-off"
|
||
|
|
Disables the output.
|
||
|
|
-.IP "\-\-crtc <crtc>"
|
||
|
|
+.IP "\-\-crtc \fIcrtc\fP"
|
||
|
|
Uses the specified crtc (either as an index in the list of CRTCs or XID).
|
||
|
|
In normal usage, this option is not required as xrandr tries to make
|
||
|
|
sensible choices about which crtc to use with each output. When that fails
|
||
|
|
for some reason, this option can override the normal selection.
|
||
|
|
-.IP "\-\-newmode <name> \fImode\fP"
|
||
|
|
-New modelines can be added to the server and then associated with outputs.
|
||
|
|
-This option does the former. The \fImode\fP is specified using the ModeLine
|
||
|
|
-syntax for xorg.conf: hdisp hsyncstart hsyncend htotal vdisp vsyncstart
|
||
|
|
-vsyncend vtotal \fIflags\fP. \fIflags\fP can be zero or more of +HSync,
|
||
|
|
--HSync, +VSync, -VSync, Interlace, DoubleScan, CSync, +CSync, -CSync.
|
||
|
|
-.IP "\-\-rmmode <name>"
|
||
|
|
-This removes a mode from the server if it is otherwise unused.
|
||
|
|
-.IP "\-\-addmode <output> <name>"
|
||
|
|
-Add a mode to the set of valid modes for an output.
|
||
|
|
-.IP "\-\-delmode <output> <name>"
|
||
|
|
-Remove a mode from the set of valid modes for an output.
|
||
|
|
.PP
|
||
|
|
.SH "RandR version 1.1 options"
|
||
|
|
These options are available for X servers supporting RandR version 1.1 or
|
||
|
|
older. They are still valid for newer X servers, but they don't interact
|
||
|
|
sensibly with version 1.2 options on the same command line.
|
||
|
|
-.IP "\-s <size index> or \-s <width>x<height>"
|
||
|
|
+.IP "\-s, \-\-size \fIsize-index\fP or \-\-size \fIwidth\fPx\fIheight\fP"
|
||
|
|
This sets the screen size, either matching by size or using the index into
|
||
|
|
the list of available sizes.
|
||
|
|
-.IP "\-o \fIrotation\fP"
|
||
|
|
+.IP "\-r, \-\-rate, \-\-refresh \fIrate\fP"
|
||
|
|
+This sets the refresh rate closest to the specified value.
|
||
|
|
+.IP "\-o, \-\-orientation \fIrotation\fP"
|
||
|
|
This specifies the orientation of the screen,
|
||
|
|
and can be one of normal, inverted, left or right.
|
||
|
|
.IP \-x
|
||
|
|
Reflect across the X axis.
|
||
|
|
.IP \-y
|
||
|
|
Reflect across the Y axis.
|
||
|
|
+.SH EXAMPLES
|
||
|
|
+Sets an output called LVDS to its preferred mode, and on its right put an
|
||
|
|
+output called VGA to preferred mode of a screen which has been physically rotated clockwise:
|
||
|
|
+.RS
|
||
|
|
+xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA --auto --rotate left --right-of LVDS
|
||
|
|
+.RE
|
||
|
|
+.PP
|
||
|
|
+Forces to use a 1024x768 mode on an output called VGA:
|
||
|
|
+.RS
|
||
|
|
+xrandr --newmode "1024x768" 63.50 1024 1072 1176 1328 768 771 775 798 -hsync +vsync
|
||
|
|
+.br
|
||
|
|
+xrandr --addmode VGA 1024x768
|
||
|
|
+.br
|
||
|
|
+xrandr --output VGA --mode 1024x768
|
||
|
|
+.RE
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
-Xrandr(3)
|
||
|
|
+Xrandr(3), cvt(1)
|
||
|
|
.SH AUTHORS
|
||
|
|
Keith Packard,
|
||
|
|
Open Source Technology Center, Intel Corporation.
|
||
|
|
--
|
||
|
|
1.5.6.3
|
||
|
|
|