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

man pages: use .BR to mark up man page references 

The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/xserver/-/merge_requests/1875>
This commit is contained in:
Alan Coopersmith 2025-03-29 13:36:54 -07:00
parent b4b6b19c9a
commit 5ac0a19e7f
14 changed files with 299 additions and 156 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
hw/kdrive/Xkdrive.man
View File

@ -16,7 +16,8 @@ servers; for information on a specific X server, please refer to the
relevant manual page. relevant manual page.
.SH OPTIONS .SH OPTIONS
In addition to the standard options accepted by all X servers (see In addition to the standard options accepted by all X servers (see
Xserver(1)), all the .BR Xserver (1)),
all the
.B Xkdrive .B Xkdrive
servers accept the following options: servers accept the following options:
.TP 8 .TP 8
@ -44,7 +45,12 @@ enable emulation of a middle mouse button by chording.
.B -3button .B -3button
disable emulation of a middle mouse button by chording. disable emulation of a middle mouse button by chording.
.SH SEE ALSO .SH SEE ALSO
X(@miscmansuffix@), Xserver(1), xdm(1), xinit(1), Xvesa(1), Xfbdev(1). .BR X (@miscmansuffix@),
.BR Xserver (1),
.BR xdm (1),
.BR xinit (1),
.BR Xvesa (1),
.BR Xfbdev (1).
.SH AUTHORS .SH AUTHORS
The Xkdrive common core was written by Keith Packard, The Xkdrive common core was written by Keith Packard,
and is based on the Sample Implementation of X. and is based on the Sample Implementation of X.

6
hw/kdrive/ephyr/man/Xephyr.man
View File

