1 This is a LyX development release
2 ---------------------------------
4 The LyX Team has adopted a new development model and
5 tries to keep the development version stable as far
6 as possible, but since the program is changing, the
7 development version will be less stable than the
10 So, don't use this development version on your production
11 documents without testing everything in depth first.
16 LyX is an advanced open-source "document processor". Unlike
17 standard word processors, LyX encourages writing based on the
18 structure of your documents, not their appearance. It lets you
19 concentrate on writing, leaving details of visual layout to the
22 You can read more about this concept in the documentation,
23 which you'll find under the Help menu. If you plan to use LyX,
24 you really should read about it to be able to make the best of
29 LyX is not just another word processor that claims to be a
30 Desktop Publishing program. It's a more modern way of
31 creating documents that look much nicer, but without wasting
32 time with layout-fiddling. For these reasons you might need
33 little time to get used to the differences.
34 If you are looking for a free Desktop Publishing program for
35 Unix, you will be disappointed.
37 What do I need to run LyX?
39 A Unix-like system or OS/2 with XFree
40 At least X11 Release 5
41 A decent LaTeX2e installation (e.g. teTeX or NTeX) not older
43 Optionally ghostscript and ghostview (or compatible)
44 Perl5.002 or later to import LaTeX files into LyX
50 How do I install a binary distribution of LyX?
52 Unpack it and run it. We recommend unpacking it in /usr/local,
53 but it should work anywhere. In particular, you can try LyX
54 in a temporary directory before installing permanently by
57 We recommend that you configure LyX system-wide by copying the
58 file share/lyx/lyxrc.example to share/lyx/lyxrc, and then
59 reading and modifying it.
61 You should read the notes regarding this particular build in
64 How do I upgrade from an earlier LyX version?
66 Read the file UPGRADING for info on this subject.
67 If you are upgrading from version 0.12.0 or later, you don't
68 need to do anything special.
70 What do I need to compile LyX from the source distribution?
72 1. A good c++ compiler. Development is being done mainly on
73 gcc/g++, but many others work.
74 2. The Xforms library version 0.81, 0.86 or 0.88.
75 3. LibXpm version 4.7 (or newer).
77 Read the file "INSTALL" for more information on compiling.
79 Okay, I've installed LyX. What now?
81 Once you've installed it, and everything looks fine, go read
82 the "Introduction" item under the Help menu. You should follow
83 the instructions there, which tell you to read (or at least skim)
84 the Tutorial. After that, you should also read "Help/LaTeX
85 configuration" which provides info on your LaTeX configuration
86 as LyX sees it. You might be missing a package or two that you'd
89 User-level configuration is possible with a file "~/.lyx/lyxrc".
90 You can use the system-wide lyxrc file (which should be somewhere
91 like /usr/local/share/lyx/lyxrc) as a template for your personal
92 lyxrc file. Remember that a personal configuration file will be
93 used instead of, not in addition to, any system-wide file.
95 Does LyX have support for non-English speakers/writers/readers?
97 Yes. LyX supports writing in many languages.
99 Menus and error messages have been translated to the following
100 languages (* means there are language-specific keyboard menu
122 Keymaps can ease typing in one or more of the following languages:
135 Internet resources of relevance to LyX
137 The LyX homepage contains valuable information about LyX and the
138 various LyX mailing lists, as well as links to mirrors and other
139 LyX homepages around the world:
142 Main LyX archive site:
143 ftp://ftp.lyx.org/pub/lyx/
145 The LyX Development page has information about the development
146 effort. LyX is now under CVS control, so you can get the very
147 latest sources from there at any time.
148 http://www.devel.lyx.org/
149 ftp://www.devel.lyx.org/pub/lyx/
151 What is the numbering scheme for releases? Is it like the Linux kernel?
153 Yes, it's like the Linux kernel since LyX version 0.8:
155 0.10.x, 0.12.x, 1.0.x ... are stable, public releases
156 0.11.x, 0.13.x, 1.1.x ... are developer releases
158 Of course you may also use the developer releases, but only
159 at your own risk. This is definitely higher than your risk when
160 using the public releases, even if this is your own risk, too.
162 How do I submit a bug report?
164 If possible, read the "Known Bugs" document found under the
165 Help menu. You'll find detailed info on submitting bug reports
168 You should also check the BUGS file in this directory.
170 If you can't do that, send details to the LyX Developers mailing
171 list. Don't forget to mention which version you are having
174 How do I prepare a binary distribution for the use of others?
176 1) Compile LyX with the right compiler switches for your
177 architecture. In particular you might want to ensure that libraries
178 like xforms and xpm are statically linked. To this end, you
179 can use a command like
181 make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
183 Moreover, make sure you use the --without-latex-config switch
184 of configure, since others might not be interested by your
187 2) Create a file README.bin describing your distribution and
188 referring to *you* if problems arise. As a model, you can use the
189 file development/tools/README.bin.example which was originally
190 written for Linux by David L. Johnson. Do *not* use directly
191 the file in the distribution, since it refers to Linux and
192 points to David L. Johnson for help. However, it can be a good
193 starting point. Note that removing the file completely is
194 better than not editing it at all.
196 3) Type `make bindist'. This will create a file
197 lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
198 and the peculiarities of your build (e.g. static vs. dynamic).
200 4) Check that everything is correct by unpacking the distribution
201 in some private place and running it. In particular, check the
202 output of `ldd lyx' to know which libraries are really needed.
204 5) Upload your binary file to ftp.lyx.org:/pub/lyx/uploads.
206 How can I participate in the development of LyX?
208 Any help with the development of LyX is greatly appreciated--
209 after all LyX wouldn't be what it is today without the help
210 of volunteers. We need your help!
212 If you want to work on LyX, you should contact the developer's
213 mailing list for discussion on how to do your stuff. LyX is being
214 cleaned up, and therefore it's important to follow some rules.
215 Read about those rules in development/Code_rules/.
217 If you don't know C++, there are many other ways to contribute.
218 Write documentation. Help to internationalize LyX by translating
219 documentation or menus/error messages, or by writing a new keymap.
220 Write a new textclass. Work on reLyX (Perl). Find bugs (but please
221 read the list of known bugs first). Contribute money. Or just offer
222 feature suggestions (but please read the online TODO list first).
224 Thank you for trying LyX, and we appreciate your feedback in the mailing