pax_global_header00006660000000000000000000000064125152270170014514gustar00rootroot0000000000000052 comment=d1fd087eb61c3a1346bd80966a857096e9535fd6 libserial-0.6.0~rc2+svn122/000077500000000000000000000000001251522701700153215ustar00rootroot00000000000000libserial-0.6.0~rc2+svn122/ABOUT-NLS000066400000000000000000000000001251522701700165360ustar00rootroot00000000000000libserial-0.6.0~rc2+svn122/AUTHORS000066400000000000000000000002601251522701700163670ustar00rootroot00000000000000Manish P. Pagey Crayzee Wulf Jay Sachdev Jan Wedekind libserial-0.6.0~rc2+svn122/COPYING000066400000000000000000000431101251522701700163530ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. libserial-0.6.0~rc2+svn122/ChangeLog000066400000000000000000000022721251522701700170760ustar00rootroot000000000000002005-09-19 * configure.in: Released version 0.5.0. * src/PosixSignalDispatcher.cpp (Repository): Formatting changes only. No logical changes. * src/PosixSignalDispatcher.h (Repository): Formatting changes only. No logical changes. * src/SerialPort.cpp (Repository): Formatting changes only. No logical changes. 2005-09-18 * src/SerialPort.h (class SerialPort): The constructor for the class is now "explicit" to make sure that a std::string does not get converted to a SerialPort object through implicit conversion. The destructor is not virtual anymore as this class is not designed to be polymorphic. 2005-09-06 Jan Wedekind * examples/write_port.cpp: An example for writing commands to the serial port was added. * src/SerialStream.h: Functions for adjusting the port's VTIME- and VMIN-parameter where added. * src/SerialStreamBuf.cc: Missing return statement was added. 2003-12-30 Manish P. Pagey * src/SerialStreamBuf.cc: Interchanged "case 1" and "case 2" in SerialStreamBuf::SetNumOfStopBits() to make sure that stop bits are set correctly. This bug was pointed out by Olivier Chambard. libserial-0.6.0~rc2+svn122/INSTALL000066400000000000000000000363321251522701700163610ustar00rootroot00000000000000Installation Instructions ************************* Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without warranty of any kind. Basic Installation ================== Briefly, the shell commands `./configure; make; make install' should configure, build, and install this package. The following more-detailed instructions are generic; see the `README' file for instructions specific to this package. Some packages provide this `INSTALL' file but do not implement all of the features documented below. The lack of an optional feature in a given package is not necessarily a bug. More recommendations for GNU packages can be found in *note Makefile Conventions: (standards)Makefile Conventions. The `configure' shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses those values to create a `Makefile' in each directory of the package. It may also create one or more `.h' files containing system-dependent definitions. Finally, it creates a shell script `config.status' that you can run in the future to recreate the current configuration, and a file `config.log' containing compiler output (useful mainly for debugging `configure'). It can also use an optional file (typically called `config.cache' and enabled with `--cache-file=config.cache' or simply `-C') that saves the results of its tests to speed up reconfiguring. Caching is disabled by default to prevent problems with accidental use of stale cache files. If you need to do unusual things to compile the package, please try to figure out how `configure' could check whether to do them, and mail diffs or instructions to the address given in the `README' so they can be considered for the next release. If you are using the cache, and at some point `config.cache' contains results you don't want to keep, you may remove or edit it. The file `configure.ac' (or `configure.in') is used to create `configure' by a program called `autoconf'. You need `configure.ac' if you want to change it or regenerate `configure' using a newer version of `autoconf'. The simplest way to compile this package is: 1. `cd' to the directory containing the package's source code and type `./configure' to configure the package for your system. Running `configure' might take a while. While running, it prints some messages telling which features it is checking for. 2. Type `make' to compile the package. 3. Optionally, type `make check' to run any self-tests that come with the package, generally using the just-built uninstalled binaries. 4. Type `make install' to install the programs and any data files and documentation. When installing into a prefix owned by root, it is recommended that the package be configured and built as a regular user, and only the `make install' phase executed with root privileges. 5. Optionally, type `make installcheck' to repeat any self-tests, but this time using the binaries in their final installed location. This target does not install anything. Running this target as a regular user, particularly if the prior `make install' required root privileges, verifies that the installation completed correctly. 6. You can remove the program binaries and object files from the source code directory by typing `make clean'. To also remove the files that `configure' created (so you can compile the package for a different kind of computer), type `make distclean'. There is also a `make maintainer-clean' target, but that is intended mainly for the package's developers. If you use it, you may have to get all sorts of other programs in order to regenerate files that came with the distribution. 7. Often, you can also type `make uninstall' to remove the installed files again. In practice, not all packages have tested that uninstallation works correctly, even though it is required by the GNU Coding Standards. 8. Some packages, particularly those that use Automake, provide `make distcheck', which can by used by developers to test that all other targets like `make install' and `make uninstall' work correctly. This target is generally not run by end users. Compilers and Options ===================== Some systems require unusual options for compilation or linking that the `configure' script does not know about. Run `./configure --help' for details on some of the pertinent environment variables. You can give `configure' initial values for configuration parameters by setting variables in the command line or in the environment. Here is an example: ./configure CC=c99 CFLAGS=-g LIBS=-lposix *Note Defining Variables::, for more details. Compiling For Multiple Architectures ==================================== You can compile the package for more than one kind of computer at the same time, by placing the object files for each architecture in their own directory. To do this, you can use GNU `make'. `cd' to the directory where you want the object files and executables to go and run the `configure' script. `configure' automatically checks for the source code in the directory that `configure' is in and in `..'. This is known as a "VPATH" build. With a non-GNU `make', it is safer to compile the package for one architecture at a time in the source code directory. After you have installed the package for one architecture, use `make distclean' before reconfiguring for another architecture. On MacOS X 10.5 and later systems, you can create libraries and executables that work on multiple system types--known as "fat" or "universal" binaries--by specifying multiple `-arch' options to the compiler but only a single `-arch' option to the preprocessor. Like this: ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ CPP="gcc -E" CXXCPP="g++ -E" This is not guaranteed to produce working output in all cases, you may have to build one architecture at a time and combine the results using the `lipo' tool if you have problems. Installation Names ================== By default, `make install' installs the package's commands under `/usr/local/bin', include files under `/usr/local/include', etc. You can specify an installation prefix other than `/usr/local' by giving `configure' the option `--prefix=PREFIX', where PREFIX must be an absolute file name. You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you pass the option `--exec-prefix=PREFIX' to `configure', the package uses PREFIX as the prefix for installing programs and libraries. Documentation and other data files still use the regular prefix. In addition, if you use an unusual directory layout you can give options like `--bindir=DIR' to specify different values for particular kinds of files. Run `configure --help' for a list of the directories you can set and what kinds of files go in them. In general, the default for these options is expressed in terms of `${prefix}', so that specifying just `--prefix' will affect all of the other directory specifications that were not explicitly provided. The most portable way to affect installation locations is to pass the correct locations to `configure'; however, many packages provide one or both of the following shortcuts of passing variable assignments to the `make install' command line to change installation locations without having to reconfigure or recompile. The first method involves providing an override variable for each affected directory. For example, `make install prefix=/alternate/directory' will choose an alternate location for all directory configuration variables that were expressed in terms of `${prefix}'. Any directories that were specified during `configure', but not in terms of `${prefix}', must each be overridden at install time for the entire installation to be relocated. The approach of makefile variable overrides for each directory variable is required by the GNU Coding Standards, and ideally causes no recompilation. However, some platforms have known limitations with the semantics of shared libraries that end up requiring recompilation when using this method, particularly noticeable in packages that use GNU Libtool. The second method involves providing the `DESTDIR' variable. For example, `make install DESTDIR=/alternate/directory' will prepend `/alternate/directory' before all installation names. The approach of `DESTDIR' overrides is not required by the GNU Coding Standards, and does not work on platforms that have drive letters. On the other hand, it does better at avoiding recompilation issues, and works well even when some directory options were not specified in terms of `${prefix}' at `configure' time. Optional Features ================= If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving `configure' the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. Some packages pay attention to `--enable-FEATURE' options to `configure', where FEATURE indicates an optional part of the package. They may also pay attention to `--with-PACKAGE' options, where PACKAGE is something like `gnu-as' or `x' (for the X Window System). The `README' should mention any `--enable-' and `--with-' options that the package recognizes. For packages that use the X Window System, `configure' can usually find the X include and library files automatically, but if it doesn't, you can use the `configure' options `--x-includes=DIR' and `--x-libraries=DIR' to specify their locations. Some packages offer the ability to configure how verbose the execution of `make' will be. For these packages, running `./configure --enable-silent-rules' sets the default to minimal output, which can be overridden with `make V=1'; while running `./configure --disable-silent-rules' sets the default to verbose, which can be overridden with `make V=0'. Particular systems ================== On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC is not installed, it is recommended to use the following options in order to use an ANSI C compiler: ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" and if that doesn't work, install pre-built binaries of GCC for HP-UX. On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot parse its `' header file. The option `-nodtk' can be used as a workaround. If GNU CC is not installed, it is therefore recommended to try ./configure CC="cc" and if that doesn't work, try ./configure CC="cc -nodtk" On Solaris, don't put `/usr/ucb' early in your `PATH'. This directory contains several dysfunctional programs; working variants of these programs are available in `/usr/bin'. So, if you need `/usr/ucb' in your `PATH', put it _after_ `/usr/bin'. On Haiku, software installed for all users goes in `/boot/common', not `/usr/local'. It is recommended to use the following options: ./configure --prefix=/boot/common Specifying the System Type ========================== There may be some features `configure' cannot figure out automatically, but needs to determine by the type of machine the package will run on. Usually, assuming the package is built to be run on the _same_ architectures, `configure' can figure that out, but if it prints a message saying it cannot guess the machine type, give it the `--build=TYPE' option. TYPE can either be a short name for the system type, such as `sun4', or a canonical name which has the form: CPU-COMPANY-SYSTEM where SYSTEM can have one of these forms: OS KERNEL-OS See the file `config.sub' for the possible values of each field. If `config.sub' isn't included in this package, then this package doesn't need to know the machine type. If you are _building_ compiler tools for cross-compiling, you should use the option `--target=TYPE' to select the type of system they will produce code for. If you want to _use_ a cross compiler, that generates code for a platform different from the build platform, you should specify the "host" platform (i.e., that on which the generated programs will eventually be run) with `--host=TYPE'. Sharing Defaults ================ If you want to set default values for `configure' scripts to share, you can create a site shell script called `config.site' that gives default values for variables like `CC', `cache_file', and `prefix'. `configure' looks for `PREFIX/share/config.site' if it exists, then `PREFIX/etc/config.site' if it exists. Or, you can set the `CONFIG_SITE' environment variable to the location of the site script. A warning: not all `configure' scripts look for a site script. Defining Variables ================== Variables not defined in a site shell script can be set in the environment passed to `configure'. However, some packages may run configure again during the build, and the customized values of these variables may be lost. In order to avoid this problem, you should set them in the `configure' command line, using `VAR=value'. For example: ./configure CC=/usr/local2/bin/gcc causes the specified `gcc' to be used as the C compiler (unless it is overridden in the site shell script). Unfortunately, this technique does not work for `CONFIG_SHELL' due to an Autoconf bug. Until the bug is fixed you can use this workaround: CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash `configure' Invocation ====================== `configure' recognizes the following options to control how it operates. `--help' `-h' Print a summary of all of the options to `configure', and exit. `--help=short' `--help=recursive' Print a summary of the options unique to this package's `configure', and exit. The `short' variant lists options used only in the top level, while the `recursive' variant lists options also present in any nested packages. `--version' `-V' Print the version of Autoconf used to generate the `configure' script, and exit. `--cache-file=FILE' Enable the cache: use and save the results of the tests in FILE, traditionally `config.cache'. FILE defaults to `/dev/null' to disable caching. `--config-cache' `-C' Alias for `--cache-file=config.cache'. `--quiet' `--silent' `-q' Do not print messages saying which checks are being made. To suppress all normal output, redirect it to `/dev/null' (any error messages will still be shown). `--srcdir=DIR' Look for the package's source code in directory DIR. Usually `configure' can determine that directory automatically. `--prefix=DIR' Use DIR as the installation prefix. *note Installation Names:: for more details, including other options available for fine-tuning the installation locations. `--no-create' `-n' Run the configure checks, but stop before creating any output files. `configure' also accepts some other, not widely useful, options. Run `configure --help' for more details. libserial-0.6.0~rc2+svn122/Makefile.am000066400000000000000000000003551251522701700173600ustar00rootroot00000000000000SUBDIRS=src doc examples sip ACLOCAL_AMFLAGS=-I m4 EXTRA_DIST = doxygen.conf.in Makefile.dist libserial.spec libserial.pc docs: make dox dox: doxygen doxygen.conf pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libserial.pc libserial-0.6.0~rc2+svn122/Makefile.dist000066400000000000000000000001161251522701700177210ustar00rootroot00000000000000all: mkdir -pv m4 autoreconf -i --force --verbose configure: ./configure libserial-0.6.0~rc2+svn122/NEWS000066400000000000000000000000001251522701700160060ustar00rootroot00000000000000libserial-0.6.0~rc2+svn122/README000066400000000000000000000007431251522701700162050ustar00rootroot00000000000000libserial ------------------------------------------------------------ This library can be used to access the serial ports on POSIX systems. You will need the latest gcc release (anything after gcc-3.2 should work) to compile libserial. When you have installed the above tools, run the following commands: ------------------------------------------------------------ ./configure make make install ------------------------------------------------------------ Enjoy, CrayzeeWulf libserial-0.6.0~rc2+svn122/configure.ac000066400000000000000000000020121251522701700176020ustar00rootroot00000000000000AC_REVISION($Revision: 1.14 $) dnl dnl Indicate the package name and the version to automake dnl AC_INIT([libserial], [0.6.0rc3]) AC_CONFIG_SRCDIR([src/SerialStream.cc]) AM_CONFIG_HEADER(config.h) AC_CONFIG_MACRO_DIR([m4]) AM_INIT_AUTOMAKE AM_MAINTAINER_MODE dnl Checks for programs. AC_PROG_CXX AC_PROG_AWK AC_PROG_CC AC_PROG_INSTALL AC_PROG_LN_S AC_PROG_MAKE_SET AC_PROG_LIBTOOL AC_CHECK_PROG(DOCBOOK2PDF,docbook2pdf,docbook2pdf,no) if test "x$DOCBOOK2PDF" == "xno"; then AC_MSG_WARN([Could not find docbook2pdf. Disabling creation of user manual therefore.]) HAVE_DOCBOOK2PDF="no" else HAVE_DOCBOOK2PDF="yes" fi AC_SUBST(DOCBOOK2PDF) AM_CONDITIONAL(HAVE_DOCBOOK2PDF, test x$HAVE_DOCBOOK2PDF = xyes) dnl Checks for header files. AC_CHECK_HEADERS(fcntl.h unistd.h) dnl Checks for typedefs, structures, and compiler characteristics. AC_C_CONST AC_C_INLINE AC_OUTPUT([Makefile doxygen.conf libserial.spec doc/UML/Makefile doc/Makefile examples/Makefile src/Makefile sip/configure.py sip/Makefile libserial.pc]) libserial-0.6.0~rc2+svn122/doc/000077500000000000000000000000001251522701700160665ustar00rootroot00000000000000libserial-0.6.0~rc2+svn122/doc/.cvsignore000066400000000000000000000000451251522701700200650ustar00rootroot00000000000000Makefile Makefile.in UserManual.pdf libserial-0.6.0~rc2+svn122/doc/Makefile.am000066400000000000000000000000151251522701700201160ustar00rootroot00000000000000SUBDIRS=UML libserial-0.6.0~rc2+svn122/doc/UML/000077500000000000000000000000001251522701700165235ustar00rootroot00000000000000libserial-0.6.0~rc2+svn122/doc/UML/.cvsignore000066400000000000000000000000261251522701700205210ustar00rootroot00000000000000Makefile Makefile.in libserial-0.6.0~rc2+svn122/doc/UML/Makefile.am000066400000000000000000000000011251522701700205460ustar00rootroot00000000000000 libserial-0.6.0~rc2+svn122/doc/UML/libserial_class_diagram.dia000066400000000000000000000175701251522701700240330ustar00rootroot00000000000000]koȶ޿¢s8~bHQ3Mn] (3oe<_g!MOBUfڮ*[x"oQ&RM n,wpVx}ܨY)o?og!cӓgў&h[c''mF'?|={ѻ&c3"CjcWuM=ɴjvusφGto~xK#鰢7_[5صczˍǞ^ Ef ]C}.k.לW9or$.6#IWDHSDMIgiwA. #>PuQ֚  c Q5ח?Z`GijLqŸ&b\sYlC\VXf lJ;]honrm2zV 'HJ8"+={لV>vwht*9%m8at6 9v_H8EBFJ)/V߲%nΊK}=o:=99ԥ쒚I@w8wvqIǞEt_`:!_PikDC2 CM9Q̾D5+J=d68H2b.z@IlH/--Bgvڕs;pKYo.)'-cK[Ktkʷj2rƄ!f6ﲜ:JR,`Ȗm*s;Qw겻,a3 Bwj7X(T[UD*3A*"TP9wccөQT葫={ sdZٱIi1\.b1tm]1Z^\B~]}>vؾ8vU0ǽ{L=bͿ?P{D@!P_}icE;H==Tuג{ 9!*K׷_ڗے#ڦϗeVJ_n!DYgDjQӆ{Vq L(͕^8_-PIAQf;LK뾳VN1&﹭={wsD#`$XfW6 HdYUF%HRE. И}`}ry_߲Wnn.3iKW'^Zx[noѵ+z[Jv }=:Evi0$rإXaycN3ʑum0<0<0d>pgp r  <3``Ϟ@ASOXOz9۝Ng*q1pzKB~c?yhhhۏ阍  ĭzې>;;邻| Nnx6 ?<+Wp8RC!`H u}Ӳ#O`;з5 x7j~Y7knu}&-n-\7,mmm.i]RÒi?ꢺ[Kσ2 ` _ K7}BZDZ̮îwVՄS I"I"I"I"I"I]bܳ?<TB5$lOb?ô7"V8.K\9G V֒k-z,OhD9&L6t,&Q stRu=Ibݥ@urSha|^=.59g5$`EJgl)!n8l%bjeێݻ|_rE<y~f0S!9I zTޜ"+γgJNhm+ T]mmwҙ f.U8.i*oN(tmo_iwV\98 }ӱY͡.GfMlRitY+-~˶e_Ynkf/~ibC;:V ._fR<9A(W\r)W'VZj%VZj%VnWdDqJ-Q֏4(Pk6U?Ս@FzZѨ-Il,q%m]ȄMC%&z6=>5*u.+]J2iaN=JR|S*Y*ҩYradoe'Ꞩ{'Ꞩ{'Ꞩ{rݳ~8uO9{j۩zI[oyKMPDΒʝgʝFNjV;Qiy .vJ:uQY,v*^3=MPDNT:QDNT:QDNT:Q\t6)O xJMwPDΒF;y,_OtM%^zqEOC44e(N6}ʣ6*|'*|'*|'*˕OY:Ev07I6KPDϒr58P -~O#g %|jRܑةCwDR*PDuN9QDuN9}sg?!ܹi]}CW<྘giE^zv^Vq0Z$HsW % )e1"*ٌqMTq=/ԬW# VKFMvkpvqN_rJ $VW{v:k%VckYNB{{tR`,NcI/_:tttttttng'D5ދ.}8=66n߮珟5oñ>Eg}}ppQxH#6\{ˡs_| aC7_[uu׾y|//_OTy;0䘗9me}^^_(x)dֈU'j{{R&zbQMńM}AFFA#vU(T zŶO+DBPWrITމ$zNLAH``%`0n0n~/7*E%7wv5Ѯn h7h7cWc,9\AAa`Ҁ0i0iru3bAεNpp-PoPd8B  NbeNF9`X5v}9w~<<'$όC3g>>gg,-~VVR^y5dI$*/ J[4É^/wk,~QjowlGǜ!W5m:5 z}AWզVl^]jzK^u_[ЫGAzy^@>Y^wPWzA]#+ڑw.?GWu%%8<1Ӟv 5+MQ]zyZ0]fpnC|_^(G#~{pSu $餒c:C Po]g?ЊleZJ]vHol9!l0s0]2che-WF"[ɤc>Cq7˞RdvIM$"X..9x>iFh, ڽVǶH_#jOꍆV7Ոi0CM9Q̾D5+J=d68H2b.zR@IlH/--Bgvڕs;pKYo.)'׭X=k}/*Nn]~oŊ(sEI[HQVel:ss{rC {d|5mU>FoaW6BFDF|QFF5d,u׾y|<ͱ,.p,Ku ?dmƯrm( 6h3*)Ҧ>Ai2#ڶ{"@nPT z jRj_φ;#$:$zv}8(6@+iϮzJ='AA-K@!ڠX ]y]\C 3"3bHiJ@Mc{v՘ȋqȓgqwmmml~']#EG2\<2-g3I$=1{n%5pIOVJ%9wBl/}ۖˠءsI(_#!!%=./>^ *+*zm)P};mA8{ [˭l-K(((dDdwlX~;>:;R=Io> VD}x-}@=Ip$x7HH&EZDZDZDZDZ|;ia m0 HHyqq7˞RdvIM&!vqIǞųIN3Fci:GQ{Po4F|ePPPPPPF}9֚=oF{i'Dzb]-;ӳjjjjj_Զ6Wh⥶QrJJڦϗ<xbbzeU"&~5#bB˭p[˭pCR% ^ו*m'fr3nnnnnnnnnnnw'Ȉ=v's[~Ff-i>yRxM}XBi%džp ;OlUXO؊s̠(Ϲt@ܱQl7M0&s̨U9)H(⸰cfLz\ P8zF3ۦ眾.u]._"*(4Ȅ?s+ )/$n3$ЎOb Kmb`qiX\_Z7 gF2Vl@ 'VJ*fV{bmOX uyFPfa0`4E3?)Њ*ZSJ&J%شV44Vkܜ}oo3=2[;᯲/U9ՌzTo0wKb-B~{_y_5CjjM}ïX[(~)#Rv(n=4R3/[6_) j3ܑRIU<:2L* Z]T+YuI/nȝm7޷}mf-yc8$)B/3a#A!P]#mO>o \ YΈ<B0tް$2WmgoŸ?O|Ef$QAٔ /.&9X8>Dqh\! E&0TϑСlan>e[ņ/t;NƌͱQ\L6xz\xj|*}(0_y,"ԯFFQZ}4Ɩwޯ]/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LibSerial.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LibSerial.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/LibSerial" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LibSerial" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." libserial-0.6.0~rc2+svn122/doc/user_manual/api_documentation.rst000066400000000000000000000002211251522701700246300ustar00rootroot00000000000000API Documentation ================= The API documentation generated by doxygen is available `here `_. libserial-0.6.0~rc2+svn122/doc/user_manual/conf.py000066400000000000000000000177751251522701700217210ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # LibSerial documentation build configuration file, created by # sphinx-quickstart on Sat Apr 18 17:19:33 2015. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.mathjax', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'LibSerial' copyright = u'2015, CrayzeeWulf' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '0.6.0' # The full version, including alpha/beta/rc tags. release = '0.6.0rc3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'LibSerialdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'LibSerial.tex', u'LibSerial Documentation', u'CrayzeeWulf', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'libserial', u'LibSerial Documentation', [u'CrayzeeWulf'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'LibSerial', u'LibSerial Documentation', u'CrayzeeWulf', 'LibSerial', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False libserial-0.6.0~rc2+svn122/doc/user_manual/description.rst000066400000000000000000000031631251522701700234610ustar00rootroot00000000000000Description =========== LibSerial provides a collection of C++ classes that allow one to access serial ports on POSIX systems like standard C++ iostream objects. The SerialStream class represents the primary class that is expected to be used by developers to access serial ports as iostream objects. Additionally a SerialPort class is available to provide access to serial ports without using the standard C++ iostream interface. This is useful for embedded systems where a complete C++ STL may not be available. Member functions are provided for setting various parameters of the serial ports such as the baud rate, character size, flow control and others. The idea is to simplify serial port programming on POSIX systems. For example, using libserial, you can do the following: .. code-block:: c++ #include // // Open the serial port. // SerialStream serial_port( "/dev/ttyS0" ) ; // // Set the baud rate of the serial port. // serial_port.SetBaudRate( SerialStreamBuf::BAUD_9600 ) ; // // Read a character from the serial port. // char next_char ; serial_port >> next_char ; // // Write the character back to the serial port. // serial_port << next_char ; In addition to the C++ programming languge, LibSerial releases after version 0.6.0 also provide bindings to several scripting languages such as Python, Perl, PHP, Java, and Ruby. This provides developers a wide range languages to select when writing applications that need access to serial ports on POSIX compatible operating systems. LibSerial has received most extensive testing under Linux operating system. libserial-0.6.0~rc2+svn122/doc/user_manual/design_documentation.rst000066400000000000000000000000701251522701700253320ustar00rootroot00000000000000Design Documentation ==================== Coming soon. libserial-0.6.0~rc2+svn122/doc/user_manual/download.rst000066400000000000000000000004211251522701700227370ustar00rootroot00000000000000Download ======== The latest version of LibSerial is 0.6.0rc2. You can download the source code for LibSerial-0.6.0rc2 from `here `_. Older versions of LibSerial may also be downloaded from the above site. libserial-0.6.0~rc2+svn122/doc/user_manual/feature_summary.rst000066400000000000000000000004161251522701700243440ustar00rootroot00000000000000Feature Summary =============== * Simplified serial port programming in C++ under POSIX operating systems. * Support for USB-serial converters. * Access serial ports from scripting languages such as PHP, Python, Perl, Ruby, and Java (coming soon in version 0.6.0). libserial-0.6.0~rc2+svn122/doc/user_manual/index.rst000066400000000000000000000010521251522701700222400ustar00rootroot00000000000000.. LibSerial documentation master file, created by sphinx-quickstart on Sat Apr 18 17:19:33 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to LibSerial's documentation! ===================================== Contents: .. toctree:: :maxdepth: 2 feature_summary description download install tutorial api_documentation design_documentation links Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` libserial-0.6.0~rc2+svn122/doc/user_manual/install.rst000066400000000000000000000000221251522701700225730ustar00rootroot00000000000000Install ======= libserial-0.6.0~rc2+svn122/doc/user_manual/links.rst000066400000000000000000000000161251522701700222500ustar00rootroot00000000000000Links ===== libserial-0.6.0~rc2+svn122/doc/user_manual/tutorial.rst000066400000000000000000000100531251522701700227750ustar00rootroot00000000000000Tutorial ======== Opening a Serial Port I/O Stream -------------------------------- A serial port I/O stream, SerialStream, instance can be created and opened by providing the name of the serial port device to the constructor: .. code-block:: c++ #include // using namespace LibSerial ; // // Create and open the serial port for communication. // SerialStream my_serial_stream( "/dev/ttyS0" ) ; In certain applications, the name of the serial port device may not be known when the SerialStream instance is created. In such cases, the same effect as above can be achieved as follows: .. code-block:: c++ #include // using namespace LibSerial ; // // Create a SerialStream instance. // SerialStream my_serial_stream ; // // Open the serial port for communication. // my_serial_stream.Open( "/dev/ttyS0" ) ; Setting the Baud Rate --------------------- The baud rate for the SerialStream can be set using the SerialStream::SetBaudRate() member function. .. code-block:: c++ // // The various available baud rates are defined in SerialStreamBuf class. // This is to be changed soon. All serial port settings will be placed in // in the SerialPort class. // my_serial_stream.SetBaudRate( SerialStreamBuf::BAUD_115200 ) ; Setting the Character Size -------------------------- .. code-block:: c++ // // Use 8 bit wide characters. // my_serial_port.SetCharSize( SerialStreamBuf::CHAR_SIZE_8 ) ; Setting the Number of Stop Bits ------------------------------- .. code-block:: c++ // // Use one stop bit. // my_serial_port.SetNumOfStopBits(1) ; Setting the Parity Type ----------------------- .. code-block:: c++ // // Use odd parity during serial communication. // my_serial_port.SetParity( SerialStreamBuf::PARITY_ODD ) ; Setting the Flow-Control Type ----------------------------- .. code-block:: c++ // // Use hardware flow-control. // my_serial_port.SetFlowControl( SerialStreamBuf::FLOW_CONTROL_HARD ) ; Reading Characters ------------------ Characters can be read from the serial port using standard iostream ">>" operator. For example: .. code-block:: c++ // // Read one character from the serial port. // char next_char ; my_serial_stream >> next_char ; // // You can also read other types of values from the serial port in a similar fashion. // int data_size ; my_serial_stream >> data_size ; All other methods of standard C++ iostream objects are available too. For example, one can read characters from the serial port using the get() method: .. code-block:: c++ // // Read one byte from the serial port. // char next_byte ; my_serial_stream.get( next_byte ) ; Writing Characters ------------------ .. code-block:: c++ // // Write a single character to the serial port. // my_serial_stream << 'U' ; // // You can write a whole string. // my_serial_stream << "Hello, Serial Port." << std::endl ; // // In fact, you can pretty much write any type of object that // is supported by a "<<" operator. // double radius = 2.0 ; double area = M_PI * 2.0 * 2.0 ; my_serial_stream << area << std::endl ; Reading Blocks of Data ---------------------- .. code-block:: c++ // // Read a whole array of data from the serial port. // const int BUFFER_SIZE = 256 ; char input_buffer[BUFFER_SIZE] ; // my_serial_stream.read( input_buffer, BUFFER_SIZE ) ; Writing Blocks of Data ---------------------- .. code-block:: c++ // // Write an array of data from the serial port. // const int BUFFER_SIZE = 256 ; char output_buffer[BUFFER_SIZE] ; // for(int i=0; i