Debian Codegraph @

upstream/fedora-44/man1/icewm-menu-xrandr.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.47)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "ICEWM-MENU-XRANDR 1"
61 .TH ICEWM-MENU-XRANDR 1 2026-01-16 "icewm\ 4.0.0" "User Commands"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SS NAME
67 .IX Subsection "NAME"
68 .Vb 1
69 \& icewm\-menu\-xrandr \- IceWM menu provider for multi\-monitor setup shortcuts
70 .Ve
71 .SS SYNOPSIS
72 .IX Subsection "SYNOPSIS"
73 \&\fBicewm\-menu\-xrandr\fR
74 .SS DESCRIPTION
75 .IX Subsection "DESCRIPTION"
76 \&\fBicewm\-menu\-xrandr\fR is a helper to manage multi\-screen configurations
77 in a semi\-automated way. It is a regular icewm menu generator that
78 detects the available xrandr screens (i.e. connected monitors) and
79 creates menu entries that call the xrandr command to setup this
80 configuration.
81 .PP
82 Optionally, the contents of the generated configurations can be accessed
83 on\-the\-fly through a "quick\-switch" style menu which pops up upon
84 pressing Super\-P key binding (or a manually configured key, see
85 \&\fBicewm\-keys\fR\|(5) for the configuration of \fBswitchkey\fR directive).
86 .PP
87 The tool does not examine the exact monitor resolutions, refresh rates
88 or screen orientation. For this matters it uses auto selected mode by
89 default. However, it is possible to replace the custom option selection
90 for each output using \fIxrandr\fR options in a custom configuration file
91 (see \fICONFIGURATION\fR below). Also tuning specific options like
92 \&\-\-brightness and \-\-gamma is possible there.
93 .PP
94 The displayed name of the monitors is constructed using the output name
95 and the monitor information from its EDID data. Either from its "Display
96 Name" field or from the "Unspecified ASCII text" fields (concatenated).
97 .SS OPTIONS
98 .IX Subsection "OPTIONS"
99 .IP \fB\-\-max\fR 4
100 .IX Item "--max"
101 Obsolete and ineffective option. Used to select the \fIxrandr\fR mode with the
102 highest detected refresh rate. However, the maximum rate might cause
103 problems, therefore the explicit configuration in the \fIINI file\fR should be
104 used now, see \fICONFIGURATION\fR.
105 .IP "\fB\-\-auto\-number [ init value ]\fR" 4
106 .IX Item "--auto-number [ init value ]"
107 Adding a auto\-incremented numbered prefix to each display name,
108 optionally started at the specified value. This mostly useful for menu
109 creation.
110 .IP "\fB\-\-xrandr command\fR" 4
111 .IX Item "--xrandr command"
112 Replacement for \fIxrandr\fR command that should deliver equivalent data
113 and accept the same options as \fIxrandr\fR.
114 .IP "\fB\-\-activate combo\-name\fR" 4
115 .IX Item "--activate combo-name"
116 A shortcut to run the activation command of the specified combo, just
117 like \fIIceWM\fR would run the commmand when selected from the menu or
118 quick\-switch dialog. The \fIcombo\-name\fR parameter needs to match the
119 displayed name exactly.
120 .SS CONFIGURATION
121 .IX Subsection "CONFIGURATION"
122 Optionally, a local configuration can specify command line options to
123 \&\fIxrandr\fR calls, and further commands to run after mode switching.
124 .PP
125 Refer to configuration examples (\fIxrandr_menu\fR) in \fIicewm\fR
126 documentation or its contrib folder for the syntax and rules of that
127 file. It can be placed into \fR\f(CI$HOME\fR\fI/.config/icewm\fR or into
128 \&\fI\fR\f(CI$HOME\fR\fI/.icewm\fR or wherever \fI\fR\f(CI$XDG_CONFIG_HOME\fR\fI/.config/icewm\fR might
129 resolve to.
130 .SS "SEE ALSO"
131 .IX Subsection "SEE ALSO"
132 \&\fBicewm\fR\|(1),
133 \&\fBxrandr\fR\|(1).
134 .SS BUGS
135 .IX Subsection "BUGS"
136 Please report bugs at <https://github.com/ice\-wm/icewm/issues>.
137 .SS AUTHOR
138 .IX Subsection "AUTHOR"
139 Eduard Bloch <mailto:[email protected]>.
140 .SS LICENSE
141 .IX Subsection "LICENSE"
142 \&\fBicewm\-menu\-xrandr\fR is licensed under the Simplified BSD License.
143 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
144 See the \fICOPYING\fR file in the distribution.