← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/programs/Xserver/hw/darwin/XDarwin.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/programs/Xserver/hw/darwin/XDarwin.man
 
1
.\" $XFree86: xc/programs/Xserver/hw/darwin/XDarwin.man,v 1.4 2002/01/09 18:01:58 torrey Exp $
 
2
.\"
 
3
.TH XDARWIN 1 __vendorversion__
 
4
.SH NAME
 
5
XDarwin \- X window system server for Darwin operating system
 
6
.SH SYNOPSIS
 
7
.B XDarwin
 
8
[ options ] ...
 
9
.SH DESCRIPTION
 
10
#ifdef DARWIN_WITH_QUARTZ
 
11
.I XDarwin
 
12
is the X window server for Mac OS X and the Darwin operating system
 
13
provided by the XFree86 Project.
 
14
.I XDarwin
 
15
can run in three different modes. On Mac OS X,
 
16
.I XDarwin
 
17
runs in parallel with Aqua in full screen or rootless modes. These modes
 
18
are called Quartz modes, named after the Quartz 2D compositing engine used
 
19
by Aqua. XDarwin can also be run from the Darwin text console in IOKit mode.
 
20
.PP
 
21
When running from the console,
 
22
.I XDarwin
 
23
acts as the window server and uses IOKit services to access the display
 
24
framebuffer, mouse and keyboard and to provide a layer of hardware
 
25
abstraction. In console mode,
 
26
.I XDarwin
 
27
will normally be started by the \fIxdm(1)\fP display manager or by a script
 
28
that runs the program \fIxinit(1)\fP.
 
29
.PP
 
30
When running with the Mac OS X Aqua GUI,
 
31
.I XDarwin
 
32
will normally be started by launching from the Finder, but it may also be
 
33
started from the command line with the \fB\-quartz\fP, \fB\-fullscreen\fP, or
 
34
\fB\-rootless\fP options. Note that the defaults for various command line
 
35
options are set by the
 
36
.I XDarwin
 
37
application preferences in the Quartz modes.
 
38
.PP
 
39
In full screen Quartz mode, when the X Window System is active, it takes over
 
40
the entire screen. CoreGraphics is used to capture and draw to the screen. The
 
41
.I XDarwin
 
42
application allows easy switching between the Mac OS X and X window
 
43
desktops. More information is available in the Help menu of the
 
44
.I XDarwin
 
45
application.
 
46
.PP
 
47
In rootless mode, the X window system and Aqua share your display.  The root
 
48
window of the X11 display is the size of the screen and contains all the
 
49
other windows. The X11 root window is not displayed in rootless mode as Aqua
 
50
handles the desktop background.
 
51
#else
 
52
.I XDarwin
 
53
is the X window server for Mac OS X and the Darwin operating system
 
54
provided by the XFree86 Project. This version of
 
55
.I XDarwin
 
56
can only be started from the Darwin text console. The Mac OS X Aqua GUI, if
 
57
present, must be shut down.
 
58
.I XDarwin
 
59
uses IOKit services to access the display
 
60
framebuffer, mouse and keyboard and to provide a layer of hardware
 
61
abstraction.
 
62
.I XDarwin
 
63
will normally be started by the \fIxdm(1)\fP display manager or by a script
 
64
that runs the program \fIxinit(1)\fP.
 
65
#endif
 
66
.SH OPTIONS
 
67
.PP
 
68
In addition to the normal server options described in the \fIXserver(1)\fP
 
69
manual page, \fIXDarwin\fP accepts the following command line switches:
 
70
.TP 8
 
71
.B \-fakebuttons
 
72
Emulates a 3 button mouse using modifier keys. By default, the Command modifier
 
73
is used to emulate button 2 and Option is used for button 3. Thus, clicking the
 
74
first mouse button while holding down Command will act like clicking
 
75
button 2. Holding down Option will simulate button 3.
 
76
.TP 8
 
77
.B \-nofakebuttons
 
78
Do not emulate a 3 button mouse. This is the default.
 
79
.TP 8
 
80
.B "\-fakemouse2 \fImodifiers\fP"
 
81
Change the modifier keys used to emulate the second mouse button. By default,
 
82
Command is used to emulate the second button. Any combination of the following
 
83
modifier names may be used: Shift, Option, Control, Command, Fn. For example,
 
84
.B \-fakemouse2 """Option,Shift""
 
85
will set holding Option, Shift and clicking on button one as equivalent to
 
86
clicking the second mouse button.
 
87
.TP 8
 
88
.B "\-fakemouse3 \fImodifiers\fP"
 
89
Change the modifier keys used to emulate the third mouse button. By default,
 
90
Option is used to emulate the third button. Any combination of the following
 
91
modifier names may be used: Shift, Option, Control, Command, Fn. For example,
 
92
.B \-fakemouse3 """Control,Shift""
 
93
will set holding Control, Shift and clicking on button one as equivalent to
 
