autorandr.1

   1 .TH AUTORANDR 1
   2 .SH NAME
   3 autorandr \- automatically select a display configuration based on connected devices
   4 .SH SYNOPSIS
   5 .B autorandr
   6 [\fIOPTION\fR] [\fIPROFILE\fR]
   7 .SH DESCRIPTION
   8 .PP
   9 This program automatically detects connected display hardware and then loads an appropriate X11 setup using xrandr. It also supports the use of display profiles for different hardware setups.
  10 .PP
  11 Autorandr also includes several virtual configurations including \fBoff\fR, \fBcommon\fR, \fBclone-largest\fR, \fBhorizontal\fR, and \fBvertical\fR. See the documentation for explanation of each.
  12 .SH OPTIONS
  13 .TP
  14 \fB\-h\fR, \fB\-\-help
  15 \fRDisplay help text and exit
  16 .TP
  17 \fB\-c\fR, \fB\-\-change
  18 \fRAutomatically load the first detected profile
  19 .TP
  20 \fB\-d\fR, \fB\-\-default \fIPROFILE
  21 \fRMake profile \fIPROFILE\fR the default profile. The default profile is used if no suitable profile can be identified. Else, the current configuration is kept.
  22 .TP
  23 \fB\-l\fR, \fB\-\-load \fIPROFILE
  24 \fRLoad profile \fIPROFILE
  25 .TP
  26 \fB\-s\fR, \fB\-\-save \fIPROFILE
  27 \fRSave the current setup to profile \fIPROFILE
  28 .TP
  29 \fB\-r\fR, \fB\-\-remove \fIPROFILE
  30 \fRRemove profile \fIPROFILE
  31 .TP
  32 .BR \-\-batch
  33 \fRRun autorandr for all users with active X11 sessions
  34 .TP
  35 .BR \-\-current
  36 List only the current (active) configuration(s)
  37 .TP
  38 .BR \-\-config
  39 Dump the variable values of your current xrandr setup
  40 .TP
  41 .BR \-\-cycle
  42 Cycle through all detected profiles
  43 .TP
  44 .BR \-\-debug
  45 Enable verbose output
  46 .TP
  47 .BR \-\-detected
  48 List only the detected (i.e. available) configuration(s)
  49 .TP
  50 .BR \-\-dry\-run
  51 Don't change anything, only print the xrandr commands
  52 .TP
  53 .BR \-\-fingerprint
  54 Fingerprint the current hardware setup
  55 .TP
  56 .BR \-\-match-edid
  57 Match displays based on edid instead of name
  58 .TP
  59 .BR \-\-force
  60 Force loading or reloading of a profile
  61 .TP
  62 .BR \-\-list
  63 List all profiles
  64 .TP
  65 \fB\-\-skip\-options [\fIOPTION\fR] ...
  66 \fRSet a comma\-separated list of xrandr arguments to skip both in change detection and profile application. See \fBxrandr(1)\fR for xrandr arguments.
  67 .TP
  68 .BR \-\-version
  69 Show version information and exit
  70 .SH FILES
  71 Configuration files are searched for in the \fIautorandr
  72 \fRdirectory in the colon separated list of paths in \fI$XDG_CONFIG_DIRS
  73 \fR- or in \fI/etc/xdg
  74 \fRif that var is not set.  They are then looked for in \fI~/.autorandr
  75 \fRand if that doesn't exist, in \fI$XDG_CONFIG_HOME/autorandr
  76 \fRor in \fI~/.config/autorandr\fR if that var is unset.
  77
  78 In each of those directories it looks for directories with \fIconfig\fR and
  79 \fIsetup\fR in them.  It is best to manage these files with the
  80 \fBautorandr\fR utility.
  81
  82 .SH DEFAULT OPTIONS
  83
  84 You can store default values for any option in an INI-file located at
  85 \fI~/.config/autorandr/settings.ini\fR. In a config section, you may
  86 place any default values in the form \fIoption-name=option-argument\fR.
  87
  88 .SH HOOK SCRIPTS
  89
  90 Three more scripts can be placed in the configuration directory:
  91 .TP
  92 \fIpostswitch\fR
  93 Executed after a mode switch has taken place. This can be used to notify
  94 window managers or other applications about the switch.
  95 .TP
  96 \fIpreswitch\fR
  97 Executed before a mode switch takes place.
  98 .TP
  99 \fIpostsave\fR
 100 Executed after a profile was stored or altered.
 101 .TP
 102 \fIpredetect\fR
 103 Executed before autorandr attempts to run xrandr.
 104
 105 .PP
 106 These scripts must be executable and can be placed directly in the
 107 configuration directory, where they will always be executed, or in
 108 the profile subdirectories, where they will only be executed on changes
 109 regarding that specific profile.
 110
 111 Instead (or in addition) to these scripts, you can also place as many
 112 executable files as you like in subdirectories called script_name.d
 113 (e.g. postswitch.d).
 114 .PP
 115
 116 Some of autorandr's state is exposed as environment variables prefixed with
 117 \fIAUTORANDR_\fR, such as:
 118 \fIAUTORANDR_CURRENT_PROFILE\fR,
 119 \fIAUTORANDR_CURRENT_PROFILES\fR,
 120 \fIAUTORANDR_PROFILE_FOLDER\fR,
 121 and \fIAUTORANDR_MONITORS\fR
 122 with the intention that they can be used within the hook scripts.
 123
 124 The one kink is that during \fIpreswitch\fR, \fIAUTORANDR_CURRENT_PROFILE\fR
 125 is reporting the upcoming profile rather
 126 than the current one.
 127
 128 .SH AUTHOR
 129 \fRPhillip Berndt <phillip.berndt@googlemail.com>
 130 .br
 131 See https://github.com/phillipberndt/autorandr for a full list of contributors.
 132 .SH REPORTING BUGS
 133 \fRReport issues upstream on GitHub:  https://github.com/phillipberndt/autorandr/issues
 134 .br
 135 \fRPlease attach the output of \fBxrandr --verbose\fR to your bug report if appropriate.
 136 .SH SEE ALSO
 137 \fRFor examples, advanced usage (including predefined per-profile & global hooks and wildcard EDID matching), and full documentation, see https://github.com/phillipberndt/autorandr.