Update of /cvsroot/ccomx/ccom/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8749/docs
Modified Files:
ccom._tx changes._tx internal._tx readme._tx
Log Message:
fixed feature 715534, fixed docs accordingly, fixed allegro.cfg
Index: ccom._tx
===================================================================
RCS file: /cvsroot/ccomx/ccom/docs/ccom._tx,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** ccom._tx 9 Dec 2003 19:03:29 -0000 1.4
--- ccom._tx 8 Feb 2004 20:47:21 -0000 1.5
***************
*** 6,10 ****
@#
@multiwordheaders
! @manh="version 0.9.1" "CCOM" "Manual"
@document_title=CCOM Manual
@rtfh=CCOM - an add on lib to CGUI for accessing the serial ports
--- 6,10 ----
@#
@multiwordheaders
! @manh="version 1.0.0" "CCOM" "Manual"
@document_title=CCOM Manual
@rtfh=CCOM - an add on lib to CGUI for accessing the serial ports
***************
*** 32,36 ****
<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 CCOM 0.9.1
</b></center>
@!text
--- 32,36 ----
<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 CCOM 1.0.0
</b></center>
@!text
Index: changes._tx
===================================================================
RCS file: /cvsroot/ccomx/ccom/docs/changes._tx,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** changes._tx 9 Dec 2003 19:03:29 -0000 1.3
--- changes._tx 8 Feb 2004 20:47:21 -0000 1.4
***************
*** 1,3 ****
- @#
@# This is the source for the CCOM changes file, in Allegro's custom format.
@# Read allegro/docs/makedoc.c for a description of what is going on...
--- 1,2 ----
***************
*** 5,11 ****
@#ignore_css
@multiwordheaders
! @#locale=latin1
! @h=<html><head><title>#</title><body>
! @f=<p><hr><p><a href="changes.html">Back to Contents</a><p>
@rtfh=Changes in CCOM
@$\input texinfo
--- 4,8 ----
@#ignore_css
@multiwordheaders
! @document_title=CCOM Changes
@rtfh=Changes in CCOM
@$\input texinfo
***************
*** 23,27 ****
@$This is the Info version of the Changes in CCOM file.
@$
! @$By Christer Sandberg
@$@end ifinfo
@$
--- 20,24 ----
@$This is the Info version of the Changes in CCOM file.
@$
! @$By Christer Sandberg Rasmus Myklebust
@$@end ifinfo
@$
***************
*** 31,40 ****
@<title>Changes in CCOM</title>
@<body>
! <center><b>A CGUI and Allegro addon for serial communication</b></center>
<center><b>by Christer Sandberg and Rasmus Myklebust</b></center>
<center>Email: <email>chr...@md...</a></center>
<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 change log of CPRI
</b></center>
@!text
--- 28,37 ----
@<title>Changes in CCOM</title>
@<body>
! <center><b>A CGUI and Allegro addon for serial port communication</b></center>
<center><b>by Christer Sandberg and Rasmus Myklebust</b></center>
<center>Email: <email>chr...@md...</a></center>
<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 changes log of CCOM
</b></center>
@!text
***************
*** 42,46 ****
Changes
! 0.9.1:
<ul>
<li>
--- 39,55 ----
Changes
! 0.9.2:
! <ul>
! <li>
! Fixed feature 715534 "Add driver for linux"
! <li>
! Fixed bug 888637 "Doesn't build on Linux"
! <li>
! Fixed bug 715554 "Remove unused items from dialogue"
! <li>
! Made some minor corrections in the doc files
! </ul>
!
! 0.9.1:
<ul>
<li>
Index: internal._tx
===================================================================
RCS file: /cvsroot/ccomx/ccom/docs/internal._tx,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** internal._tx 30 Mar 2003 19:50:40 -0000 1.2
--- internal._tx 8 Feb 2004 20:47:21 -0000 1.3
***************
*** 1,32 ****
! @#
! @# This is the source for the document describing the internals of CCOM.
! @# Allegro's custom format is used here. Read allegro/docs/makedoc.c for a
! @# description of what is going on...
! @#
! @# The point is that you read some of the documents internal.txt,
! @# internal.info, internal.html or internal.rtf rather than this file!
@#
@#ignore_css
- @#multiplefiles
@multiwordheaders
! @#locale=latin1
! @h=<html><head><title>#</title><body>
! @f=<p><hr><p><a href="internal.html">Back to Contents</a><p>
! @rtfh=CCOM Internal
! @# Note: this version number is patched by fixver.sh
! @manh="version 0.9.0" "CCOM" "CCOM Internal"
@$\input texinfo
! @$@setfilename internal.inf
! @$@settitle CCOM Internal
@$@setchapternewpage odd
@$@paragraphindent 0
@$
@$@ifinfo
@$@direntry
! @$* Internal: (internal). Internal description of CCOM.
@$@end direntry
! @$This is the Info version of the CCOM Internal description.
@$
! @$By Christer Sandberg
@$@end ifinfo
@$
--- 1,24 ----
! @# This is the source for the document describing the internals of CCOM in Allegro's custom format.
! @# Read allegro/docs/makedoc.c for a description of what is going on...
@#
@#ignore_css
@multiwordheaders
! @document_title=CCOM Internals
! @rtfh=Internals of CCOM
@$\input texinfo
! @$@setfilename internals.inf
! @$@settitle Internals of CCOM
@$@setchapternewpage odd
@$@paragraphindent 0
+ @$@setchapternewpage off
+ @# This should remain commented at the moment (dvi output) @$@finalout
@$
@$@ifinfo
@$@direntry
! @$* Internals: (internals). Internals in CCOM
@$@end direntry
! @$This is the Info version of the internals CCOM file.
@$
! @$By Christer Sandberg and Rasmus Myklebust
@$@end ifinfo
@$
***************
*** 34,74 ****
@<html>
@<head>
! @<title>CCOM Internal description</title>
! @<head>
! @<title>Readme for CCOM</title>
@<body>
! <center><b>CCOM</b></center>
! <center><b>A CGUI and Allegro addon Communication package</b></center>
<center><b>by Christer Sandberg and Rasmus Myklebust</b></center>
<center>Email: <email>chr...@md...</a></center>
<center>Homepage: <a href="http://www.idt.mdh.se/~csg/cgui/cguix">http://www.idt.mdh.se/~csg/cgui/cguix</a></center>
! <center><b>Internal description of CCOM</b></center>
@!text
-
@heading
Contents
! @shortcontents
@text
@heading
Introduction
! Currently CCOM only supports the DJGPP an Windows platforms. It uses the
! DJGPP specific functions for direct access to the I/O-bus on the PC. This
! is use both when setting parameters and when sending/receiving data. <br>
! The sending/receiving of data is always performed in polling mode. The
! async device was ment to be run in interrupt mode (the original 16-bit
! DOS version of CCOM made it that way), but we havn't yet implemented
! that in DJGPP.
!
! @heading
! Porting
! The intention is also to make a Linux port of CCOM. This can at first
! stage be limited to polling only. This may sound a big limitation, but there
! are still very useful for devices like barcode readers that can fully
! benefit a polling driver. A barcode reader has a normal operational speed
! that makes polling sufficient in most case, specially if assuming a
! 16-byte buffered port, like 16550 which is the standard chip of computers
! since many years.
@heading
--- 26,50 ----
@<html>
@<head>
! @<title>Internals in CCOM</title>
@<body>
! <center><b>A CGUI and Allegro addon for serial port communication</b></center>
<center><b>by Christer Sandberg and Rasmus Myklebust</b></center>
<center>Email: <email>chr...@md...</a></center>
<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 internals of CCOM
! </b></center>
@!text
@heading
Contents
! @contents
@text
@heading
Introduction
! CCOM 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.
@heading
Index: readme._tx
===================================================================
RCS file: /cvsroot/ccomx/ccom/docs/readme._tx,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** readme._tx 4 Jun 2003 18:34:36 -0000 1.3
--- readme._tx 8 Feb 2004 20:47:21 -0000 1.4
***************
*** 1,3 ****
- @#
@# This is the source for the CCOM readme file, in Allegro's custom format.
@# Read allegro/docs/makedoc.c for a description of what is going on...
--- 1,2 ----
***************
*** 5,16 ****
@#ignore_css
@multiwordheaders
! @#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 CCOM
@$\input texinfo
@$@setfilename readme.inf
! @$@settitle Readme for CCOM
@$@setchapternewpage odd
@$@paragraphindent 0
--- 4,12 ----
@#ignore_css
@multiwordheaders
! @document_title=CCOM readme
! @rtfh=Readme file of CCOM
@$\input texinfo
@$@setfilename readme.inf
! @$@settitle Readme of CCOM
@$@setchapternewpage odd
@$@paragraphindent 0
***************
*** 20,28 ****
@$@ifinfo
@$@direntry
! @$* CCOM: (CCOM). Readme file for CCOM
@$@end direntry
@$This is the Info version of the CCOM readme file.
@$
! @$By Christer Sandberg
@$@end ifinfo
@$
--- 16,24 ----
@$@ifinfo
@$@direntry
! @$* Readme: (readme). Readme in CCOM
@$@end direntry
@$This is the Info version of the CCOM readme file.
@$
! @$By Christer Sandberg and Rasmus Myklebust
@$@end ifinfo
@$
***************
*** 30,43 ****
@<html>
@<head>
! @<title>Readme for CCOM</title>
@<body>
! <center><b>CCOM</b></center>
! <center><b>A CGUI and Allegro addon Communication package</b></center>
<center><b>by Christer Sandberg and Rasmus Myklebust</b></center>
<center>Email: <email>chr...@md...</a></center>
<center>Homepage: <a href="http://www.idt.mdh.se/~csg/cgui/cguix">http://www.idt.mdh.se/~csg/cgui/cguix</a></center>
! <center><b>Readme file for CCOM</b></center>
@!text
-
@heading
Contents
--- 26,39 ----
@<html>
@<head>
! @<title>Readme file of CCOM</title>
@<body>
! <center><b>A CGUI and Allegro addon for serial port communication</b></center>
<center><b>by Christer Sandberg and Rasmus Myklebust</b></center>
<center>Email: <email>chr...@md...</a></center>
<center>Homepage: <a href="http://www.idt.mdh.se/~csg/cgui/cguix">http://www.idt.mdh.se/~csg/cgui/cguix</a></center>
! <center><b>
! Readme file of CCOM
! </b></center>
@!text
@heading
Contents
***************
*** 53,76 ****
that lets the user modify the port settings.
! CCOM compiles on the following platforms: DOS/DJGPP, Linux,
Windows/Mingw32 and Windows/MSVC.
- 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
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.
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:
--- 49,63 ----
that lets the user modify the port settings.
! CCOM 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:
***************
*** 84,100 ****
Installation
! 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>
! 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
--- 71,88 ----
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 CCOM to you current directory
! (i.e. enter the command > cd <the path to your CCOM 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
***************
*** 105,115 ****
</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.
--- 93,110 ----
</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>
! <pre>
! export CGUIDIR=/home/user/cgui
! </pre>
<li>
Compile the library. This is done by running "make" at the command line.
***************
*** 119,146 ****
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 CCOM 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 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
--- 114,151 ----
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 CCOM documentation with the Rhide online help
! system, go to the "Help / Syntax help / Files to search" menu in Rhide,
! and add "ccom" 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
***************
*** 150,170 ****
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 CCOM'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>
! Before calling any CCOM functions you must have initialized CGUI, Note!
! CGUI!
</ul>
-
@heading
Contact Info
--- 155,187 ----
the library.
<li>
+ Before calling any CCOM functions you must have initialized CGUI, Note!
+ CGUI! For info about available functions, please read the manual, e.g.
+ ccom.html (but the docs are also available in other formats).
+ <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 CCOM's functions, then link with '-lccomd'
! instead of '-lccom'.
! <p>
! On Linux you can use the following command to link with the default
! lib of CCOM (please note the ` )
! <pre>
! gcc -s -lccom -lcgui `allegro-config --libs release --shared` file.o
! </pre>
! where `file' is the name of your file. <br>
! For debug libraries use -lccomd -lcguid instead and replace release
! with debug in the allegro config option. For linking a static application
! use -lccom_s and -lcgui_s and replace --shared with --static.
<li>
! If you use the RHIDE environment, 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>
! If you use some other environment, there is probably some options dialog
! where you can enter the libraries names (e.g. -lccom -lcgui -lalleg).
</ul>
@heading
Contact Info
|