File: gdctl.rst

package info (click to toggle)
mutter 49.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,732 kB
  • sloc: ansic: 397,916; xml: 3,384; python: 3,270; sh: 389; ruby: 167; makefile: 61; javascript: 26
file content (212 lines) | stat: -rw-r--r-- 4,884 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
=====
gdctl
=====

------------------------
GNOME Display Controller
------------------------

:Manual section: 1
:Manual group: User Commands

SYNOPSIS
--------
**gdctl** [-h] COMMAND ...

DESCRIPTION
-----------
gdctl provides means to show the active monitor configuration, and set new
monitor configuration using command line arguments.

It requires a compositor that supports the ``org.gnome.Mutter.DisplayConfig``
D-Bus API, such as GNOME Shell.

COMMANDS
--------
``show``

  Show the current display configuration

``set``

  Set a new display configuration

``pref``

  Set display related preferences.

SHOW OPTIONS
------------
``--help``, ``-h``

  Show a help message and exit.

``--modes``, ``-m``

  List available monitor modes.

``--properties``, ``-p``

  List properties.

``--verbose``, ``-v``

  Display all available information (equivalent to ``--modes --properties``).

SET OPTIONS
-----------

``--help``, ``-h``

  Show a help message and exit.

``--persistent``, ``-P``

  Store applied configuration on persistent storage and restore when applicable.

``--verbose``, ``-v``

  Print configuration to standard out before applying it.

``--verify``, ``-V``

  Only verify, without applying, the configuration.

``--layout-mode LAYOUT-MODE``, ``-l``

  Specify the layout mode the configuration should use. Either ``logical``, or
  ``physical``.

``--logical-monitor``, ``-L``

  Add and configure a logical monitor. See LOGICAL MONITOR OPTIONS.

``--for-lease-monitor CONNECTOR``, ``-e CONNECTOR``

  Set a monitor, that is not part of any logical monitor, available for lease.

LOGICAL MONITOR OPTIONS
-----------------------

``--monitor CONNECTOR``, ``-M CONNECTOR``

  Add a monitor to the currently configured logical monitor. All monitors
  within the same logical monitor must have the same monitor resolution.

``--primary``, ``-p``

  Mark currently configured logical monitor as primary.

``--scale SCALE``, ``-s SCALE``

  Scale monitors within the currently configured logical monitor with
  ``SCALE``. Must be a scale supported by all monitors and their configured
  modes.

``--transform TRANSFORM``, ``-t TRANSFORM``

  Transform monitors within the currently configured logical monitor using
  ``TRANSFORM``. Possible transforms are ``normal``, ``90``, ``180``, ``270``,
  ``flipped``, ``flipped-90``, ``flipped-270`` and ``flipped-180``.

``--x X``, ``-x X``

  Set the X position of the currently configured logical monitor.

``--y Y``, ``-y Y``             Y position

  Set the Y position of the currently configured logical monitor.

``--right-of CONNECTOR``

  Place the logical monitor to the right of the logical monitor ``CONNECTOR``
  belongs to.

``--left-of CONNECTOR``   Place left of other monitor

  Place the logical monitor to the left of the logical monitor ``CONNECTOR``
  belongs to.

``--above CONNECTOR``

  Place the logical monitor above the logical monitor ``CONNECTOR`` belongs to.

``--below CONNECTOR``

  Place the logical monitor below the logical monitor ``CONNECTOR`` belongs to.

MONITOR OPTIONS
---------------

``--mode MODE``, ``-m MODE``

  Set the mode of the monitor.

``--color-mode COLOR-MODE``, ``-c COLOR-MODE``

  Set the color mode of the monitor. Available color modes are ``default`` and
  ``bt2100``.


``--rgb-range RGB-RANGE``, ``-r RGB-RANGE``

  Set the RGB quantization range of the monitor. Available ranges are ``auto``,
  ``full`` and ``limited`` (16:235).

PREFS OPTIONS
-------------

``--monitor CONNECTOR``, ``-M CONNECTOR``

  Change monitor preferences. See MONITOR PREFS OPTIONS.

MONITOR PREFS OPTIONS
---------------------

``--luminance LUMINANCE``, ``-l LUMINANCE``

  Set the luminance of the monitor for the current color mode.

``--reset-luminance``

  Reset the luminance of the monitor for the current color mode to its default.

EXAMPLES
--------

Mirror DP-1 and eDP-1, and place DP-2, transformed by 270 degrees, to the right
of the two mirrored monitors.

::

  gdctl set --logical-monitor
            --primary
            --monitor DP-1
            --monitor eDP-1
            --logical-monitor
            --monitor DP-2
            --right-of DP-1
            --transform 270

Set eDP-1 and DP-2 as available for lease.

::

  gdctl set --logical-monitor
            --primary
            --monitor DP-1
            --for-lease-monitor eDP-1
            --for-lease-monitor DP-2

BUGS
----
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.

ADDITIONAL INFORMATION
----------------------
For further information, visit the website
https://gitlab.gnome.org/GNOME/mutter/-/blob/main/README.md.