@ -39,7 +39,8 @@ uses the host X server window as "framebuffer" via fast SHM XImages.
It also has support for "visually" debugging what the server is It also has support for "visually" debugging what the server is
painting. painting.
.SH OPTIONS .SH OPTIONS
The server accepts all the standard options of Xserver(@appmansuffix@) The server accepts all the standard options of
.BR Xserver (@appmansuffix@)
and the following additional options: and the following additional options:
.TP 8 .TP 8
.BI -screen " width" x height .BI -screen " width" x height
@ -91,6 +92,7 @@ Keyboard handling is basic but works.
.IP \(bu 2 .IP \(bu 2
Mouse button 5 probably won't work. Mouse button 5 probably won't work.
.SH "SEE ALSO" .SH "SEE ALSO"
X(@miscmansuffix@), Xserver(@appmansuffix@) .BR X (@miscmansuffix@),
.BR Xserver (@appmansuffix@)
.SH AUTHOR .SH AUTHOR
Matthew Allum <mallum@o-hand.com> 2004 Matthew Allum <mallum@o-hand.com> 2004

9
hw/vfb/man/Xvfb.man
View File

@ -49,7 +49,8 @@ new platform, and providing an unobtrusive way to run applications
that don't really need an X server but insist on having one anyway. that don't really need an X server but insist on having one anyway.
.SH OPTIONS .SH OPTIONS
.PP .PP
In addition to the normal server options described in the \fIXserver(1)\fP In addition to the normal server options described in the
.BR Xserver (1)
manual page, \fIXvfb\fP accepts the following command line switches: manual page, \fIXvfb\fP accepts the following command line switches:
.TP 4 .TP 4
.B "\-screen \fIscreennum\fP \fIWxHxD\fP" .B "\-screen \fIscreennum\fP \fIWxHxD\fP"
@ -119,6 +120,10 @@ xwud -in /var/tmp/Xvfb_screen0
Displays screen 0 of the server started by the preceding example. Displays screen 0 of the server started by the preceding example.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
X(@miscmansuffix@), Xserver(1), xwd(1), xwud(1), XWDFile.h .BR X (@miscmansuffix@),
.BR Xserver (1),
.BR xwd (1),
.BR xwud (1),
.B XWDFile.h
.SH AUTHORS .SH AUTHORS
David P. Wiggins, The Open Group, Inc. David P. Wiggins, The Open Group, Inc.

13
hw/xfree86/drivers/modesetting/modesetting.man
View File

@ -27,9 +27,10 @@ The
driver supports all hardware where a KMS driver is available. driver supports all hardware where a KMS driver is available.
modesetting uses the Linux DRM KMS ioctls and dumb object create/map. modesetting uses the Linux DRM KMS ioctls and dumb object create/map.
.SH CONFIGURATION DETAILS .SH CONFIGURATION DETAILS
Please refer to @xconfigfile@(@filemansuffix@) for general configuration Please refer to
details. This section only covers configuration details specific to .BR @xconfigfile@ (@filemansuffix@)
this driver. for general configuration details.
This section only covers configuration details specific to this driver.
.PP .PP
For this driver it is not required to specify modes in the screen For this driver it is not required to specify modes in the screen
section of the config file. The section of the config file. The
@ -125,7 +126,9 @@ Enable atomic modesetting when supported. The default is
.B off. .B off.
.TP .TP
.SH "SEE ALSO" .SH "SEE ALSO"
@xservername@(@appmansuffix@), @xconfigfile@(@filemansuffix@), Xserver(@appmansuffix@), .BR @xservername@ (@appmansuffix@),
X(@miscmansuffix@) .BR @xconfigfile@ (@filemansuffix@),
.BR Xserver (@appmansuffix@),
.BR X (@miscmansuffix@)
.SH AUTHORS .SH AUTHORS
Authors include: Dave Airlie Authors include: Dave Airlie

12
hw/xfree86/fbdevhw/man/fbdevhw.man
View File

@ -10,13 +10,17 @@ A
.B fbdevhw .B fbdevhw
module is currently available for linux framebuffer devices. module is currently available for linux framebuffer devices.
.PP .PP
fbdev(@drivermansuffix@) is a non-accelerated driver which runs on top of the .BR fbdev (@drivermansuffix@)
is a non-accelerated driver which runs on top of the
fbdevhw module. fbdevhw can be used by other drivers too, this fbdevhw module. fbdevhw can be used by other drivers too, this
is usually activated with `Option "UseFBDev"' in the device section. is usually activated with `Option "UseFBDev"' in the device section.
.SH "SEE ALSO" .SH "SEE ALSO"
Xorg(@appmansuffix@), xorg.conf(@filemansuffix@), .BR Xorg (@appmansuffix@),
xorgconfig(@appmansuffix@), Xserver(@appmansuffix@), X(@miscmansuffix@), .BR xorg.conf (@filemansuffix@),
fbdev(@drivermansuffix@) .BR xorgconfig (@appmansuffix@),
.BR Xserver (@appmansuffix@),
.BR X (@miscmansuffix@),
.BR fbdev (@drivermansuffix@)
.SH AUTHORS .SH AUTHORS
Authors include: Gerd Knorr, based on the XF68_FBDev Server code Authors include: Gerd Knorr, based on the XF68_FBDev Server code
(Martin Schaller, Geert Uytterhoeven). (Martin Schaller, Geert Uytterhoeven).

177
hw/xfree86/man/Xorg.man
View File

@ -33,8 +33,10 @@ free/OpenSource UNIX-like systems such as Linux, FreeBSD, NetBSD,
OpenBSD, and Solaris. Commercial UNIX operating systems such as OpenBSD, and Solaris. Commercial UNIX operating systems such as
UnixWare are also supported. Other supported operating systems include UnixWare are also supported. Other supported operating systems include
GNU Hurd. Mac OS X is supported with the GNU Hurd. Mac OS X is supported with the
Xquartz(@appmansuffix@) X server. Win32/Cygwin is supported with the .BR Xquartz (@appmansuffix@)
XWin(@appmansuffix@) X server. X server. Win32/Cygwin is supported with the
.BR XWin (@appmansuffix@)
X server.
.PP .PP
.SH "NETWORK CONNECTIONS" .SH "NETWORK CONNECTIONS"
.B Xorg .B Xorg
@ -44,8 +46,10 @@ byte-streams:
.I "Local" .I "Local"
On most platforms, the "Local" connection type is a UNIX-domain socket. On most platforms, the "Local" connection type is a UNIX-domain socket.
On some System V platforms, the "local" connection types also include On some System V platforms, the "local" connection types also include
STREAMS pipes, named pipes, and some other mechanisms. See the STREAMS pipes, named pipes, and some other mechanisms.
"LOCAL CONNECTIONS" section of X(@miscmansuffix@) for details. See the "LOCAL CONNECTIONS" section of
.BR X (@miscmansuffix@)
for details.
.TP 4 .TP 4
.I TCP/IP .I TCP/IP
.B Xorg .B Xorg
@ -56,25 +60,31 @@ where
is the display number. This connection type is usually disabled by default, is the display number. This connection type is usually disabled by default,
but may be enabled with the but may be enabled with the
.B \-listen .B \-listen
option (see the Xserver(1) man page for details). option (see the
.BR Xserver (1)
man page for details).
.SH OPTIONS .SH OPTIONS
.B Xorg .B Xorg
supports several mechanisms for supplying/obtaining configuration and supports several mechanisms for supplying/obtaining configuration and
run-time parameters: command line options, environment variables, the run-time parameters: command line options, environment variables, the
xorg.conf(@filemansuffix@) configuration files, auto-detection, and .BR xorg.conf (@filemansuffix@)
configuration files, auto-detection, and
fallback defaults. When the same information is supplied in more than fallback defaults. When the same information is supplied in more than
one way, the highest precedence mechanism is used. The list of mechanisms one way, the highest precedence mechanism is used. The list of mechanisms
is ordered from highest precedence to lowest. Note that not all parameters is ordered from highest precedence to lowest. Note that not all parameters
can be supplied via all methods. The available command line options can be supplied via all methods. The available command line options
and environment variables (and some defaults) are described here and in and environment variables (and some defaults) are described here and in the
the Xserver(@appmansuffix@) manual page. Most configuration file .BR Xserver (@appmansuffix@)
manual page. Most configuration file
parameters, with their defaults, are described in the parameters, with their defaults, are described in the
xorg.conf(@filemansuffix@) manual page. Driver and module specific .BR xorg.conf (@filemansuffix@)
manual page. Driver and module specific
configuration parameters are described in the relevant driver or module configuration parameters are described in the relevant driver or module
manual page. manual page.
.PP .PP
In addition to the normal server options described in the In addition to the normal server options described in the
Xserver(@appmansuffix@) manual page, .BR Xserver (@appmansuffix@)
manual page,
.B Xorg .B Xorg
accepts the following command line switches: accepts the following command line switches:
.TP 8 .TP 8
@ -92,15 +102,17 @@ as Linux, BSD, OpenSolaris, SVR3, and SVR4.
Allow the server to start up even if the mouse device can't be opened Allow the server to start up even if the mouse device can't be opened
or initialised. This is equivalent to the or initialised. This is equivalent to the
.B AllowMouseOpenFail .B AllowMouseOpenFail
xorg.conf(@filemansuffix@) file option. .BR xorg.conf (@filemansuffix@)
file option.
.TP 8 .TP 8
.B \-allowNonLocalXvidtune .B \-allowNonLocalXvidtune
Make the VidMode extension available to remote clients. This allows Make the VidMode extension available to remote clients. This allows
the xvidtune client to connect from another host. This is equivalent the xvidtune client to connect from another host. This is equivalent
to the to the
.B AllowNonLocalXvidtune .B AllowNonLocalXvidtune
xorg.conf(@filemansuffix@) file option. By default non-local .BR xorg.conf (@filemansuffix@)
connections are not allowed. file option.
By default non-local connections are not allowed.
.TP 8 .TP 8
.BI \-bgamma " value" .BI \-bgamma " value"
Set the blue gamma correction. Set the blue gamma correction.
@ -139,10 +151,12 @@ config directory search path for all other users.
When this option is specified, the When this option is specified, the
.B Xorg .B Xorg
server loads all video driver modules, probes for available hardware, server loads all video driver modules, probes for available hardware,
and writes out an initial xorg.conf(@filemansuffix@) file based on and writes out an initial
what was detected. This option currently has some problems on some .BR xorg.conf (@filemansuffix@)
platforms, but in most cases it is a good way to bootstrap the file based on what was detected.
configuration process. This option is only available when the server This option currently has some problems on some platforms,
but in most cases it is a good way to bootstrap the configuration process.
This option is only available when the server
is run as root (i.e, with real-uid 0). is run as root (i.e, with real-uid 0).
.TP 8 .TP 8
.BI "\-crt /dev/tty" XX .BI "\-crt /dev/tty" XX
@ -159,7 +173,8 @@ Disable the parts of the VidMode extension (used by the xvidtune
client) that can be used to change the video modes. This is equivalent client) that can be used to change the video modes. This is equivalent
to the to the
.B DisableVidModeExtension .B DisableVidModeExtension
xorg.conf(@filemansuffix@) file option. .BR xorg.conf (@filemansuffix@)
file option.
.TP 8 .TP 8
.B \-fbbpp \fIn\fP .B \-fbbpp \fIn\fP
Sets the number of framebuffer bits per pixel. You should only set this Sets the number of framebuffer bits per pixel. You should only set this
@ -226,7 +241,9 @@ want to use systemd-logind integration you must specify this option.
Not all platforms support (or can use) this option. Not all platforms support (or can use) this option.
.TP 8 .TP 8
.BI \-keyboard " keyboard-name" .BI \-keyboard " keyboard-name"
Use the xorg.conf(@filemansuffix@) file Use the
.BR xorg.conf (@filemansuffix@)
file
.B InputDevice .B InputDevice
section called section called
.I keyboard-name .I keyboard-name
@ -238,7 +255,9 @@ section and this option, the first relevant
section is used for the core keyboard. section is used for the core keyboard.
.TP 8 .TP 8
.BI \-layout " layout-name" .BI \-layout " layout-name"
Use the xorg.conf(@filemansuffix@) file Use the
.BR xorg.conf (@filemansuffix@)
file
.B Layout .B Layout
section called section called
.IR layout-name . .IR layout-name .
@ -287,7 +306,8 @@ as root (i.e, with real-uid 0).
Disable automatically setting secondary GPUs up as output sinks and offload Disable automatically setting secondary GPUs up as output sinks and offload
sources. This is equivalent to setting the sources. This is equivalent to setting the
.B AutoBindGPU .B AutoBindGPU
xorg.conf(__filemansuffix__) file option. To .BR xorg.conf (@filemansuffix@)
file option. To
.B false. .B false.
.TP 8 .TP 8
.B \-nosilk .B \-nosilk
@ -298,7 +318,9 @@ Disable the automatic switching on X server reset and shutdown to the
VT that was active when the server started, if supported by the OS. VT that was active when the server started, if supported by the OS.
.TP 8 .TP 8
.BI \-pointer " pointer-name" .BI \-pointer " pointer-name"
Use the xorg.conf(@filemansuffix@) file Use the
.BR xorg.conf (@filemansuffix@)
file
.B InputDevice .B InputDevice
section called section called
.I pointer-name .I pointer-name
@ -328,7 +350,9 @@ options.
Share virtual terminals with another X server, if supported by the OS. Share virtual terminals with another X server, if supported by the OS.
.TP 8 .TP 8
.BI \-screen " screen-name" .BI \-screen " screen-name"
Use the xorg.conf(@filemansuffix@) file Use the
.BR xorg.conf (@filemansuffix@)
file
.B Screen .B Screen
section called section called
.IR screen-name . .IR screen-name .
@ -392,7 +416,8 @@ keymap.
Immediately kills the server -- no questions asked. It can be disabled by Immediately kills the server -- no questions asked. It can be disabled by
setting the setting the
.B DontZap .B DontZap
xorg.conf(@filemansuffix@) file option to a TRUE value. .BR xorg.conf (@filemansuffix@)
file option to a TRUE value.
.PP .PP
.RS 8 .RS 8
It should be noted that zapping is triggered by the It should be noted that zapping is triggered by the
@ -406,20 +431,23 @@ but can be enabled with the XKB option
Change video mode to next one specified in the configuration file. Change video mode to next one specified in the configuration file.
This can be disabled with the This can be disabled with the
.B DontZoom .B DontZoom
xorg.conf(@filemansuffix@) file option. .BR xorg.conf (@filemansuffix@)
file option.
.TP 8 .TP 8
.B Ctrl+Alt+Keypad-Minus .B Ctrl+Alt+Keypad-Minus
Change video mode to previous one specified in the configuration file. Change video mode to previous one specified in the configuration file.
This can be disabled with the This can be disabled with the
.B DontZoom .B DontZoom
xorg.conf(@filemansuffix@) file option. .BR xorg.conf (@filemansuffix@)
file option.
.TP 8 .TP 8
.B Ctrl+Alt+F1...F12 .B Ctrl+Alt+F1...F12
For systems with virtual terminal support, these keystroke For systems with virtual terminal support, these keystroke
combinations are used to switch to virtual terminals 1 through 12, combinations are used to switch to virtual terminals 1 through 12,
respectively. This can be disabled with the respectively. This can be disabled with the
.B DontVTSwitch .B DontVTSwitch
xorg.conf(@filemansuffix@) file option. .BR xorg.conf (@filemansuffix@)
file option.
.SH CONFIGURATION .SH CONFIGURATION
.B Xorg .B Xorg
typically uses a configuration file called typically uses a configuration file called
@ -429,8 +457,9 @@ and configuration files with the suffix
in a directory called in a directory called
.B @xconfigdir@ .B @xconfigdir@
for its initial setup. for its initial setup.
Refer to the xorg.conf(@filemansuffix@) manual page for information Refer to the
about the format of this file. .BR xorg.conf (@filemansuffix@)
manual page for information about the format of this file.
.PP .PP
.B Xorg .B Xorg
has a mechanism for automatically generating a built-in configuration has a mechanism for automatically generating a built-in configuration
@ -460,9 +489,11 @@ supported by Xorg. Enhancements are planned for future releases.
.SH FILES .SH FILES
The The
.B Xorg .B Xorg
server config files can be found in a range of locations. These are server config files can be found in a range of locations.
documented fully in the xorg.conf(@filemansuffix@) manual page. The These are documented fully in the
most commonly used locations are shown here. .BR xorg.conf (@filemansuffix@)
manual page.
The most commonly used locations are shown here.
.TP 30 .TP 30
.B /etc/X11/xorg.conf .B /etc/X11/xorg.conf
Server configuration file. Server configuration file.
@ -523,45 +554,49 @@ Manual pages.
Initial access control list for display Initial access control list for display
.IR n . .IR n .
.SH "SEE ALSO" .SH "SEE ALSO"
X(@miscmansuffix@), Xserver(@appmansuffix@), xdm(@appmansuffix@), xinit(@appmansuffix@), .BR X (@miscmansuffix@),
xorg.conf(@filemansuffix@), xvidtune(@appmansuffix@), .BR Xserver (@appmansuffix@),
xkeyboard-config (@miscmansuffix@), .BR xdm (@appmansuffix@),
apm(@drivermansuffix@), .BR xinit (@appmansuffix@),
ati(@drivermansuffix@), .BR xorg.conf (@filemansuffix@),
chips(@drivermansuffix@), .BR xvidtune (@appmansuffix@),
cirrus(@drivermansuffix@), .BR xkeyboard-config (@miscmansuffix@),
cyrix(@drivermansuffix@), .BR apm (@drivermansuffix@),
fbdev(@drivermansuffix@), .BR ati (@drivermansuffix@),
glide(@drivermansuffix@), .BR chips (@drivermansuffix@),
glint(@drivermansuffix@), .BR cirrus (@drivermansuffix@),
i128(@drivermansuffix@), .BR cyrix (@drivermansuffix@),
i740(@drivermansuffix@), .BR fbdev (@drivermansuffix@),
imstt(@drivermansuffix@), .BR glide (@drivermansuffix@),
intel(@drivermansuffix@), .BR glint (@drivermansuffix@),
mga(@drivermansuffix@), .BR i128 (@drivermansuffix@),
neomagic(@drivermansuffix@), .BR i740 (@drivermansuffix@),
nsc(@drivermansuffix@), .BR imstt (@drivermansuffix@),
nv(@drivermansuffix@), .BR intel (@drivermansuffix@),
openchrome (@drivermansuffix@), .BR mga (@drivermansuffix@),
r128(@drivermansuffix@), .BR neomagic (@drivermansuffix@),
rendition(@drivermansuffix@), .BR nsc (@drivermansuffix@),
s3virge(@drivermansuffix@), .BR nv (@drivermansuffix@),
siliconmotion(@drivermansuffix@), .BR openchrome (@drivermansuffix@),
sis(@drivermansuffix@), .BR r128 (@drivermansuffix@),
sunbw2(@drivermansuffix@), .BR rendition (@drivermansuffix@),
suncg14(@drivermansuffix@), .BR s3virge (@drivermansuffix@),
suncg3(@drivermansuffix@), .BR siliconmotion (@drivermansuffix@),
suncg6(@drivermansuffix@), .BR sis (@drivermansuffix@),
sunffb(@drivermansuffix@), .BR sunbw2 (@drivermansuffix@),
sunleo(@drivermansuffix@), .BR suncg14 (@drivermansuffix@),
suntcx(@drivermansuffix@), .BR suncg3 (@drivermansuffix@),
tdfx(@drivermansuffix@), .BR suncg6 (@drivermansuffix@),
tga(@drivermansuffix@), .BR sunffb (@drivermansuffix@),
trident(@drivermansuffix@), .BR sunleo (@drivermansuffix@),
tseng(@drivermansuffix@), .BR suntcx (@drivermansuffix@),
v4l(@drivermansuffix@), .BR tdfx (@drivermansuffix@),
vesa(@drivermansuffix@), .BR tga (@drivermansuffix@),
vmware(@drivermansuffix@), .BR trident (@drivermansuffix@),
.BR tseng (@drivermansuffix@),
.BR v4l (@drivermansuffix@),
.BR vesa (@drivermansuffix@),
.BR vmware (@drivermansuffix@),
.br .br
Web site Web site
.IR <https://www.x.org> . .IR <https://www.x.org> .

3
hw/xfree86/man/Xorg.wrap.man
View File

@ -64,4 +64,5 @@ graphics cards and some are not kms capable auto-detection may fail,
in this case manual configuration should be used. in this case manual configuration should be used.
.SH "SEE ALSO" .SH "SEE ALSO"
Xorg X server information: \fIXorg\fP(1) Xorg X server information:
.BR Xorg (1)

9
hw/xfree86/utils/man/gtf.man
View File

@ -15,9 +15,9 @@ is a utility for calculating VESA GTF modes. Given the desired
horizontal and vertical resolutions and refresh rate (in Hz), the parameters horizontal and vertical resolutions and refresh rate (in Hz), the parameters
for a matching VESA GTF mode are printed out. Two output formats are for a matching VESA GTF mode are printed out. Two output formats are
supported: mode lines suitable for the Xorg supported: mode lines suitable for the Xorg
.B xorg.conf(@filemansuffix@) .BR xorg.conf (@filemansuffix@)
file, and mode parameters suitable for the Linux file, and mode parameters suitable for the Linux
.B fbset(8) .BR fbset (8)
utility. utility.
.SH OPTIONS .SH OPTIONS
@ -32,9 +32,10 @@ default format.
.TP 8 .TP 8
.BR \-f | \-\-fbset .BR \-f | \-\-fbset
Print the mode parameters in a format suitable for Print the mode parameters in a format suitable for
.BR fbset(8) . .BR fbset (8).
.SH "SEE ALSO" .SH "SEE ALSO"
xorg.conf(@filemansuffix@), cvt(@appmansuffix@) .BR xorg.conf (@filemansuffix@),
.BR cvt (@appmansuffix@)
.SH AUTHOR .SH AUTHOR
Andy Ritger. Andy Ritger.
.PP .PP

37
hw/xquartz/man/Xquartz.man
View File

@ -14,7 +14,9 @@ X11 display is the size of the screen and contains all the other
windows. The X11 root window is not displayed in rootless mode as Mac windows. The X11 root window is not displayed in rootless mode as Mac
OS X handles the desktop background. OS X handles the desktop background.
.SH CUSTOMIZATION .SH CUSTOMIZATION
\fIXquartz\fP can be customized using the defaults(1) command. The available options are: \fIXquartz\fP can be customized using the
.BR defaults (1)
command. The available options are:
.TP 8 .TP 8
.B defaults write @bundle_id_prefix@.X11 enable_fake_buttons -boolean true .B defaults write @bundle_id_prefix@.X11 enable_fake_buttons -boolean true
Emulates a 3 button mouse using modifier keys. By default, the Command modifier Emulates a 3 button mouse using modifier keys. By default, the Command modifier
@ -43,11 +45,13 @@ Disables the alert dialog displayed when attempting to quit X11.
.TP 8 .TP 8
.B defaults write @bundle_id_prefix@.X11 no_auth -boolean true .B defaults write @bundle_id_prefix@.X11 no_auth -boolean true
Stops the X server requiring that clients authenticate themselves when Stops the X server requiring that clients authenticate themselves when
connecting. See Xsecurity(@miscmansuffix@). connecting. See
.BR Xsecurity (@miscmansuffix@).
.TP 8 .TP 8
.B defaults write @bundle_id_prefix@.X11 nolisten_tcp -boolean false .B defaults write @bundle_id_prefix@.X11 nolisten_tcp -boolean false
This will tell the server to listen and accept TCP connections. Doing this without enabling This will tell the server to listen and accept TCP connections.
xauth is a possible security concern. See Xsecurity(@miscmansuffix@). Doing this without enabling xauth is a possible security concern. See
.BR Xsecurity (@miscmansuffix@).
.TP 8 .TP 8
.B defaults write @bundle_id_prefix@.X11 enable_system_beep -boolean false .B defaults write @bundle_id_prefix@.X11 enable_system_beep -boolean false
Don't use the standard system beep effect for X11 alerts. Don't use the standard system beep effect for X11 alerts.
@ -88,7 +92,8 @@ This option defaults to false and is only accessible through the command line.
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. 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.
.SH OPTIONS .SH OPTIONS
.PP .PP
In addition to the normal server options described in the \fIXserver(1)\fP In addition to the normal server options described in the
.BR Xserver (1)
manual page, \fIXquartz\fP accepts the following command line switches: manual page, \fIXquartz\fP accepts the following command line switches:
.TP 8 .TP 8
.B \-fakebuttons .B \-fakebuttons
@ -110,9 +115,14 @@ XQuartz stores a server log at ~/Library/Logs/X11.@bundle_id_prefix@.log which
is analogous to /var/log/Xorg.#.log on systems that use the XFree86 DDX such as is analogous to /var/log/Xorg.#.log on systems that use the XFree86 DDX such as
Linux, BSD, and Solaris. Linux, BSD, and Solaris.
.PP .PP
In addition to this server log, XQuartz sends messages to syslogd(8) using In addition to this server log, XQuartz sends messages to
asl(3). These logs are sent to the @bundle_id_prefix@ facility, and you can .BR syslogd (8)
watch these logs using the following syslog(1) command: using
.BR asl (3).
These logs are sent to the @bundle_id_prefix@ facility, and you can
watch these logs using the following
.BR syslog (1)
command:
.TP 8 .TP 8
.B $ syslog -w -k Facility eq @bundle_id_prefix@ .B $ syslog -w -k Facility eq @bundle_id_prefix@
.PP .PP
@ -123,7 +133,9 @@ or you can include extra information such as the file, line, and function where
By default, XQuartz sets an ASL mask which prevents it from logging messages By default, XQuartz sets an ASL mask which prevents it from logging messages
below the ASL_LEVEL_WARNING level (meaning almost all logging is done strictly below the ASL_LEVEL_WARNING level (meaning almost all logging is done strictly
to the file referenced above). To force XQuartz to send all log messages to to the file referenced above). To force XQuartz to send all log messages to
syslogd(8), you can adjust this mask using the following syslog(1) command: .BR syslogd (8), you can adjust this mask using the following
.BR syslog (1)
command:
.TP 8 .TP 8
.B $ syslog -c X11.bin -d .B $ syslog -c X11.bin -d
.PP .PP
@ -134,7 +146,12 @@ you will need to adjust XQuartz's asl mask as above but using -i or -n
instead of -d. instead of -d.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
X(@miscmansuffix@), Xserver(1), xdm(1), xinit(1), syslog(1), syslogd(8) .BR X (@miscmansuffix@),
.BR Xserver (1),
.BR xdm (1),
.BR xinit (1),
.BR syslog (1),
.BR syslogd (8)
.PP .PP
https://www.xquartz.org/ https://www.xquartz.org/
.PP .PP

8
hw/xwayland/man/Xwayland.man
View File

@ -43,7 +43,9 @@ of the Wayland desktop. It is however possible for a user to launch Xwayland
non-rootless, mainly for testing purposes. non-rootless, mainly for testing purposes.
.PP .PP
Like all of the X servers, \fIXwayland\fP accepts the command line options Like all of the X servers, \fIXwayland\fP accepts the command line options
described in the \fIXserver\fP(@miscmansuffix@) manual page. described in the
.BR Xserver (@miscmansuffix@)
manual page.
The following additional arguments are supported as well. The following additional arguments are supported as well.
.TP 8 .TP 8
.B \-decorate .B \-decorate
@ -176,4 +178,6 @@ the name of the display of the Wayland server.
.B XWAYLAND_NO_GLAMOR .B XWAYLAND_NO_GLAMOR
disable glamor and DRI3 support in \fIXwayland\fP, for testing purposes. disable glamor and DRI3 support in \fIXwayland\fP, for testing purposes.
.SH "SEE ALSO" .SH "SEE ALSO"
General information: \fIX\fP(@miscmansuffix@), \fIwayland-info\fP(@miscmansuffix@) General information:
.BR X (@miscmansuffix@),
.BR wayland-info (@miscmansuffix@)

46
hw/xwin/man/XWin.man
View File

@ -31,7 +31,8 @@ containing the whole screen but this root window (traditionally covered with an
pattern) is hidden from view, so only top-level X windows are seen. pattern) is hidden from view, so only top-level X windows are seen.
.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
.BR Xserver (1)
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:
@ -110,7 +111,8 @@ Currently \fB\-fullscreen\fP may only be applied to one X screen.
.TP 8 .TP 8
.B "\-icon" \fIicon-specifier\fP .B "\-icon" \fIicon-specifier\fP
Override the window icon for the screen window from the default. Override the window icon for the screen window from the default.
The \fIicon-specifier\fP is as defined in \fIXWinrc(@filemansuffix@)\fP. The \fIicon-specifier\fP is as defined in
.BR XWinrc (@filemansuffix@).
.TP 8 .TP 8
.B \-nodecoration .B \-nodecoration
Do not give the Cygwin/X window a \fIWindows\fP window border, title bar, Do not give the Cygwin/X window a \fIWindows\fP window border, title bar,
@ -292,8 +294,9 @@ fullscreen with a DirectDraw engine. This parameter is ignored if
\fB\-fullscreen\fP is not specified. \fB\-fullscreen\fP is not specified.
.SH MISCELLANEOUS OPTIONS .SH MISCELLANEOUS OPTIONS
See also the normal server options described in the \fIXserver(1)\fP See also the normal server options described in the
manual page .BR Xserver (1)
manual page.
.TP 8 .TP 8
.B \-help .B \-help
@ -328,21 +331,27 @@ values will yield a still more detailed debug output.
.TP 8 .TP 8
.B "\-xkbvariant \fIvariant\fp" .B "\-xkbvariant \fIvariant\fp"
These options configure the xkeyboard extension to load These options configure the xkeyboard extension to load
a particular keyboard map as the X server starts. The behavior is similar a particular keyboard map as the X server starts.
to the \fIsetxkbmap\fP(1) program. The behavior is similar to the
.BR setxkbmap (1)
program.
See the \fIxkeyboard-config\fP(@miscmansuffix@) manual page for a list of See the
keyboard configurations. .BR xkeyboard\-config (@miscmansuffix@)
manual page for a list of keyboard configurations.
The keyboard layout data is located at \fI@datadir@/X11/xkb/\fP. Additional information The keyboard layout data is located at \fI@datadir@/X11/xkb/\fP.
can be found in the README files there and in the \fIsetxkbmap\fP(1) manual page. Additional information can be found in the README files there and in the
.BR setxkbmap (1)
manual page.
For example, in order to load a German layout for a pc105 keyboard, use the options: For example, in order to load a German layout for a pc105 keyboard, use the options:
.br .br
.I " \-xkblayout de \-xkbmodel pc105" .I " \-xkblayout de \-xkbmodel pc105"
Alternatively, you can use the \fIsetxkbmap\fP(1) program after \fIXWin\fP is Alternatively, you can use the
running. .BR setxkbmap (1)
program after \fIXWin\fP is running.
The default is to select a keyboard configuration matching your current layout as The default is to select a keyboard configuration matching your current layout as
reported by \fIWindows\fP, if known, or the default X server configuration reported by \fIWindows\fP, if known, or the default X server configuration
@ -387,15 +396,22 @@ window, in both the generic case and for particular programs.
* To change the style that is associated to the \fIWindows\fP window that * To change the style that is associated to the \fIWindows\fP window that
\fXWin I-multiwindow\fP produces for each top-level X window. \fXWin I-multiwindow\fP produces for each top-level X window.
.PP .PP
The format of the \fI.XWinrc\fP file is given in the XWinrc(5) manual page. The format of the \fI.XWinrc\fP file is given in the
.BR XWinrc (5)
manual page.
.SH EXAMPLES .SH EXAMPLES
Need some examples Need some examples
.SH "SEE ALSO" .SH "SEE ALSO"
X(@miscmansuffix@), Xserver(1), xdm(1), xinit(1), XWinrc(@filemansuffix@), .BR X (@miscmansuffix@),
setxkbmap(1), xkeyboard-config(@miscmansuffix@). .BR Xserver (1),
.BR xdm (1),
.BR xinit (1),
.BR XWinrc (@filemansuffix@),
.BR setxkbmap (1),
.BR xkeyboard-config (@miscmansuffix@).
.SH BUGS .SH BUGS

