[Cpri-develop] cpri/docs readme._tx,1.5,1.6

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/cpri/cpri/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv22040/docs

Modified Files:
	readme._tx 
Log Message:
Fixed some build issues

Index: readme._tx
===================================================================
RCS file: /cvsroot/cpri/cpri/docs/readme._tx,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** readme._tx	8 Nov 2004 21:27:23 -0000	1.5
--- readme._tx	21 Sep 2005 18:39:34 -0000	1.6
***************
*** 6,11 ****
  @#multiplefiles
  @#locale=latin1
! @h=<html><head><title>#</title><body>
! @f=<p><hr><p><a href="readme.html">Back to Contents</a><p>
  @rtfh=Readme for CPRI
  @$\input texinfo
--- 6,10 ----
  @#multiplefiles
  @#locale=latin1
! @document_title=CPRI readme
  @rtfh=Readme for CPRI
  @$\input texinfo
***************
*** 48,54 ****

  CPRI is a library with functions for pretty printing of tables or table-like
! printouts using the event queue of CGUI. It also provides a dialogue
! that lets the user modify the printer settings, and one for administration of
! the printer queues for the DJGPP platform.

  CPRI compiles on the following platforms: DOS/DJGPP, Linux,
--- 47,53 ----

  CPRI is a library with functions for pretty printing of tables or table-like
! printouts. It also provides a dialogue that lets the user modify the printer
! settings, and one for administration of the printer queues for the DJGPP
! platform. CPRI depends on some features in the lib CGUI.

  CPRI compiles on the following platforms: DOS/DJGPP, Linux,
***************
*** 56,64 ****

  The current version have full functionality only on the DJGPP and Windows
! platforms, there are only stubs present for the other platforms.
! 
! You need to have compiled and installed Allegro version 4.0 or later, as
! well as CGUI version 1.6 or later.
! 

  @heading
--- 55,59 ----

  The current version have full functionality only on the DJGPP and Windows
! platforms, there is only a stub present for the Linux platform.

  @heading
***************
*** 66,70 ****

  You need to have compiled and installed Allegro 4.0.x as well as CGUI 1.6.7 or later.
! You must set the environment variable ALLEGRO to point out your Allegro
  installation and set CGUIDIR to point to your CGUI installation.
  There are also other requirements like correctly installed compilers etc.
--- 61,65 ----

  You need to have compiled and installed Allegro 4.0.x as well as CGUI 1.6.7 or later.
! You have to set the environment variable ALLEGRO to point out your Allegro
  installation and set CGUIDIR to point to your CGUI installation.
  There are also other requirements like correctly installed compilers etc.
***************
*** 83,98 ****

  Installation goes in some simple steps, and should be familiar since it is
! similar to the installation procedure as of Allegro and CGUI:
  <ul>
  <li>
!    Tell the installation process what platform you use. This is done by
!    running one of the following:<br>
  <pre>
        fix.bat djgpp     - to compile with DOS/DJGPP
        fix.bat mingw32   - to compile with Windows/MinGW32
-       fix.bat bcc32     - to compile with Windows/Borland C++
        fix.bat msvc      - to compile with Windows/MSVC
!       fix.sh unix       - to compile with Linux/gcc
! </pre><li>
  <li>
     Specify the path to your allegro installation by setting the environment
--- 78,99 ----

  Installation goes in some simple steps, and should be familiar since it is
! similar to the installation procedure as of CGUI:
  <ul>
  <li>
!    Tell the installation process what platform you use. Start a command window
!    (shell) and set the main directory of CPRI to you current directory
!    i.e. enter the command
!    <pre>
!        cd c:\cpri
!    </pre>
!    or whatever is the name of your CPRI directory. Then choose platform by
!    running one of the following commands:
  <pre>
        fix.bat djgpp     - to compile with DOS/DJGPP
        fix.bat mingw32   - to compile with Windows/MinGW32
        fix.bat msvc      - to compile with Windows/MSVC
!       ./fix.sh unix     - to compile with Linux/gcc
! </pre>
! 
  <li>
     Specify the path to your allegro installation by setting the environment
***************
*** 107,111 ****
     export ALLEGRO=/home/user/allegro-4.0.3
     </pre>
!    or whatever is the name of your allegro directory.
  <li>
     Specify the path to your CGUI installation by setting the environment
--- 108,117 ----
     export ALLEGRO=/home/user/allegro-4.0.3
     </pre>
