]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/blob - debian/autorandr.1
document how to set --default; remove --default from service
[deb_pkgs/autorandr.git] / debian / autorandr.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
2 .TH AUTORANDR "1" "October 2017" "autorandr 1.2" "Automatically change screen layout"
3 .SH NAME
4 autorandr \- Automatically change screen layout
5 .SH SYNOPSIS
6 .B autorandr
7 [\fI\,options\/\fR]
8 .SH OPTIONS
9 .PP
10 \fB\-h\fR, \fB\-\-help\fR
11 .RS 4
12 get this small help
13 .RE
14 .PP
15 \fB\-c\fR, \fB\-\-change\fR
16 .RS 4
17 reload current setup
18 .RE
19 .PP
20 \fB\-s\fR, \fB\-\-save\fR <profile>
21 .RS 4
22 save your current setup to profile <profile>
23 .RE
24 .PP
25 \fB\-r\fR, \fB\-\-remove\fR <profile>
26 .RS 4
27 remove profile <profile>
28 .RE
29 .PP
30 \fB\-l\fR, \fB\-\-load\fR <profile>
31 .RS 4
32 load profile <profile>
33 .RE
34 .PP
35 \fB\-d\fR, \fB\-\-default\fR <profile>
36 .RS 4
37 use profile <profile> if no other profile matches. [Most useful if set
38 in ~/.config/autorandr/settings.ini].
39 .RE
40 .PP
41 \fB\-\-skip\-options\fR <option>
42 .RS 4
43 comma separated list of xrandr arguments (e.g. "gamma")
44 to skip both in detecting changes and applying a profile
45 .RE
46 .PP
47 \fB\-\-force\fR
48 .RS 4
49 force (re)loading of a profile
50 .RE
51 .PP
52 \fB\-\-fingerprint\fR
53 .RS 4
54 fingerprint your current hardware setup
55 .RE
56 .PP
57 \fB\-\-config\fR
58 .RS 4
59 dump your current xrandr setup
60 .RE
61 .PP
62 \fB\-\-dry\-run\fR
63 .RS 4
64 don't change anything, only print the xrandr commands
65 .RE
66 .PP
67 \fB\-\-debug\fR
68 .RS 4
69 enable verbose output
70 .RE
71 .PP
72 \fB\-\-batch\fR
73 .RS 4
74 run autorandr for all users with active X11 sessions
75 .RE
76 .PP
77 .SH "CONFIGURATION"
78 To prevent a profile from being loaded, place a script called "block" in its
79 directory. The script is evaluated before the screen setup is inspected, and
80 in case of it returning a value of 0 the profile is skipped. This can be used
81 to query the status of a docking station you are about to leave.
82 .PP
83 If no suitable profile can be identified, the current configuration is kept.
84 To change this behaviour and switch to a fallback configuration, specify
85 \fB\-\-default\fR <profile>.
86 .PP
87 Another script called "postswitch" can be placed in the directory
88 ~/.config/autorandr (or ~/.autorandr if you have an old installation) as well
89 as in any profile directories: The scripts are executed after a mode switch
90 has taken place and can notify window managers.
91 .SH "VIRTUAL CONFIGURATIONS"
92 The following virtual configurations are available:
93 .TP
94 common
95 Clone all connected outputs at the largest common resolution
96 .TP
97 clone\-largest
98 Clone all connected outputs with the largest resolution (scaled down if necessary)
99 .TP
100 horizontal
101 Stack all connected outputs horizontally at their largest resolution
102 .TP
103 vertical
104 Stack all connected outputs vertically at their largest resolution
105 .SH "EXAMPLES"
106 # save the current setup and set default
107 .RE
108 autorandr \-\-save mysetup
109 .RE
110 echo -e '[config]\\ndefault=mysetup' > ~/.config/autorandr/settings.ini
111 .RE
112 # put laptop in dock (or plug in additional monitors)
113 .RE
114 # run appropriate xrandr commands to fix things up
115 .RE
116 autorandr \-\-save docked_setup
117 .RE
118 # now remove the laptop from the dock, and settings return to mysetup
119 .SH "AUTHORS"
120 Autorandr is written and maintained by Phillip Berndt, with
121 contributions by many others. See
122 https://github.com/phillipberndt/autorandr for more information.
123 .SH "SEE ALSO"
124 .sp
125 \fBxrandr(1)\fR