Update of /cvsroot/cbar/cbar/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17658/docs
Modified Files:
cbar._tx changes._tx readme._tx
Log Message:
Some more makefile cleanup/improvements
Index: cbar._tx
===================================================================
RCS file: /cvsroot/cbar/cbar/docs/cbar._tx,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** cbar._tx 4 Feb 2004 06:21:58 -0000 1.4
--- cbar._tx 8 Feb 2004 11:34:11 -0000 1.5
***************
*** 4,8 ****
@#
@multiwordheaders
! @manh="version 0.9.2" "CBAR" "Manual"
@document_title=CBAR Manual
@rtfh=cbar - an add on lib to CGUI for bar code reading
--- 4,8 ----
@#
@multiwordheaders
! @manh="version 1.0.2" "CBAR" "Manual"
@document_title=CBAR Manual
@rtfh=cbar - an add on lib to CGUI for bar code reading
***************
*** 30,34 ****
<center>Homepage: <a href="http://www.idt.mdh.se/~csg/cgui/cguix">http://www.idt.mdh.se/~csg/cgui/cguix</a></center>
<center><b>
! The Manual of CBAR 0.9.3
</b></center>
@!text
--- 30,34 ----
<center>Homepage: <a href="http://www.idt.mdh.se/~csg/cgui/cguix">http://www.idt.mdh.se/~csg/cgui/cguix</a></center>
<center><b>
! The Manual of CBAR 1.0.2
</b></center>
@!text
Index: changes._tx
===================================================================
RCS file: /cvsroot/cbar/cbar/docs/changes._tx,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** changes._tx 4 Feb 2004 06:21:58 -0000 1.3
--- changes._tx 8 Feb 2004 11:34:11 -0000 1.4
***************
*** 20,24 ****
@$This is the Info version of the Changes in CBAR file.
@$
! @$By Christer Sandberg
@$@end ifinfo
@$
--- 20,24 ----
@$This is the Info version of the Changes in CBAR file.
@$
! @$By Christer Sandberg
@$@end ifinfo
@$
***************
*** 40,43 ****
--- 40,55 ----
Changes
+ 1.0.2:
+ <ul>
+ <li>
+ Fixed bug 888698: Improved makfiles to make it possible to build on Linux.
+ <li>
+ Some general improvements in makefiles (e.g. uninstall, clean and
+ veryclean corrected, removing of redundant code)
+ <li>
+ Removed makedoc, using CGUI's makedoc instead.
+ <li>
+ Minor bufixes and clearifications in the docs.
+ </ul>
1.0.1:
<ul>
Index: readme._tx
===================================================================
RCS file: /cvsroot/cbar/cbar/docs/readme._tx,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** readme._tx 4 Feb 2004 06:21:58 -0000 1.4
--- readme._tx 8 Feb 2004 11:34:11 -0000 1.5
***************
*** 45,72 ****
Introduction
! CBAR is a library with functions for sending and receiving data via the
! serial ports, using the event queue of CGUI. It also provides a dialogue
! that lets the user modify the port settings.
! CBAR compiles on the following platforms: DOS/DJGPP, Linux,
Windows/Mingw32 and Windows/MSVC.
- The current version have full functionality only on the DJGPP platform,
- there are only stubs present for the other platforms.
-
- You need to have compiled and installed Allegro v. 4 or later, as well as
- CGUI v. 1.6 or later and CCOM 0.9 or later.
-
-
@heading
Requirements
! You need to have compiled and installed Allegro as well as CGUI and CCOM.
! You need at least version 4.0 of Allegro, 1.6 of CGUI and 0.9 of CCOM.
! 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. but
! these are already fulfilled if you succeded in making Allegro (no additional
! requirements are needed).
You can find Allegro at:
--- 45,63 ----
Introduction
! CBAR is a library with functions that let you communicate with a bar
! code reader in a simple way. It relies on CGUI for dialogs and on
! CCOM for serial communication.
! CBAR builds and operates on the following platforms: DOS/DJGPP, Linux,
Windows/Mingw32 and Windows/MSVC.
@heading
Requirements
! You need to have compiled and installed Allegro version 4.0.x, as well as
! CGUI vesion 1.6.5 or later.
! There are also other requirements like correctly installed compilers etc.
! but these are already fulfilled if you succeded in making and installing
! Allegro and CGUI (no additional requirements are needed).
You can find Allegro at:
***************
*** 79,99 ****
http://www.mdh.se/~csg/cgui/cguix
-
@heading
Installation
! Installation goes in three simple steps, and should be familiar since it is
! exactly the same way as you installed Allegro, CGUI and CCOM:
<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
--- 70,90 ----
http://www.mdh.se/~csg/cgui/cguix
@heading
Installation
! Installation goes in five 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. Start a command window
! (shell) and set the main directory of cbar to you current directory
! (i.e. enter the command > cd <the path to your cbar directory>). Choose
! platform by running one of the following commands:<br>
<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
***************
*** 104,114 ****
</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.
--- 95,113 ----
</pre>
or alternatively put that line into your autoexec file and restart.
+ For unix users:
+ <pre>
+ 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
! CGUIDIR the same way as ALLEGRO, e.g.<br>
<pre>
set CGUIDIR=c:\cgui
</pre>
! or for unix users:
! <pre>
! export CGUIDIR=/home/user/cgui
! </pre>
<li>
Compile the library. This is done by running "make" at the command line.
***************
*** 118,147 ****
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 libcbard.a instead of libcbar.a.
<li>
! If you want to read the CBAR documentation with the Rhide online help
! system, go to the "Help / Syntax help / Files to search" menu, and add
! "cbar" 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.
-
- @heading
Usage
<ul><li>
--- 117,155 ----
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), or else you need to
! run make install as root.
</ul>
! That's it! Now you are ready to run the example program in the example directory.
! <p>
! 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 teh environment vaariable
! UNIX_TOOLS to 1 before make install is run.
! <li>
! If you want to read the CBAR documentation with the Rhide online help
! system, go to the "Help / Syntax help / Files to search" menu in Rhide,
! and add "cbar" after the existing "libc" entry (separated by a space).
! <li>
! To use the
! To use the debugging library, link with libccomd.a instead of libccom.a.
</ul>
@heading
Usage
<ul><li>
***************
*** 149,156 ****
--- 157,179 ----
the library.
<li>
+ Before calling any CBAR functions you must have initialized CBAR and CGUI,
+ Note also <b>CGUI</b>! For info about available functions, please read
+ the manual, e.g. cbarm.html (but the docs are also available in other
+ formats).
+ <li>
If you link your program on the command line, link with
'-lcbar -lccom -lcgui -lalleg'. It is important that you specify the
libraries in that order. If you want the ability to debug inside CBAR's
functions, then link with '-lcbard' instead of '-lcbar'.
+ <p>
+ On Linux you can use the following command to link with the default
+ lib of CBAR (please note the ` )
+ <pre>
+ gcc -s -lcbar -lccom -lcgui `allegro-config --libs release --shared` file.o
+ </pre>
+ where `file' is the name of your file. <br>
+ For debug libraries use -lcbard -lccomd -lcguid instead and replace release
+ with debug in the allegro config option. For linking a static application
+ use -lcbar_s -lccom_s -lcgui_s and replace --shared with --static.
<li>
If you use RHIDE, go to the menu Options/Libraries and fill in cbar. It is
***************
*** 158,173 ****
check the box to the left of the library. You have to replace cbar with
cbard to include debugging information.
- <li>
- Before calling any CBAR functions you must have initialized CBAR and CGUI,
- Note also <b>CGUI<b>!
</ul>
-
@heading
Contact Info
Email:<ul>
! cs...@md...
</ul>
Homepage:<ul>
--- 181,192 ----
check the box to the left of the library. You have to replace cbar with
cbard to include debugging information.
</ul>
@heading
Contact Info
Email:<ul>
! chr...@md...
</ul>
Homepage:<ul>
|