source: trunk/Lucide/readme

Last change on this file was 701, checked in by Gregg Young, 2 years ago

Updated make files and documentation for 1.41 GA

File size: 7.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:: Plugins ::
9
10   Supported file type         Supported features
11  --------------------------------------------------------------------------
12         PDF                   scaling, rotation, navigation, text
13                               selection, searching, asynchronous rendering,
14                               form fill-in, PostScript printing
15
16         DJVU                  Scaling, PostScript printing
17         
18         GBM                   document info, loading all formats supported
19                               by GBM*, save loaded bitmap if it has only one
20                               page, multipage bitmap viewing, load bitmap
21                               page on demand, scaling and rotation, file
22                               thumbnail creation, high quality scaling
23                               algorithm for improved appearance, configurable
24                               background rendering for fast page switching
25                               and continuous scrolling
26
27
28         JPG                   Scaling, JPG is supported by GBM so this isn't
29                               part of the default install                               
30                             
31  --------------------------------------------------------------------------
32
33*OS/2 / Windows Bitmap, CompuServe Graphics Interchange,
34ZSoft PC Paintbrush Image, Microsoft/Aldus Tagged Image,
35Truevision Targa/Vista, Amiga IFF/ILBM Interleaved Bitmap,
36YUV12C M-Motion Frame Buffer, Portable Bit-map, Portable Greyscale-map,
37Portable Pixel-map, Portable Anymap, Portable Network Graphics,
38IBM KIPS, IBM Image Access eXecutive, X Windows Bitmap,
39X Windows PixMap, Archimedes Sprite from RiscOS,
40IBM Printer Page Segment, GEM Raster, Portrait, JPEG Interchange,
41JPEG2000 Graphics, JBIG Joint Bi-level Image experts Group,
42Camera RAW Image 
43  --------------------------------------------------------------------------
44
45:: Comparison to qPDFView ::
46
47Both Lucide and qPDFView utilize the poppler library for rendering PDFs.
48Internal differences between the two program result in some rendering more
49quickly in one program vs the other. Overall, we feel that Lucide has a more
50OS/2-like - or native - feel to its interface, and is better suited to the
51operating system. Lucide also supports native OS2 printers while qPDFView
52requires CUPS The choice is left entirely to the user as to which is
53better suited to his needs.
54
55:: Requirements ::
56
57To install all prerequisites in one go from Arca Noae Package Manager, simply
58copy and paste the following string into the Quick install dialog:
59
60    libc libcx libgcc1 libgcc-fwd libstdc++6 libsupc++6 poppler poppler-data libjpeg djvulibre uclip GBMDLL
61
62If you prefer the yum command line, please type
63
64    yum install libc libcx libgcc1 libgcc-fwd libstdc++6 libsupc++6 poppler poppler-data libjpeg djvulibre uclip GBMDLL
65
66and press <Enter>.
67
68
69Specifically, Lucide requires the following:
70
71  - libc 0.6.6:
72    - http://rpm.netlabs.org/release/00/zip/libc-0_6_6-38_oc00.zip (zip format)
73      or ftp://ftp.netlabs.org/pub/gcc/libc-0_6_6-csd6.wpi (WarpIn format)
74      or "yum install libc" (from the netlabs-rel repository)
75  - libcx 0.6.3
76    - http://rpm.netlabs.org/release/00/zip/libcx-0_6_4-1_oc00.zip (zip format)
77       or "yum install libcx" (from the netlabs-rel repository)
78  - gcc492.dll:
79    - ftp://ftp.netlabs.org/pub/gcc/gcc4core-1_3_1.wpi (WarpIn format)
80      or "yum install libgcc1 libgcc-fwd" (from the netlabs-rel repository)
81
82For rendering PDFs, Lucide's plugin requires the following:
83
84    - poppler 0.59.0:
85    - "yum install poppler" (from the netlabs-rel repository)
86   
87For rendering DjVu files, Lucide's plugin requires the following:
88
89    - djvulibre 3.5.27:
90    - "yum install djvulibre" (from the netlabs-rel repository)
91   
92For rendering multiple bitmap format files (GBM), Lucide's plugin
93requires the following:
94
95    - GBMDLL 1.76:
96    - "yum install GBMDLL" (from the netlabs-rel repository)
97    - Installed by default on ArcaOS 5.0.3 and higher
98
99For rendering JPEGs, Lucide's plugin requires the following:
100
101    - libjpeg 8d:
102    - "yum install libjpeg" (from the netlabs-rel repository)
103    - Only needed if you install the JPG plugin GBM provides JPG support
104    - You should not install  JPG and GBM at the same time. (GBM is recommended)
105
106Optional: to place unicode text to the clipboard in OpenOffice.org-compatible
107format you need to install UClip package (enhanced OS/2 clipboard support,
108installed by default in eComStation 2.0 RC1 and up, as well as ArcaOS Blue
109Lion):
110
111    - http://hobbes.nmsu.edu/cgi-bin/h-search?key=UClip
112      or "yum install uclip" (from the netlabs-rel repository)
113
114Optional: to have Japanese fonts working you need the poppler-data package.
115
116    - "yum install poppler-data" (from the netlabs-rel repository)
117
118Note: If you install Lucide during the ArcaOS install all these packages
119are installed.
120
121PostScript printing requires PostScript-capable printer (pscript.drv or
122psprint.drv).
123
124
125To see a full list of features and enhancements consult the Lucide TRAC at:
126
127  https://trac.netlabs.org/lucide/
128
129If you encounter any bugs register them in the TRAC as well, see:
130
131  https://trac.netlabs.org/lucide/newticket
132
133Please make sure you select the correct version and component for your ticket.
134
135:: Known problems/limitations ::
136
137See: https://trac.netlabs.org/lucide/report/1
138
139:: Pipe commands ::
140
141The first instance of Lucide will create a named pipe \PIPE\LUCIDE.
142You may send the following commands to this pipe:
143
144$prev              - will switch to the previous page
145$next              - will switch to the next page
146$presentation      - will switch to presentation (even if minimized)
147$minimize          - will mimimize Lucide (even if fullscreen)
148$rotate            - will rotate 90ï¿œ CW
149$zoomin            - will zoom in
150$zoomout           - will zoom out
151$zoomoriginal      - will zoom to the actual size
152
153This can be useful for presentations with a remote control.
154
155:: License through version 1.21 ::
156
157Lucide version 1.21 and earlier are licensed for use with eComStation only.
158You are not allowed to distribute the product by uploading it to public
159Internet servers or making it publicly available by any other means.
160
161:: License for version 1.3.0 and better ::
162
163Starting with version 1.3.0, Mensys BV and Serenity Systems International
164have agreed in opensourcing Lucide, while still investing in the product.
165Netlabs.org would like to express its gratitude toward Mensys BV and
166Serenity Systems International.
167
168Arca Noae, LLC has agreed to foster development of Lucide from version
1691.3.6 onward. Lucide remains open source, and dual licensed.
170
171Lucide as of version 1.3.0 is released and distributed under CDDL/LGPL.
172
173:: Plugin License ::
174
175The plugins are released under CDDL/LGPL or GPL, depending on the plugin. See
176http://svn.netlabs.org/lucide/ for more information and source code.
177
178:: Links ::
179
180http://www.netlabs.org
181https://www.arcanoae.com
182
183:: News groups ::
184   Developer:
185lucide-dev@netlabs.org
186To subscribe: lucide-dev-subscribe@netlabs.org
187   User:
188lucide-user@netlabs.org
189To subscribe: lucide-user-subscribe@netlabs.org
190
191:: Copyright ::
192
193(c) 2006-2007 by Eugene Romanenko, netlabs.org
194(c) 2010-2011 by Dmitriy Kuminov, netlabs.org
195    in co-operation with Serenity Systems International
196(c) 2016-2019 by netlabs.org
197    in co-operation with Arca Noae, LLC
Note: See TracBrowser for help on using the repository browser.