source: trunk/Lucide/readme @ 520

:: About Lucide ::

Lucide is a plugin-based document viewer with support for various file formats.

It provides a SOM based plugin architecture which allows 3rd party programmers
to easily add more plugins.


:: Plugins ::

   Supported file type         Supported features
  --------------------------------------------------------------------------
         PDF                   Scaling, Rotation, Navigation, Text
                               selection, Searching, Asynchronous rendering,
                               PostScript printing

         DJVU                  Scaling, PostScript printing

         JPG                   Scaling
  --------------------------------------------------------------------------


:: Requirements ::

Lucide requires the following:

  - libc 0.6.5:
    - ftp://ftp.netlabs.org/pub/gcc/libc-0.6.5-csd5.zip (zip format)
      or ftp://ftp.netlabs.org/pub/gcc/libc-0_6_5-csd5.wpi (WarpIn format)
  - gcc446.dll:
    - ftp://ftp.netlabs.org/pub/gcc/gcc4core-1_2_1.wpi (WarpIn format)
  - poppler library needs to be installed to view PDFs:
    - "yum install poppler", can be installed from netlabs.org repository


Optional: to place unicode text to the clipboard in OpenOffice.org-compatible
format you need to install UClip package (enhanced OS/2 clipboard support, 
installed by default in eComStation 2.0 RC1 and up):

  - http://hobbes.nmsu.edu/cgi-bin/h-search?key=UClip

Optional: to have japanese fonts working you need poppler-data pack.

  - extract the 4 directories from the package found on http://poppler.freedesktop.org
    to your %unixroot%/usr/local/share/poppler or to the dir where lucide.exe is installed
  - take care that the "Times New Roman WT J" font is installed. This font is used 
    as a fallback
    
PostScript printing requires PostScript-capable printer (pscript.drv).


To see a full list of features and enhancements consult the Lucide TRAC at:

  http://svn.netlabs.org/lucide/

If you encounter any bugs register them in the TRAC as well, see:

  http://svn.netlabs.org/lucide/newticket

Please make sure you select the correct version and component for your ticket.


:: Known problems/limitations ::

General: even/odd printing unavailable for postscript printing.
          ( http://svn.netlabs.org/lucide/ticket/87#comment:4 )


:: Pipe commands ::

The first instance of Lucide will create a named pipe \PIPE\LUCIDE. 
You may send following commands to this pipe:

$prev              - will switch to the previous page
$next              - will switch to the next page
$presentation      - will switch to presentation (even if minimized)
$minimize          - will mimimize Lucide (even if fullscreen)
$rotate            - will rotate 90ￜ CW
$zoomin            - will zoom in
$zoomout           - will zoom out
$zoomoriginal      - will zoom to actual size

This can be useful for presentations with a remote control.


:: License till version 1.21 ::

Lucide version 1.21 and earlier are licensed for use with eComStation only. 
You are not allowed to distribute the product by uploading it to public 
Internet servers or make it publicly available by any other means.


:: License for version 1.3.0 and better ::

Starting with version 1.3.0 Mensys BV and Serenity Systems International 
have agreed in opensourcing Lucide, while still investing in the product.
Netlabs.org would like to express it's gratitude toward Mensys BV and 
Serenity Systems International.

Lucide as of version 1.3.0 is released and distributed under CDDL/LGPL.


:: Plugin License ::
The plugins are released under CDDL/LGPL or GPL, depending on the plugin. See
http://svn.netlabs.org/lucide/ for more information and source code.


:: Links ::

http://www.netlabs.org
http://www.ecomstation.com


:: Copyright ::

(c) 2006-2007 by Eugene Romanenko, netlabs.org
(c) 2010-2011 by Dmitriy Kuminov, netlabs.org
    in co-operation with Serenity Systems International