Debian Codegraph @

upstream/debian-unstable/man1/icewm-menu-xrandr.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
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 .\"
57 .IX Title "ICEWM-MENU-XRANDR 1"
58 .TH ICEWM-MENU-XRANDR 1 2026-01-18 "icewm\ 4.0.0" "User Commands"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SS NAME
64 .IX Subsection "NAME"
65 .Vb 1
66 \& icewm\-menu\-xrandr \- IceWM menu provider for multi\-monitor setup shortcuts
67 .Ve
68 .SS SYNOPSIS
69 .IX Subsection "SYNOPSIS"
70 \&\fBicewm-menu-xrandr\fR
71 .SS DESCRIPTION
72 .IX Subsection "DESCRIPTION"
73 \&\fBicewm-menu-xrandr\fR is a helper to manage multi-screen configurations
74 in a semi-automated way. It is a regular icewm menu generator that
75 detects the available xrandr screens (i.e. connected monitors) and
76 creates menu entries that call the xrandr command to setup this
77 configuration.
78 .PP
79 Optionally, the contents of the generated configurations can be accessed
80 on-the-fly through a "quick-switch" style menu which pops up upon
81 pressing Super-P key binding (or a manually configured key, see
82 \&\fBicewm\-keys\fR\|(5) for the configuration of \fBswitchkey\fR directive).
83 .PP
84 The tool does not examine the exact monitor resolutions, refresh rates
85 or screen orientation. For this matters it uses auto selected mode by
86 default. However, it is possible to replace the custom option selection
87 for each output using \fIxrandr\fR options in a custom configuration file
88 (see \fICONFIGURATION\fR below). Also tuning specific options like
89 \&\-\-brightness and \-\-gamma is possible there.
90 .PP
91 The displayed name of the monitors is constructed using the output name
92 and the monitor information from its EDID data. Either from its "Display
93 Name" field or from the "Unspecified ASCII text" fields (concatenated).
94 .SS OPTIONS
95 .IX Subsection "OPTIONS"
96 .IP \fB\-\-max\fR 4
97 .IX Item "--max"
98 Obsolete and ineffective option. Used to select the \fIxrandr\fR mode with the
99 highest detected refresh rate. However, the maximum rate might cause
100 problems, therefore the explicit configuration in the \fIINI file\fR should be
101 used now, see \fICONFIGURATION\fR.
102 .IP "\fB\-\-auto\-number [ init value ]\fR" 4
103 .IX Item "--auto-number [ init value ]"
104 Adding a auto-incremented numbered prefix to each display name,
105 optionally started at the specified value. This mostly useful for menu
106 creation.
107 .IP "\fB\-\-xrandr command\fR" 4
108 .IX Item "--xrandr command"
109 Replacement for \fIxrandr\fR command that should deliver equivalent data
110 and accept the same options as \fIxrandr\fR.
111 .IP "\fB\-\-activate combo-name\fR" 4
112 .IX Item "--activate combo-name"
113 A shortcut to run the activation command of the specified combo, just
114 like \fIIceWM\fR would run the commmand when selected from the menu or
115 quick-switch dialog. The \fIcombo-name\fR parameter needs to match the
116 displayed name exactly.
117 .SS CONFIGURATION
118 .IX Subsection "CONFIGURATION"
119 Optionally, a local configuration can specify command line options to
120 \&\fIxrandr\fR calls, and further commands to run after mode switching.
121 .PP
122 Refer to configuration examples (\fIxrandr_menu\fR) in \fIicewm\fR
123 documentation or its contrib folder for the syntax and rules of that
124 file. It can be placed into \fR\f(CI$HOME\fR\fI/.config/icewm\fR or into
125 \&\fI\fR\f(CI$HOME\fR\fI/.icewm\fR or wherever \fI\fR\f(CI$XDG_CONFIG_HOME\fR\fI/.config/icewm\fR might
126 resolve to.
127 .SS "SEE ALSO"
128 .IX Subsection "SEE ALSO"
129 \&\fBicewm\fR\|(1),
130 \&\fBxrandr\fR\|(1).
131 .SS BUGS
132 .IX Subsection "BUGS"
133 Please report bugs at <https://github.com/ice\-wm/icewm/issues>.
134 .SS AUTHOR
135 .IX Subsection "AUTHOR"
136 Eduard Bloch <mailto:[email protected]>.
137 .SS LICENSE
138 .IX Subsection "LICENSE"
139 \&\fBicewm-menu-xrandr\fR is licensed under the Simplified BSD License.
140 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
141 See the \fICOPYING\fR file in the distribution.