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