1AUTORANDR(1) General Commands Manual AUTORANDR(1)
2
3
4
6 autorandr - automatically select a display configuration based on con‐
7 nected devices
8
10 autorandr [OPTION] [PROFILE]
11
13 This program automatically detects connected display hardware and then
14 loads an appropriate X11 setup using xrandr. It also supports the use
15 of display profiles for different hardware setups.
16
17 Autorandr also includes several virtual configurations including off,
18 common, clone-largest, horizontal, and vertical. See the documentation
19 for explanation of each.
20
22 -h, --help
23 Display help text and exit
24
25 -c, --change
26 Automatically load the first detected profile
27
28 -d, --default PROFILE
29 Make profile PROFILE the default profile. The default profile is
30 used if no suitable profile can be identified. Else, the current
31 configuration is kept.
32
33 -l, --load PROFILE
34 Load profile PROFILE
35
36 -s, --save PROFILE
37 Save the current setup to profile PROFILE
38
39 -r, --remove PROFILE
40 Remove profile PROFILE
41
42 --batch
43 Run autorandr for all users with active X11 sessions
44
45 --current
46 List only the current (active) configuration(s)
47
48 --config
49 Dump the variable values of your current xrandr setup
50
51 --cycle
52 Cycle through all detected profiles
53
54 --debug
55 Enable verbose output
56
57 --detected
58 List only the detected (i.e. available) configuration(s)
59
60 --dry-run
61 Don't change anything, only print the xrandr commands
62
63 --fingerprint
64 Fingerprint the current hardware setup
65
66 --match-edid
67 Match displays based on edid instead of name
68
69 --ignore-lid
70 By default, closed lids are considered as disconnected if other
71 outputs are detected. This flag disables this behaviour.
72
73 --force
74 Force loading or reloading of a profile
75
76 --list List all profiles
77
78 --skip-options [OPTION] ...
79 Set a comma-separated list of xrandr arguments to skip both in
80 change detection and profile application. See xrandr(1) for
81 xrandr arguments.
82
83 --version
84 Show version information and exit
85
87 Configuration files are searched for in the autorandr directory in the
88 colon separated list of paths in $XDG_CONFIG_DIRS - or in /etc/xdg if
89 that var is not set. They are then looked for in ~/.autorandr and if
90 that doesn't exist, in $XDG_CONFIG_HOME/autorandr or in ~/.config/au‐
91 torandr if that var is unset.
92
93 In each of those directories it looks for directories with config and
94 setup in them. It is best to manage these files with the autorandr
95 utility.
96
97
99 You can store default values for any option in an INI-file located at
100 ~/.config/autorandr/settings.ini. In a config section, you may place
101 any default values in the form option-name=option-argument.
102
103
105 Three more scripts can be placed in the configuration directory:
106
107 postswitch
108 Executed after a mode switch has taken place. This can be used
109 to notify window managers or other applications about the
110 switch.
111
112 preswitch
113 Executed before a mode switch takes place.
114
115 postsave
116 Executed after a profile was stored or altered.
117
118 predetect
119 Executed before autorandr attempts to run xrandr.
120
121
122 These scripts must be executable and can be placed directly in the con‐
123 figuration directory, where they will always be executed, or in the
124 profile subdirectories, where they will only be executed on changes re‐
125 garding that specific profile.
126
127 Instead (or in addition) to these scripts, you can also place as many
128 executable files as you like in subdirectories called script_name.d
129 (e.g. postswitch.d).
130
131 Some of autorandr's state is exposed as environment variables prefixed
132 with AUTORANDR_, such as: AUTORANDR_CURRENT_PROFILE, AUTORANDR_CUR‐
133 RENT_PROFILES, AUTORANDR_PROFILE_FOLDER, and AUTORANDR_MONITORS with
134 the intention that they can be used within the hook scripts.
135
136 The one kink is that during preswitch, AUTORANDR_CURRENT_PROFILE is re‐
137 porting the upcoming profile rather than the current one.
138
139
141 Phillip Berndt <phillip.berndt@googlemail.com>
142 See https://github.com/phillipberndt/autorandr for a full list of con‐
143 tributors.
144
146 Report issues upstream on GitHub: https://github.com/phillipberndt/au‐
147 torandr/issues
148 Please attach the output of xrandr --verbose to your bug report if ap‐
149 propriate.
150
152 For examples, advanced usage (including predefined per-profile & global
153 hooks and wildcard EDID matching), and full documentation, see
154 https://github.com/phillipberndt/autorandr.
155
156
157
158 AUTORANDR(1)