|
From: <ch...@pr...> - 2004-02-01 17:11:15
|
Update of /cvsroot/cpri/cpri/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2313/docs Modified Files: changes._tx cpri._tx readme._tx Log Message: Fixed bug 888505 Doesn't build on Linux. Clearified some stuff in the readme. Removed misc/makedoc. There is already dependencies to cgui so cgui's makedoc can preferably be used (CGUIDIR is required for cpri and has so been all the time) Cleaned some other junk from makefiles. Corrected some syntactical matters in docs to avoid warnings from makedoc. Index: changes._tx =================================================================== RCS file: /cvsroot/cpri/cpri/docs/changes._tx,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** changes._tx 14 Dec 2003 16:42:40 -0000 1.4 --- changes._tx 1 Feb 2004 17:09:16 -0000 1.5 *************** *** 41,44 **** --- 41,49 ---- Changes + 0.9.4: + <ul> + <li> Fixed bug 888505 Doesn't build on Linux + <li> Clearified some stuff in the readme. + </ul> 0.9.3: <ul> Index: cpri._tx =================================================================== RCS file: /cvsroot/cpri/cpri/docs/cpri._tx,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** cpri._tx 14 Dec 2003 16:42:40 -0000 1.9 --- cpri._tx 1 Feb 2004 17:09:16 -0000 1.10 *************** *** 231,235 **** file. ! @@t_handle @CpriOpenEntry(int qno, const char *print_name, int option, const char *print_out_name); OpenEntry opens a queue entry for storing text to print and Cpri printer commands. The return value is a pointer to a handle to be used when --- 231,235 ---- file. ! @@t_handle @CpriOpenEntry(int qno, const char *print_name, int option, const char *destination); OpenEntry opens a queue entry for storing text to print and Cpri printer commands. The return value is a pointer to a handle to be used when *************** *** 244,251 **** <li>print_name - an optional string to label the job in the queue <li>option - no options implemented yet ! <li>filename - If you want the printout to be directed to a file rather ! than to a printer, the name of just pass the name "filename". If you want the printout to go to the printer pass the empty string ! for "filename". The file name suffix will be used to determine the type of printout, i.e. *.txt will force a textfile and *.htm and *.html will force a html file. --- 244,251 ---- <li>print_name - an optional string to label the job in the queue <li>option - no options implemented yet ! <li>destination - If you want the printout to be directed to a file rather ! than to a printer, the name of just pass the name of the file. If you want the printout to go to the printer pass the empty string ! for `destination'. The file name suffix will be used to determine the type of printout, i.e. *.txt will force a textfile and *.htm and *.html will force a html file. Index: readme._tx =================================================================== RCS file: /cvsroot/cpri/cpri/docs/readme._tx,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** readme._tx 4 Jun 2003 18:33:44 -0000 1.2 --- readme._tx 1 Feb 2004 17:09:16 -0000 1.3 *************** *** 1,3 **** - @# @# This is the source for the CPRI readme file, in Allegro's custom format. @# Read allegro/docs/makedoc.c for a description of what is going on... --- 1,2 ---- *************** *** 66,71 **** Requirements ! You need to have compiled and installed Allegro as well as CGUI. ! You need at least version 4.0 of Allegro and 1.6 of CGUI. You must set the environment variable ALLEGRO to point out your Allegro installation and set CGUIDIR to point to your CGUI installation. --- 65,69 ---- Requirements ! You need to have compiled and installed Allegro 4.o.x as well as CGUI 1.6 or later. You must set the environment variable ALLEGRO to point out your Allegro installation and set CGUIDIR to point to your CGUI installation. *************** *** 85,89 **** Installation goes in three simple steps, and should be familiar since it is ! exactly the same way as you installed Allegro and CGUI: <ul> <li> --- 83,87 ---- Installation goes in three simple steps, and should be familiar since it is ! exactly the same way as you installed CGUI: <ul> <li> *************** *** 98,115 **** </pre><li> <li> ! Specify the path to your allegro installation by setting the environment ! variable ALLEGRO. E.g. if your allegro directory is c:\allegro then ! you must type <br> <pre> ! set ALLEGRO=c:\allegro </pre> ! or alternatively put that line into your autoexec file and restart. ! <li> ! Specify the path to your CGUI installation by setting the environment ! variable CGUIDIR E.g.<br> <pre> ! set CGUIDIR=c:\cgui </pre> ! if your cgui directory is located at c: <li> Compile the library. This is done by running "make" at the command line. --- 96,119 ---- </pre><li> <li> ! Specify the path to your allegro and cgui installation ! <ul> ! <li>DOS/Windows platforms. If your allegro and cgui directories are ! e.g. c:\allegro and c:\cgui respectively, then you have to type ! (at the command line): ! <br> <pre> ! set ALLEGRO=c:\allegro - ! sett CGUIDIR=c:\cgui </pre> ! or alternatively put that line into your autoexec file and restart ! your computer. ! <li>Linux/Unix platforms. If your allegro and cgui directories are ! e.g. ~/allegro-4.0.3 and ~/cgui respectively, then you have to type ! (at the command line): <pre> ! export ALLEGRO=~/allegro-4.0.3 ! export CGUIDIR=~/cgui </pre> ! </ul> <li> Compile the library. This is done by running "make" at the command line. *************** *** 117,130 **** Install the files to common directories. This is done by running "make install" at the command line.<br> ! Under Linux, you may want to instead run "make install SYSTEM_DIR=<dir>", ! which will cause headers to be installed to <dir>/include and libraries to ! <dir>/lib. (default for <dir> is /usr/local) </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 use the debugging library, link with libccomd.a instead of libccom.a. <li> If you want to read the CPRI documentation with the Rhide online help --- 121,145 ---- Install the files to common directories. This is done by running "make install" at the command line.<br> ! Linux/Unix specifics:<br> ! You need to be root to succeed with the installation command i.e. type the ! command<br> ! <pre> ! su -c "make install" ! </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=<dir>", which will cause ! headers to be installed to <dir>/include and libraries to ! <dir>/lib. Default for <dir> 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 *************** *** 132,145 **** "ccom" after the existing "libc" entry (separated by a space). <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), set the environment variable "STATICLINK=1", and repeat the ! "make install" and "make install DEBUGMODE=1". These static libraries ! require the statically linked version of Allegro and CGUI. </ul> @heading MSys ! Users of the MSys environment needs to set teh environment vaariable UNIX_TOOLS to 1 before make install is run. --- 147,158 ---- "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. *************** *** 147,162 **** Usage <ul><li> ! #include <ccom.h> in the top of each file that uses a function from the library. <li> ! If you link on the command line, link with '-lccom -lcgui -lalleg'. It is important that you specify the libraries in that order. If you want the ! ability to debug inside CPRI's functions, or if you want the library to ! check for bad format strings (recommended for everything that is not a ! release version), then link with '-lccomd' instead of '-lccom'. <li> ! If you use RHIDE, go to the menu Options/Libraries and fill in ccom. It is ! important that ccom is above cgui and allegro. Don't forget to check the ! box to the left of the library. You have to replace ccom with ccomd to include debugging information. <li> --- 160,174 ---- Usage <ul><li> ! #include <cpri.h> in the top of each file that uses a function from 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. <li> |
