frederik
/
xserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cygwin/X: Update XWin man page 

Restructure to group similar options and offer some commentary on those groups
Review option descriptions, clarify and bring up-to-date

Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
Reviewed-by: Colin Harrison <colin.harrison@virgin.net>
This commit is contained in:
Jon TURNEY 2009-10-31 17:19:17 +00:00
parent 6f1836bfbd
commit 26857b1c20
1 changed files with 239 additions and 180 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

419
hw/xwin/XWin.man.pre
View File

@ -9,96 +9,124 @@ XWin \- X Server for the Cygwin environment on Microsoft Windows
.SH DESCRIPTION .SH DESCRIPTION
.I XWin is an X Server for the X Window System on the Cygwin environment \fIXWin\fP is an X Server for the X Window System on the Cygwin environment
running on Microsoft Windows. running on Microsoft Windows.
.SH MODES .SH MODES
\fIXWin\fP can operate in five different and incompatible modes: \fIXWin\fP can operate in 3 different modes:
.br .br
* \fISingle Window\fP: This is the default option. The X server * \fISingle Window\fP: This is the default mode. Each X screen
appears as a single Windows window and all X windows are contained appears as a single \fIWindows\fP window and all X windows are contained
within this window. This mode requires an external window manager. within this window.
.br (In X terminology, the \fIWindows\fP window contains the root window for
* \fINo Decoration\fP: This mode is like single window mode except the screen)
that the X server window does not have a title bar or border, thus
maximizing the amount of space available for X windows within the X
server window. This mode requires an external window manager.
.br
* \fIFull Screen\fP: This mode is like single window mode except that
the X server window takes the full screen, covering completely the
Windows desktop. This mode requires an external window manager.
.br
* \fIRootless\fP: The X server works on a window covering the whole
screen but the root window (traditionally covered with an X hatch
pattern) is hidden from view. This mode requires an external window
manager.
.br .br
* \fIMulti-Window\fP: In this mode \fIXWin\fP uses its own integrated * \fIMulti-Window\fP: In this mode \fIXWin\fP uses its own integrated
window manager in order to handle the top-level X windows, in such a window manager in order to handle the top-level X windows, in such a
way that they appear as normal Windows windows. way that they appear as normal \fIWindows\fP windows.
.PP
NOTE: \fIMulti-Window\fP mode will crash if an external window manager
such as \fItwm\fP or \fIfvwm\fP is launched since \fIMulti-Window\fP
uses its own internal window manager; all other modes require an
external window manager in order to move, resize, and perform other
operations on the individual X windows.
.SH LOG
As it runs \fIXWin\fP writes messages indicating the most relevant events
to the console
from which it was called and to a log file that by default is located at \fI
__logdir__/XWin.0.log\fP. This file is mainly for debugging purposes.
.SH PREFERENCES FILE
On startup \fIXWin\fP looks for the file \fI$HOME/.XWinrc\fP or, if
the previous file does not exist, \fI
__sysconfdir__/X11/system.XWinrc\fP. \fI.XWinrc\fP allows setting
preferences for the following:
.br .br
1- To include items into the menu associated with the \fIXWin\fP icon * \fIRootless\fP: In this mode the X server works in a window
which is in the \fIWindows\fP system tray. This functions in all containing the whole screen but this root window (traditionally covered with an X hatch
modes that have a tray icon. pattern) is hidden from view, so only top-level X windows are seen.
.br
2- To include items in the menu which is associated with the Windows
window that \fIXWin -multiwindow\fP produces for each top-level X
window. That can be done both for the generic case and for particular
programs.
.br
3- To change the icon that is associated to the Windows window that
\fIXWin -multiwindow\fP produces for each top-level X-window. Again,
that can be done both for the generic case and for particular
programs.
.PP
The format of the \fI.XWinrc\fP file is given in the man page XWinrc(5).
.SH OPTIONS .SH OPTIONS
In addition to the normal server options described in the \fIXserver(1)\fP In addition to the normal server options described in the \fIXserver(1)\fP
manual page, \fIXWin\fP accepts the following command line switches, manual page, \fIXWin\fP accepts the following command line switches,
\fIall\fP of which are optional: \fIall\fP of which are optional:
.SH OPTIONS CONTROLLING WINDOWING MODE
Only one of these options may be specified.
.TP 8
.B (default)
Windowed or rooted mode.
Each X screen appears as a single \fIWindows\fP window and all X windows are
contained within those windows.
.TP 8
.B \-multiwindow
Each top-level X window appears in its own \fIWindows\fP window.
Also start the integrated \fIWindows\fP-based window manager.
.TP 8
.B \-rootless
Run the server in rootless mode.
The X server works on a window covering the whole screen but the root window
is hidden from view.
.TP 8
.B \-mwextwm
Experimental.
The mode combines \fB\-rootless\fP mode drawing with native \fIWindows\fP
window frames managed by the experimental external window manager \fIxwinwm\fP.
.PP
\fBNOTE:\fP \fI-multiwindow\fP mode uses its own internal window manager.
All other modes require an external window manager in order to move, resize, and perform other
operations on the individual X windows.
.SH OPTIONS FOR SPECIFYING X SCREENS
An X display may be composed of multiple screens.
The default behaviour is to create a single screen 0 that is roughly the
size of useful area of the primary monitor (allowing for any window
decorations and the task-bar).
Screen specific parameters, such as \fB\-fullscreen\fP, can be applied as a
default to all screens by placing those screen specific parameters
before any \fB\-screen\fP parameter. Screen specific parameters placed after
the first \fB\-screen\fP parameter will apply only to the immediately
preceeding \fB\-screen\fP parameter.
.TP 8
.B \-[no]multimonitors or \-[no]multiplemonitors
Create a screen 0 that covers all monitors [the primary monitor] on a system with
multiple monitors.
This option is currently enabled by default in \fB\-multiwindow\fP mode.
.TP 8
.B "\-screen \fIscreen_number\fP [\fIW\fP \fIH\fP [\fIX\fP \fIY\fP] | [[\fIW\fPx\fIH\fP[+\fIX\fP+\fIY\fP]][@\fIM\fP]] ] "
Create screen number
.I screen_number
and optionally specify it's
.I height,
.I width
and
.I initial position.
Additionally a
.I
monitor number
(which count from 1) can be specified to place the screen on,
at which point, all coordinates become relative to that monitor.
Screen numbers must be contiguous starting from zero and cannot be duplicated.
Examples:
.I " -screen 0 @1 ; on 1st monitor using its full resolution (the default)"
.I " -screen 0 800x600+100+100@2 ; on 2nd monitor offset 100,100 size 800x600"
.I " -screen 0 1024x768@3 ; on 3rd monitor size 1024x768"
.SH OPTIONS CONTROLLING THE APPEARANCE OF THE X SCREEN WINDOWS
These parameters only apply to windowed mode screens i.e. not
in \fB-multwindow\fP or \fB-rootless\fP mode
.TP 8
.B "\-fullscreen"
The X server window takes the full screen, covering completely the
\fIWindows\fP desktop.
.TP 8
.B \-nodecoration
Do not give the Cygwin/X window a \fIWindows\fP window border, title bar,
etc.
This parameter is ignored when the \fB\-fullscreen\fP parameter is specified.
.TP 8
.B \-scrollbars
In windowed mode, allow screens bigger than the \fIWindows\fP desktop.
Moreover, if the window has decorations, one can now resize it.
This parameter is ignored when the \fB\-fullscreen\fP parameter is specified.
.SH OPTIONS CONTROLLING WINDOWS INTEGRATION
.TP 8 .TP 8
.B \-[no]clipboard .B \-[no]clipboard
Enables [disables] the integration between the Cygwin/X clipboard and Enables [disables] the integration between the Cygwin/X clipboard and
Windows clipboard. The default is enabled. \fIWindows\fP clipboard. The default is enabled.
.TP 8 .TP 8
.B "\-clipupdates \fInum_boxes\fP" .B "\-emulate3buttons [\fItimeout\fP]"
Specify an optional threshold, above which the boxes in a shadow
update operation will be collected into a GDI clipping region. The
clipping region is then used to do a single bit block transfer that is
constrained to the updated area by the clipping region. There is some
overhead involved in creating, installing, destroying, and removing
the clipping region, thus there may not be much benefit for a small
number of boxes (less than 10). It is even possible that this
functionality does not provide a benefit at any number of boxes; we
can only determine the usefulness of this feature through testing.
This parameter works in conjunction with engines 1, 2, and 4 (Shadow
GDI, Shadow DirectDraw, and Shadow DirectDraw Non-Locking,
respectively).
.TP 8
.B "\-emulate3buttons \fItimeout\fP"
Emulate a three button mouse; pressing both buttons within Emulate a three button mouse; pressing both buttons within
.I timeout .I timeout
milliseconds causes an emulated middle button press. The default milliseconds causes an emulated middle button press. The default
@ -107,108 +135,21 @@ is 50 milliseconds. Note that most mice with scroll wheel have middle
button functionality, usually you will need this option only if you have button functionality, usually you will need this option only if you have
a two button mouse without scroll wheel. a two button mouse without scroll wheel.
.TP 8 .TP 8
.B \-emulatepseudo
Create a depth 8 PseudoColor visual when running in depths 15, 16, 24,
or 32, collectively known as TrueColor depths.
At this date (April 2004) this option is not still operative.
.TP 8
.B "\-engine \fIengine_type_id\fP"
This option, which is intended for Cygwin/X developers,
overrides the server's automatically supported engine type. This
parameter will be ignored if the specified engine type is not
supported on the current system. The supported engine type ids are 1
- Shadow GDI, 2 - Shadow DirectDraw, and 4 - Shadow DirectDraw4.
Additionally, there is a barely functional experimental engine type id
16 - Native GDI.
.TP 8
.B "\-fullscreen [-depth \fIdepth\fP] [-refresh \fIrate_in_Hz\fP]"
Run the server in fullscreen mode, as opposed to the default windowed
mode.
.TP 8
.B "\-depth \fIdepth\fP"
Specify the color depth, in bits per pixel, to use when running in
fullscreen with a DirectDraw engine. This parameter is ignored if
\fB\-fullscreen\fP is not specified.
.TP 8
.B "\-refresh \fIrate_in_Hz\fP"
Specify an optional refresh rate to use when running in
fullscreen with a DirectDraw engine. This parameter is ignored if
\fB\-fullscreen\fP is not specified.
.TP 8
.B \-help
Write a help text to the console and to the log file.
.TP 8
.B \-ignoreinput
Ignore keyboard and mouse input. This is usually only used for testing
and debugging purposes.
.TP 8
.B \-[no]keyhook .B \-[no]keyhook
Enable [disable] a low-level keyboard hook for catching Enable [disable] a low-level keyboard hook for catching
special key combinations like Alt+Tab and passing them to the X special keypresses like Menu and Alt+Tab and passing them to the X
Server instead of letting \fIWindows\fP handle them. Server instead of letting \fIWindows\fP handle them.
.TP 8 .TP 8
.B \-lesspointer .B \-lesspointer
Hide the Windows mouse cursor when the mouse is over any Cygwin/X Normally the \fIWindows\fP mouse cursor is hidden when the mouse is
window (regardless of whether that window is active or inactive). This over an active Cygwin/X window. This option causes the mouse cursor
prevents the Windows mouse cursor from being placed overtop of the X also to be hidden when it is over an inactive Cygwin/X window. This
prevents the \fIWindows\fP mouse cursor from being drawn on top of the X
cursor. cursor.
This parameter has no effect unless \fB-swcursor\fP is also specified.
.TP 8 .TP 8
.B "\-logfile \fIFile_Name\fP" .B \-swcursor
Change the log file from the default located at \fI Disable the usage of the \fIWindows\fP cursor and use the X11 software cursor instead.
__logdir__/XWin.0.log\fP to the one indicated by \fIFile_Name\fP.
.TP 8
.B "\-logverbose \fIlevel\fP"
Control the degree of verbosity of the log messages with the integer
parameter \fIlevel\fP. For \fIlevel\fP=0 only fatal errors are
reported, for \fIlevel\fP=1 (default) simple information about
configuration is also given, for \fIlevel\fP=2 a detailed log
information (including trace and debug output) is produced. Bigger
values will yield a still more detailed debug output. At this date
(April 2004) the option is still not fully operative; the default
value is 2 and the output is insensitive to the level value.
.TP 8
.B \-multimonitors
Create a root window that covers all monitors on a system with
multiple monitors.
.TP 8
.B \-multiwindow
Start the integrated \fIWindowsi\fP-based window manager, which launches each
top-level X window in its own \fIWindows\fP window. Not to be used together
with \fB\-rootless\fP nor \fB\-fullscreen\fP.
.TP 8
.B \-nodecoration
Do not give the Cygwin/X window a Windows window border, title bar,
etc. This parameter only applies to windowed mode screens, i.e., this
parameter is ignored when the \fB\-fullscreen\fP parameter is specified.
.TP 8
.B \-nounicodeclipboard
Do not use Unicode clipboard even if NT-based platform.
.TP 8
.B \-rootless
Run the server in rootless mode. Not to be used with \fB\-multiwindow\fP
nor with \fB\-fullscreen\fP.
.TP 8
.B "\-screen \fIscreen_number\fP \fIwidth\fP \fIheight\fP"
This parameter may be used to specify the
.I screen_number,
.I height,
and
.I width
of one or several Cygwin/X screens; each Cygwin/X screen will be
opened in its own window. When using multiple screens, be sure not to
duplicate any screen numbers.
.I XWin
default behavior is to create a single screen that is roughly
the size of the current Windows display area.
Screen specific parameters, such as \fB\-fullscreen\fP, can be applied as a
default to all screens by placing those screen specific parameters
before any \fB\-screen\fP parameter. Screen specific parameters placed after
the first \fB\-screen\fP parameter will apply only to the immediately
preceeding \fB\-screen\fP parameter.
.TP 8
.B \-scrollbars
In windowed mode, allow screens bigger than the Windows desktop.
Moreover, if the window has decorations, one can now resize it.
.TP 8 .TP 8
.B \-[no]trayicon .B \-[no]trayicon
Do not create a tray icon. Default is to create one Do not create a tray icon. Default is to create one
@ -216,6 +157,9 @@ icon per screen. You can globally disable tray icons with
\fB\-notrayicon\fP, then enable it for specific screens with \fB\-notrayicon\fP, then enable it for specific screens with
\fB\-trayicon\fP for those screens. \fB\-trayicon\fP for those screens.
.TP 8 .TP 8
.B \-nounicodeclipboard
Do not use Unicode clipboard even if on a NT-based platform.
.TP 8
.B \-[no]unixkill .B \-[no]unixkill
Enable or disable the \fICtrl-Alt-Backspace\fP key combination as a Enable or disable the \fICtrl-Alt-Backspace\fP key combination as a
signal to exit the X Server. The \fICtrl-Alt-Backspace\fP key combination signal to exit the X Server. The \fICtrl-Alt-Backspace\fP key combination
@ -225,13 +169,78 @@ is disabled by default.
Enable or disable the \fIAlt-F4\fP key combination as a signal to exit the Enable or disable the \fIAlt-F4\fP key combination as a signal to exit the
X Server. X Server.
The \fIAlt-F4\fP key combination is enabled by default. The \fIAlt-F4\fP key combination is enabled by default.
.SH DRAWING ENGINE OPTIONS
.TP 8 .TP 8
.B \-swcursor .B "\-clipupdates \fInum_boxes\fP"
Disable the usage of the windows cursor and use the X11 software cursor instead. Specify an optional threshold, above which the regions in a shadow
update operation will be collected into a GDI clipping region. The
clipping region is then used to do a single bit block transfer that is
constrained to the updated area by the clipping region. There is some
overhead involved in creating, installing, destroying, and removing
the clipping region, thus there may not be much benefit for a small
number of boxes (less than 10). It is even possible that this
functionality does not provide a benefit at any number of boxes; we
can only determine the usefulness of this feature through testing.
This option probably has limited effect on current \fIWindows\fP versions
as they already perform GDI batching.
This parameter works in conjunction with engines 1, 2, and 4 (Shadow
GDI, Shadow DirectDraw, and Shadow DirectDraw Non-Locking,
respectively).
.TP 8
.B "\-engine \fIengine_type_id\fP"
This option, which is intended for Cygwin/X developers,
overrides the server's automatically selected engine type. This
parameter will be ignored if the specified engine type is not
supported on the current system. The supported engine type ids are 1
- Shadow GDI, 2 - Shadow DirectDraw, and 4 - Shadow DirectDraw Non-Locking.
Additionally, there are engines with type ids
8 - Primary DirectDraw (obsolete) and 16 - Native GDI (experimental and barely functional).
Default behavior is to determine the engine with optimum performance that
supports the specified depth and window configuration.
.SH FULLSCREEN OPTIONS
.TP 8
.B "\-depth \fIdepth\fP"
Specify the color depth, in bits per pixel, to use when running in
fullscreen with a DirectDraw engine. This parameter is ignored if
\fB\-fullscreen\fP is not specified.
.TP 8
.B "\-refresh \fIrate_in_Hz\fP"
Specify an optional refresh rate to use when running in
fullscreen with a DirectDraw engine. This parameter is ignored if
\fB\-fullscreen\fP is not specified.
.SH MISCELLANEOUS OPTIONS
See also the normal server options described in the \fIXserver(1)\fP
manual page
.TP 8
.B \-help
Write a help text listing supported command line options and their description to the console.
.TP 8
.B \-ignoreinput
Ignore keyboard and mouse input. This is usually only used for testing
and debugging purposes.
.TP 8
.B "\-logfile \fIfilename\fP"
Change the server log file from the default of \fI
__logdir__/XWin.n.log\fP,
where \fIn\fP is the display number of the XWin server, to \fIfilename\fP.
.TP 8
.B "\-logverbose \fIlevel\fP"
Control the degree of verbosity of the log messages with the integer
parameter \fIlevel\fP. For \fIlevel\fP=0 only fatal errors are
reported, for \fIlevel\fP=1 simple information about
configuration is also given, for \fIlevel\fP=2 (default)
additional runtime information is recorded
and for \fIlevel\fP=3 detailed log
information (including trace and debug output) is produced. Bigger
values will yield a still more detailed debug output.
.TP 8 .TP 8
.B \-silent-dup-error .B \-silent-dup-error
If another instance of XWin is found running, exit silently and don't display If another instance of \fIXWin\fP with the same display number is found running,
the error message. exit silently and don't display any error message.
.TP 8 .TP 8
.B "\-xkblayout \fIlayout\fP" .B "\-xkblayout \fIlayout\fP"
.TP 8 .TP 8
@ -251,10 +260,60 @@ in order to load a German layout for a pc105 keyboard one uses
the options: the options:
.br .br
.I " \-xkblayout de \-xkbmodel pc105" .I " \-xkblayout de \-xkbmodel pc105"
Alternatively one may use the \fIsetxkbmap\fP program after \fIXWin\fP is
running.
The default is to select a layout matching your current layout as
reported by \fIWindows\fP if known, or the default X server layout
if no matching keyboard layout was found.
.SH UNDOCUMENTED OPTIONS
These options are undocumented. Do not use them.
.TP 8
.B \-emulatepseudo
Create a depth 8 PseudoColor visual when running in depths 15, 16, 24,
or 32, collectively known as TrueColor depths.
Color map manipulation is not supported, so the PseudoColor visual will
not have the correct colors.
This option is intended to allow applications which only work with a depth 8
visual to operate in TrueColor modes.
.TP 8
.B \-internalwm
Run the internal window manager.
.SH LOG FILE
As it runs \fIXWin\fP writes messages indicating the most relevant events
to the console
from which it was called and to a log file that by default is located at \fI
__logdir__/XWin.0.log\fP. This file is mainly for debugging purposes.
.SH PREFERENCES FILE
On startup \fIXWin\fP looks for the file \fI$HOME/.XWinrc\fP or, if
the previous file does not exist, \fI
__sysconfdir__/X11/system.XWinrc\fP. \fI.XWinrc\fP allows setting
preferences for the following:
.br
* To include items into the menu associated with the \fIXWin\fP icon
which is in the \fIWindows\fP system tray. This functions in all
modes that have a tray icon.
.br
* To include items in the system menu which is associated with the \fIWindows\fP
window that \fIXWin -multiwindow\fP produces for each top-level X
window, in both the generic case and for particular programs.
.br
* To change the icon that is associated to the \fIWindows\fP window that
\fIXWin -multiwindow\fP produces for each top-level X-window.
.br
* To change the style that is associated to the \fIWindows\fP window that
\fXWin I-multiwindow\fP produces for each top-level X window.
.PP .PP
Alternatively one may use the \fIsetxkbmap\fP program after XWin is The format of the \fI.XWinrc\fP file is given in the man page XWinrc(5).
running or even the \fIxmodmap\fP program for loading the old-style
keyboard maps. .SH EXAMPLES
Need some examples
.SH "SEE ALSO" .SH "SEE ALSO"
@ -268,10 +327,9 @@ ones are:
.br .br
- The display mode can not be changed once the X server has started. - The display mode can not be changed once the X server has started.
.br .br
- The XWin software is developing rapidly; it is therefore likely that - The \fIXWin\fP software is continuously developing; it is therefore possible that
this man page is not up to date. It is always prudent to this man page is not up to date. It is always prudent to
look also at the output of \fIXWin -help\fP and to the Cygwin/X User Guide look also at the output of \fIXWin -help\fP in order to
at /usr/share/doc/cygwin-x-doc-x.x.x/ug/cygwin-x-ug.xxx in order to
check the options that are operative. check the options that are operative.
@ -282,6 +340,7 @@ Adamson, Michael Bax, Jehan Bing, Lev Bishop, Dr. Peter Busch, Biju G
C, Robert Collins, Nick Crabtree, Early Ehlinger, Christopher Faylor, C, Robert Collins, Nick Crabtree, Early Ehlinger, Christopher Faylor,
John Fortin, Brian Genisio, Fabrizio Gennari, Alexander Gottwald, Ralf John Fortin, Brian Genisio, Fabrizio Gennari, Alexander Gottwald, Ralf
Habacker, Colin Harrison, Matthieu Herrb, Alan Hourihane, Pierre A Habacker, Colin Harrison, Matthieu Herrb, Alan Hourihane, Pierre A
Humblet, Harold L Hunt II, Dakshinamurthy Karra, Kensuke Matsuzaki, Humblet, Harold L Hunt II, Dakshinamurthy Karra, Joe Krahn,
Takuma Murakami, Earle F. Philhower III, Benjamin Riefenstahl, Suhaib Paul Loewenstein, Kensuke Matsuzaki,
Siddiqi, Jack Tanner, and Nicholas Wourms. Takuma Murakami, Earle F. Philhower III, Benjamin Riefenstahl, Yaakov Selkowitz,
Suhaib Siddiqi, Jack Tanner, Jon Turney and Nicholas Wourms.