9
hw/xwin/man/XWinrc.man
View File

@ -7,9 +7,10 @@ XWinrc\- XWin Server Resource Configuration File.
.SH DESCRIPTION .SH DESCRIPTION
The X Server for the X Window System on the Cygwin/X environment The X Server for the X Window System on the Cygwin/X environment
running on Microsoft Windows, \fIXWin\fP can be optionally configured running on Microsoft Windows,
with the \fIXWinrc\fP file. A system-wide configuration file should .BR XWin (1)
be placed in \fI can be optionally configured with the \fIXWinrc\fP file.
A system-wide configuration file should be placed in \fI
@sysconfdir@/X11/system.XWinrc\fP, a per-user file @sysconfdir@/X11/system.XWinrc\fP, a per-user file
should be put at \fI$HOME/.XWinrc\fP. The \fIsystem.XWinrc\fP file is should be put at \fI$HOME/.XWinrc\fP. The \fIsystem.XWinrc\fP file is
read only if no \fI$HOME/.XWinrc\fP exist. read only if no \fI$HOME/.XWinrc\fP exist.
@ -248,7 +249,7 @@ This example makes an oclock window frameless in \fI-multiwindow\fP mode
.SH "SEE ALSO" .SH "SEE ALSO"
XWin(1) .BR XWin (1)
.SH AUTHOR .SH AUTHOR

