1 Preamble: LyX versionning scheme
3 In September of 1999 the LyX Team decided that we could no
4 longer successfully use the two strand development process
5 like the Linux kernel. We are in the process of switching to a
6 development model similar to that used by Fetchmail where we
7 will only make small stable changes between releases and
8 release more often. All future releases should be stable
9 although we are currently in a transition period where some
10 major changes have to be introduced and are likely to affect
11 the stability in the short term.
13 These changes include:
15 * Use of C++ Standard Library features such as the Standard
16 Template Library (STL), string and streams.
18 * Establishing the foundations of GUI/system independence,
20 * Rearrangement of the directory structure,
22 * Use of libtool, automake and autoconf.
24 Once the transition is over the 1.1 series should be very
25 stable and we will then release 1.2.0. This new series will be
26 in a state of continual advancement. Note the word
27 "advancement" and not "development." Development will be
28 occurring in branches of CVS and once the feature/modification
29 has proved stable it will be merged into the main releases.
31 Versionning uses a continuous numbering scheme where odd or
32 even numbering is no longer significant. Prereleases are
33 labelled with a "pre" suffix and any fixes required between
34 stable releases have a "fix" suffix. Thus there are three
37 lyx-1.1.5.tar.gz -- stable release
38 lyx-1.1.5fix2.tar.gz -- bug fix of the 1.1.5 stable release.
39 lyx-1.1.5pre1.tar.gz -- potentially unstable test release
41 The fix releases contain no new functionality; only fixes that
42 have already made their way into the cvs repository.
46 LyX is an advanced open-source "document processor". Unlike
47 standard word processors, LyX encourages writing based on the
48 structure of your documents, not their appearance. It lets you
49 concentrate on writing, leaving details of visual layout to the
52 You can read more about this concept in the documentation,
53 which you'll find under the Help menu. If you plan to use LyX,
54 you really should read about it to be able to make the best of
59 LyX is not just another word processor that claims to be a
60 Desktop Publishing program. It's a more modern way of
61 creating documents that look much nicer, but without wasting
62 time with layout-fiddling. For these reasons you might need
63 little time to get used to the differences.
64 If you are looking for a free Desktop Publishing program for
65 Unix, you will be disappointed.
67 What do I need to run LyX?
69 A Unix-like system or OS/2 with XFree
70 At least X11 Release 5
71 A decent LaTeX2e installation (e.g. teTeX or NTeX) not older
73 Optionally ghostscript and ghostview (or compatible)
74 Perl5.002 or later to import LaTeX files into LyX
80 How do I install a binary distribution of LyX?
82 Unpack it and run it. We recommend unpacking it in /usr/local,
83 but it should work anywhere. In particular, you can try LyX
84 in a temporary directory before installing permanently by
87 We recommend that you configure LyX system-wide by copying the
88 file share/lyx/lyxrc.example to share/lyx/lyxrc, and then
89 reading and modifying it.
91 You should read the notes regarding this particular build in
94 How do I upgrade from an earlier LyX version?
96 Read the file UPGRADING for info on this subject.
97 If you are upgrading from version 0.12.0 or later, you don't
98 need to do anything special.
100 What do I need to compile LyX from the source distribution?
102 1. A good c++ compiler. Development is being done mainly on
103 gcc/g++, but many others work.
104 2. The Xforms library version 0.88 (recommended) or 0.89.
105 3. LibXpm version 4.7 (or newer).
107 Read the file "INSTALL" for more information on compiling.
109 Okay, I've installed LyX. What now?
111 Once you've installed it, and everything looks fine, go read
112 the "Introduction" item under the Help menu. You should follow
113 the instructions there, which tell you to read (or at least skim)
114 the Tutorial. After that, you should also read "Help/LaTeX
115 configuration" which provides info on your LaTeX configuration
116 as LyX sees it. You might be missing a package or two that you'd
119 User-level configuration is possible with a file "~/.lyx/lyxrc".
120 You can use the system-wide lyxrc file (which should be somewhere
121 like /usr/local/share/lyx/lyxrc) as a template for your personal
122 lyxrc file. Remember that a personal configuration file will be
123 used instead of, not in addition to, any system-wide file.
125 Does LyX have support for non-English speakers/writers/readers?
127 Yes. LyX supports writing in many languages.
129 Menus and error messages have been translated to the following
130 languages (* means there are language-specific keyboard menu
155 Keymaps can ease typing in one or more of the following languages:
170 Internet resources of relevance to LyX
172 The LyX homepage contains valuable information about LyX and the
173 various LyX mailing lists, as well as links to mirrors and other
174 LyX homepages around the world:
177 Main LyX archive site:
178 ftp://ftp.lyx.org/pub/lyx/
180 The LyX Development page has information about the development
181 effort. LyX is now under CVS control, so you can get the very
182 latest sources from there at any time.
183 http://www.devel.lyx.org/
184 ftp://www.devel.lyx.org/pub/lyx/
186 How do I submit a bug report?
188 If possible, read the "Known Bugs" document found under the
189 Help menu. You'll find detailed info on submitting bug reports
192 You should also check the BUGS file in this directory.
194 If you can't do that, send details to the LyX Developers mailing
195 list. Don't forget to mention which version you are having
198 How can I participate in the development of LyX?
200 Any help with the development of LyX is greatly appreciated--
201 after all LyX wouldn't be what it is today without the help
202 of volunteers. We need your help!
204 If you want to work on LyX, you should contact the developer's
205 mailing list for discussion on how to do your stuff. LyX is being
206 cleaned up, and therefore it's important to follow some rules.
207 Read about those rules in development/Code_rules/.
209 If you don't know C++, there are many other ways to contribute.
210 Write documentation. Help to internationalize LyX by translating
211 documentation or menus/error messages, or by writing a new keymap.
212 Write a new textclass. Work on reLyX (Perl). Find bugs (but please
213 read the list of known bugs first). Contribute money. Or just offer
214 feature suggestions (but please read the online TODO list first).
216 Thank you for trying LyX, and we appreciate your feedback in the mailing