components/x11/dispswitch/src/dispswitch.man

   1 '\" t
   2 .\"
   3 .\" Copyright 2001 Keith Packard
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and its
   6 .\" documentation for any purpose is hereby granted without fee, provided that
   7 .\" the above copyright notice appear in all copies and that both that
   8 .\" copyright notice and this permission notice appear in supporting
   9 .\" documentation, and that the name of Keith Packard not be used in
  10 .\" advertising or publicity pertaining to distribution of the software without
  11 .\" specific, written prior permission.  Keith Packard makes no
  12 .\" representations about the suitability of this software for any purpose.  It
  13 .\" is provided "as is" without express or implied warranty.
  14 .\"
  15 .\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  16 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  17 .\" EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  18 .\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  19 .\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  20 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  21 .\" PERFORMANCE OF THIS SOFTWARE.
  22 .\"
  23 .\" Copyright (c) 2008, 2015, Oracle and/or its affiliates. All rights reserved.
  24 .\"
  25 .\" Permission is hereby granted, free of charge, to any person obtaining a
  26 .\" copy of this software and associated documentation files (the "Software"),
  27 .\" to deal in the Software without restriction, including without limitation
  28 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
  29 .\" and/or sell copies of the Software, and to permit persons to whom the
  30 .\" Software is furnished to do so, subject to the following conditions:
  31 .\"
  32 .\" The above copyright notice and this permission notice (including the next
  33 .\" paragraph) shall be included in all copies or substantial portions of the
  34 .\" Software.
  35 .\"
  36 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  37 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  38 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  39 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  40 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  41 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  42 .\" DEALINGS IN THE SOFTWARE.
  43 .\"
  44 .\"
  45 .TH DISPSWITCH 1
  46 .SH NAME
  47 dispswitch \- Display Device Switch
  48 .SH SYNOPSIS
  49 .B "/usr/bin/dispswitch"
  50 [\-display \fIdisplay\fP]
  51 [\-key \fIkeysym\fP]
  52 [\-mod \fImodifier\fP]
  53 [\-help]
  54 [\-verbose]
  55 [\-nosideview]
  56 [\-testrun]
  57 .SH DESCRIPTION
  58 .I Dispswitch
  59 uses hotkey to switch/rotate on/off of display devices up to 3 devices. Side-by-side views are included when two devices are connected. It works on systems where both server and driver support RandR version 1.2 (or above).
  60 User can define a hotkey with -key and -mod options (see below), the default is "Shift + F5".
  61
  62 If a key stroke is hit 5 seconds or longer after the previous switch, display devices are re-probed so that any changes such as adding or removing devices, can be detected and adapted to.
  63
  64 If a new display device is added whose mode size is larger than the one with which X server is started, or a side-by-side view is switched into that needs a larger mode to cover both screens, a config file specifying larger virtual screen size (Virtual field in Screen Section) will be needed during X server startup. Otherwise the larger mode will not be realized, or the side-by-side view will be skipped.
  65
  66 .IP \-help
  67 Print out a summary of the usage and exit.
  68 .IP "\-verbose or -v"
  69 Print out debug messages when run.
  70 .IP \-nosideview
  71 Skip side-by-side views in two devices rotating.
  72 .IP \-testrun
  73 Switch/rotate display device states repeatedly without hotkey strokes.
  74 .IP "\-key <keysym> or -k <keysym>"
  75 Define the keysym of hotkey to be <keysym>, which can be any entry defined in
  76 defined in /usr/include/X11/keysymdef.h, with prefix XK_ removed, such as F5, F8, Escape.
  77 .IP "\-mod <modifier> or -m <modifier>"
  78 Define the modifier of hotkey to be <modifier>. <modifier> is any or combination of modifiers on your system. Run
  79 .BR xmodmap (1)
  80 to find all available modifiers on your system. They can be none, shift, control, mod1, mod3, mod4, mod5, any.
  81 .SH
  82 Examples:
  83
  84 dispswitch -key Escape -mod shift               defines hotkey to be 'shift + Esc'
  85 .sp
  86 dispswitch -key F2 -mod "shift+control"         defines hotkey to be 'shift + control + F2'
  87
  88
  89 .\" Begin Sun update
  90 .SH "ATTRIBUTES"
  91 See \fBattributes\fR(7) for descriptions of the following attributes:
  92 .sp
  93 .TS
  94 allbox;
  95 cw(2.750000i)| cw(2.750000i)
  96 lw(2.750000i)| lw(2.750000i).
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 Availability    pkg:/x11/x11-server-utilities
  99 Interface Stability     Volatile
 100 .TE
 101 .sp
 102 .\" End Sun update