16
hw/xwin/winclipboard/xwinclip.man
View File

@ -17,8 +17,14 @@ It also monitors the contents of the Windows clipboard for changes, taking owner
CLIPBOARD selections, and making the contents of the Windows clipboard available in them. CLIPBOARD selections, and making the contents of the Windows clipboard available in them.
.B Note well: .B Note well:
The \fIXWin(1)\fP X server has internal clipboard integration that is enabled by default. The
Do \fINOT\fP run \fIxwinclip\fP unless \fIXWin(1)\fP has been started with the -noclipboard option. .BR XWin (1)
X server has internal clipboard integration that is enabled by default.
Do \fINOT\fP run \fIxwinclip\fP unless
.BR XWin (1)
has been started with the
.B -noclipboard
option.
.SH OPTIONS .SH OPTIONS
\fIxwinclip\fP accepts the following optional command line switches: \fIxwinclip\fP accepts the following optional command line switches:
@ -31,7 +37,7 @@ Specifies the X server display to connect to.
Do not monitor the PRIMARY selection. Do not monitor the PRIMARY selection.
.SH "SEE ALSO" .SH "SEE ALSO"
XWin(1) .BR XWin (1)
.SH BUGS .SH BUGS
Only text clipboard contents are supported. Only text clipboard contents are supported.
@ -49,7 +55,9 @@ client which owns the selection to convert the selection to our requested format
using a fixed timeout. After requesting conversion of the selection, if no events are received from the X using a fixed timeout. After requesting conversion of the selection, if no events are received from the X
client which owns the selection for one second, the conversion is assumed to have failed. client which owns the selection for one second, the conversion is assumed to have failed.
The XWin(1) server should indicate somehow (by placing an atom on the root window?) that it is running with its The
.BR XWin (1)
server should indicate somehow (by placing an atom on the root window?) that it is running with its
internal clipboard integration enabled, and xwinclip should notice this and exit with an appropriate error. internal clipboard integration enabled, and xwinclip should notice this and exit with an appropriate error.
Probably many other bugs. Probably many other bugs.

