Ticket #284: readme

:: 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,
                               form fill-in, PostScript printing

         DJVU                  Scaling, PostScript printing

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

:: Comparison to qPDFView ::

Both Lucide and qPDFView utilize the poppler library for rendering PDFs.
Internal differences between the two program result in some rendering more
quickly in one program vs the other. Overall, we feel that Lucide has a more
OS/2-like - or native - feel to its interface, and is better suited to the
operating system. The choice is left entirely to the user as to which is
better suited to his needs.


:: Requirements ::

To install all prerequisites in one go from Arca Noae Package Manager, simply
copy and paste the following string into the Quick install dialog:

    libc libgcc1 libgcc-fwd poppler poppler-data uclip


Specifically, Lucide requires the following:

  - libc 0.6.6:
    - ftp://ftp.netlabs.org/pub/gcc/libc-0.6.6-csd6.zip (zip format)
      or ftp://ftp.netlabs.org/pub/gcc/libc-0_6_6-csd6.wpi (WarpIn format)
      or "yum install libc" (from the netlabs-rel repository)
  - gcc492.dll:
    - ftp://ftp.netlabs.org/pub/gcc/gcc4core-1_3_1.wpi (WarpIn format)
      or "yum install libgcc1 libgcc-fwd" (from the netlabs-rel repository)
  - poppler 0.42.0 library needs to be installed to view PDFs:
    - "yum install poppler", can be installed from netlabs-rel 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, as well as ArcaOS Blue
Lion):

  - http://hobbes.nmsu.edu/cgi-bin/h-search?key=UClip
    or "yum install uclip" (from the netlabs-rel repository)

Optional: to have Japanese fonts working you need the poppler-data package.

  - "yum install poppler-data" (from the netlabs-rel repository)


PostScript printing requires PostScript-capable printer (pscript.drv or
psprint.drv).


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

  https://trac.netlabs.org/lucide/

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

  https://trac.netlabs.org/lucide/newticket

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


:: Known problems/limitations ::

See: https://trac.netlabs.org/lucide/report/1


:: Third-Party plugins ::

GBM (Generalised Bitmap Module) is a library for handling many different bitmap
file formats. It comes with a set of useful command line tools for doing bitmap
manipulations and format conversion. In this version BMP, JPG, JP2, PNG, TIF,
PBM, PGM, PPM, PNM, XPM, JBG and RAW support is additionally included.

http://hobbes.nmsu.edu/h-search.php?key=gbmos2pm160_gbm176_lu143_moz147_bin_wpi

N.B.: If using GBM to render JPG images, it is advised to disable the JPG
plugin which ships with Lucide to avoid conflicts (see ticket #236). This may
be accimplished by simply renaming lujpeg.dll in the Lucide program directory
to lujpeg.dl_ when Lucide is not running. To re-enable the included JPG plugin,
simply rename the file to its original name and start Lucide.

:: 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 through 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.

Arca Noae, LLC has agreed to foster development of Lucide from version
1.3.6 onward. Lucide remains open source, and dual licensed.

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
https://www.arcanoae.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
(c) 2016 by netlabs.org
    in co-operation with Arca Noae, LLC