Use mode ID instead of mode for autoconfig
[x-on-resize.git] / x-on-resize.man
blob18a06d4ee6590352a5fb0df94f7d3a82d152846c
1 .\"
2 .\" Copyright 2013 Keith Packard
3 .\"
4 .\" Permission to use, copy, modify, distribute, and sell this software and its
5 .\" documentation for any purpose is hereby granted without fee, provided that
6 .\" the above copyright notice appear in all copies and that both that
7 .\" copyright notice and this permission notice appear in supporting
8 .\" documentation, and that the name of Keith Packard not be used in
9 .\" advertising or publicity pertaining to distribution of the software without
10 .\" specific, written prior permission.  Keith Packard makes no
11 .\" representations about the suitability of this software for any purpose.  It
12 .\" is provided "as is" without express or implied warranty.
13 .\"
14 .\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 .\" EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 .\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 .\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
20 .\" PERFORMANCE OF THIS SOFTWARE.
21 .\"
22 .TH X-ON-RESIZE __appmansuffix__ __vendorversion__
23 .SH NAME
24 x-on-resize \- monitor for hotplug or screen reconfigure events
25 .SH SYNOPSIS
26 .B "x-on-resize"
27 [\-\-help]
28 [\-\-display \fIdisplay\fP]
29 [\-\-config \fIconfig-script\fP]
30 [\-\-resize \fIresize-script\fP]
31 [\-\-start]
32 .SH DESCRIPTION
33 .I X-on-resize
34 is used to monitor the X display for output configuration changes
35 and/or screen resize events. When these occur, it can call external
36 programs to respond to the new display environment.
38 .SH OPTIONS
39 .IP "\-h, \-\-help"
40 Print out a summary of the usage and exit.
41 .IP "\-d, \-\-display \fIname\fP"
42 This option selects the X display to use. Note this refers to the X
43 screen abstraction, not the monitor (or output).
44 .IP "\-c, \-\-config \fIconfig-script\fP"
45 This option selects the external script to run when the set of
46 available outputs has changed. If not provided, x-on-resize prints
47 "config" on stdout.
48 .IP "\-r, \-\-resize \fIresize-script\fP"
49 This option selects the external script to run when the size
50 of the root window has changed. If not provided, x-on-resize prints
51 "resize" on stdout.
52 .IP "\-a, \-\-auto"
53 This is the same as \-\-config "xrandr --auto", which sets
54 the system to a reasonable configuration each time the connected set
55 of outputs changes.
56 .IP "\-s, \-\-start"
57 This directs x-on-resize to run any defined scripts at startup time in
58 addition to when the specified conditions occur.
59 .SH "SEE ALSO"
60 Xrandr(__libmansuffix__), xrandr(__appmansuffix__)
61 .SH AUTHORS
62 Keith Packard,
63 Open Source Technology Center, Intel Corporation.