hw/xquartz/man/Xquartz.man

   1 .TH XQUARTZ 1 __vendorversion__
   2 .SH NAME
   3 Xquartz \- X window system server for Mac OSX
   4 .SH SYNOPSIS
   5 .B Xquartz
   6 [ options ] ...
   7 .SH DESCRIPTION
   8 .I Xquartz
   9 is the X window server for Mac OS X provided by Apple.
  10 .I Xquartz
  11 runs in parallel with Aqua in rootless mode. In rootless mode, the X
  12 window system and Mac OS X share your display.  The root window of the
  13 X11 display is the size of the screen and contains all the other
  14 windows. The X11 root window is not displayed in rootless mode as Mac
  15 OS X handles the desktop background.
  16 .SH CUSTOMIZATION
  17 \fIXquartz\fP can be customized using the defaults(1) command. The available options are:
  18 .TP 8
  19 .B defaults write __bundle_id_prefix__.X11 enable_fake_buttons -boolean true
  20 Emulates a 3 button mouse using modifier keys. By default, the Command modifier
  21 is used to emulate button 2 and Option is used for button 3. Thus, clicking the
  22 first mouse button while holding down Command will act like clicking
  23 button 2. Holding down Option will simulate button 3.
  24 .TP 8
  25 .B defaults write __bundle_id_prefix__.X11 fake_button2 \fImodifiers\fP
  26 Change the modifier keys used to emulate the second mouse button. By default,
  27 Command is used to emulate the second button. Any combination of the following
  28 modifier names may be used: {l,r,}shift, {l,r,}option, {l,r,}control, {l,r,}command, fn
  29 .TP 8
  30 .B defaults write __bundle_id_prefix__.X11 fake_button3 \fImodifiers\fP
  31 Change the modifier keys used to emulate the second mouse button. By default,
  32 Command is used to emulate the second button. Any combination of the following
  33 modifier names may be used: {l,r,}shift, {l,r,}option, {l,r,}control, {l,r,}command, fn
  34 .TP 8
  35 .B defaults write __bundle_id_prefix__.X11 fullscreen_hotkeys -boolean true
  36 Enable OSX hotkeys while in fullscreen
  37 .TP 8
  38 .B defaults write __bundle_id_prefix__.X11 fullscreen_menu -boolean true
  39 Show the OSX menu while in fullscreen
  40 .TP 8
  41 .B defaults write __bundle_id_prefix__.X11 no_quit_alert -boolean true
  42 Disables the alert dialog displayed when attempting to quit X11.
  43 .TP 8
  44 .B defaults write __bundle_id_prefix__.X11 no_auth -boolean true
  45 Stops the X server requiring that clients authenticate themselves when
  46 connecting.  See Xsecurity(__miscmansuffix__).
  47 .TP 8
  48 .B defaults write __bundle_id_prefix__.X11 nolisten_tcp -boolean false
  49 This will tell the server to listen and accept TCP connections.  Doing this without enabling
  50 xauth is a possible security concern.  See Xsecurity(__miscmansuffix__).
  51 .TP 8
  52 .B defaults write __bundle_id_prefix__.X11 enable_system_beep -boolean false
  53 Don't use the standard system beep effect for X11 alerts.
  54 .TP 8
  55 .B defaults write __bundle_id_prefix__.X11 enable_key_equivalents -boolean false
  56 Disable menu keyboard equivalents while X11 windows are focused.
  57 .TP 8
  58 .B defaults write __bundle_id_prefix__.X11 depth \fIdepth\fP
  59 Specifies the color bit depth to use. Currently only 15, and 24 color
  60 bits per pixel are supported. If not specified, or a value of -1 is specified,
  61 defaults to the depth of the main display.
  62 .TP 8
  63 .B defaults write __bundle_id_prefix__.X11 sync_keymap -boolean true
  64 Keep the X11 keymap up to date with the OSX system keymap.
  65 .TP 8
  66 .B defaults write __bundle_id_prefix__.X11 option_sends_alt -boolean true
  67 The Option key will send Alt_L and Alt_R instead of Mode_switch.
  68 .TP 8
  69 .B defaults write __bundle_id_prefix__.X11 sync_pasteboard -boolean true
  70 Enable syncing between the OSX pasteboard and clipboard/primary selection buffers in X11.  This option needs to be true for any of the other pasteboard sync options to have an effect.
  71 .TP 8
  72 .B defaults write __bundle_id_prefix__.X11 sync_pasteboard_to_clipboard -boolean true
  73 Update the X11 CLIPBOARD when the OSX NSPasteboard is updated.
  74 .TP 8
  75 .B defaults write __bundle_id_prefix__.X11 sync_pasteboard_to_primary -boolean true
  76 Update the the X11 PRIMARY buffer when the OSX NSPasteboard is updated.
  77 .TP 8
  78 .B defaults write __bundle_id_prefix__.X11 sync_clipboard_to_pasteboard -boolean true
  79 Update the the OSX NSPasteboard when the X11 CLIPBOARD is updated.  Note that enabling this option causes the clipboard synchronization to act as a clipboard manager in X11.  This makes it impossible to use xclipboard, klipper, or any other such clipboard managers.  If you want to use any of these programs, you must disable this option.
  80 .TP 8
  81 .B defaults write __bundle_id_prefix__.X11 sync_primary_on_select -boolean true
  82 This option defaults to false and is provided only "for experts."  It updates the NSPasteboard whenever a new X11 selection is made (rather than requiring you to hit cmd-c to copy the selection to the NSPasteboard).  Since the X11 protocol does not require applications to send notification when they change selection, this might not work in all cases (if you run into this problem, try selecting text in another application first, then selecting the text you want).
  83 .TP 8
  84 .B defaults write __bundle_id_prefix__.X11 enable_test_extensions -boolean true
  85 This option defaults to false and is only accessible through the command line.  Enable this option to turn on the DEC-XTRAP, RECORD, and XTEST extensions in the server.
  86 .TP 8
  87 .B defaults write __laucnd_id_prefix__.X11 scroll_in_device_direction -boolean true
  88 This option defaults to false.  Enable this option to ensure that X11 scroll events are always in the direction of the device.  This overrides the related option in the Mouse/Trackpad section of System Preferences.
  89 .SH OPTIONS
  90 .PP
  91 In addition to the normal server options described in the \fIXserver(1)\fP
  92 manual page, \fIXquartz\fP accepts the following command line switches:
  93 .TP 8
  94 .B \-fakebuttons
  95 Same as enable_fake_buttons above with value true.
  96 .TP 8
  97 .B \-nofakebuttons
  98 Same as enable_fake_buttons above with value false.
  99 .TP 8
 100 .B "\-fakemouse2 \fImodifiers\fP"
 101 Same as fake_button2 above.
 102 .TP 8
 103 .B "\-fakemouse3 \fImodifiers\fP"
 104 Same as fake_button3 above.
 105 .TP 8
 106 .B "\-depth \fIdepth\fP"
 107 Same as depth above.
 108 .SH LOGGING
 109 XQuartz stores a server log at ~/Library/Logs/X11.__bundle_id_prefix__.log which
 110 is analogous to /var/log/Xorg.#.log on systems that use the XFree86 DDX such as
 111 Linux, BSD, and Solaris.
 112 .PP
 113 In addition to this server log, XQuartz sends messages to syslogd(8) using
 114 asl(3).  These logs are sent to the __bundle_id_prefix__ facility, and you can
 115 watch these logs using the following syslog(1) command:
 116 .TP 8
 117 .B $ syslog -w -k Facility eq __bundle_id_prefix__
 118 .PP
 119 or you can include extra information such as the file, line, and function where the message originated:
 120 .TP 8
 121 .B $ syslog -w -F '$(Time) $(Sender) <$(Level)> $(File):$(Line) $(Function) :: $(Message)' -k Facility eq __bundle_id_prefix__
 122 .PP
 123 By default, XQaurtz sets an ASL mask which prevents it from logging messages
 124 below the ASL_LEVEL_WARNING level (meaning almost all logging is done strictly
 125 to the file referenced above).  To force XQuartz to send all log messages to
 126 syslogd(8), you can adjust this mask using the following syslog(1) command:
 127 .TP 8
 128 .B $ syslog -c X11.bin -d
 129 .PP
 130 The stdout and stderr messages printed by any process launched by XQuartz will
 131 be redirected to this syslog facility with a priority level of ASL_LEVEL_INFO
 132 and ASL_LEVEL_NOTICE respectively.  In order to see these messages in syslog,
 133 you will need to adjust XQuartz's asl mask as above but using -i or -n
 134 instead of -d.
 135 .SH "SEE ALSO"
 136 .PP
 137 X(__miscmansuffix__), Xserver(1), xdm(1), xinit(1), syslog(1), syslogd(8)
 138 .PP
 139 http://xquartz.macosforge.org
 140 .PP
 141 .SH AUTHORS / HISTORY
 142 X11 was originally ported to Mac OS X Server by John Carmack.  Dave
 143 Zarzycki used this as the basis of his port of XFree86 4.0 to Darwin 1.0.
 144 Torrey T. Lyons improved and integrated this code into the XFree86
 145 Project's mainline for the 4.0.2 release.
 146 .PP
 147 The following members of the XonX Team contributed to the following
 148 releases (in alphabetical order):
 149 .TP 4
 150 XFree86 4.1.0:
 151 .br
 152 Rob Braun - Darwin x86 support
 153 .br
 154 Torrey T. Lyons - Project Lead
 155 .br
 156 Andreas Monitzer - Cocoa version of XDarwin front end
 157 .br
 158 Gregory Robert Parker - Original Quartz implementation
 159 .br
 160 Christoph Pfisterer - Dynamic shared X libraries
 161 .br
 162 Toshimitsu Tanaka - Japanese localization
 163 .TP 4
 164 XFree86 4.2.0:
 165 .br
 166 Rob Braun - Darwin x86 support
 167 .br
 168 Pablo Di Noto - Spanish localization
 169 .br
 170 Paul Edens - Dutch localization
 171 .br
 172 Kyunghwan Kim - Korean localization
 173 .br
 174 Mario Klebsch - Non-US keyboard support
 175 .br
 176 Torrey T. Lyons - Project Lead
 177 .br
 178 Andreas Monitzer - German localization
 179 .br
 180 Patrik Montgomery - Swedish localization
 181 .br
 182 Greg Parker - Rootless support
 183 .br
 184 Toshimitsu Tanaka - Japanese localization
 185 .br
 186 Olivier Verdier - French localization
 187 .PP
 188 Code from Apple's X11.app (which was based on XFree86 4.1) was integrated into X.org's XDarwin DDX by Ben Byer for xorg-server-1.2.
 189 The XDarwin DDX was renamed Xquartz to more accurately reflect its state (the pure-darwin backend was removed).
 190 Jeremy Huddleston took over as project lead and brought the project up to the X.org 1.4 server branch.
 191 .PP
 192 Jeremy Huddleston <jeremyhu@apple.com> is the current maintainer.