94
clicking the third mouse button.
 
95
.TP 8
 
96
.B "\-keymap \fIfile\fP"
 
97
On startup \fIXDarwin\fP translates a Darwin keymapping into an X keymap.
 
98
The default is to read this keymapping from USA.keymapping. With this option
 
99
the keymapping will be read from \fIfile\fP instead. If the file's path is
 
100
not specified, it will be searched for in Library/Keyboards/ underneath the
 
101
following directories (in order): ~, /, /Network, /System.
 
102
.TP 8
 
103
.B \-nokeymap
 
104
On startup \fIXDarwin\fP translates a Darwin keymapping into an X keymap.
 
105
With this option XDarwin queries the kernel for the current keymapping
 
106
instead of reading it from a file. This will often fail on newer kernels.
 
107
#ifdef DARWIN_WITH_QUARTZ
 
108
.TP 8
 
109
.B "\-size \fIwidth\fP \fIheight\fP"
 
110
Sets the screen resolution for the X server to use.
 
111
Ignored in rootless mode.
 
112
.TP 8
 
113
.B "\-depth \fIdepth\fP"
 
114
Specifies the color bit depth to use. Currently only 8, 15, and 24 color bits
 
115
per pixel are supported.
 
116
Ignored in rootless mode.
 
117
.TP 8
 
118
.B "\-refresh \fIrate\fP"
 
119
Gives the refresh rate to use in Hz. For LCD displays this should be 0.
 
120
Ignored in rootless mode.
 
121
.TP 8
 
122
.B \-fullscreen
 
123
Run full screen in parallel with Mac OS X Aqua GUI.
 
124
.TP 8
 
125
.B \-rootless
 
126
Run rootless inside Mac OS X Aqua GUI.
 
127
.TP 8
 
128
.B \-quartz
 
129
Run in parallel with the Mac OS X Aqua GUI using the default mode.
 
130
#else
 
131
.TP 8
 
132
.B "\-size \fIwidth\fP \fIheight\fP"
 
133
Sets the screen resolution for the X server to use.
 
134
.TP 8
 
135
.B "\-depth \fIdepth\fP"
 
136
Specifies the color bit depth to use. Currently only 8, 15, and 24 color bits
 
137
per pixel are supported.
 
138
.TP 8
 
139
.B "\-refresh \fIrate\fP"
 
140
Gives the refresh rate to use in Hz. For LCD displays this should be 0.
 
141
#endif
 
142
.TP 8
 
143
.B \-showconfig
 
144
Print out the server version and patchlevel.
 
145
.TP 8
 
146
.B \-version
 
147
Same as \fB\-showconfig\fP.
 
148
.SH "SEE ALSO"
 
149
.PP
 
150
X(__miscmansuffix__), XFree86(1), Xserver(1), xdm(1), xinit(1)
 
151
.SH BUGS
 
152
.I XDarwin
 
153
and this man page still have many limitations. Some of the more obvious
 
154
ones are:
 
155
.br
 
156
- The display mode cannot be changed once the X server has started.
 
157
.br
 
158
- A screen saver is not supported.
 
159
.PP
 
160
.SH AUTHORS
 
161
XFree86 was originally ported to Mac OS X Server by John Carmack. Dave
 
162
Zarzycki used this as the basis of his port of XFree86 4.0 to Darwin 1.0.
 
163
Torrey T. Lyons improved and integrated this code into the XFree86
 
164
Project's mainline for the 4.0.2 release.
 
165
.PP
 
166
The following members of the XonX Team contributed to the following
 
167
releases (in alphabetical order):
 
168
.TP 4
 
169
XFree86 4.1.0:
 
170
.br
 
171
Rob Braun - Darwin x86 support
 
172
.br
 
173
Torrey T. Lyons - Project Lead
 
174
.br
 
175
Andreas Monitzer - Cocoa version of XDarwin front end
 
176
.br
 
177
Gregory Robert Parker - Original Quartz implementation
 
178
.br
 
179
Christoph Pfisterer - Dynamic shared X libraries
 
180
.br
 
181
Toshimitsu Tanaka - Japanese localization
 
182
.TP 4
 
183
XFree86 4.2.0:
 
184
.br
 
185
Rob Braun - Darwin x86 support
 
186
.br
 
187
Pablo Di Noto - Spanish localization
 
188
.br
 
189
Paul Edens - Dutch localization
 
190
.br
 
191
Kyunghwan Kim - Korean localization
 
192
.br
 
193
Mario Klebsch - Non-US keyboard support
 
194
.br
 
195
Torrey T. Lyons - Project Lead
 
196
.br
 
197
Andreas Monitzer - German localization
 
198
.br
 
199
Patrik Montgomery - Swedish localization
 
200
.br
 
201
Greg Parker - Rootless support
 
202
.br
 
203
Toshimitsu Tanaka - Japanese localization
 
204
.br
 
205
Olivier Verdier - French localization