libserial  1.6.2
RoadNarrows Roboitics Serial Library
main.doxy
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // Package: RoadNarrows RS-232 Serial Interface Library
4 //
5 // File: main.doxy
6 //
7 // Description:
8 // This file contains the doxygen directives to generate the main page.
9 //
10 ////////////////////////////////////////////////////////////////////////////////
11 
12 /*! \file */
13 
14 /*! \mainpage RoadNarrows RS-232 Serial Interface Library - libserial
15 
16 \section intro Introduction
17 
18 The library libserial provides a set of useful interfaces to a RS-232 serial
19 device.
20 
21 All libserial diagnostics logging is at diagnostics level 4.
22 
23 \section platforms Supported Platforms
24 \li i386 - any Linux Intel (backwards) compatible 32-bit architecures
25 \li x86_64 - any Linux AMD 64-bit architectures
26 \li armpxa - Linux Intel XScale PXA Arm architecures.
27 \li cygwin - Windows systems with installed cygwin.
28 \li osx - Mac OS-X architectures
29 
30 \section tested Tested Systems
31 \li Fedora Core 5 and 6 Linux for the i386 and x86_64 architectures.
32 \li Ubuntus 9.4 Linux for the i386 and x86_64 architectures.
33 \li Familiar Linux 2.4 (K-Team KoreBot version) for the XScale PXA 255 Arm
34 \li Windows XP with Cygwin for Intel processors.
35 \li Mac OS-X 10.x for Intel processors.
36 \page page_eula EULA
37 \section eula_txt RoadNarrows Robotics libserial Package End User Licence Agreement
38 
39 \subsection eula_permissions Permissions
40 Permission is hereby granted, without written agreement and without
41 license or royalty fees, to use, copy, modify, and distribute this
42 software and its documentation for any purpose, provided that
43 (1) The above copyright notice and the following two paragraphs
44 appear in all copies of the source code and (2) redistributions
45 including binaries reproduces these notices in the supporting
46 documentation. Substantial modifications to this software may be
47 copyrighted by their authors and need not follow the licensing terms
48 described here, provided that the new terms are clearly indicated in
49 all files where they apply.
50 
51 \subsection eula_warranties Warranties
52 In no event shall the author, RoadNarrows Robotics or any members/employees
53 of RoadNarrows Robotics or distributors of this software be liable to any
54 party for direct, indirect, special, incidental, or consequential
55 damages arising out of the use of this software and its documentation,
56 even if the authors or any of the above parties have been advised of
57 the possibility of such damage.
58 
59 The author and RoadNarrows Robotics specifically disclaim any warranties,
60 including, but not limited to, the implied warranties of merchantability anD
61 fitness for a particular purpose. the software provided hereunder is on an
62 "as is" basis, and the authors and distributors have no obligation tO
63 provide maintenance, support, updates, enhancements, or modifications.
64 
65 \subsection eula_copyright Copyright
66 All Rights Reserved by RoadNarrows Robotics
67 \n (C) 2006-2009
68 \n http://www.roadnarrowsrobotics.com
69 
70 */