100
man/Xserver.man
View File

@ -39,13 +39,15 @@ frequently a link or a copy of the appropriate server binary for
driving the most frequently used server on a given machine. driving the most frequently used server on a given machine.
.SH "STARTING THE SERVER" .SH "STARTING THE SERVER"
The X server is usually started from the X Display Manager program The X server is usually started from the X Display Manager program
\fIxdm\fP(1) or a similar display manager program. .BR xdm (1)
or a similar display manager program.
This utility is run from the system boot files and takes care of keeping This utility is run from the system boot files and takes care of keeping
the server running, prompting for usernames and passwords, and starting up the server running, prompting for usernames and passwords, and starting up
the user sessions. the user sessions.
.PP .PP
Installations that run more than one window system may need to use the Installations that run more than one window system may need to use the
\fIxinit\fP(1) utility instead of a display manager. However, \fIxinit\fP is .BR xinit (1)
utility instead of a display manager. However, \fIxinit\fP is
to be considered a tool for building startup scripts and is not to be considered a tool for building startup scripts and is not
intended for use by end users. Site administrators are \fBstrongly\fP intended for use by end users. Site administrators are \fBstrongly\fP
urged to use a display manager, or build other interfaces for novice users. urged to use a display manager, or build other interfaces for novice users.
@ -73,8 +75,10 @@ should override values specified via other mechanisms.
.B :\fIdisplaynumber\fP .B :\fIdisplaynumber\fP
The X server runs as the given \fIdisplaynumber\fP, which by default is 0. The X server runs as the given \fIdisplaynumber\fP, which by default is 0.
If multiple X servers are to run simultaneously on a host, each must have If multiple X servers are to run simultaneously on a host, each must have
a unique display number. See the DISPLAY a unique display number.
NAMES section of the \fIX\fP(@miscmansuffix@) manual page to learn how to See the DISPLAY NAMES section of the
.BR X (@miscmansuffix@)
manual page to learn how to
specify which display number clients should try to use. specify which display number clients should try to use.
.TP 8 .TP 8
.B \-a \fInumber\fP .B \-a \fInumber\fP
@ -98,8 +102,12 @@ Audit lines are sent as standard error output.
.TP 8 .TP 8
.B \-auth \fIauthorization-file\fP .B \-auth \fIauthorization-file\fP
specifies a file which contains a collection of authorization records used specifies a file which contains a collection of authorization records used
to authenticate access. See also the \fIxdm\fP(1) and to authenticate access.
\fIXsecurity\fP(@miscmansuffix@) manual pages. See also the
.BR xdm (1)
and
.BR Xsecurity (@miscmansuffix@)
manual pages.
.TP 8 .TP 8
.B \-background none .B \-background none
Asks the driver not to clear the background on startup, Asks the driver not to clear the background on startup,
@ -446,15 +454,17 @@ loads keyboard description in \fIfilename\fP on server startup.
.SH "NETWORK CONNECTIONS" .SH "NETWORK CONNECTIONS"
The X server supports client connections via a platform-dependent subset of The X server supports client connections via a platform-dependent subset of
the following transport types: TCP/IP, Unix Domain sockets, the following transport types: TCP/IP, Unix Domain sockets,
and several varieties of SVR4 local connections. See the DISPLAY and several varieties of SVR4 local connections.
NAMES section of the \fIX\fP(@miscmansuffix@) manual page to learn how to See the DISPLAY NAMES section of the
.BR X (@miscmansuffix@)
manual page to learn how to
specify which transport type clients should try to use. specify which transport type clients should try to use.
.SH GRANTING ACCESS .SH GRANTING ACCESS
The X server implements a platform-dependent subset of the following The X server implements a platform-dependent subset of the following
authorization protocols: MIT-MAGIC-COOKIE-1, XDM-AUTHORIZATION-1, authorization protocols: MIT-MAGIC-COOKIE-1, XDM-AUTHORIZATION-1,
XDM-AUTHORIZATION-2, SUN-DES-1, and MIT-KERBEROS-5. See the XDM-AUTHORIZATION-2, SUN-DES-1, and MIT-KERBEROS-5. See the
\fIXsecurity\fP(@miscmansuffix@) manual page for information on the .BR Xsecurity (@miscmansuffix@)
operation of these protocols. manual page for information on the operation of these protocols.
.PP .PP
Authorization data required by the above protocols is passed to the Authorization data required by the above protocols is passed to the
server in a private file named with the \fB\-auth\fP command line server in a private file named with the \fB\-auth\fP command line
@ -464,9 +474,10 @@ If this file contains any authorization records, the local host is not
automatically allowed access to the server, and only clients which automatically allowed access to the server, and only clients which
send one of the authorization records contained in the file in the send one of the authorization records contained in the file in the
connection setup information will be allowed access. See the connection setup information will be allowed access. See the
\fIXau\fP manual page for a description of the binary format of this .BR Xau (3)
file. See \fIxauth\fP(1) for maintenance of this file, and distribution manual page for a description of the binary format of this file. See
of its contents to remote hosts. .BR xauth (1)
for maintenance of this file, and distribution of its contents to remote hosts.
.PP .PP
The X server also uses a host-based access control list for deciding The X server also uses a host-based access control list for deciding
whether or not to accept connections from clients on a particular machine. whether or not to accept connections from clients on a particular machine.
@ -476,7 +487,9 @@ well as any machines listed in the file \fI/etc/X\fBn\fI.hosts\fR, where
\fBn\fP is the display number of the server. Each line of the file should \fBn\fP is the display number of the server. Each line of the file should
contain either an Internet hostname (e.g., expo.lcs.mit.edu) contain either an Internet hostname (e.g., expo.lcs.mit.edu)
or a complete name in the format or a complete name in the format
\fIfamily\fP:\fIname\fP as described in the \fIxhost\fP(1) manual page. \fIfamily\fP:\fIname\fP as described in the
.BR xhost (1)
manual page.
There should be no leading or trailing spaces on any lines. For example: There should be no leading or trailing spaces on any lines. For example:
.sp .sp
.in +8 .in +8
@ -495,8 +508,9 @@ The X protocol intrinsically does not have any notion of window operation
permissions or place any restrictions on what a client can do; if a program can permissions or place any restrictions on what a client can do; if a program can
connect to a display, it has full run of the screen. connect to a display, it has full run of the screen.
X servers that support the SECURITY extension fare better because clients X servers that support the SECURITY extension fare better because clients
can be designated untrusted via the authorization they use to connect; see can be designated untrusted via the authorization they use to connect; see the
the \fIxauth\fP(1) manual page for details. Restrictions are imposed .BR xauth (1)
manual page for details. Restrictions are imposed
on untrusted clients that curtail the mischief they can do. See the SECURITY on untrusted clients that curtail the mischief they can do. See the SECURITY
extension specification for a complete list of these restrictions. extension specification for a complete list of these restrictions.
.PP .PP
@ -537,7 +551,8 @@ A special kind of directory can be specified using the \fBcatalogue\fP:
prefix. Directories specified this way can contain symlinks pointing to the prefix. Directories specified this way can contain symlinks pointing to the
real font directories. See the FONTPATH.D section for details. real font directories. See the FONTPATH.D section for details.
.LP .LP
The font path can be set with the \fB\-fp\fP option or by \fIxset\fP(1) The font path can be set with the \fB\-fp\fP option or by
.BR xset (1)
after the server has started. after the server has started.
.SH "FONTPATH.D" .SH "FONTPATH.D"
You can specify a special kind of font path in the form \fBcatalogue:<dir>\fR. You can specify a special kind of font path in the form \fBcatalogue:<dir>\fR.
@ -587,36 +602,61 @@ Outline font directories
Unix domain socket for display number \fBn\fP Unix domain socket for display number \fBn\fP
.TP 30 .TP 30
.I /usr/adm/X\fBn\fPmsgs .I /usr/adm/X\fBn\fPmsgs
Error log file for display number \fBn\fP if run from \fIinit\fP(@adminmansuffix@) Error log file for display number \fBn\fP if run from
.BR init (@adminmansuffix@)
.TP 30 .TP 30
.I @projectroot@/lib/X11/xdm/xdm\-errors .I @projectroot@/lib/X11/xdm/xdm\-errors
Default error log file if the server is run from \fIxdm\fP(1) Default error log file if the server is run from
.BR xdm (1)
.SH "SEE ALSO" .SH "SEE ALSO"
General information: \fIX\fP(@miscmansuffix@) General information:
.BR X (@miscmansuffix@)
.PP .PP
Protocols: Protocols:
.I "X Window System Protocol," .I "X Window System Protocol,"
.I "The X Font Service Protocol," .I "The X Font Service Protocol,"
.I "X Display Manager Control Protocol" .I "X Display Manager Control Protocol"
.PP .PP
Fonts: \fIbdftopcf\fP(1), \fImkfontdir\fP(1), \fImkfontscale\fP(1), Fonts:
\fIxfs\fP(1), \fIxlsfonts\fP(1), \fIxfontsel\fP(1), \fIxfd\fP(1), .BR bdftopcf (1),
.BR mkfontdir (1),
.BR mkfontscale (1),
.BR xfs (1),
.BR xlsfonts (1),
.BR xfontsel (1),
.BR xfd (1),
.I "X Logical Font Description Conventions" .I "X Logical Font Description Conventions"
.PP .PP
Keyboards: \fIxkeyboard\-config\fP(@miscmansuffix@) Keyboards:
.BR xkeyboard\-config (@miscmansuffix@)
.PP .PP
Security: \fIXsecurity\fP(@miscmansuffix@), \fIxauth\fP(1), \fIXau\fP(1), Security:
\fIxdm\fP(1), \fIxhost\fP(1) .BR Xsecurity (@miscmansuffix@),
.BR xauth (1),
.BR Xau (3),
.BR xdm (1),
.BR xhost (1),
.I "Security Extension Specification" .I "Security Extension Specification"
.PP .PP
Starting the server: \fIstartx\fP(1), \fIxdm\fP(1), \fIxinit\fP(1) Starting the server:
.BR startx (1),
.BR xdm (1),
.BR xinit (1)
.PP .PP
Controlling the server once started: \fIxset\fP(1), \fIxsetroot\fP(1), Controlling the server once started:
\fIxhost\fP(1), \fIxinput\fP(1), \fIxrandr\fP(1) .BR xset (1),
.BR xsetroot (1),
.BR xhost (1),
.BR xinput (1),
.BR xrandr (1)
.PP .PP
Server-specific man pages: Server-specific man pages:
\fIXorg\fP(1), \fIXephyr\fP(1), \fIXnest\fP(1), .BR Xorg (1),
\fIXvfb\fP(1), \fIXquartz\fP(1), \fIXWin\fP(1). .BR Xephyr (1),
.BR Xnest (1),
.BR Xvfb (1),
.BR Xquartz (1),
.BR XWin (1).
.PP .PP
Server internal documentation: Server internal documentation:
.I "Definition of the Porting Layer for the X v11 Sample Server" .I "Definition of the Porting Layer for the X v11 Sample Server"