.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GDCTL" "1" "" "" "User Commands"
.SH NAME
gdctl \- GNOME Display Controller
.SH SYNOPSIS
.sp
\fBgdctl\fP [\-h] COMMAND ...
.SH DESCRIPTION
.sp
gdctl provides means to show the active monitor configuration, and set new
monitor configuration using command line arguments.
.sp
It requires a compositor that supports the \fBorg.gnome.Mutter.DisplayConfig\fP
D\-Bus API, such as GNOME Shell.
.SH COMMANDS
.sp
\fBshow\fP
.INDENT 0.0
.INDENT 3.5
Show the current display configuration
.UNINDENT
.UNINDENT
.sp
\fBset\fP
.INDENT 0.0
.INDENT 3.5
Set a new display configuration
.UNINDENT
.UNINDENT
.sp
\fBpref\fP
.INDENT 0.0
.INDENT 3.5
Set display related preferences.
.UNINDENT
.UNINDENT
.SH SHOW OPTIONS
.sp
\fB\-\-help\fP, \fB\-h\fP
.INDENT 0.0
.INDENT 3.5
Show a help message and exit.
.UNINDENT
.UNINDENT
.sp
\fB\-\-modes\fP, \fB\-m\fP
.INDENT 0.0
.INDENT 3.5
List available monitor modes.
.UNINDENT
.UNINDENT
.sp
\fB\-\-properties\fP, \fB\-p\fP
.INDENT 0.0
.INDENT 3.5
List properties.
.UNINDENT
.UNINDENT
.sp
\fB\-\-verbose\fP, \fB\-v\fP
.INDENT 0.0
.INDENT 3.5
Display all available information (equivalent to \fB\-\-modes \-\-properties\fP).
.UNINDENT
.UNINDENT
.SH SET OPTIONS
.sp
\fB\-\-help\fP, \fB\-h\fP
.INDENT 0.0
.INDENT 3.5
Show a help message and exit.
.UNINDENT
.UNINDENT
.sp
\fB\-\-persistent\fP, \fB\-P\fP
.INDENT 0.0
.INDENT 3.5
Store applied configuration on persistent storage and restore when applicable.
.UNINDENT
.UNINDENT
.sp
\fB\-\-verbose\fP, \fB\-v\fP
.INDENT 0.0
.INDENT 3.5
Print configuration to standard out before applying it.
.UNINDENT
.UNINDENT
.sp
\fB\-\-verify\fP, \fB\-V\fP
.INDENT 0.0
.INDENT 3.5
Only verify, without applying, the configuration.
.UNINDENT
.UNINDENT
.sp
\fB\-\-layout\-mode LAYOUT\-MODE\fP, \fB\-l\fP
.INDENT 0.0
.INDENT 3.5
Specify the layout mode the configuration should use. Either \fBlogical\fP, or
\fBphysical\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-logical\-monitor\fP, \fB\-L\fP
.INDENT 0.0
.INDENT 3.5
Add and configure a logical monitor. See LOGICAL MONITOR OPTIONS.
.UNINDENT
.UNINDENT
.sp
\fB\-\-for\-lease\-monitor CONNECTOR\fP, \fB\-e CONNECTOR\fP
.INDENT 0.0
.INDENT 3.5
Set a monitor, that is not part of any logical monitor, available for lease.
.UNINDENT
.UNINDENT
.SH LOGICAL MONITOR OPTIONS
.sp
\fB\-\-monitor CONNECTOR\fP, \fB\-M CONNECTOR\fP
.INDENT 0.0
.INDENT 3.5
Add a monitor to the currently configured logical monitor. All monitors
within the same logical monitor must have the same monitor resolution.
.UNINDENT
.UNINDENT
.sp
\fB\-\-primary\fP, \fB\-p\fP
.INDENT 0.0
.INDENT 3.5
Mark currently configured logical monitor as primary.
.UNINDENT
.UNINDENT
.sp
\fB\-\-scale SCALE\fP, \fB\-s SCALE\fP
.INDENT 0.0
.INDENT 3.5
Scale monitors within the currently configured logical monitor with
\fBSCALE\fP\&. Must be a scale supported by all monitors and their configured
modes.
.UNINDENT
.UNINDENT
.sp
\fB\-\-transform TRANSFORM\fP, \fB\-t TRANSFORM\fP
.INDENT 0.0
.INDENT 3.5
Transform monitors within the currently configured logical monitor using
\fBTRANSFORM\fP\&. Possible transforms are \fBnormal\fP, \fB90\fP, \fB180\fP, \fB270\fP,
\fBflipped\fP, \fBflipped\-90\fP, \fBflipped\-270\fP and \fBflipped\-180\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-x X\fP, \fB\-x X\fP
.INDENT 0.0
.INDENT 3.5
Set the X position of the currently configured logical monitor.
.UNINDENT
.UNINDENT
.sp
\fB\-\-y Y\fP, \fB\-y Y\fP             Y position
.INDENT 0.0
.INDENT 3.5
Set the Y position of the currently configured logical monitor.
.UNINDENT
.UNINDENT
.sp
\fB\-\-right\-of CONNECTOR\fP
.INDENT 0.0
.INDENT 3.5
Place the logical monitor to the right of the logical monitor \fBCONNECTOR\fP
belongs to.
.UNINDENT
.UNINDENT
.sp
\fB\-\-left\-of CONNECTOR\fP   Place left of other monitor
.INDENT 0.0
.INDENT 3.5
Place the logical monitor to the left of the logical monitor \fBCONNECTOR\fP
belongs to.
.UNINDENT
.UNINDENT
.sp
\fB\-\-above CONNECTOR\fP
.INDENT 0.0
.INDENT 3.5
Place the logical monitor above the logical monitor \fBCONNECTOR\fP belongs to.
.UNINDENT
.UNINDENT
.sp
\fB\-\-below CONNECTOR\fP
.INDENT 0.0
.INDENT 3.5
Place the logical monitor below the logical monitor \fBCONNECTOR\fP belongs to.
.UNINDENT
.UNINDENT
.SH MONITOR OPTIONS
.sp
\fB\-\-mode MODE\fP, \fB\-m MODE\fP
.INDENT 0.0
.INDENT 3.5
Set the mode of the monitor.
.UNINDENT
.UNINDENT
.sp
\fB\-\-color\-mode COLOR\-MODE\fP, \fB\-c COLOR\-MODE\fP
.INDENT 0.0
.INDENT 3.5
Set the color mode of the monitor. Available color modes are \fBdefault\fP and
\fBbt2100\fP\&.
.UNINDENT
.UNINDENT
.SH PREFS OPTIONS
.sp
\fB\-\-monitor CONNECTOR\fP, \fB\-M CONNECTOR\fP
.INDENT 0.0
.INDENT 3.5
Change monitor preferences. See MONITOR PREFS OPTIONS.
.UNINDENT
.UNINDENT
.SH MONITOR PREFS OPTIONS
.sp
\fB\-\-luminance LUMINANCE\fP, \fB\-l LUMINANCE\fP
.INDENT 0.0
.INDENT 3.5
Set the luminance of the monitor for the current color mode.
.UNINDENT
.UNINDENT
.sp
\fB\-\-reset\-luminance\fP
.INDENT 0.0
.INDENT 3.5
Reset the luminance of the monitor for the current color mode to its default.
.UNINDENT
.UNINDENT
.SH EXAMPLES
.sp
Mirror DP\-1 and eDP\-1, and place DP\-2, transformed by 270 degrees, to the right
of the two mirrored monitors.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
gdctl set \-\-logical\-monitor
          \-\-primary
          \-\-monitor DP\-1
          \-\-monitor eDP\-1
          \-\-logical\-monitor
          \-\-monitor DP\-2
          \-\-right\-of DP\-1
          \-\-transform 270
.EE
.UNINDENT
.UNINDENT
.sp
Set eDP\-1 and DP\-2 as available for lease.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
gdctl set \-\-logical\-monitor
          \-\-primary
          \-\-monitor DP\-1
          \-\-for\-lease\-monitor eDP\-1
          \-\-for\-lease\-monitor DP\-2
.EE
.UNINDENT
.UNINDENT
.SH BUGS
.sp
The bug tracker can be reached by visiting the website
 <https://gitlab.gnome.org/GNOME/mutter/\-/issues> \&.
Before sending a bug report, please verify that you have the latest version
of gnome\-shell. Many bugs (major and minor) are fixed at each release, and
if yours is out of date, the problem may already have been solved.
.SH ADDITIONAL INFORMATION
.sp
For further information, visit the website
 <https://gitlab.gnome.org/GNOME/mutter/\-/blob/main/README.md> \&.
.\" Generated by docutils manpage writer.
.