]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/commitdiff
clean up the autorandr manpage some more
authorDon Armstrong <don@donarmstrong.com>
Tue, 31 Oct 2017 17:57:53 +0000 (10:57 -0700)
committerDon Armstrong <don@donarmstrong.com>
Tue, 31 Oct 2017 17:57:53 +0000 (10:57 -0700)
debian/autorandr.1

index 08b1369af56f59353e17fc1a7f1193ec3f4442ef..74e03a37dc74bddc3a0ea1067c9a764711f60d84 100644 (file)
@@ -1,42 +1,93 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
-.TH AUTORANDR.PY "1" "October 2017" "autorandr.py 1.2" "Automatically change screen layout"
+.TH AUTORANDR "1" "October 2017" "autorandr 1.2" "Automatically change screen layout"
 .SH NAME
 .SH NAME
-autorandr.py \- autorandr
+autorandr \- Automatically change screen layout
 .SH SYNOPSIS
 .B autorandr
 [\fI\,options\/\fR]
 .SH SYNOPSIS
 .B autorandr
 [\fI\,options\/\fR]
-.SH DESCRIPTION
-\fB\-h\fR, \fB\-\-help\fR              get this small help
-\fB\-c\fR, \fB\-\-change\fR            reload current setup
-\fB\-s\fR, \fB\-\-save\fR <profile>    save your current setup to profile <profile>
-\fB\-r\fR, \fB\-\-remove\fR <profile>  remove profile <profile>
-\fB\-l\fR, \fB\-\-load\fR <profile>    load profile <profile>
-\fB\-d\fR, \fB\-\-default\fR <profile> make profile <profile> the default profile
-\fB\-\-skip\-options\fR <option> comma separated list of xrandr arguments (e.g. "gamma")
-.IP
+.SH OPTIONS
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+get this small help
+.RE
+.PP
+\fB\-c\fR, \fB\-\-change\fR
+.RS 4
+reload current setup
+.RE
+.PP
+\fB\-s\fR, \fB\-\-save\fR <profile>
+.RS 4
+save your current setup to profile <profile>
+.RE
+.PP
+\fB\-r\fR, \fB\-\-remove\fR <profile>
+.RS 4
+remove profile <profile>
+.RE
+.PP
+\fB\-l\fR, \fB\-\-load\fR <profile>
+.RS 4
+load profile <profile>
+.RE
+.PP
+\fB\-d\fR, \fB\-\-default\fR <profile>
+.RS 4
+make profile <profile> the default profile
+.RE
+.PP
+\fB\-\-skip\-options\fR <option>
+.RS 4
+comma separated list of xrandr arguments (e.g. "gamma")
 to skip both in detecting changes and applying a profile
 to skip both in detecting changes and applying a profile
+.RE
+.PP
+\fB\-\-force\fR
+.RS 4
+force (re)loading of a profile
+.RE
 .PP
 .PP
-\fB\-\-force\fR                 force (re)loading of a profile
-\fB\-\-fingerprint\fR           fingerprint your current hardware setup
-\fB\-\-config\fR                dump your current xrandr setup
-\fB\-\-dry\-run\fR               don't change anything, only print the xrandr commands
-\fB\-\-debug\fR                 enable verbose output
-\fB\-\-batch\fR                 run autorandr for all users with active X11 sessions
-.IP
+\fB\-\-fingerprint\fR
+.RS 4
+fingerprint your current hardware setup
+.RE
+.PP
+\fB\-\-config\fR
+.RS 4
+dump your current xrandr setup
+.RE
+.PP
+\fB\-\-dry\-run\fR
+.RS 4
+don't change anything, only print the xrandr commands
+.RE
+.PP
+\fB\-\-debug\fR
+.RS 4
+enable verbose output
+.RE
+.PP
+\fB\-\-batch\fR
+.RS 4
+run autorandr for all users with active X11 sessions
+.RE
+.PP
+.SH "CONFIGURATION"
 To prevent a profile from being loaded, place a script called "block" in its
 directory. The script is evaluated before the screen setup is inspected, and
 in case of it returning a value of 0 the profile is skipped. This can be used
 to query the status of a docking station you are about to leave.
 To prevent a profile from being loaded, place a script called "block" in its
 directory. The script is evaluated before the screen setup is inspected, and
 in case of it returning a value of 0 the profile is skipped. This can be used
 to query the status of a docking station you are about to leave.
-.IP
+.PP
 If no suitable profile can be identified, the current configuration is kept.
 To change this behaviour and switch to a fallback configuration, specify
 \fB\-\-default\fR <profile>.
 If no suitable profile can be identified, the current configuration is kept.
 To change this behaviour and switch to a fallback configuration, specify
 \fB\-\-default\fR <profile>.
-.IP
+.PP
 Another script called "postswitch" can be placed in the directory
 ~/.config/autorandr (or ~/.autorandr if you have an old installation) as well
 as in any profile directories: The scripts are executed after a mode switch
 has taken place and can notify window managers.
 Another script called "postswitch" can be placed in the directory
 ~/.config/autorandr (or ~/.autorandr if you have an old installation) as well
 as in any profile directories: The scripts are executed after a mode switch
 has taken place and can notify window managers.
-.IP
+.SH "VIRTUAL CONFIGURATIONS"
 The following virtual configurations are available:
 .TP
 common
 The following virtual configurations are available:
 .TP
 common
@@ -50,15 +101,20 @@ Stack all connected outputs horizontally at their largest resolution
 .TP
 vertical
 Stack all connected outputs vertically at their largest resolution
 .TP
 vertical
 Stack all connected outputs vertically at their largest resolution
+.SH "EXAMPLES"
+# save the current setup and make it the default
+.RE
+autorandr \-\-save mysetup
+.RE
+autorandr \-\-default mysetup
+.RE
+# put laptop in dock (or plug in additional monitors)
+.RE
+# run appropriate xrandr commands to fix things up
+.RE
+autorandr \-\-save docked_setup
+.RE
+# now remove the laptop from the dock, and settings return to mysetup
 .SH "SEE ALSO"
 .SH "SEE ALSO"
-The full documentation for
-.B autorandr.py
-is maintained as a Texinfo manual.  If the
-.B info
-and
-.B autorandr.py
-programs are properly installed at your site, the command
-.IP
-.B info autorandr.py
-.PP
-should give you access to the complete manual.
+.sp
+\fBxrandr\fR