3 # Automatically select a display configuration based on connected devices
5 # Stefan Tomanek <stefan.tomanek@wertarbyte.de>
9 # Save your current display configuration and setup with:
10 # $ autorandr --save mobile
12 # Connect an additional display, configure your setup and save it:
13 # $ autorandr --save docked
15 # Now autorandr can detect which hardware setup is active:
20 # To automatically reload your setup, just append --change to the command line
22 # To manually load a profile, you can use the --load <profile> option.
24 # autorandr tries to avoid reloading an identical configuration. To force the
25 # (re)configuration, apply --force.
27 # To prevent a profile from being loaded, place a script call "block" in its
28 # directory. The script is evaluated before the screen setup is inspected, and
29 # in case of it returning a value of 0 the profile is skipped. This can be used
30 # to query the status of a docking station you are about to leave.
32 # If no suitable profile can be identified, the current configuration is kept.
33 # To change this behaviour and switch to a fallback configuration, specify
36 # Another script called "postswitch "can be placed in the directory
37 # ~/.autorandr as well as in all profile directories: The scripts are executed
38 # after a mode switch has taken place and can notify window managers or other
39 # applications about it.
42 # While the script uses xrandr by default, calling it by the name "autodisper"
43 # or "auto-disper" forces it to use the "disper" utility, which is useful for
44 # controlling nvidia chipsets. The formats for fingerprinting the current setup
45 # and saving/loading the current configuration are adjusted accordingly.
47 XRANDR=/usr/bin/xrandr
48 DISPER=/usr/bin/disper
49 XDPYINFO=/usr/bin/xdpyinfo
50 PROFILES=~/.autorandr/
51 CONFIG=~/.autorandr.conf
58 FP_METHODS="setup_fp_sysfs_edid setup_fp_xrandr_edid"
59 CURRENT_CFG_METHOD="current_cfg_xrandr"
60 LOAD_METHOD="load_cfg_xrandr"
62 SCRIPTNAME="$(basename $0)"
63 # when called as autodisper/auto-disper, we assume different defaults
64 if [ "$SCRIPTNAME" = "auto-disper" ] || [ "$SCRIPTNAME" = "autodisper" ]; then
65 echo "Assuming disper defaults..." >&2
66 FP_METHODS="setup_fp_disper"
67 CURRENT_CFG_METHOD="current_cfg_disper"
68 LOAD_METHOD="load_cfg_disper"
71 if [ -f $CONFIG ]; then
72 echo "Loading configuration from '$CONFIG'" >&2
76 setup_fp_xrandr_edid() {
77 $XRANDR -q --verbose | awk '
78 /^[^ ]+ (dis)?connected / { DEV=$1; }
79 $1 ~ /^[a-f0-9]+$/ { ID[DEV] = ID[DEV] $1 }
80 END { for (X in ID) { print X " " ID[X]; } }'
83 setup_fp_sysfs_edid() {
84 # xrandr triggers the reloading of EDID data
85 $XRANDR -q > /dev/null
86 # hash the EDIDs of all _connected_ devices
87 for P in /sys/class/drm/card*-*/; do
89 [ ! -d "$P" ] && continue
90 if grep -q "^connected$" < "${P}status"; then
91 echo -n "$(basename "$P") "
92 md5sum ${P}edid | awk '{print $1}'
98 $DISPER -l | grep '^display '
103 for M in $FP_METHODS; do
105 if [ -n "$FP" ]; then
109 if [ -z "$FP" ]; then
110 echo "Unable to fingerprint display configuration" >&2
116 current_cfg_xrandr() {
117 local PRIMARY_SETUP="";
118 if [ -x "$XDPYINFO" ]; then
119 PRIMARY_SETUP="$($XDPYINFO -ext XINERAMA | awk '/^ head #0:/ {printf $3 $5}')"
121 $XRANDR -q | awk -v primary_setup="${PRIMARY_SETUP}" '
122 # display is connected and has a mode
123 /^[^ ]+ connected [^(]/ {
125 if ($3 == "primary") {
132 if (A[1] A[2] "," A[3] == primary_setup)
136 print "pos "A[2]"x"A[3];
142 # disconnected or disabled displays
143 /^[^ ]+ (dis)?connected / ||
144 /^[^ ]+ unknown connection / {
151 current_cfg_disper() {
161 [ ! -x "$PROFILES/$PROFILE/block" ] && return 1
163 "$PROFILES/$PROFILE/block" "$PROFILE"
168 if [ "$(cat "$PROFILES/$PROFILE/config")" = "$(current_cfg)" ]; then
169 echo "Config already loaded"
177 # sed 1: Prefix arguments with "--"
178 # sed 2: Merge arguments into one line per output
179 # sed 3: Merge into two lines, all --off outputs in the first one
180 sed 's/^/--/' "$1" | sed -e '
188 # Merge if next line contains --off
189 s/\n\([^\n]* --off\)/ \1/
195 # Merge if previous line contains --mode
196 s/\(--mode [^\n]*\)\n/\1 /
198 $!d' | xargs -L 1 $XRANDR
207 local CONF="$PROFILES/$PROFILE/config"
208 if [ -e "$CONF" ] ; then
209 echo " -> loading profile $PROFILE"
212 [ -x "$PROFILES/$PROFILE/postswitch" ] && \
213 "$PROFILES/$PROFILE/postswitch" "$PROFILE"
214 [ -x "$PROFILES/postswitch" ] && \
215 "$PROFILES/postswitch" "$PROFILE"
221 Usage: $SCRIPTNAME [options]
223 -h, --help get this small help
224 -c, --change reload current setup
225 -s, --save <profile> save your current setup to profile <profile>
226 -l, --load <profile> load profile <profile>
227 -d, --default <profile> make profile <profile> the default profile
228 --force force (re)loading of a profile
229 --fingerprint fingerprint your current hardware setup
230 --config dump your current xrandr setup
232 To prevent a profile from being loaded, place a script call "block" in its
233 directory. The script is evaluated before the screen setup is inspected, and
234 in case of it returning a value of 0 the profile is skipped. This can be used
235 to query the status of a docking station you are about to leave.
237 If no suitable profile can be identified, the current configuration is kept.
238 To change this behaviour and switch to a fallback configuration, specify
241 Another script called "postswitch "can be placed in the directory
242 ~/.autorandr as well as in any profile directories: The scripts are executed
243 after a mode switch has taken place and can notify window managers.
245 When called by the name "autodisper" or "auto-disper", the script uses "disper"
246 instead of "xrandr" to detect, configure and save the display configuration.
252 OPTS=$(getopt -n autorandr -o s:l:d:cfh --long change,default:,save:,load:,force,fingerprint,config,help -- "$@")
253 if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
258 -c|--change) CHANGE_PROFILE=1; shift ;;
259 -d|--default) DEFAULT_PROFILE="$2"; shift 2 ;;
260 -s|--save) SAVE_PROFILE="$2"; shift 2 ;;
261 -l|--load) LOAD_PROFILE="$2"; shift 2 ;;
263 --force) FORCE_LOAD=1; shift ;;
264 --fingerprint) setup_fp; exit 0;;
265 --config) current_cfg; exit 0;;
267 *) echo "Error: $1"; exit 1;;
271 CURRENT_SETUP="$(setup_fp)"
273 if [ -n "$SAVE_PROFILE" ]; then
274 echo "Saving current configuration as profile '${SAVE_PROFILE}'"
275 mkdir -p "$PROFILES/$SAVE_PROFILE"
276 echo "$CURRENT_SETUP" > "$PROFILES/$SAVE_PROFILE/setup"
277 $CURRENT_CFG_METHOD > "$PROFILES/$SAVE_PROFILE/config"
281 if [ -n "$LOAD_PROFILE" ]; then
282 CHANGE_PROFILE=1 FORCE_LOAD=1 load "$LOAD_PROFILE"
286 for SETUP_FILE in $PROFILES/*/setup; do
287 if ! [ -e $SETUP_FILE ]; then
290 PROFILE="$(basename $(dirname "$SETUP_FILE"))"
293 if blocked "$PROFILE"; then
298 FILE_SETUP="$(cat "$PROFILES/$PROFILE/setup")"
299 if [ "$CURRENT_SETUP" = "$FILE_SETUP" ]; then
301 if [ "$CHANGE_PROFILE" -eq 1 ]; then
302 if [ "$FORCE_LOAD" -eq 1 ] || ! config_equal "$PROFILE"; then
306 # found the profile, exit with success
313 # we did not find the profile, load default
314 if [ -n "$DEFAULT_PROFILE" ]; then
315 echo "No suitable profile detected, falling back to $DEFAULT_PROFILE"
316 load "$DEFAULT_PROFILE"