]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/blob - autorandr.1
Merge --cycle option (needs work)
[deb_pkgs/autorandr.git] / 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 \-\-debug
42 Enable verbose output
43 .TP
44 .BR \-\-detected
45 List only the detected (i.e. available) configuration(s)
46 .TP
47 .BR \-\-dry\-run
48 Don't change anything, only print the xrandr commands
49 .TP
50 .BR \-\-fingerprint
51 Fingerprint the current hardware setup
52 .TP
53 .BR \-\-force
54 Force loading or reloading of a profile
55 .TP
56 \fB\-\-skip\-options [\fIOPTION\fR] ...
57 \fRSet a comma\-separated list of xrandr arguments to skip both in change detection and profile application. See \fBxrandr(1)\fR for xrandr arguments.
58 .TP
59 .BR \-\-version
60 Show version information and exit
61 .SH FILES
62 Configuration files are searched for in the \fIautorandr
63 \fRdirectory in the colon separated list of paths in \fI$XDG_CONFIG_DIRS
64 \fR- or in \fI/etc/xdg
65 \fRif that var is not set.  They are then looked for in \fI~/.autorandr
66 \fRand if that doesn't exist, in \fI$XDG_CONFIG_HOME/autorandr
67 \fRor in \fI~/.config/autorandr\fR if that var is unset.
68
69 In each of those directories it looks for directories with \fIconfig\fR and
70 \fIsetup\fR in them.  It is best to manage these files with the
71 \fBautorandr\fR utility.
72 .SH AUTHOR
73 \fRPhillip Berndt <phillip.berndt@googlemail.com>
74 .br
75 See https://github.com/phillipberndt/autorandr for a full list of contributors. 
76 .SH REPORTING BUGS
77 \fRReport issues upstream on GitHub:  https://github.com/phillipberndt/autorandr/issues
78 .br
79 \fRPlease attach the output of \fBxrandr --verbose\fR to your bug report if appropriate.
80 .SH SEE ALSO
81 \fRFor examples, advanced usage (including predefined per-profile & global hooks and wildcard EDID matching), and full documentation, see https://github.com/phillipberndt/autorandr.