README.OS2

   1
   2 README file for OS/2 version of LyX 1.0.1
   3 by Shigeru Miyata <miyata@kusm.kyoto-u.ac.jp>
   4 modified by Arnd Hanses <Arnd.H.Hanses@rz.ruhr-uni-bochum.de>
   5 ##############################################################
   6
   7 - This README.OS2 addresses experienced users of XFree86 and
   8   LyX on OS/2 and covers in very short form the steps for
   9   updating (installing) LyX.
  10
  11 - For general information on LyX please refer to the generic
  12   README. For generic compiling instructions refer to INSTALL.
  13
  14 - For a more detailed step by step guide on installing (or compiling)
  15   LyX and other related useful (or even necessary) optional programs
  16   on OS/2 please refer to INSTALL.OS2. If you are not already an
  17   experienced user of LyX an OS/2 you are advised to read it.
  18
  19 - For a description of the binary distribution and any necessary
  20   support libraries please refer to README.bin, which comes with the
  21   binary distribution.
  22
  23
  24 LyX has been ported to OS/2 with XFree86 by Shigeru Miyata and
  25 has been installed and used successfully by many people.
  26 Unfortunately there is yet no easy to install and complete distribu-
  27 tion of XFree86-related software for OS/2. Despite increasing popula-
  28 rity of X on OS/2, extensive printed documentation about XFree/2 and
  29 related programs like LyX is still not available. So you will
  30 have to study the available documentation (man pages, READMEs, faq,
  31 etc.) thoroughly to avoid unnecessary grief for you and for other
  32 people, trying to help you on the net. Nevertheless, there are
  33 existing tutorials and manuals covering X on UNIX family operating
  34 systems, which do contain some valuable information even for X on
  35 OS/2.
  36     [A hint as a starting point for users speaking German:
  37         http://www.rrzn-uni-hannover.de/Umdrucke/WSC.5/WSC5_1.html].
  38
  39 This release is considered to be stable for general use, but - like
  40 any other piece of software - certainly is not bug free.
  41 So take the usual precautions like adopting a regular backup policy.
  42 Standard disclaimers of non liability apply.
  43
  44 As this is a voluntary project with a large number of contributions
  45 by many people, hints and bug fixes to the program and/or the
  46 documentation are always appreciated and thoroughly considered. If
  47 you have the necessary skills (or want to take the chance to acquire
  48 them) for programming in LaTeX or C++ you can become a LyX developer.
  49 You can support further development by making a donation, if you feel
  50 that LyX made your live a bit easier or you want to support open source
  51 software.
  52 Please refer to the links at www.lyx.org for details.
  53
  54 ==============================================================
  55
  56         A. Quick Update:
  57            ------------
  58
  59 0) Only for update: If you are upgrading from LyX v. 0.12.0,
  60    any old documentation files in %HOME%/.lyx/doc/ and
  61    %X11ROOT%/XFree86/lib/X11/lyx/doc should be removed before
  62    unpacking (since they are read only). You might wish to make
  63    a backup, if you want to keep old docs.
  64
  65 1) Unpack the archive at %X11ROOT%.
  66
  67 2) Run lyx and let the program copy configuration files to
  68         %HOME%\.lyx\.
  69
  70 3) If you don't have %HOME%\.lyx\lyxrc then move
  71    %X11ROOT%\XFree86\lyxrc.example to %HOME%\.lyx\lyxrc.
  72    If updating, make a backup of old version, if you want.
  73    Read README and WHATSNEW about updating and run
  74    Options->Reconfigure as indicated.
  75
  76 4) Verify if LYX is able to find the programs mentioned
  77    in %HOME%\.lyx\lyxrc and in %HOME%\.lyx\lyxrc.defaults; if not,
  78    change name and path as required.
  79
  80    Note: Remember to repeat the check after any 'Reconfigure'!
  81
  82 5) In config.sys SET LANG and LANGUAGE according to
  83    your preferences. Beware: All programs supporting local
  84    languages will be affected, e.g.:
  85
  86 SET LANG=de_DE          rem german helpfiles will be used
  87 SET LANGUAGE=de_DE      rem german menus and messages
  88
  89 6) Restart OS/2 and run LyX. Have fun!
  90
  91
  92
  93         B. Help/Problems:
  94            -------------
  95
  96 * Please refer to the manpage (type 'man lyx' on the command line or
  97   use 'xman')
  98
  99 * If you encounter apparently OS/2 specific bugs, (i.e. bugs not
 100   already mentioned in the documentation or the buglist) you can report
 101   them to the XFree86/OS2 mailing list as well as to the LyX developer
 102   mailing list.
 103
 104 * For any questions on using LyX please subscribe to the the LyX user
 105   mailing list.
 106
 107   - To subscribe to the XFree86 mailing list send mail to
 108       majordomo@borneo.gmd.de
 109     with "subscribe" as the subject.
 110     To contribute to the mailing list, mail to
 111       xfreeos2@borneo.gmd.de
 112
 113   - For subscription to lyx-user list (general help on LyX) go to
 114         http://www.lyx.org
 115     and search for subscription info.
 116
 117 * Hints:
 118   -----
 119 1. To prevent 'file not found' with EmTeX and some non-US versions
 120    of Warp, I recommend:
 121
 122         1) In filenames use only A-Z, a-z, 1-9.
 123
 124         2) Use a recent LaTeX package inputenc.sty. Select
 125            Layout->Document->Encoding:latin1, so that LyX adds
 126            the LaTeX command '\usepackage[latin1]{inputenc}'.
 127
 128 2. LaTeX import occasionally produces buggy *.lyx files. LyX tries
 129    to save data in case of problems (and does a good job here),
 130    but I recommend:
 131
 132         To import LaTeX close down and restart LyX (or close all
 133         documents, you are working on) and try the import, so that
 134         in case of any problems none of your existing documents will
 135         be affected.
 136
 137 3. Inline preview of inline images sometimes does not show the
 138    image: If you want to preview the image, just click on it and
 139    select fullscreen preview.
 140
 141 4. Some XFree/2 programs (as ported from UNIX) expect a sh.exe
 142    in \bin directory: I recommend to install sh.exe of pdksh.zip
 143    in x:\bin (x: drive of %X11ROOT%). To work around problems you
 144    can try the commands
 145         set EMXSHELL=x:\bin\sh.exe
 146    before starting the programs. As far as I know, LyX runs without
 147    problems in this way.
 148
 149
 150 Some suggestions in case of problems:
 151 ------------------------------------
 152 1) Please check, if your x:\xfree86\lib does appear correctly in
 153    libpath.
 154
 155 2) Please check against the file list, if you did install all files of
 156    the distribution.
 157
 158 3) Remove all installed files and
 159         %.home%/.lyx/
 160    and perform a
 161         chkdsk /f
 162    and a consistency check of your lyx binary package (unzip -tv
 163    foo.zip).
 164
 165 4) Reinstall the complete package and check out if everything appears,
 166    no truncated files, no crc errors, etc.
 167
 168 5) Run
 169         lyx -dbg 1026 >lyxerrors.log 2>&1
 170    or, if you have tee.exe,
 171         lyx -dbg 1026 2>&1|tee lyxerrors.log
 172   and watch out for any error messages. Report any remaining problems.
 173   As this is a completely voluntary project, everybody involved will be
 174   grateful for user efforts like detailed bug reports, suggestions,
 175   fixes, additions to the documentation, etc.
 176
 177 6) Have fun! (I'm sure).
 178
 179
 180         C. Tips for Advanced Users:
 181            -----------------------
 182 * You can start LyX automatically by adding
 183         'start/min/n xconsole.exe'
 184         'set EMXSHELL=x:\bin\sh.exe'
 185         'start/min/n lyx >/dev/console$ 2>&1'
 186   to xinitrc.cmd before the line that invokes the
 187   window manager, so that LyX' messages appear in the
 188   console window and LyX appears in the pm-task list.
 189
 190 * You can start LyX automatically by adding
 191         'detach xconsole.exe'
 192         'detach lyx >/dev/console$ 2>&1'
 193   to xinitrc.cmd before the line that invokes the
 194   window manager, so that LyX' messages appear in the
 195   console window and LyX does not appear in the PM task list.
 196
 197 \x1a