source: trunk/Lucide/readme @ 559

Last change on this file since 559 was 559, checked in by rbri, 5 years ago

cleanup the text a bit, remove duplicate apm call description

File size: 6.1 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 utilize 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 libjpeg djvulibre uclip
38
39If you prefer the yum command line, please type
40
41    yum install libc libgcc1 libgcc-fwd poppler poppler-data libjpeg djvulibre uclip
42
43and press <Enter>.
44
45
46Specifically, Lucide requires the following:
47
48  - libc 0.6.6:
49    - ftp://ftp.netlabs.org/pub/gcc/libc-0.6.6-csd6.zip (zip format)
50      or ftp://ftp.netlabs.org/pub/gcc/libc-0_6_6-csd6.wpi (WarpIn format)
51      or "yum install libc" (from the netlabs-rel repository)
52  - gcc492.dll:
53    - ftp://ftp.netlabs.org/pub/gcc/gcc4core-1_3_1.wpi (WarpIn format)
54      or "yum install libgcc1 libgcc-fwd" (from the netlabs-rel repository)
55
56For rendering PDFs, Lucide's plugin requires the following:
57
58    - poppler 0.47.0:
59    - "yum install poppler" (from the netlabs-rel repository)
60
61For rendering JPEGs, Lucide's plugin requires the following:
62
63    - libjpeg 8c:
64    - "yum install libjpeg" (from the netlabs-rel repository)
65
66For rendering DjVu files, Lucide's plugin requires the following:
67
68    - djvulibre 3.5.22:
69    - "yum install djvulibre" (from the netlabs-rel repository)
70
71
72Optional: to place unicode text to the clipboard in OpenOffice.org-compatible
73format you need to install UClip package (enhanced OS/2 clipboard support,
74installed by default in eComStation 2.0 RC1 and up, as well as ArcaOS Blue
75Lion):
76
77    - http://hobbes.nmsu.edu/cgi-bin/h-search?key=UClip
78      or "yum install uclip" (from the netlabs-rel repository)
79
80Optional: to have Japanese fonts working you need the poppler-data package.
81
82    - "yum install poppler-data" (from the netlabs-rel repository)
83
84
85PostScript printing requires PostScript-capable printer (pscript.drv or
86psprint.drv).
87
88
89To see a full list of features and enhancements consult the Lucide TRAC at:
90
91  https://trac.netlabs.org/lucide/
92
93If you encounter any bugs register them in the TRAC as well, see:
94
95  https://trac.netlabs.org/lucide/newticket
96
97Please make sure you select the correct version and component for your ticket.
98
99
100:: Known problems/limitations ::
101
102See: https://trac.netlabs.org/lucide/report/1
103
104
105:: Third-Party plugins ::
106
107GBM (Generalised Bitmap Module) is a library for handling many different bitmap
108file formats. It comes with a set of useful command line tools for doing bitmap
109manipulations and format conversion. In this version BMP, JPG, JP2, PNG, TIF,
110PBM, PGM, PPM, PNM, XPM, JBG and RAW support is additionally included.
111
112http://hobbes.nmsu.edu/h-search.php?key=gbmos2pm160_gbm176_lu143_moz147_bin_wpi
113
114N.B.: If using GBM to render JPG images, it is advised to disable the JPG
115plugin which ships with Lucide to avoid conflicts (see ticket #236). This may
116be accimplished by simply renaming lujpeg.dll in the Lucide program directory
117to lujpeg.dl_ when Lucide is not running. To re-enable the included JPG plugin,
118simply rename the file to its original name and start Lucide.
119
120:: Pipe commands ::
121
122The first instance of Lucide will create a named pipe \PIPE\LUCIDE.
123You may send following commands to this pipe:
124
125$prev              - will switch to the previous page
126$next              - will switch to the next page
127$presentation      - will switch to presentation (even if minimized)
128$minimize          - will mimimize Lucide (even if fullscreen)
129$rotate            - will rotate 90ï¿œ CW
130$zoomin            - will zoom in
131$zoomout           - will zoom out
132$zoomoriginal      - will zoom to actual size
133
134This can be useful for presentations with a remote control.
135
136
137:: License through version 1.21 ::
138
139Lucide version 1.21 and earlier are licensed for use with eComStation only.
140You are not allowed to distribute the product by uploading it to public
141Internet servers or make it publicly available by any other means.
142
143
144:: License for version 1.3.0 and better ::
145
146Starting with version 1.3.0, Mensys BV and Serenity Systems International
147have agreed in opensourcing Lucide, while still investing in the product.
148Netlabs.org would like to express it's gratitude toward Mensys BV and
149Serenity Systems International.
150
151Arca Noae, LLC has agreed to foster development of Lucide from version
1521.3.6 onward. Lucide remains open source, and dual licensed.
153
154Lucide as of version 1.3.0 is released and distributed under CDDL/LGPL.
155
156
157:: Plugin License ::
158
159The plugins are released under CDDL/LGPL or GPL, depending on the plugin. See
160http://svn.netlabs.org/lucide/ for more information and source code.
161
162
163:: Links ::
164
165http://www.netlabs.org
166https://www.arcanoae.com
167
168
169:: Copyright ::
170
171(c) 2006-2007 by Eugene Romanenko, netlabs.org
172(c) 2010-2011 by Dmitriy Kuminov, netlabs.org
173    in co-operation with Serenity Systems International
174(c) 2016 by netlabs.org
175    in co-operation with Arca Noae, LLC
Note: See TracBrowser for help on using the repository browser.