]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/commitdiff
Merge pull request #278 from aviau/aviau/manpage-improvements
authorPhillip Berndt <phillip.berndt@googlemail.com>
Sun, 9 Jan 2022 18:25:08 +0000 (19:25 +0100)
committerGitHub <noreply@github.com>
Sun, 9 Jan 2022 18:25:08 +0000 (19:25 +0100)
manpage: default options and hook scripts

1  2 
autorandr.1

diff --combined autorandr.1
index 4e7d4d1bb81f5cc3db09c733ad25fc290c102a83,6418c5e1a0c44cdf943a19316fd4b87bd1e78aaf..776b3ef94d79d5b8092a0f78a762bcc4f5dc14d8
@@@ -56,9 -56,6 +56,9 @@@ Fingerprint the current hardware setu
  .BR \-\-match-edid
  Match displays based on edid instead of name
  .TP
 +.BR \-\-ignore-lid
 +By default, closed lids are considered as disconnected if other outputs are detected. This flag disables this behaviour.
 +.TP
  .BR \-\-force
  Force loading or reloading of a profile
  .TP
@@@ -81,6 -78,53 +81,53 @@@ Configuration files are searched for i
  In each of those directories it looks for directories with \fIconfig\fR and
  \fIsetup\fR in them.  It is best to manage these files with the
  \fBautorandr\fR utility.
+ .SH DEFAULT OPTIONS
+ You can store default values for any option in an INI-file located at
+ \fI~/.config/autorandr/settings.ini\fR. In a config section, you may
+ place any default values in the form \fIoption-name=option-argument\fR.
+ .SH HOOK SCRIPTS
+ Three more scripts can be placed in the configuration directory:
+ .TP
+ \fIpostswitch\fR
+ Executed after a mode switch has taken place. This can be used to notify
+ window managers or other applications about the switch.
+ .TP
+ \fIpreswitch\fR
+ Executed before a mode switch takes place.
+ .TP
+ \fIpostsave\fR
+ Executed after a profile was stored or altered.
+ .TP
+ \fIpredetect\fR
+ Executed before autorandr attempts to run xrandr.
+ .PP
+ These scripts must be executable and can be placed directly in the
+ configuration directory, where they will always be executed, or in
+ the profile subdirectories, where they will only be executed on changes
+ regarding that specific profile.
+ Instead (or in addition) to these scripts, you can also place as many
+ executable files as you like in subdirectories called script_name.d
+ (e.g. postswitch.d).
+ .PP
+ Some of autorandr's state is exposed as environment variables prefixed with
+ \fIAUTORANDR_\fR, such as:
+ \fIAUTORANDR_CURRENT_PROFILE\fR,
+ \fIAUTORANDR_CURRENT_PROFILES\fR,
+ \fIAUTORANDR_PROFILE_FOLDER\fR,
+ and \fIAUTORANDR_MONITORS\fR
+ with the intention that they can be used within the hook scripts.
+ The one kink is that during \fIpreswitch\fR, \fIAUTORANDR_CURRENT_PROFILE\fR
+ is reporting the upcoming profile rather
+ than the current one.
  .SH AUTHOR
  \fRPhillip Berndt <phillip.berndt@googlemail.com>
  .br