summaryrefslogtreecommitdiffstats
path: root/x11vnc/x11vnc.1
diff options
context:
space:
mode:
authorrunge <runge>2005-04-10 04:30:48 +0000
committerrunge <runge>2005-04-10 04:30:48 +0000
commitbaee5e2b3a00993fee00dca9d4e560f904693a6c (patch)
tree7cea15f636074f4d81fd100f6f37cc25750f3211 /x11vnc/x11vnc.1
parentac01f36ce0e2630db608537641b0335b249fea3c (diff)
downloadlibtdevnc-baee5e2b3a00993fee00dca9d4e560f904693a6c.tar.gz
libtdevnc-baee5e2b3a00993fee00dca9d4e560f904693a6c.zip
x11vnc: -rawfb, -pipeinput, -xtrap, -flag, ...
Diffstat (limited to 'x11vnc/x11vnc.1')
-rw-r--r--x11vnc/x11vnc.1149
1 files changed, 115 insertions, 34 deletions
diff --git a/x11vnc/x11vnc.1 b/x11vnc/x11vnc.1
index e1d4cf8..08f253e 100644
--- a/x11vnc/x11vnc.1
+++ b/x11vnc/x11vnc.1
@@ -2,7 +2,7 @@
.TH X11VNC "1" "April 2005" "x11vnc " "User Commands"
.SH NAME
x11vnc - allow VNC connections to real X11 displays
- version: 0.7.2pre, lastmod: 2005-04-03
+ version: 0.7.2pre, lastmod: 2005-04-10
.SH SYNOPSIS
.B x11vnc
[OPTION]...
@@ -180,16 +180,18 @@ is taken as a floating point number, alternatively
the notation "m/n" may be used to denote fractions
exactly, e.g. \fB-scale\fR 2/3
.IP
-Scaling Options: can be added after \fIfraction\fR via
-":", to supply multiple ":" options use commas.
-If you just want a quick, rough scaling without
-blending, append ":nb" to \fIfraction\fR (e.g. \fB-scale\fR
-1/3:nb). For compatibility with vncviewers the scaled
-width is adjusted to be a multiple of 4: to disable
-this use ":n4". More esoteric options: ":in" use
-interpolation scheme even when shrinking, ":pad",
-pad scaled width and height to be multiples of scaling
-denominator (e.g. 3 for 2/3).
+Scaling Options: can be added after \fIfraction\fR
+via ":", to supply multiple ":" options use
+commas. If you just want a quick, rough scaling
+without blending, append ":nb" to \fIfraction\fR
+(e.g. \fB-scale\fR 1/3:nb). No blending is the default
+for 8bpp indexed color, to force blending for this
+case use ":fb". For compatibility with vncviewers
+the scaled width is adjusted to be a multiple of 4:
+to disable this use ":n4". More esoteric options:
+":in" use interpolation scheme even when shrinking,
+":pad", pad scaled width and height to be multiples
+of scaling denominator (e.g. 3 for 2/3).
.PP
\fB-scale_cursor\fR \fIfrac\fR
.IP
@@ -564,6 +566,15 @@ areas to black out (if your system has libXinerama).
In general on XINERAMA displays you may need to use the
\fB-xwarppointer\fR option if the mouse pointer misbehaves.
.PP
+\fB-xtrap\fR
+.IP
+Use the DEC-XTRAP extension for keystroke and mouse
+input insertion. For use on legacy systems, e.g. X11R5,
+running an incomplete or missing XTEST extension.
+By default DEC-XTRAP will be used if XTEST server grab
+control is missing, use \fB-xtrap\fR to do the keystroke and
+mouse insertion via DEC-XTRAP as well.
+.PP
\fB-xrandr\fR \fI[mode]\fR
.IP
If the display supports the XRANDR (X Resize, Rotate
@@ -613,6 +624,12 @@ Write stderr messages to file \fIlogfile\fR instead of
to the terminal. Same as "\fB-logfile\fR \fIfile\fR". To append
to the file use "\fB-oa\fR \fIfile\fR" or "\fB-logappend\fR \fIfile\fR".
.PP
+\fB-flag\fR \fIfile\fR
+.IP
+Write the "PORT=NNNN" (e.g. PORT=5900) string to
+\fIfile\fR in addition to stdout. This option could be
+useful by wrapper script to detect when x11vnc is ready.
+.PP
\fB-rc\fR \fIfilename\fR
.IP
Use \fIfilename\fR instead of $HOME/.x11vncrc for rc file.
@@ -1142,6 +1159,64 @@ this mode is very wasteful of memory I/O resources
It may be of use in video capture-like applications,
or where window tearing is a problem.
.PP
+\fB-rawfb\fR \fIstring\fR
+.IP
+Experimental option, instead of polling X, poll the
+memory object specified in \fIstring\fR. For shared
+memory segments it is of the form: "shm:N@WxHxB"
+which specifies a shmid N and framebuffer width, height,
+and bits per pixel. To memory map
+.IR mmap (2)
+a file use:
+"map:/path/to/a/file@WxHxB". If there is trouble
+with mmap, use "file:/..." for slower
+.IR lseek (2)
+based
+reading.
+.IP
+Optional suffixes are ":R/G/B" and "+O" to specify
+red, green, and blue masks and an offset into the
+memory object. If the masks are not provided x11vnc
+guesses them based on the bpp.
+.IP
+Examples:
+\fB-rawfb\fR shm:210337933@800x600x32:ff/ff00/ff0000
+\fB-rawfb\fR map:/dev/fb0@1024x768x32
+\fB-rawfb\fR map:/tmp/Xvfb_screen0@640x480x8+3232
+\fB-rawfb\fR file:/tmp/my.pnm@250x200x24+37
+.IP
+(see
+.IR ipcs (1)
+and
+.IR fbset (1)
+for the first two examples)
+.IP
+All user input is discarded. Most of the X11 (screen,
+keyboard, mouse) options do not make sense and many
+will cause this mode to crash, so please think twice
+before setting/changing them. If you don't want x11vnc
+to close the DISPLAY in rawfb mode, then capitalize
+the prefix, SHM:, MAP: etc. Keeping the display open
+enables defautl remote control channel.
+.PP
+\fB-pipeinput\fR \fIcmd\fR
+.IP
+Another experimental option: it lets you supply an
+extern command in \fIcmd\fR that x11vnc will pipe all of
+the user input events to in a simple format. By default
+x11vnc will not process any of the user input events.
+If you prefix \fIcmd\fR with "tee:" it will both send
+them to the pipe command and process them. For a
+description of the format run "\fB-pipeinput\fR \fItee:cat\fR".
+Another prefix is "reopen" which means to reopen pipe
+if it exits. Separate multiple prefixes with commas.
+.IP
+In combination with \fB-rawfb\fR one might be able to
+do amusing things (e.g. control non-X devices).
+To facilitate this, if \fB-rawfb\fR is in effect then the
+value is stored in X11VNC_RAWFB_STR for the pipe command
+to use if it wants. Do 'env | grep X11VNC' for more.
+.PP
\fB-gui\fR \fI[gui-opts]\fR
.IP
Start up a simple tcl/tk gui based on the the remote
@@ -1373,6 +1448,10 @@ xinerama enable \fB-xinerama\fR mode. (if applicable)
.IP
noxinerama disable \fB-xinerama\fR mode.
.IP
+xtrap enable \fB-xtrap\fR input mode.
+.IP
+noxtrap disable \fB-xtrap\fR input mode.
+.IP
xrandr enable \fB-xrandr\fR mode. (if applicable)
.IP
noxrandr disable \fB-xrandr\fR mode.
@@ -1525,6 +1604,8 @@ snapfb enable \fB-snapfb\fR mode.
.IP
nosnapfb disable \fB-snapfb\fR mode.
.IP
+rawfb:str set \fB-rawfb\fR mode to "str".
+.IP
progressive:n set libvncserver \fB-progressive\fR slice
height parameter to n.
.IP
@@ -1622,39 +1703,39 @@ scale_cursor viewonly noviewonly shared noshared
forever noforever once timeout deny lock nodeny unlock
connect allowonce allow localhost nolocalhost listen
lookup nolookup accept gone shm noshm flipbyteorder
-noflipbyteorder onetile noonetile solid_color solid
-nosolid blackout xinerama noxinerama xrandr noxrandr
-xrandr_mode padgeom quiet q noquiet modtweak nomodtweak
-xkb noxkb skip_keycodes add_keysyms noadd_keysyms
-clear_mods noclear_mods clear_keys noclear_keys
-remap repeat norepeat fb nofb bell nobell sel nosel
-primary noprimary cursorshape nocursorshape cursorpos
-nocursorpos cursor show_cursor noshow_cursor nocursor
-arrow xfixes noxfixes xdamage noxdamage xd_area
-xd_mem alphacut alphafrac alpharemove noalpharemove
-alphablend noalphablend xwarp xwarppointer noxwarp
-noxwarppointer buttonmap dragging nodragging
+noflipbyteorder onetile noonetile solid_color
+solid nosolid blackout xinerama noxinerama xtrap
+noxtrap xrandr noxrandr xrandr_mode padgeom quiet q
+noquiet modtweak nomodtweak xkb noxkb skip_keycodes
+add_keysyms noadd_keysyms clear_mods noclear_mods
+clear_keys noclear_keys remap repeat norepeat fb nofb
+bell nobell sel nosel primary noprimary cursorshape
+nocursorshape cursorpos nocursorpos cursor show_cursor
+noshow_cursor nocursor arrow xfixes noxfixes xdamage
+noxdamage xd_area xd_mem alphacut alphafrac alpharemove
+noalpharemove alphablend noalphablend xwarp xwarppointer
+noxwarp noxwarppointer buttonmap dragging nodragging
pointer_mode pm input_skip input client_input speeds
debug_pointer dp nodebug_pointer nodp debug_keyboard dk
nodebug_keyboard nodk deferupdate defer wait rfbwait
nap nonap sb screen_blank fs gaps grow fuzz snapfb
-nosnapfb progressive rfbport http nohttp httpport
+nosnapfb rawfb progressive rfbport http nohttp httpport
httpdir enablehttpproxy noenablehttpproxy alwaysshared
noalwaysshared nevershared noalwaysshared dontdisconnect
nodontdisconnect desktop noremote
.IP
aro= display vncdisplay desktopname http_url auth
users rootshift clipshift scale_str scaled_x scaled_y
-scale_numer scale_denom scale_fac scaling_noblend
-scaling_nomult4 scaling_pad scaling_interpolate inetd
-safer unsafe passwdfile using_shm logfile o rc norc
-h help V version lastmod bg sigpipe threads clients
-client_count pid ext_xtest ext_xtrap ext_xkb ext_xshm
-ext_xinerama ext_overlay ext_xfixes ext_xdamage
-ext_xrandr rootwin num_buttons button_mask mouse_x
-mouse_y bpp depth indexed_color dpy_x dpy_y wdpy_x
-wdpy_y off_x off_y cdpy_x cdpy_y coff_x coff_y rfbauth
-passwd
+scale_numer scale_denom scale_fac scaling_blend
+scaling_nomult4 scaling_pad scaling_interpolate
+inetd safer unsafe passwdfile using_shm logfile o
+flag rc norc h help V version lastmod bg sigpipe
+threads clients client_count pid ext_xtest ext_xtrap
+ext_xkb ext_xshm ext_xinerama ext_overlay ext_xfixes
+ext_xdamage ext_xrandr rootwin num_buttons button_mask
+mouse_x mouse_y bpp depth indexed_color dpy_x dpy_y
+wdpy_x wdpy_y off_x off_y cdpy_x cdpy_y coff_x coff_y
+rfbauth passwd
.PP
\fB-sync\fR
.IP