Package: x11-xserver-utils
Version: 7.7+10+b1
Severity: minor
Tags: patch
Dear Maintainer,
* What led up to the situation?
Checking for defects with
[test-][g|n]roff -mandoc -t -K utf8 -ww -b -z <man page>
[test-groff is a script in the repository for "groff"]
* What was the outcome of this action?
troff: backtrace: file '<stdin>':36
troff:<stdin>:36: warning: [page 1, 1.8i]: cannot break line
troff: backtrace: file '<stdin>':58
troff:<stdin>:58: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':59
troff:<stdin>:59: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':60
troff:<stdin>:60: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':61
troff:<stdin>:61: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':62
troff:<stdin>:62: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':133
troff:<stdin>:133: warning: register '"' not defined
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':611
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':590: macro 'TP'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':611: macro 'IP'
troff: backtrace: file '<stdin>':133
troff:<stdin>:133: warning: expected numeric expression, got character '}'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':613: macro 'IP'
troff: backtrace: file '<stdin>':172
troff:<stdin>:172: warning: [page 2, 7.2i (diversion 'an*paragraph-tag',
0.2i)]: cannot break line
* What outcome did you expect instead?
No output (warnings).
-.-
Remarks and a patch are in the attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages x11-xserver-utils depends on:
ii cpp 4:13.2.0-7
ii libc6 2.38-11
ii libice6 2:1.0.10-1+b1
ii libx11-6 2:1.8.7-1+b1
ii libxaw7 2:1.0.14-1+b2
ii libxcursor1 1:1.2.1-1+b1
ii libxext6 2:1.3.4-1+b1
ii libxi6 2:1.8.1-1
ii libxmu6 2:1.1.3-3+b2
ii libxmuu1 2:1.1.3-3+b2
ii libxrandr2 2:1.5.4-1
ii libxt6t64 1:1.2.1-1.2
ii libxxf86vm1 1:1.1.4-1+b2
x11-xserver-utils recommends no packages.
Versions of packages x11-xserver-utils suggests:
pn cairo-5c <none>
pn nickle <none>
ii xorg-docs-core 1:1.7.1-1.2
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any generator should check its products with the above mentioned
'groff' and additionally with 'nroff ...'.
This is just a simple quality control measure.
The generator may have to be corrected to get a better man page,
the source file may, and any additional file may.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint xrandr.1": (possibly shortened list)
mandoc: xrandr.1:36:199: STYLE: input text line longer than 80 bytes:
[\-\-panning \fIwidt...
mandoc: xrandr.1:39:87: STYLE: input text line longer than 80 bytes:
[\-\-transform \fIa\...
mandoc: xrandr.1:58:27: WARNING: undefined escape, printing literally: \]
mandoc: xrandr.1:59:28: WARNING: undefined escape, printing literally: \]
mandoc: xrandr.1:60:24: WARNING: undefined escape, printing literally: \]
mandoc: xrandr.1:61:24: WARNING: undefined escape, printing literally: \]
mandoc: xrandr.1:62:26: WARNING: undefined escape, printing literally: \]
mandoc: xrandr.1:124:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:126:2: WARNING: skipping paragraph macro: PP after SH
mandoc: xrandr.1:128:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:134:81: STYLE: input text line longer than 80 bytes: Define a
new monitor...
mandoc: xrandr.1:135:86: STYLE: input text line longer than 80 bytes: The
output list is e...
mandoc: xrandr.1:137:90: STYLE: input text line longer than 80 bytes: will
automatically t...
mandoc: xrandr.1:140:87: STYLE: input text line longer than 80 bytes: where w,
h, x, y are...
mandoc: xrandr.1:143:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:145:2: WARNING: skipping paragraph macro: PP after SH
mandoc: xrandr.1:161:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:163:2: WARNING: skipping paragraph macro: PP after SH
mandoc: xrandr.1:165:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:222:2: WARNING: skipping paragraph macro: br before text line
with leading blank
mandoc: xrandr.1:235:84: STYLE: input text line longer than 80 bytes: If the
\fIy\fP value...
mandoc: xrandr.1:247:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:274:82: STYLE: input text line longer than 80 bytes: the
specified DPI va...
mandoc: xrandr.1:308:81: STYLE: input text line longer than 80 bytes: Position
the output ...
mandoc: xrandr.1:330:89: STYLE: input text line longer than 80 bytes: (see
\-\-prop) comma...
mandoc: xrandr.1:346:112: STYLE: input text line longer than 80 bytes: for
cloned outputs (...
mandoc: xrandr.1:352:81: STYLE: input text line longer than 80 bytes: actually
change the ...
mandoc: xrandr.1:353:2: WARNING: skipping paragraph macro: PP empty
mandoc: xrandr.1:372:92: STYLE: input text line longer than 80 bytes: output
called VGA to...
mandoc: xrandr.1:374:103: STYLE: input text line longer than 80 bytes: xrandr
--output LVDS...
mandoc: xrandr.1:379:85: STYLE: input text line longer than 80 bytes: xrandr
--newmode "10...
mandoc: xrandr.1:386:93: STYLE: input text line longer than 80 bytes: Enables
panning on a...
mandoc: xrandr.1:391:99: STYLE: input text line longer than 80 bytes: Have one
small 1280x...
mandoc: xrandr.1:394:124: STYLE: input text line longer than 80 bytes: xrandr
--fb 3200x200...
mandoc: xrandr.1:400:82: STYLE: input text line longer than 80 bytes: xrandr
--fb 1024x768...
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended. An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (end of options) then use "\-\-".
xrandr.1:179:size with \fI--fb\fP simultaneously.
xrandr.1:374:xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA
--auto --rotate left --right-of LVDS
xrandr.1:379:xrandr --newmode "1024x768" 63.50 1024 1072 1176 1328 768 771
775 798 -hsync +vsync
xrandr.1:381:xrandr --addmode VGA 1024x768
xrandr.1:383:xrandr --output VGA --mode 1024x768
xrandr.1:388:xrandr --fb 1600x768 --output VGA --mode 1024x768 --panning 1600x0
xrandr.1: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
xrandr.1:400:xrandr --fb 1024x768 --output VGA --transform
1.24,0.16,-124,0,1.24,0,0,0.000316,1
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
253:output. \-\-verbose also enables \-\-prop.
283:vsyncend vtotal \fIflags\fP. \fIflags\fP can be zero or more of +HSync,
319:the output contents to be rotated in the specified direction. 'right'
specifies
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
179:size with \fI--fb\fP simultaneously.
374:xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA --auto
--rotate left --right-of LVDS
379:xrandr --newmode "1024x768" 63.50 1024 1072 1176 1328 768 771 775 798
-hsync +vsync
381:xrandr --addmode VGA 1024x768
383:xrandr --output VGA --mode 1024x768
388:xrandr --fb 1600x768 --output VGA --mode 1024x768 --panning 1600x0
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
400:xrandr --fb 1024x768 --output VGA --transform
1.24,0.16,-124,0,1.24,0,0,0.000316,1
-.-.
Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.
300:first preferred mode (or, something close to 96dpi if they have no preferred
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
196:.RI "(x y)"
198:.RI "(x y w),"
203:.RI "(x' y')"
-.-.
Change - to \- if it shall be printed as a minus sign.
xrandr.1:400:xrandr --fb 1024x768 --output VGA --transform
1.24,0.16,-124,0,1.24,0,0,0.000316,1
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
xrandr.1:223: 0 0 1
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
179:size with \fI--fb\fP simultaneously.
219:cos T -sin T 0
284:-HSync, +VSync, -VSync, Interlace, DoubleScan, CSync, +CSync, -CSync.
Several
374:xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA --auto
--rotate left --right-of LVDS
379:xrandr --newmode "1024x768" 63.50 1024 1072 1176 1328 768 771 775 798
-hsync +vsync
381:xrandr --addmode VGA 1024x768
383:xrandr --output VGA --mode 1024x768
388:xrandr --fb 1600x768 --output VGA --mode 1024x768 --panning 1600x0
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
400:xrandr --fb 1024x768 --output VGA --transform
1.24,0.16,-124,0,1.24,0,0,0.000316,1
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
N.B
The number of lines affected can be too large to be in the patch.
82:screen. It can also set the screen size.
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
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
100:complete color profile stored in the server. When
109:Apply the modifications without grabbing the screen. It avoids to block
other
113:This option selects the X display to use. Note this refers to the X
116:This option selects which screen to manipulate. Note this refers to the X
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
193:The transformation is based on homogeneous coordinates. The matrix
multiplied
199:with 1 as the w coordinate and multiplied against the matrix. The final
device
215:are respectively 0, 0 and 1. The matrix can also be used to express more
253:output. \-\-verbose also enables \-\-prop.
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
261:(union of all configured monitors). In configurations with multiple
264:version 1.2 to compute a reference font scaling. Normally,
266:This overrides that computation. Default DPI value is 96.
270:(union of all configured monitors). In configurations with multiple
273:version 1.2 to compute a reference font scaling. This option uses either
275:physical size using whatever pixel size will be set. Typical values are
281:This option does the former. The \fImode\fP is specified using the ModeLine
283:vsyncend vtotal \fIflags\fP. \fIflags\fP can be zero or more of +HSync,
284:-HSync, +VSync, -VSync, Interlace, DoubleScan, CSync, +CSync, -CSync.
Several
296:Selects an output to reconfigure. Use either the name of the output or the
301:mode). For disconnected but enabled outputs, this will disable them.
303:This selects a mode. Use either the name or the XID for \fImode\fP
308:Position the output within the screen using pixel coordinates. In case
reflection
315:Reflection can be one of 'normal' 'x', 'y' or 'xy'. This causes the output
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
324:another output. This allows convenient tiling of outputs within the screen.
329:Sets an output property. Integer properties may be specified as a valid
338:sensible choices about which crtc to use with each output. When that fails
350:specified floating value. Useful for overly bright or overly dim outputs.
356:older. They are still valid for newer X servers, but they don't interact
-.-.
Test nr. 32:
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
xrandr.1: line 36 length 199
[\-\-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]]]]
xrandr.1: line 39 length 87
[\-\-transform
\fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP]
xrandr.1: line 133 length 101
.IP "\-\-setmonitor \fIname\fP \fIgeometry\fP \fIoutputs\fP"}
{none|\fIoutput\fP,\fIoutput\fP,...}\n"
xrandr.1: line 134 length 81
Define a new monitor with the given geometry and associated to the given
outputs.
xrandr.1: line 135 length 86
The output list is either the keyword \fBnone\fP or a comma-separated list of
outputs.
xrandr.1: line 137 length 90
will automatically track the geometry of the associated outputs, or a manual
specification
xrandr.1: line 140 length 87
where w, h, x, y are in pixels and mmw, mmh are the physical dimensions of the
monitor.
xrandr.1: line 172 length 203
.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]]]"
xrandr.1: line 180 length 91
.IP "\-\-transform
\fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP"
xrandr.1: line 235 length 84
If the \fIy\fP value is omitted, the \fIx\fP value will be used for both
dimensions.
xrandr.1: line 274 length 82
the specified DPI value, or the DPI of the given output, to compute an
appropriate
xrandr.1: line 308 length 81
Position the output within the screen using pixel coordinates. In case
reflection
xrandr.1: line 322 length 89
.IP "\-\-left\-of, \-\-right\-of, \-\-above, \-\-below, \-\-same-as
\fIanother-output\fP"
xrandr.1: line 330 length 89
(see \-\-prop) comma-separated list of decimal or hexadecimal (with a leading
0x) values.
xrandr.1: line 346 length 112
for cloned outputs (i.e.: which share the same crtc) and that switching an
output to another crtc doesn't change
xrandr.1: line 352 length 81
actually change the brightness, you will probably prefer to use
\fBxbacklight\fR.
xrandr.1: line 372 length 92
output called VGA to preferred mode of a screen which has been physically
rotated clockwise:
xrandr.1: line 374 length 103
xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA --auto
--rotate left --right-of LVDS
xrandr.1: line 379 length 85
xrandr --newmode "1024x768" 63.50 1024 1072 1176 1328 768 771 775 798 -hsync
+vsync
xrandr.1: line 386 length 93
Enables panning on a 1600x768 desktop while displaying 1024x768 mode on an
output called VGA:
xrandr.1: line 391 length 99
Have one small 1280x800 LVDS screen showing a small version of a huge 3200x2000
desktop, and have a
xrandr.1: line 394 length 124
xrandr --fb 3200x2000 --output LVDS --scale 2.5x2.5 --output VGA --pos 0x0
--panning 3200x2000+0+0/3200x2000+0+0/64/64/64/64
xrandr.1: line 400 length 82
xrandr --fb 1024x768 --output VGA --transform
1.24,0.16,-124,0,1.24,0,0,0.000316,1
-.-.
Use "\\n", not "\n"
133:.IP "\-\-setmonitor \fIname\fP \fIgeometry\fP \fIoutputs\fP"}
{none|\fIoutput\fP,\fIoutput\fP,...}\n"
-.-.
Protect a period (.) or an apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line
(by splitting the line into more lines).
85:showing the existing modes for each of them, with a '+' after the preferred
86:modes and a '*' after the current mode.
232:Can be either 'bilinear' or 'nearest'.
315:Reflection can be one of 'normal' 'x', 'y' or 'xy'. This causes the output
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
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
403:Xrandr(3), cvt(1), xkeystone(1), xbacklight(1)
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of an option in UTF-8 text.
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
38:[\-\-scale-from \fIw\fPx\fIh\fP]
62:[\-\-same-as \fIoutput\fP\]
240:.IP "\-\-scale-from \fIw\fPx\fIh\fP"
322:.IP "\-\-left\-of, \-\-right\-of, \-\-above, \-\-below, \-\-same-as
\fIanother-output\fP"
374:xrandr --output LVDS --auto --rotate normal --pos 0x0 --output VGA --auto
--rotate left --right-of LVDS
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -K utf8 -t -ww -z -K
utf8":
troff: backtrace: file '<stdin>':36
troff:<stdin>:36: warning: [page 1, 1.8i]: cannot break line
troff: backtrace: file '<stdin>':58
troff:<stdin>:58: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':59
troff:<stdin>:59: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':60
troff:<stdin>:60: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':61
troff:<stdin>:61: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':62
troff:<stdin>:62: warning: ignoring escape character before ']'
troff: backtrace: file '<stdin>':133
troff:<stdin>:133: warning: register '"' not defined
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':611
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':590: macro 'TP'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':611: macro 'IP'
troff: backtrace: file '<stdin>':133
troff:<stdin>:133: warning: expected numeric expression, got character '}'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':613: macro 'IP'
troff: backtrace: file '<stdin>':172
troff:<stdin>:172: warning: [page 2, 7.2i (diversion 'an*paragraph-tag',
0.2i)]: cannot break line
--- xrandr.1 2024-06-02 17:34:29.253037099 +0000
+++ xrandr.1.new 2024-06-02 19:16:29.894121688 +0000
@@ -33,9 +33,11 @@ xrandr \- primitive command line interfa
[\-\-q12]
[\-\-current]
[\-\-noprimary]
-[\-\-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]]]]
+[\-\-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]]]]
[\-\-scale \fIx\fP[x\fIy\fP]]
-[\-\-scale-from \fIw\fPx\fIh\fP]
+[\-\-scale\-from \fIw\fPx\fIh\fP]
[\-\-transform
\fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP]
[\-\-primary]
[\-\-prop]
@@ -55,11 +57,11 @@ xrandr \- primitive command line interfa
[\-\-rate \fIrate\fP]
[\-\-reflect \fIreflection\fP]
[\-\-rotate \fIorientation\fP]
-[\-\-left\-of \fIoutput\fP\]
-[\-\-right\-of \fIoutput\fP\]
-[\-\-above \fIoutput\fP\]
-[\-\-below \fIoutput\fP\]
-[\-\-same-as \fIoutput\fP\]
+[\-\-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 \fIcrtc\fP]
@@ -82,8 +84,8 @@ is used to set the size, orientation and
screen. It can also set the screen size.
If invoked without any option, it will dump the state of the outputs,
-showing the existing modes for each of them, with a '+' after the preferred
-modes and a '*' after the current mode.
+showing the existing modes for each of them, with a \&'+' after the preferred
+modes and a \&'*' after the current mode.
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
@@ -121,28 +123,28 @@ is available.
.IP \-\-q12
Forces the usage of the RandR version 1.2 protocol, even if the display does
not report it as supported or a higher version is available.
-.PP
.SH "RandR version 1.5 options"
-.PP
Options for RandR 1.5 are used as a superset of the options for RandR 1.4.
-.PP
.IP \-\-listmonitors
Report information about all defined monitors.
.IP \-\-listactivemonitors
Report information about currently active monitors.
-.IP "\-\-setmonitor \fIname\fP \fIgeometry\fP \fIoutputs\fP"}
{none|\fIoutput\fP,\fIoutput\fP,...}\n"
-Define a new monitor with the given geometry and associated to the given
outputs.
-The output list is either the keyword \fBnone\fP or a comma-separated list of
outputs.
+.IP "\-\-setmonitor \fIname\fP {\fIgeometry\fP \fIoutputs\fP} \
+{none|\fIoutput\fP,\fIoutput\fP,...}"
+Define a new monitor with the given geometry and associated to the given
+outputs.
+The output list is either the keyword \fBnone\fP or a comma-separated list
+of outputs.
The geometry is either the keyword \fBauto\fP, in which case the monitor
-will automatically track the geometry of the associated outputs, or a manual
specification
+will automatically track the geometry of the associated outputs, or a manual
+specification
in the form
\fIw\fP/\fImmw\fPx\fIh\fP/\fImmh\fP+\fIx\fP+\fIy\fP
-where w, h, x, y are in pixels and mmw, mmh are the physical dimensions of the
monitor.
+where w, h, x, y are in pixels and mmw, mmh are the physical dimensions of
+the monitor.
.IP "\-\-delmonitor \fIname\fP"
Delete the given user-defined monitor.
-.PP
.SH "RandR version 1.4 options"
-.PP
Options for RandR 1.4 are used as a superset of the options for RandR 1.3.
.IP \-\-listproviders
Report information about the providers available.
@@ -158,25 +160,24 @@ This is only possible if \fIprovider\fP
Offload\fR and \fBSink Offload\fR capabilities, respectively.
If \fIsink\fP is \fB0x0\fP, then \fIprovider\fP is disconnected from its
current
render offload sink.
-.PP
.SH "RandR version 1.3 options"
-.PP
Options for RandR 1.3 are used as a superset of the options for RandR 1.2.
-.PP
.IP \-\-current
Return the current screen configuration, without polling for hardware changes.
.IP \-\-noprimary
Don't define a primary output.
.PP
.B "Per-output options"
-.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]]]"
+.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]]]"
This option sets the panning parameters. As soon as panning is
enabled, the CRTC position can change with every pointer move.
The first four parameters specify the total panning area, the next four the
pointer tracking area (which defaults to the same area). The last four
parameters specify the border and default to 0. A width or height set to zero
disables panning on the according axis. You typically have to set the screen
-size with \fI--fb\fP simultaneously.
+size with \fI\-\-fb\fP simultaneously.
.IP "\-\-transform
\fIa\fP,\fIb\fP,\fIc\fP,\fId\fP,\fIe\fP,\fIf\fP,\fIg\fP,\fIh\fP,\fIi\fP"
Specifies a transformation matrix to apply on the output.
A bilinear filter is selected automatically unless the \-\-filter parameter is
@@ -193,14 +194,14 @@ g h i
The transformation is based on homogeneous coordinates. The matrix multiplied
by the coordinate vector of a pixel of the output gives the transformed
coordinate vector of a pixel in the graphic buffer. More precisely, the vector
-.RI "(x y)"
+.RI ( "x y" )
of the output pixel is extended to 3 values
-.RI "(x y w),"
+.RI ( "x y w" ),
with 1 as the w coordinate and multiplied against the matrix. The final device
coordinates of the pixel are then calculated with the so-called homogenic
division by the transformed w coordinate. In other words, the device
coordinates
-.RI "(x' y')"
+.RI ( "x' y'" )
of the transformed pixel are:
.RS
x' = (ax + by + c) / w' and
@@ -216,10 +217,10 @@ are respectively 0, 0 and 1. The matrix
complex transformations such as keystone correction, or rotation. For a
rotation of an angle T, this formula can be used:
.RS
-cos T -sin T 0
+cos T \-sin T 0
.br
sin T cos T 0
-.br
+.\".br
0 0 1
.RE
As a special argument, instead of
@@ -229,28 +230,29 @@ values are used (a unit matrix without f
.IP "\-\-filter \fIfiltermode\fP"
Chooses the scaling filter method to be applied when the screen is scaled or
transformed.
-Can be either 'bilinear' or 'nearest'.
+Can be either \&'bilinear' or \&'nearest'.
.IP "\-\-scale \fIx\fP[x\fIy\fP]"
Changes the dimensions of the output picture.
-If the \fIy\fP value is omitted, the \fIx\fP value will be used for both
dimensions.
+If the \fIy\fP value is omitted,
+the \fIx\fP value will be used for both dimensions.
Values larger than 1 lead to a compressed screen (screen dimension bigger
than the dimension of the output mode), and values less than 1 lead to
a zoom in on the output.
This option is actually a shortcut version of the \fI\-\-transform\fP option.
-.IP "\-\-scale-from \fIw\fPx\fIh\fP"
+.IP "\-\-scale\-from \fIw\fPx\fIh\fP"
Specifies the size in pixels of the area of the framebuffer to be displayed on
this output.
This option is actually a shortcut version of the \fI\-\-transform\fP option.
.IP \-\-primary
Set the output as primary.
It will be sorted first in Xinerama and RANDR geometry requests.
-.PP
.SH "RandR version 1.2 options"
These options are only available for X server supporting RandR version 1.2
or newer.
.IP "\-\-prop, \-\-properties"
This option causes xrandr to display the contents of properties for each
-output. \-\-verbose also enables \-\-prop.
+output.
+\-\-verbose also enables \-\-prop.
.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
@@ -271,17 +273,19 @@ This also sets the value reported as phy
monitors with different DPIs, the value has no physical meaning, but
it may be used by some legacy clients which do not support RandR
version 1.2 to compute a reference font scaling. This option uses either
-the specified DPI value, or the DPI of the given output, to compute an
appropriate
-physical size using whatever pixel size will be set. Typical values are
-the default (96 DPI), the DPI of the only monitor in single-monitor
-configurations, or the DPI of the primary monitor in multi-monitor
-configurations.
+the specified DPI value, or the DPI of the given output,
+to compute an appropriate physical size using whatever pixel size will be set.
+Typical values are the default (96 DPI),
+the DPI of the only monitor in single-monitor configurations,
+or the DPI of the primary monitor in multi-monitor configurations.
.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: clock 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
+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 height, width, and refresh
rate, for instance you can use \fBcvt\fR.
.IP "\-\-rmmode \fIname\fP"
@@ -297,29 +301,33 @@ Selects an output to reconfigure. Use ei
XID.
.IP \-\-auto
For connected but disabled outputs, this will enable them using their
-first preferred mode (or, something close to 96dpi if they have no preferred
-mode). For disconnected but enabled outputs, this will disable them.
+first preferred mode (or, something close to 96\~dpi if they have no preferred
+mode).
+For disconnected but enabled outputs, this will disable them.
.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 \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.
+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.
.IP "\-\-reflect \fIreflection\fP"
-Reflection can be one of 'normal' 'x', 'y' or 'xy'. This causes the output
+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. 'right' specifies
-a clockwise rotation of the picture and 'left' specifies a counter-clockwise
+Rotation can be one of \&'normal', \&'left', \&'right' or \&'inverted'. This
causes
+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"
+.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
@@ -327,7 +335,8 @@ output, so it is not valid to say \-\-ou
b \-\-left\-of a.
.IP "\-\-set \fIproperty\fP \fIvalue\fP"
Sets an output property. Integer properties may be specified as a valid
-(see \-\-prop) comma-separated list of decimal or hexadecimal (with a leading
0x) values.
+(see \-\-prop) comma-separated list of decimal or hexadecimal
+(with a leading 0x) values.
Atom properties may be set to any of the valid atoms (see \-\-prop).
String properties may be set to any value.
.IP "\-\-off"
@@ -343,14 +352,15 @@ currently attached to this output.
If green and blue are not specified, the red value will be used
for all three components.
Note that you cannot get two different values
-for cloned outputs (i.e.: which share the same crtc) and that switching an
output to another crtc doesn't change
+for cloned outputs (i.e.: which share the same crtc) and that switching an
+output to another crtc doesn't change
the crtc gamma corrections at all.
.IP "\-\-brightness \fIbrightness\fP"
Multiply the gamma values on the crtc currently attached to the output to
specified floating value. Useful for overly bright or overly dim outputs.
However, this is a software only modification, if your hardware has support to
-actually change the brightness, you will probably prefer to use
\fBxbacklight\fR.
-.PP
+actually change the brightness, you will probably prefer to use
+\fBxbacklight\fR.
.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
@@ -369,38 +379,45 @@ Reflect across the X axis.
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:
+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
+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
+xrandr \-\-newmode "1024x768" 63.50 1024 1072 1176 1328 768 771 775 798
+\-hsync +vsync
.br
-xrandr --addmode VGA 1024x768
+xrandr \-\-addmode VGA 1024x768
.br
-xrandr --output VGA --mode 1024x768
+xrandr \-\-output VGA \-\-mode 1024x768
.RE
.PP
-Enables panning on a 1600x768 desktop while displaying 1024x768 mode on an
output called VGA:
+Enables panning on a 1600x768 desktop while displaying 1024x768 mode on an
+output called VGA:
.RS
-xrandr --fb 1600x768 --output VGA --mode 1024x768 --panning 1600x0
+xrandr \-\-fb 1600x768 \-\-output VGA \-\-mode 1024x768 \-\-panning 1600x0
.RE
.PP
-Have one small 1280x800 LVDS screen showing a small version of a huge
3200x2000 desktop, and have a
-big VGA screen display the surrounding of the mouse at normal size.
+Have one small 1280x800 LVDS screen showing a small version of a huge
+3200x2000 desktop,
+and have a big VGA screen display the surrounding of the mouse at normal size.
.RS
-xrandr --fb 3200x2000 --output LVDS --scale 2.5x2.5 --output VGA --pos 0x0
--panning 3200x2000+0+0/3200x2000+0+0/64/64/64/64
+xrandr \-\-fb 3200x2000 \-\-output LVDS \-\-scale 2.5x2.5 \-\-output VGA
\-\-pos 0x0
+\-\-panning 3200x2000+0+0/3200x2000+0+0/64/64/64/64
.RE
.PP
Displays the VGA output in trapezoid shape so that it is keystone corrected
when the projector is slightly above the screen:
.RS
-xrandr --fb 1024x768 --output VGA --transform
1.24,0.16,-124,0,1.24,0,0,0.000316,1
+xrandr \-\-fb 1024x768 \-\-output VGA \-\-transform
+1.24,0.16,\-124,0,1.24,0,0,0.000316,1
.RE
.SH "SEE ALSO"
-Xrandr(3), cvt(1), xkeystone(1), xbacklight(1)
+.BR Xrandr "(3), " cvt "(1), " xkeystone "(1), " xbacklight (1)
.SH AUTHORS
Keith Packard,
Open Source Technology Center, Intel Corporation.
