home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / xvnc_os2.zip / README.txt < prev    next >
Text File  |  1999-07-27  |  12KB  |  372 lines
  1.  
  2.     X VNC Server for OS/2 - based on Xvnc server 3.3.2r3
  3.     
  4.                       V1.00, 1999/03/27, akira@sra.co.jp
  5.               V1.01, 1999/07/27, akira@sra.co.jp
  6.  
  7. _What is VNC ?
  8.  
  9.     VNC stands for Virtual Network Computing, developed by ORL.
  10.     VNC is a system to access remote desktops from a local machine. 
  11.     It consists of a remote server and a local viewer (client).  This 
  12.     is (X base) VNC server for OS/2.
  13.  
  14.         Jan. 1999, ORL has been acquired by AT&T to form AT&T
  15.         Laboratories Cambridge.
  16.  
  17.     See  VNC site <http://www.uk.research.att.com/vnc/> for details.
  18.  
  19. _What is Xvnc ?
  20.  
  21.     Xvnc is a virtual X/VNC server.  X applications use it as normal X
  22.     server, and VNC viewer uses it as VNC server to get X display images.
  23.  
  24.         +-------+         +-----+        +-------+
  25.         |X apps |<------->|     |        |       |
  26.         +-------+         |Xvnc |<------>|  VNC  |
  27.     +-------+         |     |        |viewer |
  28.     |X apps |<------->|     |        |       |
  29.         +-------+         +-----+        +-------+
  30.                X protocol       VNC(RFB) Protocol
  31.  
  32.     Combining Xvnc and VNC viewer makes pseudo X environment. As you can 
  33.     run X application, Xvnc and VNC viewer on different machines, you may
  34.     use several machines to balancing network/CPU loads, or you'll use
  35.     remote applications with specific combinations.
  36.     
  37.     If you run Xapps. Vcnx, Viewer all in OS/2, then you'll get psuedo X
  38.     environment on OS/2.
  39.     
  40.         +- OS/2 ------------------------------+
  41.     | +-------+     +-----+     +-------+ |
  42.         | | X apps|<--->|     |     |       | |
  43.         | +-------+     | Xvnc|<--->|  VNC  | |
  44.         | +-------+     |     |     |Viewer | |
  45.         | | X apps|<--->|     |     |       | |
  46.         | +-------+     +-----+     +-------+ |
  47.         +-------------------------------------+
  48.  
  49.     If you run Xvnc and Viewer on you OS/2 and use Xapps on remote
  50.     machine, it gives pseudo X terminal on you OS/2.
  51.  
  52.                     +- OS/2 ------------------+
  53.         +-------+   |   +-----+     +-------+ |
  54.         | X apps|<----->|     |     |       | |
  55.         +-------+   |   | Xvnc|<--->|  VNC  | |
  56.         +-------+   |   |     |     | viewer| |
  57.         | X apps|<----->|     |     |       | |
  58.         +-------+   |   +-----+     +-------+ |
  59.                     +-------------------------+
  60.  
  61.     Also you can remote access to OS/2 with running viewer on another
  62.     machine (only use X apps, cannnot access to WPS/PM).
  63.  
  64.         +- OS/2 ------------------+
  65.         | +-------+     +-----+   |   +-------+
  66.         | | X apps|<--->|     |   |   |       | 
  67.         | +-------+     | Xvnc|<----->|  VNC  |
  68.         | +-------+     |     |   |   | viewer|
  69.         | | X apps|<--->|     |   |   |       |
  70.         | +-------+     +-----+   |   +-------+
  71.         +-------------------------+
  72.  
  73. _Contents
  74.  
  75.     Archive contains Xvnc and related binaries and patches to build Xvnc
  76.     from unix source.  Binaries are build on Warp3/Connect with EMX. I
  77.     hope they works on Warp4 also.
  78.  
  79.     Descriptions
  80.         README.txt                  Now you are reading.
  81.         README.jpn                  Japanese Description                  
  82.  
  83.     Executables
  84.         Xvnc.exe                    Xvnc itself
  85.     vncserver.cmd               Wrapper to startup Xvnc
  86.     vncpasswd.exe               Prepare password for Xvnc
  87.     xstartup.cmd                startup script (sample)
  88.  
  89.     Patches (in 'patches' directory)
  90.         patch-vnc_3_3_2r3_os2   Patch
  91.     Xvnc.def                Link definition file for OS/2
  92.     os2_stubs.c             Need to run OS/2.
  93.     os2_stubs.c.org         Original version (from XFree86)
  94.         os2_stubs.c.dif         diff of above
  95.  
  96.     In v1.01, I modified 'vncserver.cmd' script and documents.
  97.     
  98. _Install and Use Binaries
  99.  
  100. INSTALL
  101.   
  102.     Copy 
  103.  
  104.         Xvnc.exe
  105.     vncserver.cmd
  106.     vncpasswd.exe
  107.  
  108.     to a directory in a PATH.
  109.     
  110.     If you want to start some applications in X (as XFree86 does),
  111.     edit 'xstartup.cmd' and put it to directory
  112.     
  113.         HOME/.vnc
  114.  
  115.     HOME directory must placed on HPFS drive, and shoud be shared between
  116.     server and clients.
  117.  
  118.     These program requires EMX runtime (0.9c later) and some XFree86/2
  119.     files, such as X fonts and some X programs. At least, you need
  120.     
  121.         Xbase.zip
  122.     Xbin.zip
  123.     Xfnts.zip
  124.     Xfnon.zip
  125.  
  126.     of XFree86/2 distribution.  Look at XFree86/2 page at
  127.     
  128.         http://borneo.gmd.de/~veit/os2/xf86os2.html
  129.  
  130.     for more detail.
  131.  
  132. START
  133.  
  134.     Use wrapper script 'vncserver' to start VNC server.  'vncserver.cmd' 
  135.     is normal REXX script to setup environment and parameters required
  136.     Xvnc.  If you installed XFree86/2, it will work without any changes.
  137.     Otherwise, adjust 'vncserver.cmd'  to your environment.
  138.  
  139.     If you haven't run a VNC server before, it asks password.  This
  140.     password is required when you access to this server from viewer.
  141.     Password was saved to
  142.  
  143.         HOME/.vnc/passwd
  144.  
  145.     with some encription.  You can change it with
  146.     
  147.         vncpasswd
  148.  
  149.     command.
  150.  
  151. STOP
  152.  
  153.     To terminate VCN server, call task-list (Ctrl-ESC) and close it.
  154.  
  155.         In UNIX, 'vncserver -kill:<display number>' terminate server,
  156.     but OS/2 version script does not support it.
  157.  
  158.     Xvnc server is normal VIO (WINDOWCOMPAT) program, and you can stop
  159.     it with Ctrl-C.
  160.  
  161. LOG
  162.  
  163.     If you start server with 'vncserver' script, execution log will
  164.     saved to
  165.     
  166.         HOME/.vnc/host.display.log
  167.  
  168.     If you have a trouble, check it.
  169.         
  170.         Log file name is bit differs from UNIX version.
  171.  
  172. Combination with VNC Viewer
  173.  
  174.     If you have installed VNC viewer for PM (vncview.exe in PATH),
  175.     
  176.         vncserver -view
  177.  
  178.     will start both server and viewer.  It makes pseudo X on your WPS/PM.
  179.  
  180. Using remote machine
  181.  
  182.     If you only use X applications on remote machine (as X terminal),
  183.     then your may use XDMCP (X Display Manager Control Protocol).
  184.     If you specify
  185.  
  186.         -query remote-host
  187.         -indirect remote-host
  188.         -broadcast
  189.  
  190.     then XDMCP will enabled and Xvnc will connect to remote host's xdm 
  191.     (X Display Manager).  In this case, local commands in 'xstartup.cmd'
  192.     is not started.
  193.  
  194.         '-once' option with XDMCP terminate Xvnc when X session
  195.         terminates.
  196.     
  197. Option and Customize 'vncserver'
  198.  
  199.     'vncserver' accept following options other than normal X server
  200.     options.
  201.  
  202.     üF<number>
  203.             Specify display number. If not given, 'vncserver' select
  204.             first non-used display number.
  205.  
  206.     -name <desktop-name>
  207.             Set name of remote desktop.  It will shown in title of VNC
  208.             viewer.
  209.  
  210.     -depth <depth>
  211.             Specify pixel depth (bits per pixel) for remote desktop.
  212.         8/16/24/32 will work.
  213.  
  214.     -geometry <width>x<height>
  215.             Specify size of remote desktop.
  216.  
  217.     -pixelformat rgbNNN|bgrNNN
  218.             Specify pixel format (order and bits for each RGB).
  219.  
  220.     Default values are defined in 'vncserver' script.  You may change
  221.     these values.
  222.  
  223. _FAQ
  224.  
  225.     Q.  I got X screen but not X applications on it.
  226.     
  227.     A.  Try
  228.     
  229.             xterm -display yourpc:0 (use display number report on startup)
  230.  
  231.     A1. If you got 'xterm' on desktop, then you have a problem on
  232.         startup script.  Xvnc (invoked with vncserver script) uses local
  233.         startup script 'xstartup.cmd' in HOME/.vnc directory.  Confirm
  234.     HOME/.vnc directory and 'xstartup.cmd' script in it.
  235.     
  236.     A2. If Xvnc refused to start 'xterm' as
  237.  
  238.             Xlib: connection to "yourpc:0.0" refused by server
  239.             Xlib: Client is not authorized to connect to Server
  240.  
  241.         then you have authentication problem.  First, restart Xvnc
  242.         server with '-noauth' option.
  243.     
  244.         vncserver -noauth
  245.  
  246.         '-noauth' option disable authentication, access from local 
  247.         machine is always allowed.  If 'xterm' worked with this, 
  248.     then you certain have authentication problem.
  249.  
  250.         If you run X applications (client) on same machine on Xvnc, then
  251.     server (Xvnc) and clients (X application) must share same
  252.     'HOME/.Xauthority' file.  If server and client uses different
  253.     'HOME' directory, then you have such problem. Confirm HOME
  254.         environment value in server and client.
  255.  
  256. _Build from Sources        
  257.  
  258.     I build Xvnc and vncpasswd as below.  If you want to build them from
  259.     source (vnc_3_3_2r3_unixsrc.xxx), try it.  It requires XFree86/2
  260.     developping environment.
  261.  
  262. Expand archive
  263.  
  264.     Expand source archive (vnc_3_3_2r3_unixsrc.xxx) on root of some
  265.     drive.  Build script put some commands on root, so select drive
  266.     which have not many files in root.  Also it requires about 40MB 
  267.     of disk space to build.  Archives are expanded under directory
  268.     'vnc_unixsrc'.
  269.  
  270. Change to writable
  271.  
  272.     All files in archives are read-only.  Change to writable.
  273.  
  274.     [X:\vnc_unixsrc] chmod -R a+rw .
  275.  
  276. Apply patch
  277.  
  278.     [X:\vnc_unixsrc] patch -p 1 < patch_vnc_3_3_2r3_os2
  279.  
  280. Build 'libvncauth' and 'vncpasswd'
  281.  
  282.     [X:\vnc_unixsrc] xmkmf
  283.     [X:\vnc_unixsrc] make World
  284.  
  285. Convert command files (*.cmd) to DOS/OS2 text
  286.  
  287.     Command files comes with archive (same as XFree86/2) are all in UNIX
  288.     style text files, and REXX cannot read them.  So convert them to DOS
  289.     style text files.
  290.  
  291.     [X:\vnc_unixsrc\Xvnc\config\imake] unix2dos *.cmd
  292.     [X:\vnc_unixsrc\Xvnc\config\util]  unix2dos *.cmd
  293.  
  294. Build Xvnc
  295.  
  296.     [X:\vnc_unixsrc\Xvnc] copy config\util\buildos2.cmd
  297.     [X:\vnc_unixsrc\Xvnc] buildos2
  298.  
  299.     Binary 'Xvnc.exe' is palced on
  300.  
  301.         X:\vnc_unixsrc\Xvnc\programs\Xserver
  302.  
  303. _About Patches
  304.  
  305. vnc_unixsrc/Imakefile
  306.  
  307.     I don't build 'vncviewer' (VNC viewer for X), so deleted it.
  308.  
  309. vnc_unixsrc/vncpasswd/Imakefile
  310.  
  311.     It assumes target library name as 'libvncauth.a', but OS/2 uses
  312.     another library naming rule, it causes error on make.  So changed
  313.     it with 'TargetLibraryName' macro to build target library name.
  314.  
  315. vnc_unixsrc/Xvnc/config/cf/os2.cf
  316.  
  317.     Two definitions
  318.     
  319.         BuildXKB
  320.     BuildLBX
  321.  
  322.     are defined both 'vnc.def' and 'os2.cf'.  Of course, Xvnc never uses
  323.     such extentions (LBX may be used, but never use XKB), enclosed them
  324.     with '#ifndef'.
  325.  
  326. vnc_unixsrc/Xvnc/config/cf/vnclibs.def
  327.  
  328.     It assumes target library name as 'libvncauth.a', but OS/2 uses
  329.     another library naming rule, it causes error on make.  So changed
  330.     it with 'TargetLibraryName' macro to build target library name.
  331.  
  332. vnc_unixsrc/Xvnc/programs/Xserver/hw/vnc/init.c
  333.  
  334.     There is no 'strcasecmp' in EMX.  Relaced with 'stricmp'.
  335.  
  336. vnc_unixsrc/Xvnc/programs/Xserver/Imakefile
  337.  
  338.     It assumes target library name as 'libvn.a', but OS/2 uses another 
  339.     library naming rule, it causes error on make.  So changed
  340.     it with 'TargetLibraryName' macro to build target library name.
  341.  
  342. vnc_unixsrc/Xvnc/programs/Xserver/os/Imakefile
  343.  
  344.     Add definitions for additional 'os2_stubs.c' file.
  345.     
  346. vnc_unixsrc/Xvnc/programs/Xserver/os/os2_stubs.c
  347.  
  348.     Additonal file to build OS/2 version.  This was modified version of
  349.  
  350.         xc/programs/Xserver/hw/xfree86/os-support/os2/os2_stubs.c
  351.  
  352. vnc_unixsrc/Xvnc/programs/Xserver/Xvnc.def
  353.  
  354.     Addtinal file to build OS/2 version.  It is linker definition file.
  355.  
  356. _Acknowledges
  357.  
  358.     Thanks for suggestions from
  359.  
  360.         Mr. Ueno <zodiac@ibm.net>
  361.         Mr. Miyata <miyata@kusm.kyoto-u.ac.jp>
  362.         Mr. Okunishi <fuji0924@mbox.kyoto-inet.or.jp>
  363.     for porting.
  364.  
  365. _Contanct
  366.  
  367.     Please send bug reports, fixes, suggetions to <akira@sra.co.jp>.
  368.  
  369.     Newest version will placed at
  370.  
  371.         <http://www.sra.co.jp/people/akira/os2/xvnc/index-j.html>
  372.