1ICEWM-MENU-XRANDR(1)             User Commands            ICEWM-MENU-XRANDR(1)
2
3
4
5   NAME
6        icewm-menu-xrandr - IceWM menu provider for multi-monitor setup shortcuts
7
8   SYNOPSIS
9       icewm-menu-xrandr
10
11   DESCRIPTION
12       icewm-menu-xrandr is a helper to manage multi-screen configurations in
13       a semi-automated way. It is a regular icewm menu generator that detects
14       the available xrandr screens (i.e. connected monitors) and creates menu
15       entries that call the xrandr command to setup this configuration.
16
17       Optionally, the contents of the generated configurations can be
18       accessed on-the-fly through a "quick-switch" style menu which pops up
19       upon pressing Super-P key binding (or a manually configured key, see
20       icewm-keys(5) for the configuration of switchkey directive).
21
22       The tool does not examine the exact monitor resolutions, refresh rates
23       or screen orientation. For this matters it uses auto selected mode by
24       default. However, it is possible to replace the custom option selection
25       for each output using xrandr options in a custom configuration file
26       (see CONFIGURATION below). Also tuning specific options like
27       --brightness and --gamma is possible there.
28
29       The displayed name of the monitors is constructed using the output name
30       and the monitor information from its EDID data. Either from its
31       "Display Name" field or from the "Unspecified ASCII text" fields
32       (concatenated).
33
34   OPTIONS
35       --max
36           Obsolete and ineffective option. Used to select the xrandr mode
37           with the highest detected refresh rate. However, the maximum rate
38           might cause problems, therefore the explicit configuration in the
39           INI file should be used now, see CONFIGURATION.
40
41       --auto-number [ init value ]
42           Adding a auto-incremented numbered prefix to each display name,
43           optionally started at the specified value. This mostly useful for
44           menu creation.
45
46       --xrandr command
47           Replacement for xrandr command that should deliver equivalent data
48           and accept the same options as xrandr.
49
50       --activate combo-name
51           A shortcut to run the activation command of the specified combo,
52           just like IceWM would run the commmand when selected from the menu
53           or quick-switch dialog. The combo-name parameter needs to match the
54           displayed name exactly.
55
56   CONFIGURATION
57       Optionally, a local configuration can specify command line options to
58       xrandr calls, and further commands to run after mode switching.
59
60       Refer to configuration examples (xrandr_menu) in icewm documentation or
61       its contrib folder for the syntax and rules of that file. It can be
62       placed into $HOME/.config/icewm or into $HOME/.icewm or wherever
63       $XDG_CONFIG_HOME/.config/icewm might resolve to.
64
65   SEE ALSO
66       icewm(1), xrandr(1).
67
68   BUGS
69       Please report bugs at <https://github.com/bbidulock/icewm/issues>.
70
71   AUTHOR
72       Eduard Bloch <mailto:edi@gmx.de>.
73
74   LICENSE
75       icewm-menu-xrandr is licensed under the Simplified BSD License.  IceWM
76       is licensed under the GNU Library General Public License.  See the
77       COPYING file in the distribution.
78
79
80
81icewm 3.4.4                       2023-11-03              ICEWM-MENU-XRANDR(1)
Impressum