Merge branch 'randr-1.2-origin' into randr-1.2
[xorg/xrandr] / 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 [-o \fIorientation\fP]
31 [-q] [-v]
32 [-s \fIsize\fP]
33 [-x] [-y]
34 [--screen \fIsnum\fP]
35 [--verbose]
36 .br
37 [--fb <width>x<height>]
38 [--dpi <dpi>]
39 [--output <output>]
40 [--crtc <crtc>]
41 [--mode <mode>]
42 [--pos <x>x<y>]
43 [--off]
44 .SH DESCRIPTION
45 .I Xrandr
46 is used to set the screen size, orientation and/or reflection.
47 The
48 .I -s
49 option is a small integer index used to specify which size the screen should be set to.
50 To find out what sizes are available, use the
51 .I -q
52 option, which reports the sizes available, the current rotation, and
53 the possible rotations and reflections.
54 The default size is the first size specified in the list.
55 The
56 .I -o
57 option is used to specify the orientation of the screen,
58 and can be one of
59 \fI"normal inverted left right 0 1 2 3"\fP.
60 .PP
61 The
62 .I -x
63 option instructs the server to reflect the screen on the X axis.
64 The
65 .I -y
66 option instructs the server to reflect the screen on the Y axis.
67 Reflection is applied after rotation.
68 .PP
69 The
70 .I -help
71 option prints out a usage summary.
72 The
73 .I --verbose
74 option tells you what xrandr is doing, selects for events, and tells you
75 when events are received to enable debugging.
76 .SH "RANDR 1.2"
77 .PP
78 Randr version 1.2 adds numerous new capabilities to the extension which 
79 are supported by new options to the xrandr program.
80 .PP
81 The
82 .I --fb
83 option sets the new pixel size of the screen (e.g. --fb 320x200). If left unspecified, the
84 screen is set to just fit the specified outputs.
85 The 
86 .I --dpi
87 option changes the dpi of the screen (e.g. -dpi 96). If left unspecified,
88 the dpi is left unchanged by any screen size changes.
89 .PP
90 The
91 .I --output
92 option selects an output (either by name or XID in hex) to change with any
93 of the following parameters. More than one output may be changed per
94 invocation.
95 .SH "OUTPUT OPTIONS"
96 .PP
97 The
98 .I --crtc
99 option specifies the desired crtc by XID. If left unspecified, an unused
100 crtc is selected.
101 The
102 .I --mode
103 option selects the desired output mode, either by name or XID. If left
104 unspecified, the mode will be left unchanged.
105 The
106 .I --pos
107 option selects where to position the output within the screen (e.g. --pos
108 320x0). If left unspecified, the position will be left unchanged, or set to
109 0x0 if the output is currently disabled.
110 The
111 .I --off
112 option disables the specified output completely.
113 .SH "SEE ALSO"
114 Xrandr(3)
115 .SH AUTHORS
116 Keith Packard,
117 and
118 Jim Gettys, 
119 Cambridge Research Laboratory, HP Labs, HP.