#!/bin/sh # the next line restarts using wish. \ exec wish "$0" "$@" catch {rename send {}} # # Copyright (C) 2004-2009 Karl J. Runge # All rights reserved. # # This is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This software is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this software; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, # USA. # # tkx11vnc v0.2 # This is a simple frontend to x11vnc. It uses the remote control # and query features (-remote/-query aka -R/-Q) to interact with it. # It is just a quick-n-dirty hack (it parses -help output, etc), but # it could be of use playing with or learning about the (way too) many # parameters x11vnc has. # # It can be used to interact with a running x11vnc (see the x11vnc # -gui option), or to set the parameters and then start up x11vnc. # # # Below is a simple picture of how the gui should be laid out and how # the menus should be organized. Most menu items correspond to remote # control commands. A trailing ":" after the item name means it is a string # to be set rather than a boolean that can be toggled (e.g. the entry # box must be used). # # Some tweak options may be set in the prefix "=" string. # A means it is an "Action" (not a true variable) # R means it is an action only valid in remote mode. # S means it is an action only valid in startup mode. # Q means it is an action worth querying after running. # P means the string can be +/- appended/deleted (string may not # be the same after the remote command) # G means gui internal item # F means can be set via file browse # D means for simple gui # -C:val1,... means it will be a checkbox (radio button) # the "-" means no other options follow # 0 means to skip the item. # -- means add a separator # # The =GAL ... =GAL LOFF stuff is to provide submenus. # global env started time_count set started "" proc dtime {{msg ""}} { global started time_count if {$started == ""} { return } set diff [expr "[exec gtod.bin] - $started"] set diff [format "%.2f" $diff] incr time_count if {$msg == ""} { set msg $time_count } puts -nonewline stderr "$msg $diff " puts stderr [clock format [clock seconds]] } if [info exists env(X11VNC_GUI_TIME)] { global started time_count set started [exec gtod.bin] set time_count 0 dtime "S" } proc set_template {} { global template set template " Row: Actions Clients Permissions Keyboard Pointer Help Row: Displays Screen Tuning Debugging Misc Actions =SA start =RA stop -- =DSA attach =DRA detach -- =RA ping =RA update-all =GAL Settings:: =GA save-settings =SFA load-settings: =SA defaults-all =0SA clear-all -- =F rc: norc =GAL LOFF -- D =DRA stop+quit =DGA Quit Help =DGA gui =DGA all Clients =DRQA current: =DF connect: =DRQA disconnect: -- accept: afteraccept: gone: vncconnect zeroconf -- D tightfilexfer ultrafilexfer proxy: =GAL Chat:: chatwindow =DRA chaton =DRA chatoff =GAL LOFF =GAL Java-applet:: =D http httpdir: httpport: https: httpsredir: enablehttpproxy =GAL LOFF Displays =D display: =F auth: =S reflect: =D desktop: =D rfbport: =S autoport: =0 gui: Screen =DRA refresh =RA reset =RA blacken -- D =D scale: scale_cursor: -- =D solid solid_color: -- =GAL OverlayVisuals:: overlay overlay_nocursor 8to24 8to24_opts: =GAL LOFF =GAL 8-Bit-Color:: flashcmap shiftcmap: notruecolor =GAL LOFF =GAL SubWindow:: id: sid: =RA id_cmd: =GAL LOFF =GAL ResizeRotate:: = xrandr =-C:resize,newfbsize,exit xrandr_mode: rotate: padgeom: =GAL LOFF =GAL Clipping:: =P blackout: xinerama clip: =GAL LOFF =GAL Misc-Screen:: fixscreen: visual: rawfb: pipeinput: uinput_accel: uinput_reset: uinput_always: 24to32 =GAL LOFF Keyboard =D norepeat =D add_keysyms modtweak xkb -- capslock skip_lockkeys -- skip_keycodes: skip_dups sloppy_keys -- =FP remap: clear_mods clear_keys clear_all =RA clear_locks Pointer =D-C:none,arrow,X,some,most cursor: =-C:1,2,3,4,5,6 arrow: -- cursorpos =D nocursorshape -- noxfixes cursor_drag =GAL AlphaBlending:: noalphablend alphacut: alphafrac: alpharemove =GAL LOFF -- buttonmap: -- xwarppointer always_inject Misc =GD-C:full,icon,tray WindowView: =GD simple-gui -- D =GA all-settings =RA remote-cmd: =GAL Selection:: =D nosel noprimary nosetprimary noclipboard nosetclipboard seldir: =GAL LOFF =GAL X-ext:: xtrap noxrecord =RQA reset_record =GAL LOFF =GAL MacOSX:: macnosaver macnowait macwheel: macnoswap macnoresize maciconanim: macmenu =GAL LOFF -- 6 noipv6 noipv4 -- nofb =D nobell nolookup rfbversion: bg =S loop =S loopbg =S sleepin: =-C:ignore,exit sigpipe: =0 inetd Debugging debug_pointer debug_keyboard =F logfile: =GA show-logfile =GA tail-logfile quiet -- =GA show-start-cmd =DG debug_gui =GAL Misc-Debug:: debug_xevents debug_xdamage =-C:0,1,2,3 debug_wireframe: debug_scroll debug_tiles debug_grabs debug_sel debug_ncache dbg =GAL LOFF Permissions =DRQA lock =DRQA unlock =D shared =D forever -- =DFP allow: =D localhost =RA allowonce: listen: -- D =D viewonly input: -- =GAL Passwords:: passwd: viewpasswd: =F passwdfile: =F rfbauth: usepw -- unixpw unixpw_list: unixpw_nis unixpw_nis_list: =0 storepasswd =GAL LOFF =GAL SSL:: ssl =F ssl_pem: stunnel =F stunnel_pem: =F ssldir: =F sslverify: ssltimeout: -- enc: =GAL LOFF =GAL Misc-Perms:: safer unsafe =RA noremote =0S alwaysshared =0S nevershared =0S dontdisconnect =SQA deny_all timeout: grabkbd grabptr grabalways grablocal: forcedpms clientdpms noserverdpms noultraext =GAL LOFF Tuning =D-C:0,1,2,3,4 pointer_mode: input_skip: allinput =D nodragging -- D speeds: =D wait: defer: =D nap screen_blank: -- =GAL WireFrame:: wireframe wireframe_mode: =-C:never,top,always wirecopyrect: =GAL LOFF =GAL ScrollCopyRect:: =-C:never,keys,mouse,always scrollcopyrect: scr_area: scr_skip: scr_inc: scr_keys: scr_term: scr_keyrepeat: scr_parms: =GAL LOFF =GAL XDAMAGE:: xdamage xd_area: xd_mem: =GAL LOFF =GAL Ncache:: ncache ncache_size: ncache_cr ncache_no_moveraise ncache_no_dtchange ncache_old_wm ncache_no_rootpixmap ncache_keep_anims ncache_pad: =RA ncache_reset_rootpixmap =GAL LOFF -- =GAL SharedMemory:: noshm flipbyteorder onetile =GAL LOFF =GAL Misc-Tuning:: progressive: fs: gaps: grow: fuzz: extra_fbur: wait_ui: setdefer: nowait_bog slow_fb: xrefresh: readtimeout: snapfb threads wmdt: rfbwait: nodpms nofbpm =GAL LOFF " } proc set_internal_help {} { global helptext helpall # set some internal item help here: set helptext(start) " Launch x11vnc with the settings you have prescribed in the gui. The x11vnc process is started in an xterm window so you can see the output, kill it, etc. By viewing this help item, the command built so far will be displayed in the gui text area. Have a look. If you Press start it will be shown as well and you will be asked to confirm running it. If you want to use a saved profile \"rc file\" you can do \"Misc -> rc\" and select the file and simply start x11vnc using the rc file. Alternatively, you could first use the \"Actions -> load-settings\" action to load in an \"rc file\" and then press \"Actions -> start\" to start up x11vnc based on those values. " set helptext(stop) " The \"Actions -> stop\" action sends a signal to the running x11vnc server indicating it should shutdown all connections and exit. The GUI stays running in case you want to start a new x11vnc or attach to another one. Use \"Actions -> Quit\" if you then want to have the gui exit. Use \"Actions -> stop+quit\" to have both exit at once. " set helptext(show-start-cmd) " Displays in the text area what the x11vnc start command (i.e. the command run by \"Actions -> start\") looks like for the current values of the settings. This can be done even in the attached state. Intended for debugging the gui. The help item for \"Actions -> start\" gives the same info. If you want to load in a saved profile \"rc file\" use \"Misc -> rc\" and select the file. \"Actions -> load-settings\" does a similar thing with an rc-file, but reading the file and setting the gui variables to its values. " set helptext(debug_gui) " Set debug_gui to get more output printed in the text area. " set helptext(detach) " No longer be associated with the x11vnc server. Switch to the non-connected state. The x11vnc server keeps running: it does not exit. You can either later reattach to it \"Actions -> attach\", or start up a new x11vnc \"Actions -> start\", or exit \"Actions -> Quit\". " set helptext(attach) " Attach to a running x11vnc server, if possible. Switches to connected state if successful. Usually the channel used to attach is via the X display (VNC_CONNECT rootwin property) being polled by the x11vnc server. To change or set the X display to use do \"Displays -> display\". Sometimes the \"-connect /path/to/filename\" is used as the communcation channel. The running x11vnc has to know that \"/path/to/filename\" is the communication channel (i.e. it is using the same -connect option). " set helptext(ping) " Check if x11vnc still responds to \"ping\" remote command. " set helptext(update-all) " Query the x11vnc server for the current values of all variables. Populate the values into the gui's database. Normally the gui will refresh this info every time it interacts with the x11vnc server (including after a few minutes of inactivity), so one doesn't need to use this action very often (unless something else is changing the state of the x11vnc server, or new clients have connected, etc). " set helptext(clear-all) " Forget any variable settings either entered in by you or set at the default. Basically sets everything to 0 or the string (unset). This action is only available in \"startup\" mode, not when connected to a running x11vnc server (in that case the variable settings reflect the state of the running x11vnc). To detach from a running x11vnc server use \"Actions -> detach\"; to completely stop the x11vnc server use \"Actions -> stop\". " set helptext(defaults-all) " Reset all variable settings to the default values. Basically sets everything to the default queries \"x11vnc -QD var\" retrieved at startup. This action is only available in \"startup\" mode, not when connected to a running x11vnc server (in that case the variable settings reflect the state of the running x11vnc). To detach from a running x11vnc server use \"Actions -> detach\"; to completely stop the x11vnc server use \"Actions -> stop\". " set helptext(load-settings) " Read in the \"rc file\" you prescribe in the dialog and then set the variables to those in the rc-file. Any variables not mentioned in the rc-file are set to their default value. You could then do \"Actions -> start\" to start x11vnc with these parameters. Or you could make some further changes to variables using the gui before starting x11vnc. This action is only available in \"startup\" mode, not when connected to a running x11vnc server (in that case the variable settings reflect the state of the running x11vnc). To detach from a running x11vnc server use \"Actions -> detach\"; to completely stop the x11vnc server use \"Actions -> stop\". " set helptext(save-settings) " Construct a ~/.x11vncrc file based on the current settings and offer to save it in a file (default ~/.x11vncrc). If saved in a file other than the default, you can access the profile by using the \"-rc \" option when starting x11vnc. If an rc file entry begins with \"#d\" that means the current setting is at the Default value and so you probably want to leave it commented out with the \"#\" character. If an rc file entry begins with \"#?\" that means we think you probably do not really want to force the value to this setting. In either case, feel free to uncomment the line and/or change any of the parameter values in the file. " set helptext(all-settings) " Displays the gui's database of all of the x11vnc server's current settings. Use \"Actions -> update-all\" or \"Control+R\" to refresh this list if it ever gets out of sync. " set helptext(remote-cmd) " Run a remote command (-R) or query (-Q) directly. Only a few remote commands are not on a menu, but for those few you can run the command directly this way. Just enter the command into the Entry box when prompted. Use the prefix \"Q:\" to indicate a -Q query. Examples: \"zero:20,20,100,100\", \"Q:ext_xfixes\" " set helptext(stop+quit) " Send the stop command to the x11vnc server, then terminate the tkx11vnc gui. " set helptext(show-logfile) " View the current contents of the logfile (if it exists and is accessible by the gui process). " set helptext(tail-logfile) " Run the tail(1) command with -f option on the logfile in an xterm. (if it exists and is accessible by the gui process). " set helptext(Quit) " Terminate the tkx11vnc gui. Any x11vnc server will be left running. " set helptext(current) " Shows a menu of currently connected VNC clients on the x11vnc server. Allows you to find more information about them, change their input permissions, or disconnect them. Note that the File transfer permission only applies to UltraVNC file transfer, not TightVNC file transfer. You will be prompted to confirm any disconnections. " set helptext(client) " After selecting a VNC client from the \"Clients -> current\" menu, you will be presented with a dialog that shows the information about the VNC client. You can choose to disconnect the client by clicking on the \"Disconnect\" checkbox and pressing \"OK\". There will be a confirmation dialog to doublecheck. Alternatively, you can fine tune the VNC client's input permissions by selecting any of the Keystrokes, Mouse-Motion, Button-Click, Clipboard-Input, or Files checkboxes and pressing \"OK\". This is like the \"-input\" option but on a per-client basis. To not change any aspects of the VNC client press \"Cancel\". " set helptext(solid_color) " Set the -solid color value. " set helptext(xrandr_mode) " Set the -xrandr mode value. " set helptext(unixpw_list) " Set the -unixpw usernames list value. " set helptext(unixpw_nis_list) " Set the -unixpw_nis usernames list value. " set helptext(stunnel_pem) " Set the -stunnel pem filename value. " set helptext(ssl_pem) " Set the -ssl pem filename value. " set helptext(wireframe_mode) " Set the -wireframe mode string value. " set helptext(simple-gui) " Toggle between menu items corresponding the most basic ones and all possible settings. I.e. toggle between a simple gui and one for power users. " set helptext(Tray) " The tray/icon mode (started with \"x11vnc -gui tray ...\", etc.) presents a small icon that indicates the status of the running x11vnc server. Depending on your environment, this icon may be embedded in a system tray or applet dock, or simply be a standalone window. \"-gui tray\" will attempt to embed the icon in the system tray, while \"-gui icon\" is for a standalone window. Use \"-gui tray=setpass\" (or icon=setpass) to be prompted to set the session password at startup. When the icon has a light background, that means no VNC viewers are currently connected to the VNC display. When the icon has a dark background (i.e. reverse-video), that means at least one VNC viewer is connected to the VNC display. Moving the mouse pointer over the icon will popup a \"status balloon\" indicating the VNC display name and the names and info of any connected VNC viewers. Press the middle mouse button if the balloon does not appear. Clicking the left or right mouse button on the icon displays a menu of actions: Properties - Brings up the Properties dialog to set some basic parameters. The full tkx11vnc GUI may be accessed via the \"Advanced ...\" button. Press \"Help\" in the Properties dialog for more info. Help - Displays this help text. New Client - Presents an entry box where you type in the name of a computer that is running a VNC viewer in \"listen\" mode (e.g. vncviewer -listen). For a non-standard listening port use \"host:port\". Pressing \"OK\" will initiate the reverse connection. Use a blank hostname to skip it. Disconnect - Shows a popup menu of connected clients. Click on one to disconnect it, or click on \"All Clients\" disconnect all clients. Window View - Switch between the \"full\" gui (also known as \"Advanced\"), \"icon\" mode (small icon window with popups), or \"tray\" mode (small icon embedded in the system tray). This is a shortcut for the action: \"Properties -> Advanced -> Misc -> WindowView\". Stop x11vnc - Directs the x11vnc server to disconnect all vncviewers and then exit. The tray/icon GUI then exits as well. Logfile - Show the logfile if x11vnc is being run with one. Custom - If you have a \$HOME/.x11vnc.gui file each uncommented line in it becomes an additional menu item for this menu. The remote control command is run directly via \"x11vnc -R \", or if prefixed with \"action:\" runs a gui internal action, or if \"sep\" adds a separator. Set X11VNC_CUSTOM_GUI to use a different filename. Example file contents: scale:3/4 scale:1 scale_cursor:1 sep action:all-settings #debug_keyboard sep action:Quit Termination: If the x11vnc server stops for any reason, the tray/icon gui will exit. If you delete the tray/icon (e.g. X out button), that is the same as the \"Stop x11vnc\" action in the menu. (This will disconnect any VNC viewer you are currently using to access the display since the x11vnc server is terminated). To terminate the tray/icon gui window but not the x11vnc server press Control-C on the tray/icon window. You can also do this (and much more) via Properties -> Advanced -> Actions -> Quit " set helptext(NewClient) " New Client - Presents an entry box where you type in the name of a computer that is running a VNC viewer in \"listen\" mode (e.g. vncviewer -listen). For a non-standard listening port use \"host:port\". Pressing \"OK\" will initiate the reverse connection. Use a blank hostname to skip it, or delete (\"X-out\") the window. " set helptext(Properties) " The Properties dialog allows you to set some basic parameters of a running x11vnc server. After modifying them press \"OK\" or \"Apply\" to apply the changes, or press \"Cancel\" to skip applying them. Accept Connections: Toggles whether VNC viewers are allowed to connect or not. It corresponds to the \"-R unlock\" and \"-R lock\" remote-control commands. Ask for Confirmation: Toggles whether a popup menu will be presented at the X display when a new VNC viewer attempts to connect. The person sitting at the X display can choose to accept or reject the connection or accept the connection in ViewOnly mode. It corresponds to the \"-R accept:popup\" and \"-R accept:\" remote-control commands. All Clients ViewOnly: Toggles whether the entire VNC desktop is view only. All clients will only be able to watch when this is set (regardless of how they logged in). It corresponds to the \"-R viewonly\" and \"-R noviewonly\" remote-control commands. Shared: Toggles whether multiple simultaneous viewer connections are allowed or not. It corresponds to the \"-R shared\" and \"-R noshared\" remote-control commands. Advertise Service (Zeroconf): Toggles whether this VNC server should advertize itself via Zeroconf (also called Bonjour, mDNS, and avahi). Then VNC viewers can then find this service on the local network. It corresponds to the \"-R zeroconf\" and \"-R nozeroconf\" remote-control commands. Serve Java Viewer Applet: Toggles whether this VNC server should serve up a Java VNC Viewer applet via HTTP on http://hostname:5800/ (or port 5800+n for VNC port 5900+n). A java enabled Web Browser can then connect to the desktopby VNC. If SSL is active then the HTTPS URL https://hostname:5900/ (etc.) will work as well. This requires the x11vnc java viewer jar file (shared/x11vnc/classes) to be installed. It corresponds to the \"-R http\" and \"-R nohttp\" remote commands. Solid Background Color: To improve VNC performance, if this option is set, then x11vnc will try to make the desktop background a solid color (which compresses extremely well compared to photo images, etc.) It corresponds to the \"-R solid\" and \"-R nosolid\" remote commands. Password: Lets you set the session password viewers may use to gain full access to the display. This will only work if x11vnc was started with the -gui icon or -gui tray mode. ViewOnly Password: Lets you set the session password viewers may use to gain view only access to the display. This will only work if x11vnc was started with the -gui icon or -gui tray mode. NOTE: These \"session\" passwords only last for the current x11vnc session (they are not remembered, see the -storepasswd, -passwdfile, and -rfbauth x11vnc options for using stored passwords). If you set \"Password\" to the empty string that makes the \"ViewOnly Password\" empty as well and removes the need for any password to log in. If you set \"ViewOnly Password\" to the empty string that just removes the ViewOnly log in aspect: \"Password\" is still required to log in. - The \"Help\" button shows this help text. - The \"Advanced ...\" button replaces the Properties dialog with the full tkx11vnc GUI. All dynamic settings can be modified in the full GUI. ========================================================================== Don't Lock Yourself Out: If you are sitting at the physical X display you cannot get into too much trouble setting the Properties dialog values. However IF you are using a VNC Viewer to REMOTELY access the X display some items in the Properties dialog can lock you out of further access: \"Accept Connections\" if you disable this remotely, and accidentally disconnect your VNC viewer then you will not be able to reconnect. \"Ask for Confirmation\" if you enable this only someone sitting at the X display can confirm any new VNC connections. Furthermore, any current VNC viewers will be blocked while waiting for the confirmation (times out in 120 sec by default). \"All Clients ViewOnly\" if you enable this remotely, well you can no longer provide input to disable it. If you do lock yourself out you could log in remotely and start up a second x11vnc and connect to that one to try to fix things in the first one. Note that if there are two or more x11vnc's on the same display the use of the GUI may be ill-behaved. Terminate the second x11vnc as soon as you have fixed the setting in the first one. Use of a remote control command, e.g. \"x11vnc -R noviewonly\" or \"x11vnc -R unlock\" is a good way to avoid this problem. " set helptext(all) $helpall set helptext(Misc-Tuning:) " x11vnc has what seems like hundreds of tuning parameters! In this sub-menu we place some lesser used ones. Most likely you'll want to leave them at their default values, but you can try them out quickly with the gui to see if they improve things. " set helptext(Passwords:) " The items in this sub-menu pertain to setting passwords. Note that x11vnc has two types of password files: RealVNC-style ones (you can create them with x11vnc -storepasswd or other VNC utility program) you use these via -rfbauth; and plain-text file passwords you use via -passwdfile. Normally passwords cannot be changed by remote-control (e.g. the gui), but for the case of the \"Icon\" and \"Tray\" modes this constraint has been relaxed. In neither the RealVNC-style nor the plain-text file cases should the password files be readable by users you do not want to access the VNC server. Contrary to popular belief, the RealVNC-style passwords are not encrypted, merely obscured. x11vnc has the even less secure -passwd and -viewpasswd supplied on the command line. Be careful with these since they could be read by users with something like the ps(1) command. On some operating systems x11vnc tries to quickly overwrite them on the command line but it doesn't work everywhere. Regarding ViewOnly passwords (where a VNC client using that password can only watch the screen, not interact with it), this is not available with -rfbauth, but only with -passwdfile, -passwd, and -viewpasswd. " set helptext(SSL:) " In this sub-menu we provide the options related to SSL encrpytion and authentication. There is a built-in mode (-ssl) using the OpenSSL library, and a 2nd using the external stunnel program (-stunnel, that needs to be installed on the system). Either may require or benefit from having PEM certificate files specified. " set helptext(Misc-Perms:) " In this sub-menu we provide some lesser used permission options. Regarding -alwaysshared, -nevershared, and -dontdisconnect, you probably should never use them and just use x11vnc's -shared and -forever options instead (these give basically the same functionality and if you mixed them too much unexpected things may happen). " #' set helptext(AlphaBlending:) " In this sub-menu we provide some tweak parameters for cursors (little icon at the mouse pointer) that have transparency (i.e. an Alpha channel in addition to Red, Green, and Blue RGB channels). For these cursors, some of the graphics underneath the cursor is allowed to be blended in: e.g. a drop-shadow (a terrible effect IMNSHO). AlphaBlending for x11vnc is only available when the XFIXES X extension is present (since otherwise it cannot see the cursors at all and so applies heuristics to show some fake cursors). AlphaBlending is only a problem with x11vnc when the cursors are not opaque. Opaque cursors (e.g. bitmap or simply colored cursor) are rendered correctly by x11vnc. Only when there is transparency does x11vnc have to make some approximation to transform the cursor to be opaque (the VNC protocol does not provide for an alpha channel in cursors, only RGB). The items in this sub-menu let you tweak x11vnc's approximation scheme for cursors with transparency. Hopefully you won't have to use them. Certain cursor \"themes\" may require adjustment however. " #' set helptext(OverlayVisuals:) " In this sub-menu are some options that involve fixing color problems for \"Overlay\" or \"Multi-Depth\" visuals. This problem is rare since overlay and multi-depth visual video hardware is rare. Some Sun, SGI, and HP machines are known to have them. The short answer is if you have a multi-depth visual display (e.g. 8 and 24 bits), and you see messed up colors in x11vnc try the \"-overlay\" option on Solaris or IRIX. A brief Background on pixels, color, and visuals: Pixels (picture elements) are kept in video memory as a certain number of bits-per-pixel (bpp). Most common are 8bpp, 16bpp, and 32bpp. Less common are 24bpp, 4bpp, and 1bpp (monochrome). How pixel values (i.e. values of the bits) are rendered into colors on the screen can be done via different \"Recipes\". These different recipes are referred to as \"visuals\". E.g. for 8bpp there is a PseudoColor visual that maintains a mapping (that can be changed dynamically) of the pixel values (256 possible ones) into RGB values. Other 8bpp visuals, e.g. StaticGrey and TrueColor have fixed, regular mappings and so provide less variation in kinds of colors. A visual's \"depth\" is how many of the pixels are used in the actual recipe. This may sound wasteful (i.e. not using some of the bits), but for 32bpp (4 billion colors) that is too much and nearly always only 24 for them are used. The most common Visual seems to be depth 24 TrueColor at 32bpp. This provides 16 million colors which is more than the number of pixels on most screens (1280x1024 = 1.3 million pixels). Another sometimes used visual that ignores some bits is depth 15 TrueColor at 16bpp. OK, now, finally, to the Overlay Visuals. Some hardware (or software emulations) allow different depth visuals to be used on the display at the same time. The pixels of windows using different depth visuals may overlap. The most common seems to be both 8 and 24 depth visuals on a 32bpp setup. 24 of the pixels can be used for one visual and the remaining 8 for the other. This is sometimes referred to as \"8+24\" mode. Furthermore, a speedup is achieved because writing graphics data to, say, the 8bit visual does not destroy the image data in the 24bit visual. Evidently popup menus can be done very quickly this way: they use the 8bit visual and when the popup goes away the graphics data in the 24bit visual is immediately reexposed without having the application redraw it. Also, some legacy applications can only use 8bpp visuals. But in these days of high color graphics and web browsers one would like the rest of the desktop to use depth 24 visuals. They often work on the multi depth visuals. How does this effect x11vnc? x11vnc nearly always polls the root window (container of all other windows). The root window will be one depth, e.g. 8 or 24. Any windows using the *other* depth will appear to have messed up colors (or just be black or some other solid color) when viewed via x11vnc. How to fix? Solaris and IRIX provide an API to extract the full snapshot of the display with all the colors correct. It comes to x11vnc as depth 24 TrueColor. To enable this use the \"-overlay\" option. Performance may be slower, but if the colors are correct that is a big improvement. " set helptext(8-Bit-Color:) " Some older displays (e.g. with limited Video RAM) use 8 bits-per-pixel color. This allows for only 256 different colors on the screen at the same time. This sometimes leads to problems with viewing these 8bpp displays via x11vnc. This sub-menu has some options that correspond to workarounds for this case. If you can configure the machine to use 16bpp it may be worth it to avoid the color problems (e.g. color flashing as the 8bit colormap is switched). " set helptext(SubWindow:) " This sub-menu has a couple options regarding having x11vnc poll a single window, not the entire display. This way just the window is shared. Note if the application pops up multiple windows they are not tracked and shared. So this is not application sharing. The application has to be very simple (e.g. a simple terminal or the image window on a webcam) for this mode to be usable. " set helptext(ResizeRotate:) " This sub-menu has some options regarding screens that support the X Resize, Reflection, and Rotation Extension (RANDR), and one expects screen resizing, reflection, or rotation to take place during the x11vnc session. This is pretty rare, but x11vnc seems to handle it reasonably well using this X extension. This mode is on by default in -id mode to try to track the changing size of the SubWindow. It is not on by default for full-screen mode because of the extra overhead, etc. " set helptext(WireFrame:) " This sub-menu has some options for the x11vnc wireframing speedup scheme. For x11vnc, Wireframing means to watch for toplevel windows being Opaquely Moved or Resized. When x11vnc detects this, it stops polling the screen and simply shows a \"wireframe\" outline of the window as it is being moved or resized. This avoids \"screen polling thrashing\" when the screen is changing so rapidly during this period. For various reasons this is usually much faster then letting the window manager do its own wireframing (you are encouraged to do Opaque moves and resizes when using x11vnc!) Also, once a moved window is released in its new position, x11vnc uses the VNC CopyRect encoding to very efficiently update the VNC viewers (each just copies the image data locally). This sort of scheme was used much in the 1990's on local displays because video hardware was slow at the time. x11vnc tries to use this same trick as a speedup for its activities (the network is much slower than video hardware writes, and the video hardware reads that x11vnc uses to poll the screen are still slow today). " #'" set helptext(Safe:) " In this sub-menu are some options for making x11vnc operations more, or less, safe. E.g. disable the running of external commands, etc. You can also turn off the Remote control channel (NOTE that doing that will disable the GUI from being able to communicate with x11vnc). " set helptext(X-ext:) " In this sub-menu are a few rarely used options regarding some X extensions used by x11vnc. " set helptext(Clipping:) " In this sub-menu are some options regarding clipping or blacking out portions of the Screen. E.g. under XINERAMA when the multiple monitors are not the same size. " set helptext(Misc-Screen:) " In this sub-menu are some little used options modifying aspects of the screen source. " set helptext(Settings:) " In this sub-menu are some options for saving and loading option settings. The default file to store settings in is ~/.x11vncrc, but you can save different \"profiles\" in other files for later use. " set helptext(Java-applet:) " In this sub-menu are some options for running the built-in HTTP server that delivers the TightVNC Java VNC Viewer applet (VncViewer.jar) to clients. The viewer runs in their Web browser. The default port listened on is 5800, so the URL is typically: http://hostname:5800/ but this can be altered by -httpport, etc. " set helptext(Chat:) " In this sub-menu are some options for enabling a local chat window and starting or stopping the current chat. This is the UltraVNC Text Chat support in x11vnc. " set helptext(ScrollCopyRect:) " This sub-menu has some options for the x11vnc Scroll detection and CopyRect speedup scheme. For this mode, x11vnc \"spies\" on communication between the X server and applications using the RECORD extension. It looks for various patterns to detect a scrolled window. This only works for some applications, fortunately some important ones. Once the scroll is detected it uses the VNC CopyRect encoding for a big speedup. Screen polling is also sped up for this scheme. There are many tweakable parameters for this mode and they are described in the sub-menu items. " set helptext(XDAMAGE:) " The DAMAGE X extension allows the X server to send signals to x11vnc telling it which regions of the screen have been changed. This improves x11vnc's performance markedly. The DAMAGE extension must be available on the display for this to work. Unfortunately DAMAGE cannot be trusted completely for the changed regions, because often the reported changed region is much larger than the actual changed regions. Nevertheless, x11vnc uses the DAMAGE information very effectively as hints to improve its performance. The items in the sub-menu allow tweaking x11vnc's DAMAGE algorithm. " set helptext(Ncache:) " A simple client-side (viewer) caching scheme is enabled with the \"-ncache n\" option. It simply uses \"n\" framebuffer sized areas below the actual display for caching window pixel data. Drawbacks are it uses a lot of RAM (roughly n times more), and the pixels cache area is visible in the viewers. The items in the sub-menu allow tweaking x11vnc's -ncache algorithm. " set helptext(SharedMemory:) " This sub-menu provides some options regarding SYSV shared memory usage (shm) by x11vnc. Usually you want shm turned on because the x11vnc process is nearly always running on the same machine the X server process is running on. SharedMemory gives a performance speedup. However, if you need to modify this scenario for special usage these options allow you to. " set helptext(Misc-Debug:) " This sub-menu contains a lot of debugging parameters usually used for debugging x11vnc itself. This is unlike the -debug_pointer and -debug_keyboard options that are useful in learning information, quirks, etc. about your local display and environment. " set helptext(Selection:) " This sub-menu contains some options centering around the Selection (also referred to as the Clipboard, Cutbuffers, etc). x11vnc will try to exchange the selections between the VNC viewers and the X server. You can adjust that behavior with these options. " set helptext(WindowView) " Set the Window View Mode for the gui. There are three modes: - full: Presents the full gui (Actions, Clients, etc, buttons, and the Text area and Set/Entry box). - icon: Presents a small icon instead of the full gui. Moving the mouse over it shows the VNC display name and any connected clients. Clicking on the icon pops up a menu of actions to perform. Among them is \"Properties\" that allows setting more parameters. Clicking on \"Advanced\" in \"Properties\" brings up the full gui. - tray: Attempt to embed the small icon in the system tray. If this fails it will resort to icon mode where the small icon is a standalone window. Note that in \"full\" mode if you delete the full gui window the gui terminates (but the x11vnc server keeps running). However under \"icon\" or \"tray\" mode if you bring up the full gui window via \"Properties -> Advanced\" and then delete it the gui does NOT terminate. Also note that by default in \"icon\" mode if you delete the icon window both the gui *and* the x11vnc server terminate. " set helptext(gui) " tkx11vnc is a simple frontend to x11vnc. Nothing fancy, it merely provides an interface to each of the many x11vnc command line options and remote control commands. See \"Help -> all\" for much info about x11vnc. For a simplier gui, run x11vnc in \"tray\" or \"icon\" mode such as \"-gui tray\", \"-gui icon\", or \"-gui tray=setpass\". In that mode the full gui is only available under \"Advanced ...\". Also, \"-gui ez\" will show fewer menu items (toggle via Misc -> simple_gui) All menu items have a (?) button one can click on to get more information about the option or command. There are two states tkx11vnc can be in: 1) Available to control a running x11vnc process. 2) Getting ready to start a x11vnc process. Most people will just use state 1). In state 1) the Menu items available in the menus are those that correspond to the x11vnc \"remote control\" commands. See the -remote entry under \"Help -> all\" for a complete list. Also available is the \"Actions -> stop\" item to shut down the running x11vnc server, thereby changing to state 2). There are other actions available too. In state 2) the Menu items available in the menus (\"Actions\", \"Clients\", etc.) are those that correspond to command line options used in starting an x11vnc process, and the \"Actions -> start\" item executes x11vnc thereby changing to state 1). To see what x11vnc startup command you have built so far, look at the (?) help for \"Actions -> start\" and it will show you what the command looks like. There is much overlap between the menu items available in state 1) and state 2), but it is worth keeping in mind it is not 100%. For example, you cannot set passwords or password files in state 1). (update: simple password setting is now allowed in \"tray\" or \"icon\" mode). Also note that there may be *two* separate X displays involved, not just one: 1) the X display x11vnc will be polling (and making available to VNC viewers), and 2) the X display this GUI is intended to display on. For example, one might use ssh to access the remote machine where the GUI would display on :11 and x11vnc would poll display :0. By default the gui will display on the value in the DISPLAY env. variable followed by the value from the -display option. To override this, use something like: \"-gui otherhost:0\", etc. GUI components: --- ---------- 1) At the top of the gui is a info text label where information will be posted, e.g. when traversing menu items text indicating how to get help on the item and its current value will be displayed. 2) Below the info label is the area where the menu buttons, \"Actions\", \"Clients\", etc., are presented. If a menu item has a checkbox, it corresponds to a boolean on/off variable. Otherwise it is either a string variable, or an action not associated with a variable (for the most part). 3) Below the menu button area is a label indicating the current x11vnc X display being polled and the corresponding VNC display name. Both will be \"(*none*)\" when there is no connection established. 4) Below the x11 and vnc displays label is a text area there scrolling information about actions being taken and commands being run is displayed. To scroll click in the area and use PageUp/PageDown or the arrow keys. 5) At the bottom is an entry area. When one selects a menu item that requires supplying a string value, the label will be set to the parameter name and one types in the new value. Then one presses the \"OK\" button or presses \"Enter\" to set the value. Or you can press \"Cancel\" or \"Escape\" to avoid changing the variable. Many variables are boolean toggles (for example, \"Permissions -> viewonly\") or Radio button selections. Selecting these menu items will NOT activate the entry area but rather toggle the variable immediately. CASCADES BUG: There is a bug not yet worked around for the cascade menus where the (?) help button gets in the way. To get the mouse over to the cascade menu click and release mouse to activate the cascade, then you can click on its items. Dragging with a mouse button held down will not work (sorry!). Key Bindings: In the Text Area: Control-/ selects all of the text. Anywhere: Control-d invokes \"Actions -> detach\" Anywhere: Control-a invokes \"Actions -> attach\" Anywhere: Control-p invokes \"Actions -> ping\" Anywhere: Control-u and Control-r invoke \"Actions -> update-all\" " set under_wally " Misc: Since x11vnc has so many settings and to avoid further confusion, the libvncserver options: -alwaysshared -nevershared -dontdisconnect are not available for changing in a running x11vnc (even though it is feasible). These options overlap with the x11vnc options -shared and -forever which are hopefully enough for most usage. They may be specified for x11vnc startup if desired. " global beginner_mode if {$beginner_mode} { set helptext(gui) " tkx11vnc is a simple frontend to x11vnc. It is currently running in \"ez\" or \"simple\" mode. For many more options run it in normal mode by toggling \"Misc -> simple_gui\". All menu items have a (?) button one can click on to get more information about the option or command. GUI components: --- ---------- 1) At the top of the gui is a info text label where information will be posted, e.g. when traversing menu items text indicating how to get help on the item and its current value will be displayed. 2) Below the info label is the area where the menu buttons, \"Actions\", \"Clients\", etc., are presented. If a menu item has a checkbox, it corresponds to a boolean on/off variable. Otherwise it is either a string variable, or an action not associated with a variable (for the most part). 3) Below the menu button area is a label indicating the current x11vnc X display being polled and the corresponding VNC display name. Both will be \"(*none*)\" when there is no connection established. 4) Below the x11 and vnc displays label is a text area there scrolling information about actions being taken and commands being run is displayed. To scroll click in the area and use PageUp/PageDown or the arrow keys. 5) At the bottom is an entry area. When one selects a menu item that requires supplying a string value, the label will be set to the parameter name and one types in the new value. Then one presses the \"OK\" button or presses \"Enter\" to set the value. Or you can press \"Cancel\" or \"Escape\" to avoid changing the variable. Many variables are boolean toggles (for example, \"Permissions -> viewonly\") or Radio button selections. Selecting these menu items will NOT activate the entry area but rather toggle the variable immediately. CASCADES BUG: There is a bug not yet worked around for the cascade menus where the (?) help button gets in the way. To get the mouse over to the cascade menu click and release mouse to activate the cascade, then you can click on its items. Dragging with a mouse button held down will not work (sorry!). " } } proc center_win {w} { wm withdraw $w set x [expr [winfo screenwidth $w]/2 - [winfo reqwidth $w]/2]; set y [expr [winfo screenheight $w]/2 - [winfo reqheight $w]/2]; wm geometry $w +$x+$y wm deiconify $w update } proc textwidth {text} { set min 0; foreach line [split $text "\n"] { set n [string length $line] if {$n > $min} { set min $n } } return $min } proc textheight {text} { set count 0; foreach line [split $text "\n"] { incr count } return $count } proc set_name {name} { global full_win icon_mode global saved_set_name if {![info exists saved_set_name]} { set saved_set_name "tkx11vnc" } if {$name == "RESTORE"} { set name $saved_set_name } else { set saved_set_name $name } if {![info exists full_win]} { return } set w "." if {$icon_mode} { wm title $w "$name" wm iconname $w "$name" set w $full_win } wm title $w "$name" wm iconname $w "$name" } proc make_toplevel {w {title ""}} { catch {destroy $w} toplevel $w; bind $w "destroy $w" if {$title != ""} { wm title $w $title wm iconname $w $title } } proc textwin {name title text {entry ""}} { global max_text_height max_text_width global bfont ffont set width [textwidth $text] incr width if {$width > $max_text_width} { set width $max_text_width } set height [textheight $text] if {$height > $max_text_height} { set height $max_text_height } set w ".text_$name" make_toplevel $w $title frame $w.f -bd 0; pack $w.f -fill both -expand 1 text $w.f.t -width $width -height $height -setgrid 1 -bd 2 \ -yscrollcommand "$w.f.y set" -relief ridge \ -font $ffont; scrollbar $w.f.y -orient v -relief sunken -command "$w.f.t yview"; button $w.f.b -text "Dismiss" -command "destroy $w" -font $bfont \ -pady 2 $w.f.t insert 1.0 $text; bind $w "focus $w.f.t" if {$entry != ""} { # varname+Label Name set list [split $entry "+"] set varname [lindex $list 0] set labname [lindex $list 1] frame $w.f.ef -bd 1 -relief groove label $w.f.ef.l -text "$labname" -anchor w -font $bfont entry $w.f.ef.e -relief sunken -font $ffont \ -textvariable $varname button $w.f.ef.b -text "OK" -font $bfont \ -command "set ${varname}_ok 1; destroy $w" bind $w.f.ef.e "set ${varname}_ok 1; destroy $w" pack $w.f.ef.l -side left pack $w.f.ef.e -side left -fill x -expand 1 pack $w.f.ef.b -side right } wm withdraw $w pack $w.f.b -side bottom -fill x if {$entry != ""} { pack $w.f.ef -side bottom -fill x bind $w "focus $w.f.ef.e" $w.f.ef.e icursor end } else { bind $w "focus $w.f.t" } pack $w.f.y -side right -fill y; pack $w.f.t -side top -fill both -expand 1; update center_win $w return $w } proc active_when_connected {item} { global helpremote helptext global icon_mode if {$icon_mode} { if {$item == "passwd"} { return 1 } if {$item == "viewpasswd"} { return 1 } } if {[opt_match G $item]} { return 1 } elseif {[opt_match R $item]} { return 1 } elseif {[opt_match S $item]} { return 0 } elseif {[is_action $item]} { if {[opt_match R $item]} { return 1 } else { return 0 } } elseif {[info exists helpremote($item)]} { return 1 } else { return 0 } } proc active_when_starting {item} { global helpremote helptext beginner_mode if {$beginner_mode} { if {[opt_match G $item]} { return 1 } if {$item == "display"} { return 1 } if {$item == "attach"} { return 1 } if {$item == "debug_gui"} { return 1 } return 0 } if {[opt_match G $item]} { return 1 } elseif {[opt_match S $item]} { return 1 } elseif {[opt_match R $item]} { return 0 } elseif {[is_action $item]} { if {[opt_match S $item]} { return 1 } else { return 0 } } elseif {[info exists helptext($item)]} { return 1 } else { return 0 } } proc help_win {item} { global helptext helpremote menu_var global query_ans query_aro global beginner_mode set ok 0 set text "Help on $item:\n\n" if {$item == "NewClient"} { ; } elseif {[is_gui_internal $item]} { if {$item != "gui" && $item != "all" && $item != "Misc-Tuning:" \ && $item != "Properties" && $item != "Tray"} { append text " + Is a gui internal Action (cannot be set).\n"; } } elseif {[is_action $item]} { append text " + Is a remote control Action (cannot be set).\n"; } elseif {[active_when_connected $item]} { append text " + Can be changed in a running x11vnc.\n"; } else { append text " - Cannot be changed in a running x11vnc.\n"; } if {$item == "NewClient"} { ; } elseif {[is_gui_internal $item]} { ; } elseif {[active_when_starting $item]} { append text " + Can be set at x11vnc startup.\n"; } else { if {! $beginner_mode} { append text " - Cannot be set at x11vnc startup.\n"; } } append text "\n" if {[info exists helptext($item)]} { append text "\n" if {[is_gui_internal $item]} { append text "==== x11vnc help: ====\n"; } else { append text "==== x11vnc startup option help: ====\n"; } append text "\n" append text $helptext($item) append text "\n" set ok 1 } if {[info exists helpremote($item)]} { append text "\n" append text "==== x11vnc remote control help: ====\n"; append text "\n" append text $helpremote($item) set ok 1 } if {![is_action $item] && [info exists menu_var($item)]} { global unset_str append text "\n\n" append text "==== current $item value: ====\n"; append text "\n" if {$item == "passwd" || $item == "viewpasswd"} { ; } elseif {$menu_var($item) == ""} { append text "$unset_str\n" } else { append text "$menu_var($item)\n" } if {$item == "http" || $item == "httpdir" || $item == "httpport"} { global vnc_url; append text "\nURL: $vnc_url\n" } } if {$item == "start"} { set str [get_start_x11vnc_txt] append_text "$str\n" # append text "\nPossible \$HOME/.x11vncrc settings for this command:\n\n" # set rctxt [get_start_x11vnc_cmd 1] # append text "$rctxt\n" } regsub -all { } $item " " name if {$ok} { textwin $name "x11vnc help: $item" "$text"; } return $ok } proc parse_help {} { global env x11vnc_prog; global helpall helptext; set helppipe [open "| $x11vnc_prog -help" "r"]; if {$helppipe == ""} { puts stderr "failed to run $x11vnc_prog -help"; exit 1; } set sawopts 0; set curropt ""; while {[gets $helppipe line] > -1} { append helpall "$line\n" # XXX if {[regexp {^Options:} $line]} { set sawopts 1; continue; } # XXX if {[regexp {^These options} $line]} { continue; } # tweak aliases: regsub {^-zeroconf} $line "-zero_conf" line regsub {^-avahi } $line "-zeroconf" line if {! $sawopts} { continue; } if {[regexp {^-([0-9A-z_][0-9A-z_]*)} $line match name]} { set allnames($name) 1; if {"$curropt" != "no$name" && "no$curropt" != "$name"} { set curropt $name; set helptext($curropt) "$line\n"; } else { append helptext($curropt) "$line\n"; } } elseif {$curropt != ""} { append helptext($curropt) "$line\n"; } } foreach name [array names allnames] { if {[regexp {^no} $name]} { regsub {^no} $name "" pair } else { set pair "no$name" } if {[info exists helptext($name)]} { if ![info exists helptext($pair)] { set helptext($pair) $helptext($name); } } elseif {[info exists helptext($pair)]} { if ![info exists helptext($name)] { set helptext($name) $helptext($pair); } } } set_internal_help } proc tweak_both {new old} { tweak_help $new $old tweak_remote_help $new $old } proc tweak_remote_help {new old} { global helpremote if ![info exists helpremote($new)] { if {[info exists helpremote($old)]} { set helpremote($new) $helpremote($old) } } } proc tweak_help {new old} { global helptext if ![info exists helptext($new)] { if {[info exists helptext($old)]} { set helptext($new) $helptext($old) } } } proc parse_remote_help {} { global helpremote helptext help_indent remote_name; set sawopts 0; set curropt ""; set possopts ""; set offset [expr $help_indent - 1]; foreach line [split $helptext(remote) "\n"] { set line [string range $line $offset end]; # XXX if {[regexp {^The following -remote/-R commands} $line]} { set sawopts 1; continue; } # XXX if {[regexp {^The vncconnect.*command} $line]} { set sawopts 0; } if {! $sawopts} { continue; } if {[regexp {^([0-9A-z_][0-9A-z_:]*)} $line match name]} { regsub {:.*$} $name "" popt lappend possopts $popt if {"$curropt" != "no$name" && "no$curropt" != "$name"} { set curropt $name; regsub {:.*$} $curropt "" curropt set remote_name($curropt) $name set helpremote($curropt) "$line\n"; } else { append helpremote($curropt) "$line\n"; } } elseif {$curropt != ""} { append helpremote($curropt) "$line\n"; } } foreach popt $possopts { if {[info exists helpremote($popt)]} { continue } if {[regexp {^no} $popt]} { regsub {^no} $popt "" try } else { set try "no$popt" } if {[info exists helpremote($try)]} { set helpremote($popt) $helpremote($try) } } } proc parse_query_help {} { global query_ans query_aro query_ans_list query_aro_list helptext; set sawans 0; set sawaro 0; set ans_str "" set aro_str "" foreach line [split $helptext(query) "\n"] { if {! $sawans && [regexp {^ *ans=} $line]} { set sawans 1 } if {! $sawans} { continue } if {[regexp {^ *aro=} $line]} { set sawaro 1 } if {$sawaro && [regexp {^[ ]*$} $line]} { set sawans 0 break } regsub {ans=} $line "" line regsub {aro=} $line "" line set line [string trim $line] if {$sawaro} { set aro_str "$aro_str $line" } else { set ans_str "$ans_str $line" } } regsub -all { *} $ans_str " " ans_str regsub -all { *} $aro_str " " aro_str set ans_str [string trim $ans_str] set aro_str [string trim $aro_str] set query_ans_list [split $ans_str] set query_aro_list [split $aro_str] foreach item $query_ans_list { if {[regexp {^[ ]*$} $item]} { continue } set query_ans($item) 1 } foreach item $query_aro_list { if {[regexp {^[ ]*$} $item]} { continue } set query_aro($item) 1 } } proc in_debug_mode {} { global menu_var if {![info exists menu_var(debug_gui)]} { return 0 } return $menu_var(debug_gui) } # Menubar utilities: proc menus_state {state} { global menu_b foreach case [array names menu_b] { set menu_button $menu_b($case) if {![winfo exists $menu_button]} { continue } $menu_button configure -state $state } } proc menus_enable {} { global menus_disabled menus_state "normal" set menus_disabled 0 } proc menus_disable {} { global menus_disabled set menus_disabled 1 menus_state "disabled" } # Entry box utilities: proc entry_state {x state} { global entry_box entry_label entry_ok entry_help entry_skip entry_browse global old_labels if {$x == "all"} { if {!$old_labels} { $entry_label configure -state $state } $entry_box configure -state $state $entry_ok configure -state $state $entry_skip configure -state $state $entry_help configure -state $state $entry_browse configure -state $state } elseif {$x == "label"} { if {!$old_labels} { $entry_label configure -state $state } } elseif {$x == "box"} { $entry_box configure -state $state } elseif {$x == "ok"} { $entry_ok configure -state $state } elseif {$x == "skip"} { $entry_skip configure -state $state } elseif {$x == "help"} { $entry_help configure -state $state } elseif {$x == "browse"} { $entry_browse configure -state $state } } proc entry_enable {{x "all"}} { entry_state $x normal } proc entry_disable {{x "all"}} { entry_state $x disabled } proc entry_browse_button {{show 1}} { global entry_browse if {$show} { pack $entry_browse -side left } else { pack forget $entry_browse } } proc entry_focus {} { global entry_box focus $entry_box } proc entry_select {} { global entry_box $entry_box selection range 0 end } proc entry_get {} { global entry_box return [$entry_box get] } proc entry_insert {str} { global entry_box entry_delete $entry_box insert end $str $entry_box icursor end } proc entry_delete {} { global entry_box $entry_box delete 0 end } # Utilities for remote control and updating vars. proc push_new_value {item name new {query 1}} { global menu_var always_update remote_output query_output global query_result_list set debug [in_debug_mode] set getout 0 set print_getout 0; set do_query_all 0 set newnew "" if {$item == "disconnect"} { set newnew "N/A" set do_query_all 1 } elseif {$always_update} { set do_query_all 1 } if {$item == "remote-cmd"} { # kludge for arbitrary remote command: if {[regexp {^Q:} $new]} { # extra kludge for Q:var to mean -Q var regsub {^Q:} $new "" new set qonly 1 } else { set qonly 0 } # need to extract item from new: set qtmp $new regsub {:.*$} $qtmp "" qtmp if {$qonly} { set rargs [list "-Q" "$qtmp"] set print_getout 1 set qargs "" } else { set rargs [list "-R" "$new"] set qargs "" } set getout 1 } elseif {[value_is_string $item]} { # string var: set rargs [list "-R" "$name:$new"] set qargs [list "-Q" "$name"] } else { # boolean var: set rargs [list "-R" "$name"] set qargs [list "-Q" "$name"] } if {! $query && ! $always_update} { set getout 1 } elseif {$item == "noremote"} { set getout 1 } elseif {[is_action $item] && ![opt_match Q $item] && $rargs != ""} { set getout 1 } elseif {[regexp {^(sid|id)$} $item] && ![regexp {^0x} $new]} { set getout 1 } set remote_output "" set query_output "" if {!$debug} { if [regexp {passwd} $rargs] { append_text "x11vnc ..." } else { append_text "x11vnc $rargs ..." } } if {$getout} { set remote_output [run_remote_cmd $rargs] if {$print_getout} { append_text "\t$remote_output" } append_text "\n" return } if {$do_query_all} { set all [all_query_vars] set qargs [list "-Q" $all] global last_query_all_time set last_query_all_time [clock seconds] } set rqargs [concat $rargs $qargs] set query [run_remote_cmd $rqargs] set query_output $query set query_result_list "" if {$newnew != ""} { set new $newnew } if {![see_if_ok $query $item "$name:$new"]} { # failed if {[regexp {^a..=} $query]} { # but some result came back # synchronize everything with a 2nd call. set query_output [query_all 1] } else { # server may be dead if {$item != "ping" && $item != "attach"} { try_connect } } } else { # succeeded # synchronize this variable (or variables) # for a speedup used the list parsed by see_if_ok. update_menu_vars "USE_LIST" if {$do_query_all} { global all_settings set all_settings $query } } } proc set_kmbc_str {} { global vl_bk vl_bm vl_bb vl_bc vl_bf vr_bk vr_bm vr_bb vr_bc vr_bf set str "" if {$vl_bk} { append str "K" } if {$vl_bm} { append str "M" } if {$vl_bb} { append str "B" } if {$vl_bc} { append str "C" } if {$vl_bf} { append str "F" } if {$vr_bk || $vr_bm || $vr_bb || $vr_bc || $vr_bf} { append str "," } if {$vr_bk} { append str "K" } if {$vr_bm} { append str "M" } if {$vr_bb} { append str "B" } if {$vr_bc} { append str "C" } if {$vr_bf} { append str "F" } entry_insert $str } proc insert_input_window {} { global text_area cleanup_window global ffont menu_var global vl_bk vl_bm vl_bb vl_bc vl_bf vr_bk vr_bm vr_bb vr_bc vr_bf append_text "\nUse these checkboxes to set the input permissions, " append_text "or type in the \"KMBCF...\"\n" append_text "-input string manually. Then press \"OK\" or \"Cancel\".\n" append_text "(note: an empty setting means use the default behavior, " append_text "see viewonly)\n\n" set w "$text_area.wk_f" catch {destroy $w} frame $w -bd 1 -relief ridge -cursor {top_left_arrow} set fl $w.fl frame $fl set fr $w.fr frame $fr label $fl.l -font $ffont -text "Normal clients: " checkbutton $fl.bk -pady 1 -font $ffont -anchor w -variable vl_bk \ -pady 1 -command set_kmbc_str -text "Keystrokes" checkbutton $fl.bm -font $ffont -anchor w -variable vl_bm \ -pady 1 -command set_kmbc_str -text "Mouse-Motion" checkbutton $fl.bb -font $ffont -anchor w -variable vl_bb \ -pady 1 -command set_kmbc_str -text "Button-Click" checkbutton $fl.bc -font $ffont -anchor w -variable vl_bc \ -pady 1 -command set_kmbc_str -text "Clipboard-Input" checkbutton $fl.bf -font $ffont -anchor w -variable vl_bf \ -pady 1 -command set_kmbc_str -text "Files" label $fr.l -pady 1 -font $ffont -text "View-Only clients:" checkbutton $fr.bk -font $ffont -anchor w -variable vr_bk \ -pady 1 -command set_kmbc_str -text "Keystrokes" checkbutton $fr.bm -font $ffont -anchor w -variable vr_bm \ -pady 1 -command set_kmbc_str -text "Mouse-Motion" checkbutton $fr.bb -font $ffont -anchor w -variable vr_bb \ -pady 1 -command set_kmbc_str -text "Button-Click" checkbutton $fr.bc -font $ffont -anchor w -variable vr_bc \ -pady 1 -command set_kmbc_str -text "Clipboard-Input" checkbutton $fr.bf -font $ffont -anchor w -variable vr_bf \ -pady 1 -command set_kmbc_str -text "Files" if {[info exists menu_var(input)]} { set input_str $menu_var(input) } else { set input_str "" } if {[regexp {(.*),(.*)} $input_str match normal viewonly]} { ; } else { set normal $input_str set viewonly "" } set vl_bk 0 set vl_bm 0 set vl_bb 0 set vl_bc 0 set vl_bf 0 set vr_bk 0 set vr_bm 0 set vr_bb 0 set vr_bc 0 set vr_bf 0 if {[regexp -nocase {K} $normal]} { set vl_bk 1 } if {[regexp -nocase {M} $normal]} { set vl_bm 1 } if {[regexp -nocase {B} $normal]} { set vl_bb 1 } if {[regexp -nocase {C} $normal]} { set vl_bc 1 } if {[regexp -nocase {F} $normal]} { set vl_bf 1 } if {[regexp -nocase {K} $viewonly]} { set vr_bk 1 } if {[regexp -nocase {M} $viewonly]} { set vr_bm 1 } if {[regexp -nocase {B} $viewonly]} { set vr_bb 1 } if {[regexp -nocase {C} $viewonly]} { set vr_bc 1 } if {[regexp -nocase {F} $viewonly]} { set vr_bf 1 } pack $fl.l $fl.bk $fl.bm $fl.bb $fl.bc $fl.bf -side top -fill x pack $fr.l $fr.bk $fr.bm $fr.bb $fr.bc $fr.bf -side top -fill x pack $fl $fr -side left update update idletasks $text_area window create end -window $w $text_area see end $text_area insert end "\n" # $text_area insert end "\n\n\n\n\n\n\n\n\n" set cleanup_window $w } proc set_ca_str {w} { global ca_bk ca_bm ca_bb ca_bc ca_bf ca_di if {$ca_di} { entry_insert "disconnect" $w.bk configure -state disabled $w.bm configure -state disabled $w.bb configure -state disabled $w.bc configure -state disabled $w.bf configure -state disabled return } $w.bk configure -state normal $w.bm configure -state normal $w.bb configure -state normal $w.bc configure -state normal $w.bf configure -state normal set str "" if {$ca_bk} { append str "K" } if {$ca_bm} { append str "M" } if {$ca_bb} { append str "B" } if {$ca_bc} { append str "C" } if {$ca_bf} { append str "F" } entry_insert $str } proc insert_client_action_window {input} { global text_area cleanup_window global ffont menu_var global ca_bk ca_bm ca_bb ca_bc ca_bf ca_di append_text "\nUse these checkboxes to set the input permissions " append_text "for this client\n-OR- whether to disconnect it instead. " append_text "Then press \"OK\" or \"Cancel\".\n\n" set w "$text_area.ca_f" catch {destroy $w} frame $w -bd 1 -relief ridge -cursor {top_left_arrow} checkbutton $w.di -pady 1 -font $ffont -anchor w -variable ca_di \ -pady 1 -command "set_ca_str $w" -text "Disconnect " checkbutton $w.bk -font $ffont -anchor w -variable ca_bk \ -pady 1 -command "set_ca_str $w" -text "Keystrokes" checkbutton $w.bm -font $ffont -anchor w -variable ca_bm \ -pady 1 -command "set_ca_str $w" -text "Mouse-Motion" checkbutton $w.bb -font $ffont -anchor w -variable ca_bb \ -pady 1 -command "set_ca_str $w" -text "Button-Click" checkbutton $w.bc -font $ffont -anchor w -variable ca_bc \ -pady 1 -command "set_ca_str $w" -text "Clipboard" checkbutton $w.bf -font $ffont -anchor w -variable ca_bf \ -pady 1 -command "set_ca_str $w" -text "Files" set ca_di 0 set ca_bk 0 set ca_bm 0 set ca_bb 0 set ca_bf 0 set ca_bc 0 if {[regexp -nocase {K} $input]} { set ca_bk 1 } if {[regexp -nocase {M} $input]} { set ca_bm 1 } if {[regexp -nocase {B} $input]} { set ca_bb 1 } if {[regexp -nocase {C} $input]} { set ca_bc 1 } if {[regexp -nocase {F} $input]} { set ca_bf 1 } pack $w.di $w.bk $w.bm $w.bb $w.bc $w.bf -side left update update idletasks $text_area window create end -window $w $text_area see end $text_area insert end "\n" set cleanup_window $w } proc cleanup_text_window {} { global cleanup_window if {[info exists cleanup_window]} { catch {destroy $cleanup_window} } } # For updating a string variable. Also used for simple OK/Cancel dialogs # with entry = 0. proc entry_dialog {item {entry 1}} { global menu_var entry_str entry_set entry_dialog_item global unset_str connected_to_x11vnc entry_box set entry_str "Set $item" set entry_set 0 set entry_dialog_item $item entry_enable menus_disable if {$item == "passwd" || $item == "viewpasswd"} { $entry_box configure -show "*" } if {$entry} { entry_insert "" if {[info exists menu_var($item)] && $menu_var($item) != $unset_str} { entry_insert $menu_var($item) entry_select } if {[is_browse $item]} { entry_browse_button } set_info "Set parameter in entry box, " entry_focus } else { entry_disable box } set clean_text_window 0; if {$item == "input"} { insert_input_window set clean_text_window 1 } update # wait for user reply: vwait entry_set set rc $entry_set set entry_set 0 set value [entry_get] update entry_browse_button 0 set entry_str "Set... :" entry_delete entry_disable menus_enable if {$clean_text_window} { cleanup_text_window; } update if {! $entry} { ; } elseif {$rc} { set menu_var($item) $value } else { if {[in_debug_mode]} { append_text "skipped setting $item\n" } } $entry_box configure -show "" return $rc } proc warning_dialog {msg {item "gui"} } { append_text $msg # just reuse the entry widgets for a yes/no dialog return [entry_dialog $item 0] } # For updating a boolean toggle: proc check_var {item} { global menu_var set inval $menu_var($item); if {$item == "debug_gui"} { return ""; } set rname $item if {! $inval} { if {[regexp {^no} $item]} { regsub {^no} $rname "" rname } else { set rname "no$rname" } } return $rname } proc see_if_ok {query item expected} { global query_result_list set ok 0 set found "" set query_result_list [split_query $query] foreach q $query_result_list { # XXX following will crash if $item is not a good regexp # need to protect it \Q$item\E style... # if {[regexp "^$item:" $q]} { # set found $q # } if {[string first "$item:" $q] == 0} { set found $q } if {$q == $expected} { set ok 1 if {$found != ""} { break; } } } if {$found == ""} { set msg $query regsub {^a..=} $msg {} msg if {[string length $msg] > 60} { set msg [string range $msg 0 60] } } else { set msg $found } if {!$ok && $found != ""} { # check for floating point match: set v1 "" set v2 "" regexp {:([0-9.][0-9.]*)$} $found m0 v1 regexp {:([0-9.][0-9.]*)$} $expected m0 v2 if {$v1 != "" && $v2 != ""} { set diff "" catch {set diff [expr "$v1 - $v2"]} if {$diff != ""} { if {$diff < 0} { set diff [expr "0.0 - $diff"] } if {$diff < 0.00001} { set ok 1 } } } } if {$ok} { append_text "\tSet OK ($msg)\n" return 1 } elseif {[opt_match P $item] && [regexp {:(-|\+)} $expected]} { # e.g. blackout:+30x30+20+20 append_text "\t($msg)\n" return 1 } elseif {[regexp {:[0-9]\.[0-9]} $expected]} { append_text "\t($msg)\n" return 1 } elseif {$item == "connect" || $item == "disconnect" || $item == "client" || $item == "client_input"} { append_text "\t($msg)\n" return 1 } elseif {$item == "passwd" || $item == "viewpasswd"} { append_text "\t($msg)\n" return 1 } else { append_text "\t*FAILED* $msg\n" return 0 } } proc get_default_vars {} { global default_var env set qry [all_query_vars] append qry ",vncconnect" set q "" set i 0 set all "" foreach s [split $qry ","] { if {$q != ""} { append q "," } append q $s incr i if {$i > 50} { set qargs [list "-QD" $q] set a [run_remote_cmd $qargs] if [info exists env(TKX11VNC_PRINT_ALL_QD)] { puts $q puts $a puts "---------------" } if {$all != ""} { append all "," } append all $a set q "" set i 0 } } if {$q != ""} { set qargs [list "-QD" $q] set a [run_remote_cmd $qargs] if [info exists env(TKX11VNC_PRINT_ALL_QD)] { puts $q puts $a puts "---------------" } if {$all != ""} { append all "," } append all $a } # old way, qry too long... # set qargs [list "-QD" $qry] # set all [run_remote_cmd $qargs] if {[regexp {ans=} $all]} { #append_text "Retrieved all default settings.\n" } else { #append_text "Failed to retrieve default settings.\n" } set query_result_list [split_query $all] set default_var(gui) "" foreach piece $query_result_list { if {[regexp {^([^:][^:]*):(.*)$} $piece m0 item val]} { if {$val == "N/A"} { if {$item == "vncconnect"} { set val 1 } else { set val "" } } if {$item == "display"} { set val "" } elseif {$item == "desktop"} { set val "" } elseif {$item == "auth"} { set val "" } elseif {$item == "gui"} { continue } # some hacks we do here for now.. if {$item == "cursor" && $val == ""} { set val "most" } elseif {$item == "scrollcopyrect" && $val == ""} { set val "always" } elseif {$item == "wirecopyrect" && $val == ""} { set val "always" # } elseif {$item == "overlay_nocursor" && $val == 0} { # set val 1 } set default_var($item) $val #puts "default: $item -> $val" } } } proc tilde_expand {file} { global env if {[file exists $file]} { return $file } set user "" if {[info exists env(USER)]} { set user $env(USER) } if {$user == "" && [info exists env(LOGNAME)]} { set user $env(LOGNAME) } set home "" if {[info exists env(HOME)]} { set home $env(HOME) } elseif {$user != ""} { set home "/home/$user" } if {[regexp {^~} $file]} { if {[regexp {^~/} $file]} { if {$home != ""} { regsub {^~} $file $home file } } else { regsub {^~} $file "/home/" file } } return $file } proc insert_cmdline_vars {} { global env cmd_var menu_var default_var x11vnc_cmdline if {![info exists x11vnc_cmdline]} { return } if {$x11vnc_cmdline == ""} { return } set cmd_var(novar) 1 set str [string trim $x11vnc_cmdline] while {[regexp -- {^-} $str]} { if {[regexp -- {^--*([^ \t][^ \t]*)(.*)$} $str m var rest]} { set rest [string trim $rest] set var [string trim $var] if {[regexp {^\{\{([^\}]*)\}\}(.*)} $rest m val rest]} { set str [string trim $rest] set cmd_var($var) $val } else { set str $rest set cmd_var($var) "boolean" } } else { break } } if {[info exists cmd_var(rc)]} { load_settings $cmd_var(rc) } elseif {[info exists cmd_var(norc)]} { ; } else { set filex [tilde_expand "~/.x11vncrc"] if {[file exists $filex]} { load_settings $filex } } foreach var [array names cmd_var] { if {$var == "novar"} { continue } if {[regexp {^[ \t]*$} $var]} { continue } if {[info exists menu_var($var)]} { if {$cmd_var($var) == "boolean"} { set menu_var($var) 1 } else { set menu_var($var) $cmd_var($var) } } } } proc copy_default_vars {} { global menu_var default_var foreach item [array names default_var] { if {[info exists menu_var($item)]} { if {[info exists default_var($item)]} { set menu_var($item) $default_var($item) } } } foreach item [array names menu_var] { if {[info exists default_var($item)]} { set menu_var($item) $default_var($item) } } } proc update_menu_vars {{query ""}} { global all_settings menu_var query_result_list global x11vnc_icon_mode set debug [in_debug_mode] if {$query == "USE_LIST"} { ; } elseif {$query == ""} { set query_result_list [split_query $all_settings] } else { set query_result_list [split_query $query] } foreach piece $query_result_list { #puts stderr "UMV: $piece" if [regexp {icon_mode:0} $piece] { set x11vnc_icon_mode 0 #puts stderr "x11vnc_icon_mode: $x11vnc_icon_mode" } if [regexp {icon_mode:1} $piece] { set x11vnc_icon_mode 1 #puts stderr "x11vnc_icon_mode: $x11vnc_icon_mode" } # XXX ipv6 if {[regexp {^([^:][^:]*):(.*)$} $piece m0 item val]} { if {[info exists menu_var($item)]} { set old $menu_var($item) #puts stderr " $old" if {$val == "N/A"} { continue } set menu_var($item) $val } if {$item == "clients"} { update_clients_menu $val } elseif {$item == "display"} { set_x11_display $val } elseif {$item == "vncdisplay"} { set_vnc_display $val } elseif {$item == "http_url"} { set_vnc_url $val } } } } proc load_settings {{file ""}} { global menu_var default_var env if {$file == ""} { if {![info exists menu_var(load-settings)]} { return } set file $menu_var(load-settings) } if {$file == ""} { return } set fh "" set filex [tilde_expand $file] catch {set fh [open $filex "r"]} if {$fh == ""} { append_text "load_settings: *** failed to open $filex ***\n" return } copy_default_vars set str "" while {[gets $fh line] > -1} { regsub -all {\\#} $line {__QUOTED_HASH__} line if {[regexp {^[ \t]*#} $line]} { continue } for {set i 0} {$i < 5} {incr i} { regsub {#.*$} $line "" line } if {[regexp {^[ \t]*$} $line]} { continue } regsub -all {__QUOTED_HASH__} $line {#} line if {[regexp {\\$} $line]} { regsub {\\$} $line " " line append str "$line" } else { append str "$line\n" } } close $fh set count 0 set parms "" foreach line [split $str "\n"] { set line [string trim $line] regsub {^--*} $line "" line regsub -all {[ \t][ \t]*} $line " " line set list [split $line] set item [lindex $list 0] set value [lindex $list 1] if {[regexp {^[ \t]*$} $item]} { continue } if {$item == "gui"} { continue } if {[info exists menu_var($item)]} { if {[value_is_bool $item]} { set menu_var($item) 1 incr count append parms " -$item\n" } elseif {[value_is_string $item]} { if {$value != ""} { set menu_var($item) $value set nitem [get_nitem $item] append parms " -$nitem $value\n" incr count } } } } append_text "loaded $count parameter settings from $filex" if {$count > 0} { append_text ":\n" append_text $parms } else { append_text ".\n" } } proc save_settings {} { set rc_text [get_settings_rcfile] set top "# # This file is based on the current x11vnc settings and can be used as # as a ~/.x11vncrc defaults file. If saved to another filename, these # settings can be passed to x11vnc at startup via \"-rc \". # # The rc file comment character is \"#\". Use \"\\#\" for the literal char. # You can continue lines using \"\\\" as the last character of a line. # # Lines beginning with \"#d\" indicate the parameter value is at its default # setting and you probably want to leave it commented out. # # Lines beginning with \"#?\" indicate parameters you probably do not # want to hardwire to the current setting (uncomment if you want that). # # Some parameters are boolean, e.g. -forever, and take no value; while # the others, e.g. -wait 50, take a string or numerical value. # # For booleans, the line will end with comment \"default: on\" or # \"default: off\" indicating the default setting. (Note: often # \"-nofoobar\" corresponds to option \"-foobar\" and the former is # \"the default\", e.g. -norepeat). # # For string or numerical options, the value \"\" in a line below # means the default is unset and you will need to supply some non-empty # value to use the parameter. For reference, if the default differs # from your value it placed at the end of the line as a comment. # # Feel free to uncomment or comment any of the lines or to change any # of the values of the parameters. Don't be surprised that most if not # all of the lines below are commented out (x11vnc has so many parameters, # most of them will be at their default values). #------------------------------------------------------------------------- " set rc_text "$top$rc_text" global env save_settings_var save_settings_var_ok if {[info exists env(HOME)]} { set save_settings_var "$env(HOME)/.x11vncrc" } else { set save_settings_var ".x11vncrc" } set save_settings_var_ok 0 set w [textwin "save_settings" "Save Settings..." $rc_text \ "save_settings_var+Save as:"] tkwait window $w if {$save_settings_var_ok == 1} { set file $save_settings_var if {$file == ""} { return } set file [tilde_expand $file] append_text "\nSaving current settings to $file ...\n" if {[file exists $file]} { set backup "${file}~" append_text "Backing up $file -> $backup ...\n" catch {file delete -force $backup} set emsg "*** Backup to $backup failed. ***\n" if {![file exists $backup]} { catch {file copy -force $file $backup} if {![file exists $backup]} { append_text $emsg bell } } else { append_text $emsg bell } } set fh "" catch {set fh [open $file "w"]} if {$fh != ""} { puts $fh $rc_text close $fh if {![file exists $file]} { append_text "*** Saving to $file failed. ***\n" bell } else { append_text "Done.\n" } } else { append_text "*** Open of $file failed. ***\n" bell } } } proc clear_all {} { global menu_var unset_str set debug [in_debug_mode] foreach item [array names menu_var] { if {$item == "debug_gui"} { continue } if {[info exists menu_var($item)]} { if {[is_action $item]} { set menu_var($item) "" } elseif {[value_is_bool $item]} { set menu_var($item) 0 } elseif {[value_is_string $item]} { set menu_var($item) $unset_str } } } append_text "Cleared all settings.\n" } proc defaults_all {} { copy_default_vars append_text "Reset all variables to default values.\n" } proc all_query_vars {} { global query_ans_list query_aro_list all_settings global cache_all_query_vars if {$cache_all_query_vars != ""} { return $cache_all_query_vars } set qry "" foreach item $query_ans_list { if {$qry == ""} { set qry $item } else { append qry ",$item" } } foreach item $query_aro_list { if {$qry == ""} { set qry $item } else { append qry ",$item" } } set cache_all_query_vars $qry global env if [info exists env(TKX11VNC_PRINT_ALL_VARS)] { puts "--------------- BEGIN ALL VARS ---------------" puts $qry puts "--------------- END ALL VARS ---------------" } return $qry } proc query_all {{quiet 0}} { global query_ans_list query_aro_list all_settings global last_query_all_time dtime 1 set qry [all_query_vars] set qargs [list "-Q" $qry] set all [run_remote_cmd $qargs] if {[regexp {ans=} $all]} { if {! $quiet} { append_text "Retrieved all current settings.\n" } set all_settings $all update_menu_vars $all } else { if {! $quiet} { append_text "Failed to retrieve current settings.\n" } } set last_query_all_time [clock seconds] dtime 2 return $all } proc set_info {str} { global info_str info_label #set w1 [$info_label cget -width] #set w2 [winfo width $info_label] #puts "set_info: w=$w1 winfo=$w2" #append_text "$str\n" set info_str "$str" update } proc append_text {str} { global text_area text_area_str if {![info exists text_area_str]} { set text_area_str "" } append text_area_str $str if {![info exists text_area]} { puts stderr $str return } if {$text_area == ""} { puts stderr $str return } if {![winfo exists $text_area]} { puts stderr $str return } $text_area insert end $str $text_area see end } proc show_all_settings {} { global all_settings global client_sock client_tail global x11vnc_client_file set txt "\nRead-Write settings:\n\n" foreach item [split_query $all_settings] { regsub {:} $item {: } item append txt " $item\n" if {[regexp {noremote} $item]} { append txt "\nRead-Only settings:\n\n" } } append txt "\nInternal settings:\n\n" append txt "x11vnc_client_file: $x11vnc_client_file\n" if {[info exists client_tail]} { append txt "client_tail: $client_tail\n" } else { append txt "client_tail: unset\n" } if {[info exists client_sock]} { append txt "client_sock: $client_sock\n" } else { append txt "client_sock: unset\n" } set estr "" catch {set estr [exec env | grep -i X11VNC]} append txt "$estr\n" textwin "Settings" "All Current Settings" $txt } proc show_logfile {} { global menu_var unset_str set logfile [tilde_expand $menu_var(logfile)] if {$logfile == "" || $logfile == $unset_str} { set txt "\nNo logfile was specified at x11vnc startup.\n\n" } elseif {![file exists $logfile]} { set txt "\nLogfile \"$logfile\" does not exist.\n\n" } else { set fh "-3" set err "" catch {set fh [open $logfile "r"]} err if {$fh == "-3"} { set txt "\nError opening \"$logfile\" $err.\n\n" } else { set txt "\nLogfile \"$logfile\" current contents:\n" while {[gets $fh line] > -1} { append txt "$line\n" } close $fh } } textwin "Logfile" "Logfile" $txt } proc tail_logfile {} { global menu_var unset_str ffont set logfile $menu_var(logfile) set txt "" if {$logfile == "" || $logfile == $unset_str} { set txt "\nNo logfile was specified at x11vnc startup.\n\n" } elseif {![file exists $logfile]} { set txt "\nLogfile \"$logfile\" does not exist.\n\n" } else { set cmd "" set xterm_cmd "xterm -sb -fn $ffont -geometry 80x45 -title x11vnc-logfile -e" set cmd [split $xterm_cmd] lappend cmd "tail" lappend cmd "-3000f" lappend cmd $logfile lappend cmd "&" catch {[eval exec $cmd]} } if {$txt != ""} { textwin "Logfile" "Logfile" $txt } } proc set_connected {yesno} { global connected_to_x11vnc set orig $connected_to_x11vnc if {$yesno == "yes"} { set connected_to_x11vnc 1 } else { set connected_to_x11vnc 0 no_x11_display no_vnc_display } if {$orig != $connected_to_x11vnc} { set_widgets } } proc detach_from_display {} { global connected_to_x11vnc reply_xdisplay x11vnc_xdisplay set str "Detaching from X display." if {$reply_xdisplay != ""} { set str "Detaching from $reply_xdisplay." } elseif {$x11vnc_xdisplay != ""} { set str "Detaching from $x11vnc_xdisplay." } if {$connected_to_x11vnc} { append_text "$str\n" } set_connected no } proc do_stop_quit {} { push_new_value "stop" "stop" 1 0 set_connected no update after 250 destroy . } # Menu item is an action: proc do_action {item} { global menu_var connected_to_x11vnc beginner_mode if {[in_debug_mode]} { append_text "action: \"$item\"\n" } #puts "action: \"$item\"\n" if {$item == "ping"} { if {$beginner_mode} { try_connect_and_query_all } else { try_connect } return } elseif {$item == "start"} { start_x11vnc return } elseif {$item == "detach"} { detach_from_display return } elseif {$item == "attach"} { try_connect_and_query_all return } elseif {$item == "update-all"} { query_all return } elseif {$item == "clear-all"} { clear_all return } elseif {$item == "defaults-all"} { defaults_all return } elseif {$item == "save-settings"} { save_settings return } elseif {$item == "show-start-cmd"} { show_start_cmd return } elseif {$item == "all-settings"} { show_all_settings return } elseif {$item == "show-logfile"} { show_logfile return } elseif {$item == "tail-logfile"} { tail_logfile return } elseif {$item == "Misc-Tuning:"} { menu_help "$item" return } elseif {$item == "WindowView"} { change_view_state return } elseif {$item == "quit" || $item == "Quit"} { destroy . exit 0 } elseif {$item == "stop+quit"} { do_stop_quit } if {[value_is_string $item]} { if {! [entry_dialog $item]} { return } set new $menu_var($item) set name $item } else { set new 1 set name $item } if {$item == "load-settings"} { load_settings return } if {! $connected_to_x11vnc} { ; } elseif {[regexp {^(stop|quit|exit|shutdown)$} $item]} { # just do -R append_text "stopping remote x11vnc server...\n" push_new_value $item $name $new 0 set_connected no } elseif {[opt_match Q $item]} { push_new_value $item $name $new 1 } else { push_new_value $item $name $new 0 } } proc ptime {time} { set usec [lindex [split $time] 0] set sec [format "%.3f" [expr "$usec / 1000000.0"]] puts "time: $sec secs." } proc do_var {item} { global connected_to_x11vnc item_cascade menu_var set debug [in_debug_mode] set string 0 if {[is_action $item] || $item == "WindowView"} { # Menu item is action: if {$debug} { ptime [time {do_action $item}] } else { do_action $item } return } if {[value_is_string $item]} { # Menu item is a string: if {$item_cascade($item) != ""} { # Cascade sets variable automatically } else { # Otherwise Entry box if {![entry_dialog $item]} { return } } set new $menu_var($item) set name $item } else { # Menu item is a boolean: set name [check_var $item] if {$name == ""} { return } set new 1 } if {$connected_to_x11vnc} { if {$debug} { ptime [time {push_new_value $item $name $new 1}] } else { push_new_value $item $name $new 1 } if {$item == "http"} { global vnc_url append_text " URL: $vnc_url\n" } } } proc menu_help {item} { if ![help_win $item] { textwin "nohelp" "No help available" \ "Sorry, no help avaiable for \"$item\"" } } proc opt_match {c item} { global item_opts if {[info exists item_opts($item)]} { if {[regexp "^\[A-z\]*$c" $item_opts($item)]} { return 1 } } return 0 } proc is_action {item} { return [opt_match A $item] } proc is_gui_internal {item} { if {$item == "Properties"} { return 1 } if {$item == "Tray"} { return 1 } return [opt_match G $item] } proc is_browse {item} { return [opt_match F $item] } proc value_is_string {item} { global item_bool if {![info exists item_bool($item)]} { return 0 } if {! $item_bool($item)} { return 1 } else { return 0 } } proc value_is_bool {item} { global item_bool if {![info exists item_bool($item)]} { return 0 } if {$item_bool($item)} { return 1 } else { return 0 } } proc split_query0 {query} { # original slower way with regexp/regsub regsub -all {aro=} $query {ans=} query set items {} while {1} { if {! [regexp {^ans=(.*)$} $query m0 m1]} { break } set item $m1 set m2 "" regexp {,ans=.*$} $item m2 regsub {,ans=.*$} $item "" item if {$item != ""} { lappend items $item } set query $m2 regsub {^,} $query "" query } return $items } proc split_query {query} { regsub -all {aro=} $query {ans=} query set items {} while {1} { set n [string first "ans=" $query] if {$n < 0} { break } set from [expr $n+4] set m [string first ",ans=" $query] if {$m < 0} { set more 0 set item [string range $query $from end] } else { set more 1 set to [expr $m-1] set item [string range $query $from $to] } if {$item != ""} { lappend items $item } if {$more} { incr m set query [string range $query $m end] } else { set query "" } } return $items } proc set_x11_display {name} { global x11_display set x11_display "x11vnc X display: $name" set_name "tkx11vnc - $name" } proc set_vnc_display {name} { global vnc_display icon_mode set vnc_display "VNC display: $name" if {$icon_mode} { set_icon_label } } proc set_vnc_url {name} { global vnc_url set vnc_url $name } proc no_x11_display {} { set_x11_display "(*none*)" set_name "tkx11vnc" } proc no_vnc_display {} { set_vnc_display "(*none*)" } proc no_vnc_url {} { set_vnc_url "(*none*)" } proc get_vnc_display_number {} { global vnc_display if ![info exists vnc_display] { return "none" } if {$vnc_display == ""} { return "none" } set str $vnc_display regsub {VNC display: *} $str "" str if [regexp {:([0-9][0-9]*)} $str m0 n] { return $n } return "none" } proc fetch_displays {} { set qargs [list "-Q" "display,vncdisplay"] set result [run_remote_cmd $qargs] set got_x11 0 set got_vnc 0 set got_url 0 foreach item [split_query $result] { if {[regexp {^display:(.*)$} $item m0 m1]} { set_x11_display $m1 set got_x11 1 } elseif {[regexp {^vncdisplay:(.*)$} $item m0 m1]} { set_vnc_display $m1 set got_vnc 1 } elseif {[regexp {^http_url:(.*)$} $item m0 m1]} { set_vnc_url $m1 set got_url 1 } } if {! $got_x11} { no_x11_display } if {! $got_vnc} { no_vnc_display } if {! $got_url} { no_vnc_url } } proc client_dialog {client} { set cid "" set host "" set ip "" global menu_var text_area cleanup_window item_bool #::::::::