source: trunk/Lucide/readme @ 526

Last change on this file since 526 was 526, checked in by Lewis Rosenthal, 5 years ago

Updated readme and changelog in preparation for tagging 1.3.6 release

File size: 5.6 KB
Line 
1:: About Lucide ::
2
3Lucide is a plugin-based document viewer with support for various file formats.
4
5It provides a SOM based plugin architecture which allows 3rd party programmers
6to easily add more plugins.
7
8
9:: Plugins ::
10
11   Supported file type         Supported features
12  --------------------------------------------------------------------------
13         PDF                   scaling, rotation, navigation, text
14                               selection, searching, asynchronous rendering,
15                               form fill-in, PostScript printing
16
17         DJVU                  Scaling, PostScript printing
18
19         JPG                   Scaling
20  --------------------------------------------------------------------------
21
22:: Comparison to qPDFView ::
23
24Both Lucide and qPDFView uutilize the poppler library for rendering PDFs.
25Internal differences between the two program result in some rendering more
26quickly in one program vs the other. Overall, we feel that Lucide has a more
27OS/2-like - or native - feel to its interface, and is better suited to the
28operating system. The choice is left entirely to the user as to which is
29better suited to his needs.
30
31
32:: Requirements ::
33
34To install all prerequisites in one go from Arca Noae Package Manager, simply
35copy and paste the following string into the Quick install dialog:
36
37    libc libgcc1 libgcc-fwd poppler poppler-data uclip
38
39
40Specifically, Lucide requires the following:
41
42  - libc 0.6.6:
43    - ftp://ftp.netlabs.org/pub/gcc/libc-0.6.6-csd6.zip (zip format)
44      or ftp://ftp.netlabs.org/pub/gcc/libc-0_6_6-csd6.wpi (WarpIn format)
45      or "yum install libc" (from the netlabs-rel repository)
46  - gcc492.dll:
47    - ftp://ftp.netlabs.org/pub/gcc/gcc4core-1_3_1.wpi (WarpIn format)
48      or "yum install libgcc1 libgcc-fwd" (from the netlabs-rel repository)
49  - poppler 0.42.0 library needs to be installed to view PDFs:
50    - "yum install poppler", can be installed from netlabs-rel repository
51
52
53Optional: to place unicode text to the clipboard in OpenOffice.org-compatible
54format you need to install UClip package (enhanced OS/2 clipboard support,
55installed by default in eComStation 2.0 RC1 and up, as well as ArcaOS Blue
56Lion):
57
58  - http://hobbes.nmsu.edu/cgi-bin/h-search?key=UClip
59    or "yum install uclip" (from the netlabs-rel repository)
60
61Optional: to have Japanese fonts working you need the poppler-data package.
62
63  - "yum install poppler-data" (from the netlabs-rel repository)
64
65
66PostScript printing requires PostScript-capable printer (pscript.drv or
67psprint.drv).
68
69
70To see a full list of features and enhancements consult the Lucide TRAC at:
71
72  https://trac.netlabs.org/lucide/
73
74If you encounter any bugs register them in the TRAC as well, see:
75
76  https://trac.netlabs.org/lucide/newticket
77
78Please make sure you select the correct version and component for your ticket.
79
80
81:: Known problems/limitations ::
82
83See: https://trac.netlabs.org/lucide/report/1
84
85
86:: Third-Party plugins ::
87
88GBM (Generalised Bitmap Module) is a library for handling many different bitmap
89file formats. It comes with a set of useful command line tools for doing bitmap
90manipulations and format conversion. In this version BMP, JPG, JP2, PNG, TIF,
91PBM, PGM, PPM, PNM, XPM, JBG and RAW support is additionally included.
92
93http://hobbes.nmsu.edu/h-search.php?key=gbmos2pm160_gbm176_lu143_moz147_bin_wpi
94
95N.B.: If using GBM to render JPG images, it is advised to disable the JPG
96plugin which ships with Lucide to avoid conflicts (see ticket #236). This may
97be accimplished by simply renaming lujpeg.dll in the Lucide program directory
98to lujpeg.dl_ when Lucide is not running. To re-enable the included JPG plugin,
99simply rename the file to its original name and start Lucide.
100
101:: Pipe commands ::
102
103The first instance of Lucide will create a named pipe \PIPE\LUCIDE.
104You may send following commands to this pipe:
105
106$prev              - will switch to the previous page
107$next              - will switch to the next page
108$presentation      - will switch to presentation (even if minimized)
109$minimize          - will mimimize Lucide (even if fullscreen)
110$rotate            - will rotate 90ï¿œ CW
111$zoomin            - will zoom in
112$zoomout           - will zoom out
113$zoomoriginal      - will zoom to actual size
114
115This can be useful for presentations with a remote control.
116
117
118:: License through version 1.21 ::
119
120Lucide version 1.21 and earlier are licensed for use with eComStation only.
121You are not allowed to distribute the product by uploading it to public
122Internet servers or make it publicly available by any other means.
123
124
125:: License for version 1.3.0 and better ::
126
127Starting with version 1.3.0, Mensys BV and Serenity Systems International
128have agreed in opensourcing Lucide, while still investing in the product.
129Netlabs.org would like to express it's gratitude toward Mensys BV and
130Serenity Systems International.
131
132Arca Noae, LLC has agreed to foster development of Lucide from version
1331.3.6 onward. Lucide remains open source, and dual licensed.
134
135Lucide as of version 1.3.0 is released and distributed under CDDL/LGPL.
136
137
138:: Plugin License ::
139The plugins are released under CDDL/LGPL or GPL, depending on the plugin. See
140http://svn.netlabs.org/lucide/ for more information and source code.
141
142
143:: Links ::
144
145http://www.netlabs.org
146https://www.arcanoae.com
147
148
149:: Copyright ::
150
151(c) 2006-2007 by Eugene Romanenko, netlabs.org
152(c) 2010-2011 by Dmitriy Kuminov, netlabs.org
153    in co-operation with Serenity Systems International
154(c) 2016 by netlabs.org
155    in co-operation with Arca Noae, LLC
Note: See TracBrowser for help on using the repository browser.