!    or whatever is the name of your allegro directory.<br>
!    When CPRI is built some programs in the `tools' directory of Allegro will be
!    needed, so you have to install an Allegro version built from sources (or
!    alternatively obtain the required tools some other way, put them in a
!    directory named `tools' and let the variable ALLEGRO point out the directory
!    immediately above `tools').
  <li>
     Specify the path to your CGUI installation by setting the environment
***************
*** 128,139 ****
         make mktext
     </pre>
!    Return to the main directory of cbar, e.g.:
     <pre>
         cd c:\cpri
     </pre>
  <li>
!    Compile the library. This is done by running "make" at the command line.
  <li>
!    Install the files to common directories. This is done by running
     "make install" at the command line.<br>
     Linux/Unix specifics:<br>
--- 134,145 ----
         make mktext
     </pre>
!    Return to the main directory of CPRI, e.g.:
     <pre>
         cd c:\cpri
     </pre>
  <li>
!    Compile the CPRI library. This is done by running "make" at the command line.
  <li>
!    Install the CPRI files to common directories. This is done by running
     "make install" at the command line.<br>
     Linux/Unix specifics:<br>
***************
*** 144,174 ****
     </pre>
     and enter the root password when prompted for.<br>
!    Alternatively, if you cannot be root you may install cpri to some other
     location by running "make install SYSTEM_DIR=&ltdir&gt", which will cause
     headers to be installed to &ltdir&gt/include and libraries to
     &ltdir&gt/lib. Default for &ltdir&gt is /usr/local.<br>
!    To be able to link your program to an installation at some other location
!    than the default you need to specifiy the paths when compiling and linking.
  </ul>
!    That's it! You may also want to perform some of the optional steps:
! <ul><li>
!    You can compile a debugging library by typing "make DEBUGMODE=1". To
!    compile both the usual and the debug library in one step, type "make all".
  <li>
!    To link your application with the debugging lib, link with -lcprid
!    instead of -lcpri.
  <li>
     If you want to read the CPRI documentation with the Rhide online help
!    system, go to the "Help / Syntax help / Files to search" menu, and add
!    "ccom" after the existing "libc" entry (separated by a space).
  <li>
!    If you want statically linked libraries under Unix or Windows just add
!    "STATICLINK=1" at end of the make command. The static libraries
!    require the statically linked versions of Allegro and CGUI.
  </ul>

  @heading
  MSys
! Users of the MSys environment needs to set the environment vaariable
  UNIX_TOOLS to 1 before make install is run.

--- 150,195 ----
     </pre>
     and enter the root password when prompted for.<br>
!    Alternatively, if you cannot be root you may install CPRI to some other
     location by running "make install SYSTEM_DIR=&ltdir&gt", which will cause
     headers to be installed to &ltdir&gt/include and libraries to
     &ltdir&gt/lib. Default for &ltdir&gt is /usr/local.<br>
!    To be able to link your program to the CPRI files installed at some other
!    location than the default you need to specifiy the paths to your compiler
!    and linker.
  </ul>
! That's it! Now you are ready to run the example program in the example directory.
! <hr>
! You may also want to perform some of the optional steps during the installation:
! <ul>
  <li>
!    You can compile a debugging library by typing "make DEBUGMODE=1" instead of
!    just "make" and "make install DEBUGMODE=1" instead of "make install".
!    To compile both the usual and the debug library in one step,
!    type "make all" and "make installall".<br>
!    These debugging libraries require that you also have maked and installed
!    the debugging versions of Allegro and CGUI.
! <li>
!    If you want statically linked libraries under Unix or Windows as well as
!    the default dynamically linked libraries (dll under Windows, .so under
!    Unix), add "STATICLINK=1" to the make command like "make STATICLINK=1",
!    or "make DEBUGMODE=1 STATICLINK=1" and also add it to the installation
!    command.<br>
!    These static libraries require that you also have maked and installed
!    the static versions of Allegro and CGUI.
! <li>
!    Users of the MSys environment needs to set the environment vaariable
!    UNIX_TOOLS to 1 before make install is run.
  <li>
     If you want to read the CPRI documentation with the Rhide online help
!    system, go to the "Help / Syntax help / Files to search" menu in Rhide,
!    and add "cpri" after the existing "libc" entry (separated by a space).
  <li>
!    To link your application with the debugging lib, link with -lcprid
!    instead of -lcpri.
  </ul>

  @heading
  MSys
! Users of the MSys environment needs to set the environment variable
  UNIX_TOOLS to 1 before make install is run.

***************
*** 179,189 ****
     the library.
  <li>
!    If you link on the command line, link with '-lpri -lcgui -lalleg'. It is
!    important that you specify the libraries in that order. If you want the
!    ability to debug inside CPRI's functions, then link with '-lcprid'
!    instead of '-lcpri'.
  <li>
!    If you use RHIDE, go to the menu Options/Libraries and fill in cpri. It is
!    important that cpri is above `cgui' and `alleg'. Don't forget to check the
     box to the left of the library. You have to replace cpri with cprid to
     include debugging information.
--- 200,225 ----
     the library.
  <li>
!    Before calling any CPRI functions you must have initialized CPRI and CGUI,
!    Note also <b>CGUI</b>! For info about available functions, please read
!    the manual, e.g. cpri.html (but the docs are also available in other
!    formats).
  <li>
!    If you link your program on the command line, link with
!    '-lcpri -lcgui -lalleg'.  It is important that you specify the
!    libraries in that order. If you want the ability to debug inside CPRI's
!    functions, then link with '-lcprid' instead of '-lcpri'.
!    <p>
!    On Linux you can use the following command to link with the default
!    lib of CPRI (please note the ` )
!    <pre>
!    gcc -s -lcpri -lcgui `allegro-config --libs release --shared` file.o
!    </pre>
!    where `file' is the name of your file. <br>
!    For debug libraries use -lcprid -lcguid instead and replace release
!    with debug in the allegro config option. For linking a static application
!    use -lcpri_s -lcgui_s and replace --shared with --static.
! <li>
!    If you use RHIDE, go to the menu Options/Libraries and fill in CPRI. It is
!    important that `cpri' is above `cgui' and `alleg'. Don't forget to check the
     box to the left of the library. You have to replace cpri with cprid to
     include debugging information.
***************
*** 194,198 ****

- 
  @heading
  Contact Info
--- 230,233 ----