README.OS2

   1 These are temporary instructions from Shigeru Miyata <miyata@kusm.kyoto-u.ac.jp>
   2 ===========================================================================
   3
   4 (The top level) configure.cmd is obsoleted by.  Please follow the
   5 step like this:
   6
   7 1. Install GNU m4, gnu?utils, aclocal/2, autoheader/2, automake/2,
   8    autoconf/2, perl, GNU patch and a UNIX type shell like pdksh.
   9 2. Apply the patch development/OS2/quick_fix.patch
  10    // os2_defines.h needs a modification because bmtable.c is C.
  11    // Now it hits me, why don't we patch "test -x" (gnufutils)?
  12    // However, we can't modify the behavior of "test -f", so
  13    // it is still necessary to modify script files for LyX.
  14 3. Install xforms 0.88 and rename
  15       forms.a   -> forms_d.a
  16       forms_s.a -> forms.a
  17    // Ever since 1.1.5pre1, you cannot link xforms 0.88 dynamically.
  18    // If you don't like this, please ask Holger Veit to export
  19    // fl_get_scrollbar_bounds, fl_get_scrollbar_increment and
  20    // fl_get_scrollbar_value from the DLL.  They're already there!
  21    // I will try to release xforms 0.89 ASAP.
  22 4. Install Hung-Chi Chu's port of GNU gettext.  Other ports will
  23    not work.
  24 5. Set environment variables
  25       MAKE_SHELL=sh
  26       LIBS=-lulib -lsocket -lbsd -lshm -lstdcpp
  27       CXXFLAGS=-g -O2 -m486 -Zmt -DOS2 -fno-rtti -fno-exceptions
  28    // ulib must be linked if we use static xforms library 0.88.
  29    // If xforms 0.89 is used -lulib must be removed from above.
  30    // Unless you are using pgcc, we use gcc rather than g++.
  31    // Hence stdc++ must be linked explicitely.  Also please
  32    // note that ld for pgcc often fails to link big executables
  33    // like unstripped lyx.exe
  34    // Due to a bug (actually a limitation) of autoconf/2,
  35    // you have to set CXXFLAGS explicitely in order to compile
  36    // CVS version newer than 11 Oct. 2000.
  37 6. From sh prompt, type
  38       autogen.sh; rm -f config.cache
  39    and then
  40       configure --prefix=/XFree86 --datadir=/XFree86/lib/X11 --with-included-string
  41       x11make
  42    // Please do not use make.cmd  make.exe should be OK.
  43    // x11make.exe is the safest choice
  44    // While you are running configure, make sure that it is not
  45    // a background process to other CPU intensive processes.
  46    // While OS/2 kernel is much more efficient, faster and
  47    // more responsive than other systems like LINUX (you can
  48    // easily *FEEL* this if you stop PM/WPS and run XFree86
  49    // only), its TTY interface is lousy, to say the least.
  50    // If the synchronization to the children breaks, configure
  51    // often detects wrongfully.
  52
  53 7. If you are going to make a binary distribution, you have
  54    to prepare lib/configure.cmd noweb2lyx.cmd and reLyX.cmd,
  55    since end users may not have a UNIX type shell installed.
  56    In order to create noweb2lyx.cmd and reLyX.cmd, first rename
  57    noweb2lyx and reLyX and open them in a text editor.  You
  58    have to remove hardcoded path in the first line:
  59 #!perl
  60    Also in reLyX.cmd, $lyxdir should be changed to include the
  61    drive letter (the line 21):
  62 $lyxdir = "$ENV{X11ROOT}/XFree86/lib/X11/lyx";
  63    Finally, prepend a line
  64 extproc perl.exe -S
  65    so that cmd.exe pass the execution control to perl.
  66    // I know configure.cmd had done this automatically.
  67    // So you can compare the result with the scripts in 1.0.4
  68    // distribution.
  69
  70
  71 ===========================================================================
  72
  73 README file for OS/2 version of LyX 1.0.1
  74 by Shigeru Miyata <miyata@kusm.kyoto-u.ac.jp>
  75 modified by Arnd Hanses <Arnd.H.Hanses@rz.ruhr-uni-bochum.de>
  76 ##############################################################
  77
  78 - This README.OS2 addresses experienced users of XFree86 and
  79   LyX on OS/2 and covers in very short form the steps for
  80   updating (installing) LyX.
  81
  82 - For general information on LyX please refer to the generic
  83   README. For generic compiling instructions refer to INSTALL.
  84
  85 - For a more detailed step by step guide on installing (or compiling)
  86   LyX and other related useful (or even necessary) optional programs
  87   on OS/2 please refer to INSTALL.OS2. If you are not already an
  88   experienced user of LyX an OS/2 you are advised to read it.
  89
  90 - For a description of the binary distribution and any necessary
  91   support libraries please refer to README.bin, which comes with the
  92   binary distribution.
  93
  94
  95 LyX has been ported to OS/2 with XFree86 by Shigeru Miyata and
  96 has been installed and used successfully by many people.
  97 Unfortunately there is yet no easy to install and complete distribu-
  98 tion of XFree86-related software for OS/2. Despite increasing popula-
  99 rity of X on OS/2, extensive printed documentation about XFree/2 and
 100 related programs like LyX is still not available. So you will
 101 have to study the available documentation (man pages, READMEs, faq,
 102 etc.) thoroughly to avoid unnecessary grief for you and for other
 103 people, trying to help you on the net. Nevertheless, there are
 104 existing tutorials and manuals covering X on UNIX family operating
 105 systems, which do contain some valuable information even for X on
 106 OS/2.
 107     [A hint as a starting point for users speaking German:
 108         http://www.rrzn-uni-hannover.de/Umdrucke/WSC.5/WSC5_1.html].
 109
 110 This release is considered to be stable for general use, but - like
 111 any other piece of software - certainly is not bug free.
 112 So take the usual precautions like adopting a regular backup policy.
 113 Standard disclaimers of non liability apply.
 114
 115 As this is a voluntary project with a large number of contributions
 116 by many people, hints and bug fixes to the program and/or the
 117 documentation are always appreciated and thoroughly considered. If
 118 you have the necessary skills (or want to take the chance to acquire
 119 them) for programming in LaTeX or C++ you can become a LyX developer.
 120 You can support further development by making a donation, if you feel
 121 that LyX made your live a bit easier or you want to support open source
 122 software.
 123 Please refer to the links at www.lyx.org for details.
 124
 125 ==============================================================
 126
 127         A. Quick Update:
 128            ------------
 129
 130 0) Only for update: If you are upgrading from LyX v. 0.12.0,
 131    any old documentation files in %HOME%/.lyx/doc/ and
 132    %X11ROOT%/XFree86/lib/X11/lyx/doc should be removed before
 133    unpacking (since they are read only). You might wish to make
 134    a backup, if you want to keep old docs.
 135
 136 1) Unpack the archive at %X11ROOT%.
 137
 138 2) Run lyx and let the program copy configuration files to
 139         %HOME%\.lyx\.
 140
 141 3) If you don't have %HOME%\.lyx\lyxrc then move
 142    %X11ROOT%\XFree86\lyxrc.example to %HOME%\.lyx\lyxrc.
 143    If updating, make a backup of old version, if you want.
 144    Read README and WHATSNEW about updating and run
 145    Options->Reconfigure as indicated.
 146
 147 4) Verify if LYX is able to find the programs mentioned
 148    in %HOME%\.lyx\lyxrc and in %HOME%\.lyx\lyxrc.defaults; if not,
 149    change name and path as required.
 150
 151    Note: Remember to repeat the check after any 'Reconfigure'!
 152
 153 5) In config.sys SET LANG and LANGUAGE according to
 154    your preferences. Beware: All programs supporting local
 155    languages will be affected, e.g.:
 156
 157 SET LANG=de_DE          rem german helpfiles will be used
 158 SET LANGUAGE=de_DE      rem german menus and messages
 159
 160 6) Restart OS/2 and run LyX. Have fun!
 161
 162
 163
 164         B. Help/Problems:
 165            -------------
 166
 167 * Please refer to the manpage (type 'man lyx' on the command line or
 168   use 'xman')
 169
 170 * If you encounter apparently OS/2 specific bugs, (i.e. bugs not
 171   already mentioned in the documentation or the buglist) you can report
 172   them to the XFree86/OS2 mailing list as well as to the LyX developer
 173   mailing list.
 174
 175 * For any questions on using LyX please subscribe to the the LyX user
 176   mailing list.
 177
 178   - To subscribe to the XFree86 mailing list send mail to
 179       majordomo@borneo.gmd.de
 180     with "subscribe" as the subject.
 181     To contribute to the mailing list, mail to
 182       xfreeos2@borneo.gmd.de
 183
 184   - For subscription to lyx-user list (general help on LyX) go to
 185         http://www.lyx.org
 186     and search for subscription info.
 187
 188 * Hints:
 189   -----
 190 1. To prevent 'file not found' with EmTeX and some non-US versions
 191    of Warp, I recommend:
 192
 193         1) In filenames use only A-Z, a-z, 1-9.
 194
 195         2) Use a recent LaTeX package inputenc.sty. Select
 196            Layout->Document->Encoding:latin1, so that LyX adds
 197            the LaTeX command '\usepackage[latin1]{inputenc}'.
 198
 199 2. LaTeX import occasionally produces buggy *.lyx files. LyX tries
 200    to save data in case of problems (and does a good job here),
 201    but I recommend:
 202
 203         To import LaTeX close down and restart LyX (or close all
 204         documents, you are working on) and try the import, so that
 205         in case of any problems none of your existing documents will
 206         be affected.
 207
 208 3. Inline preview of inline images sometimes does not show the
 209    image: If you want to preview the image, just click on it and
 210    select fullscreen preview.
 211
 212 4. Some XFree/2 programs (as ported from UNIX) expect a sh.exe
 213    in \bin directory: I recommend to install sh.exe of pdksh.zip
 214    in x:\bin (x: drive of %X11ROOT%). To work around problems you
 215    can try the commands
 216         set EMXSHELL=x:\bin\sh.exe
 217    before starting the programs. As far as I know, LyX runs without
 218    problems in this way.
 219
 220
 221 Some suggestions in case of problems:
 222 ------------------------------------
 223 1) Please check, if your x:\xfree86\lib does appear correctly in
 224    libpath.
 225
 226 2) Please check against the file list, if you did install all files of
 227    the distribution.
 228
 229 3) Remove all installed files and
 230         %.home%/.lyx/
 231    and perform a
 232         chkdsk /f
 233    and a consistency check of your lyx binary package (unzip -tv
 234    foo.zip).
 235
 236 4) Reinstall the complete package and check out if everything appears,
 237    no truncated files, no crc errors, etc.
 238
 239 5) Run
 240         lyx -dbg 1026 >lyxerrors.log 2>&1
 241    or, if you have tee.exe,
 242         lyx -dbg 1026 2>&1|tee lyxerrors.log
 243   and watch out for any error messages. Report any remaining problems.
 244   As this is a completely voluntary project, everybody involved will be
 245   grateful for user efforts like detailed bug reports, suggestions,
 246   fixes, additions to the documentation, etc.
 247
 248 6) Have fun! (I'm sure).
 249
 250
 251         C. Tips for Advanced Users:
 252            -----------------------
 253 * You can start LyX automatically by adding
 254         'start/min/n xconsole.exe'
 255         'set EMXSHELL=x:\bin\sh.exe'
 256         'start/min/n lyx >/dev/console$ 2>&1'
 257   to xinitrc.cmd before the line that invokes the
 258   window manager, so that LyX' messages appear in the
 259   console window and LyX appears in the pm-task list.
 260
 261 * You can start LyX automatically by adding
 262         'detach xconsole.exe'
 263         'detach lyx >/dev/console$ 2>&1'
 264   to xinitrc.cmd before the line that invokes the
 265   window manager, so that LyX' messages appear in the
 266   console window and LyX does not appear in the PM task list.
 267