summaryrefslogtreecommitdiffstats
path: root/x2usb.man
diff options
context:
space:
mode:
Diffstat (limited to 'x2usb.man')
-rw-r--r--x2usb.man270
1 files changed, 270 insertions, 0 deletions
diff --git a/x2usb.man b/x2usb.man
new file mode 100644
index 0000000..1f31cd7
--- /dev/null
+++ b/x2usb.man
@@ -0,0 +1,270 @@
+.nh
+.TH x2x 1
+.SH NAME
+x2x \- X to X connection
+.SH SYNTAX
+\f x2x\fR <[-to <DISPLAY>] | [-fromwin | -from <DISPLAY>]> [options...]
+.SH DESCRIPTION
+x2x allows the keyboard and mouse on one ("from") X display to be used to
+control another ("to") X display. Since x2x uses the XTEST extension,
+the "to" X display must support XTEST.
+
+If x2x is built under Cygwin (on Windows XP or Windows 2000) then the
+-fromwin option may be specified to allow the "from" display to be the
+Windows desktop. (The Cygwin build also supports use of an X display
+for the "from" screen). Use of -fromwin sets the default behaviour as
+if the -big -west -capslockhack options had also been given.
+
+In the default interface, x2x puts a window on the "from" display.
+This window is labeled with the name of the "to" display. Keystrokes
+typed into this window go to the window on the "to" display that has
+the input focus. Clicking on the x2x window causes the mouse on the
+"from" display to control the cursor on the "to" display. Performing
+a subsequent multiple button click on the "to" display returns control
+to the "from" display.
+
+If the -fromwin or -east or -west options are specified on the command
+line, x2x starts up with a different interface. When the mouse moves
+to the (east or west) side of the default screen on the "from"
+display, the cursor slides over to the "to" display. When the mouse
+returns to to side of the "to" display that it entered, it slides back
+onto the "from" display.
+
+Unless the -nosel option is specified, x2x relays X selections from
+one display to the other. (If -fromwin is specified then the X
+selection is relayed to and from the Windows clipboard as text strings).
+
+Here are a few hints for eXcursion users (based on Intel version
+2.1.309). First, use the -big option. Second, in the control panel,
+under mouse, check the box that enables "Automatically Capture Text on
+Button Up." X selections will then automatically move into the
+Windows clipboard. As is the case with all X applications running on
+2.1.309 (including x2x), you will need to do an extra mouse click
+after performing the X selection for this operation to work. x2x is
+known to work poorly with eXcursion running on Windows 95, probably
+due to the Windows 95 task scheduler. x2x does work well with eXcursion
+running on Windows NT.
+
+The hints for eXcursion are also valid for Exceed, with the exception
+that X selections work better, as long as you are using x2x version
+1.25 or later.
+
+.SH OPTIONS
+Either the -to option or the -from option (or both) must be specified.
+.TP
+.B \-to \fIdisplay\fP
+.IP
+Indicates the ("to") display that is remotely controlled by the "from" display.
+Default is equivalent to the default display.
+.TP
+.B \-from \fIdisplay\fP
+.IP
+Indicates the ("from") display that remotely controls the "to" display.
+Default is equivalent to the default display.
+.TP
+.B \-fromwin
+.IP
+Available when x2x is built in the Cygwin environment. This option
+indicates the ("from") display should be the Windows desktop. In this
+case the "to" display must be specified with the \-to option. Setting
+this option forces \-big and sets the default to \-west \-capslockhack
+
+The -fromwin option works best when Windows is configured for
+focus-follows-mouse also known as X Mouse. This can be set using
+TweakUI for Windows XP (on the Mouse/X-Mouse panel) or the XMouse2000
+program for Windows 2000. If Windows is set for its default behaviour
+x2x will attempt to get the keyboard and mouse focus but may not
+succeed. (The Windows XP TweakUI has a General/Focus option that can be
+unchecked to allow applications to steal the focus.) If it fails the
+first try, x2x tries quite hard to get the focus!
+
+If the "to" display supports mouse buttons 4 and 5 then mouse wheel
+events on the Windows side are translated to clicks of buttons 4 and 5
+on the X display. This matches with XFree86 servers using
+Option "ZAxisMapping" "4 5".
+
+A link may be created on the Windows desktop to conveniently launch
+x2x. Assuming cygwin is installed to C:\\cygwin and x2x.exe is in
+/usr/X11R6/bin then the link properties should be set to:
+
+Target:
+.br
+C:\\cygwin\\usr\\X11R6\\bin\\run.exe\ /usr/X11R6/bin/x2x\ \-fromwin\ \-to\ somewhere:0.0\ \-east
+
+Start In: C:\\cygwin\\usr\\X11R6\\bin
+
+The "Start In" option is important to allow DLLs to be loaded and
+C:\\cygwin\\bin must be on the Windows PATH to allow other DLLs to be
+loaded. (If either of these are incorrect, launching the application
+tends to silently fail.)
+
+There are two magic key combinations activated by -fromwin:
+
+RightAlt-Home: Forces the focus back to Windows without needing the
+mouse to be moved. Useful when some popup window on the Windows side
+grabs the mouse!
+
+RightAlt-End: Exit x2x
+.TP
+.B \-east
+.IP
+Slide off the east side of the "to" display onto the "from" display.
+.TP
+.B \-west
+.IP
+Slide off the west side of the "to" display onto the "from" display.
+.TP
+.B \-font \fIfontname\fP
+.IP
+The font used in the x2x window. (Overridden by -east or -west.)
+.TP
+.B \-geometry \fIspecification\fP
+.IP
+The X geometry specification for the x2x window.
+(Overridden by -east or -west.)
+.TP
+.B \-wait
+.IP
+Tells x2x to poll the "to" and "from" displays at startup until they
+are ready. Useful for login scripts.
+.TP
+.B \-big
+.IP
+Workaround for a bug in the cursor grab implementations of at least one
+X server. Put a big window over the "to" display in order to force the
+X server to track the cursor. (This option is forced by the -fromwin option).
+.TP
+.B \-buttonblock
+.IP
+If this option is enabled with -east or -west, the cursor will not
+slide back onto the "from" display when one or more mouse buttons
+are pressed.
+.TP
+.B \-nomouse
+.IP
+Don't capture the mouse.
+(Overridden by -east or -west.)
+.TP
+.B \-nopointermap
+.IP
+Since x2x uses XTEST, which sends input at a lower level than the
+pointer button mapping, x2x needs to understand the "to" display's
+button mapping and do appropriate conversion. Use this option
+to turn off the pointer button conversion.
+.TP
+.B \-nosel
+.IP
+Don't relay the X selection between displays.
+.TP
+.B \-noautoup
+.IP
+Normally, the autoup feature in x2x automatically lifts up all keys and
+mouse buttons when it removes the cursor from the "from" display.
+.B
+Note: the autoup feature changes the state of lock functions like
+.B
+Caps Lock. The state of the lock function may not correspond to
+.B
+the state of the keyboard LEDs!
+To disable this feature, use the \-noautoup command line option.
+.TP
+.B \-resurface
+.IP
+Ugly hack to work-around window manager ugliness. The -east and -west
+modes actually put a small window on the side of the "from" display.
+This option causes this window to resurface itself if another window
+ever obscures it. This option can cause really nasty behavior if another
+application tries to do the same thing. Useful for login scripts.
+.TP
+.B \-capslockhack
+.IP
+Ugly hack to work-around the situation in which the "to" Xserver doesn't
+seem to honor the state of the CapsLock on the "from" Xserver. This is
+the default when the -fromwin option is given (although the hack used
+is slightly less ugly).
+.TP
+.B \-nocapslockhack
+.IP
+Disable the -capslockhack behaviour. Used to change the default
+behaviour after the -fromwin option is specified.
+.TP
+.B \-clipcheck
+.IP
+Check that clipboard entries are regular strings (XA_STRING) before
+forwarding to Windows. Enabling this is safer but may prevent copying
+with certain setups (eg from emacs under KDE/XFree).
+.TP
+.B \-shadow \fIdisplay\fP
+.IP
+Also sends mouse movements and keystrokes to this display. Useful
+for demos. Amaze your friends: specify multiple shadows.
+.TP
+.B \-sticky \fIsticky-key\fP
+.IP
+This option is primarily for "lock" keys like Caps_Lock. If a lock
+key only seems to work on every other press, try this option. The
+sticky option prevents autoup for the specified key. Look in
+/usr/include/X11/keysymdef.h for a list of valid names of keys
+(remove the leading XK_).
+.TP
+.B \-copyright
+.IP
+Prints the full copyright for the x2x code.
+.SH AUTHOR
+David Chaiken
+.br
+(chaiken@pa.dec.com)
+.br
+Mark Hayter (-fromwin code, thanks to the WinVNC sources)
+.SH BUGS
+This software is experimental! Heaven help you if your network
+connection should go down. Caveat hacker. TANSTAAFL.
+
+When using the -fromwin option if the Ctrl-Alt-Del keysequence is used
+while the mouse is forwarded to the X display then the Ctrl and Alt
+key press events are reported to x2x and forwarded but no other key
+events are generated. Thus if the Ctrl-Alt-Del sequence is used to
+manually lock the Windows display when the display is unlocked the
+mouse will still be forwarded to the X screen and the X server will
+believe Ctrl and Alt are still pressed. Pressing and releasing Ctrl
+and Alt should restore correct operation, as should returning the
+mouse to the Windows display (or using the RightAlt-Home magic key
+sequence).
+
+.SH LAWYERESE
+Copyright (c) 1997
+Digital Equipment Corporation. All rights reserved.
+
+By downloading, installing, using, modifying or distributing this
+software, you agree to the following:
+
+1. CONDITIONS. Subject to the following conditions, you may download,
+install, use, modify and distribute this software in source and binary forms:
+
+a) Any source code, binary code and associated documentation
+(including the online manual) used, modified or distributed must
+reproduce and retain the above copyright notice, this list of
+conditions and the following disclaimer.
+
+b) No right is granted to use any trade name, trademark or logo of
+Digital Equipment Corporation. Neither the "Digital Equipment
+Corporation" name nor any trademark or logo of Digital Equipment
+Corporation may be used to endorse or promote products derived from
+this software without the prior written permission of Digital
+Equipment Corporation.
+
+2. DISCLAIMER. THIS SOFTWARE IS PROVIDED BY DIGITAL "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED.IN NO EVENT SHALL DIGITAL BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Windows 95 and Windows NT are trademarks of Microsoft Corporation.
+.br
+Exceed is a trademark of Hummingbird Communications Ltd.