xephyr(1)

NAME

Xephyr - X server outputting to a window on a pre-existing X display

SYNOPSIS

Xephyr [:display] [option R ... ]

DESCRIPTION

Xephyr is a kdrive server that outputs to a window on a pre-existing "host" X display. Think Xnest but with support for modern extensions like composite, damage and randr.

Unlike Xnest which is an X proxy, i.e. limited to the capabilities of the host X server, Xephyr is a real X server which uses the host X server window as "framebuffer" via fast SHM XImages.

It also has support for "visually" debugging what the server is
painting.

OPTIONS

-a# Mouse acceleration (pixels)

-ac Disable access control restrictions

-audit int: Set audit trail level
-auth file: Select authorization file
-br Create root window with black background
+bs Enable any backing store support
-bs Disable any backing store support
-c Turns off key-click
c# Key-click volume (0-100)
-ccint Default color visual class
-core Generate core dump on fatal error
-dpiint: Screen resolution in dots per inch
dpms Enables VESA DPMS monitor control
-dpms Disables VESA DPMS monitor control
-deferglyphs[none|all|16]: Defer loading of [no|all|16-bit] glyphs
-f# Bell base (0-100)
-fc <string>: Cursor font
-fn <string>: Default font name
-fp <string>: Default font path
-help Prints message with these options
-I Ignore all remaining arguments
-ldint Limit data space to N Kb
-lfint Limit number of open files to N
-lsint Limit stack space to N Kb
-logo Enable logo in screen saver
nologo Disable logo in screen saver
-nolistenstring: Do not listen on protocol
-noreset: Do not reset after last client exists
-reset Reset after last client exists
-p# Screen-saver pattern duration (minutes)
-pn Accept failure to listen on all ports
-nopn Reject failure to listen on all ports
-r Turns off auto-repeat
r Turns on auto-repeat
-render[default|mono|gray|color]: Set render color alloc policy
-retro Start with classic stipple and cursor
-s# Screen-saver timeout (minutes)
-t# Mouse threshold (pixels)
-terminate: Terminate at server reset
-to# Connection time out
-tst Disable testing extensions
ttyxx Server started from init on /dev/ttyxx
v Video blanking for screen-saver
-v Screen-saver without video blanking
-wm WhenMapped default backing-store
-wr Create root window with white background
-xstring: Loads named extension at init time
-maxbigreqsize: Set maximal bigrequest size
+xinerama: Enable XINERAMA extension
-xinerama: Disable XINERAMA extension
-dumbSched: Disable smart scheduling, enable old behavior
-schedIntervalint: Set scheduler interval in msec
+extensionname: Enable extension
-extensionname: Disable extension
-queryhost-name: Contact named host for XDMCP
-broadcast: Broadcast for XDMCP
-multicast[addr[hops]]: IPv6 multicast for XDMCP
-indirect <host-name>: Contact named host for indirect XDMCP
-portport-num: UDP port number to send messages to
-fromlocal-address: Specify the local address to connect from
-once Terminate server after one session
-classdisplay-class: Specify display class to send in manage
-cookiexdm-auth-bits: Specify the magic cookie for XDMCP
-displayIDdisplay-id: Manufacturer display ID for request
-kb Disable the X Keyboard Extension
+kb Enable the X Keyboard Extension
[+-]accessx[timeout[timeout_mask[feedback[options_mask]]]]: Enable/disable accessx key sequences
-ardelay: Set XKB autorepeat delay
-arinterval: Set XKB autorepeat interval

TINYX DEVICE DEPENDENT USAGE

-cardpcmcia: Use PCMCIA card as additional screen
-screen WIDTH[/WIDTHMM]xHEIGHT[/HEIGHTMM][@ROTATION][X][Y]: [xDEPTH/BPP{,DEPTH/BPP}[xFREQ]]
Specify screen characteristics
-rgbargb/bgr/vrgb/vbgr/none: Specify subpixel ordering for LCD panels
-mousedriver[,n,,options]: Specify the pointer driver and its options (n is the number of buttons)
-keybddriver[,,options]: Specify the keyboard driver and its options
-zaphod: Disable cursor screen switching
-2button: Emulate 3 button mouse
-3button: Disable 3 button mouse emulation
-rawcoord: Do not transform pointer coordinates on rotation
-dumb Disable hardware acceleration
-softCursor: Force software cursor
-videoTest: Start the server, pause momentarily and exit
-origin X,Y: Locates the next screen in the the virtual screen (Xinerama)
-switchCmd: Command to execute on vt switch
-zap Terminate server on Ctrl+Alt+Backspace
vtxx Use virtual terminal xx instead of the next available

XEPHYR OPTION USAGE

-parent <XID>: Use existing window as Xephyr root win
-host-cursor: Re-use exisiting X host server cursor
-fullscreen: Attempt to run Xephyr fullscreen
-grayscale: Simulate 8bit grayscale
-fakexa: Simulate acceleration using software rendering
-verbosity <level>: Set log verbosity level
-nodri Do not use DRI
-noxv Do not use XV
-name [name]: Define the name in the WM_CLASS property

SIGNALS

Send a SIGUSR1 to the server (e.g. pkill -USR1 Xephyr) to toggle the debugging mode. In this mode red rectangles are painted to screen areas getting painted before painting the actual content. The delay between this can be altered by setting a XEPHYR_PAUSE env var to a value in micro seconds.

CAVEATS

Rotated displays are currently updated via full blits. This is slower than a normal orientated display. Debug mode will therefore not be of much use rotated.

The -host-cursor cursor is static in its appearance.

The build gets a warning about nanosleep. I think the various -D build flags are causing this. I have not figured as yet how to work round it. It does not appear to break anything however.

Keyboard handling is basic but works.

Mouse button 5 probably wont work.

AUTHOR

Xephyr was written by Matthew Allum <mallum@o-hand.com> 2004.

This man page was written by Charlie Smotherman for Matthew Allum and the Debian project.

docs.sk

comprehensive documentation repository

See also