RepoMirrors
/
autorandr
mirror of https://github.com/phillipberndt/autorandr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
autorandr/autorandr.1

91 lines
3.1 KiB
Groff
Raw Normal View History

Initial start to man page
2019-01-17 04:10:12 +00:00
.TH AUTORANDR 1
.SH NAME
Wrote initial man page
2019-01-17 08:55:17 +00:00
autorandr \- automatically select a display configuration based on connected devices
.SH SYNOPSIS
.B autorandr
[\fIOPTION\fR] [\fIPROFILE\fR]
.SH DESCRIPTION
.PP
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.
.PP
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.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help
\fRDisplay help text and exit
.TP
\fB\-c\fR, \fB\-\-change
\fRAutomatically load the first detected profile
.TP
\fB\-d\fR, \fB\-\-default \fIPROFILE
\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.
.TP
\fB\-l\fR, \fB\-\-load \fIPROFILE
\fRLoad profile \fIPROFILE
.TP
\fB\-s\fR, \fB\-\-save \fIPROFILE
\fRSave the current setup to profile \fIPROFILE
.TP
\fB\-r\fR, \fB\-\-remove \fIPROFILE
\fRRemove profile \fIPROFILE
.TP
.BR \-\-batch
\fRRun autorandr for all users with active X11 sessions
.TP
.BR \-\-current
List only the current (active) configuration(s)
.TP
.BR \-\-config
Dump the variable values of your current xrandr setup
.TP
Update manpage with new options
2021-12-16 09:31:56 +00:00
.BR \-\-cycle
Cycle through all detected profiles
.TP
Wrote initial man page
2019-01-17 08:55:17 +00:00
.BR \-\-debug
Enable verbose output
.TP
.BR \-\-detected
List only the detected (i.e. available) configuration(s)
.TP
.BR \-\-dry\-run
Don't change anything, only print the xrandr commands
.TP
.BR \-\-fingerprint
Fingerprint the current hardware setup
.TP
Add an option to match profiles based on edid In some cases the display names change so the profile matching fails. This commit introduces the "--match-edid" option, that allows one to specify that the profiles matching should be done based on display edid. This is done by updating the profiles after loading, based on current display name/edid mapping requested using xrandr.
2021-05-17 09:52:46 +00:00
.BR \-\-match-edid
Match displays based on edid instead of name
.TP
Wrote initial man page
2019-01-17 08:55:17 +00:00
.BR \-\-force
Force loading or reloading of a profile
.TP
Update manpage with new options
2021-12-16 09:31:56 +00:00
.BR \-\-list
List all profiles
.TP
Wrote initial man page
2019-01-17 08:55:17 +00:00
\fB\-\-skip\-options [\fIOPTION\fR] ...
\fRSet a comma\-separated list of xrandr arguments to skip both in change detection and profile application. See \fBxrandr(1)\fR for xrandr arguments.
.TP
.BR \-\-version
Show version information and exit
Explain where files are saved For people who manage their home directories with things like vcsh or other versioning system, it's good to know where configuration files live. This CL adds a FILES section to the man page.
2021-07-11 13:48:05 +00:00
.SH FILES
Configuration files are searched for in the \fIautorandr
\fRdirectory in the colon separated list of paths in \fI$XDG_CONFIG_DIRS
\fR- or in \fI/etc/xdg
\fRif that var is not set. They are then looked for in \fI~/.autorandr
\fRand if that doesn't exist, in \fI$XDG_CONFIG_HOME/autorandr
\fRor in \fI~/.config/autorandr\fR if that var is unset.
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.
Wrote initial man page
2019-01-17 08:55:17 +00:00
.SH AUTHOR
\fRPhillip Berndt <phillip.berndt@googlemail.com>
.br
See https://github.com/phillipberndt/autorandr for a full list of contributors.
.SH REPORTING BUGS
Typo
2019-08-23 11:35:26 +00:00
\fRReport issues upstream on GitHub: https://github.com/phillipberndt/autorandr/issues
Wrote initial man page
2019-01-17 08:55:17 +00:00
.br
\fRPlease attach the output of \fBxrandr --verbose\fR to your bug report if appropriate.
.SH SEE ALSO
\fRFor examples, advanced usage (including predefined per-profile & global hooks and wildcard EDID matching), and full documentation, see https://github.com/phillipberndt/autorandr.