This is Edition 4, last updated 2007-06-24, of The OpenSS7 STREAMS Binary Compatibility Modules Installation and Reference Manual, for Version 0.9.2 release 4 of the OpenSS7 STREAMS Binary Compatibility Modules package.
This package is released and distributed under the GPL (see GNU General Public License). Please note, however, that there are different licensing terms for the manual pages and some of the documentation (derived from OpenGroup1 publications and other sources). Consult the permission notices contained in the documentation for more information.
This manual is released under the FDL (see GNU Free Documentation License) with all sections invariant.
This manual provides a Installation and Reference Manual for OpenSS7 STREAMS Binary Compatibility Modules.
The objective of this manual is to provide a guide for the STREAMS programmer when developing STREAMS modules, drivers and application programs for OpenSS7 STREAMS Binary Compatibility Modules.
This guide provides information to developers on the use of the STREAMS mechanism at user and kernel levels.
STREAMS was incorporated in UNIX System V Release 3 to augment the character input/output (I/O) mechanism and to support development of communication services.
STREAMS provides developers with integral functions, a set of utility routines, and facilities that expedite software design and implementation.
The intent of this manual is to act as an introductory guide to the STREAMS programmer. It
is intended to be read alone and is not intended to replace or supplement the
OpenSS7 STREAMS Binary Compatibility Modules manual pages. For a reference for writing code, the manual pages
(see STREAMS(9)) provide a better reference to the programmer.
Although this describes the features of the OpenSS7 STREAMS Binary Compatibility Modules package,
OpenSS7 Corporation is under no obligation to provide any software,
system or feature listed herein.
This manual is intended for a highly technical audience. The reader should already be familiar with Linux kernel programming, the Linux file system, character devices, driver input and output, interrupts, software interrupt handling, scheduling, process contexts, multiprocessor locks, etc.
The guide is intended for network and systems programmers, who use the STREAMS mechanism at user and kernel levels for Linux and UNIX system communication services.
Readers of the guide are expected to possess prior knowledge of the Linux and UNIX system, programming, networking, and data communication.
Take care that you are working with a current version of this manual: you will not be notified of updates. To ensure that you are working with a current version, contact the Author, or check The OpenSS7 Project website for a current version.
A current version of this manual is normally distributed with the OpenSS7 STREAMS Binary Compatibility Modules package, strbcm-0.9.2.4.2
strbcm.texi,v
Revision 0.9.2.13 2007/06/22 00:18:32 brian
- mostly documentation updates for release, some netconfig workaround
Revision 0.9.2.12 2007/05/07 18:20:59 brian
updated release files
Revision 0.9.2.11 2007/02/28 06:30:38 brian
- updates and corrections, #ifdef instead of #if
Revision 0.9.2.10 2006/09/18 01:06:31 brian
- updated manuals and release texi docs
Revision 0.9.2.9 2006/08/28 10:46:56 brian
- correction
Revision 0.9.2.8 2006/08/28 10:32:52 brian
- updated references
Revision 0.9.2.7 2006/08/27 12:26:41 brian
- finalizing auto release files
Revision 0.9.2.6 2006/08/26 09:17:41 brian
- better release file generation
Revision 0.9.2.5 2006/08/23 11:00:31 brian
- added preface, corrections and updates for release
Revision 0.9.2.3 2006-03-22 03:02:01 -0700 brian
- added makefile target index
Revision 0.9.2.2 2006-03-08 16:20:42 -0700 brian
- changes for successful build
Revision 0.9.2.1 2006-03-08 01:20:14 -0700 brian
- starting off strbcm package
Revision 0.9 2006-03-08 01:20:14 -0700 brian
file strbcm.texi was initially added on branch OpenSS7-0_9_2.
Only the TeX, texinfo, or roff source for this manual is controlled. An opaque (printed, postscript or portable document format) version of this manual is an UNCONTROLLED VERSION.
OpenSS7 Corporation disclaims all warranties with regard to this documentation including all implied warranties of merchantability, fitness for a particular purpose, non-infringement, or title; that the contents of the manual are suitable for any purpose, or that the implementation of such contents will not infringe on any third party patents, copyrights, trademarks or other rights. In no event shall OpenSS7 Corporation be liable for any direct, indirect, special or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with any use of this manual or the performance or implementation of the contents thereof.
OpenSS7 Corporation reserves the right to revise this software and documentation for any reason, including but not limited to, conformity with standards promulgated by various agencies, utilization of advances in the state of the technical arts, or the reflection of changes in the design of any techniques, or procedures embodied, described, or referred to herein. OpenSS7 Corporation is under no obligation to provide any feature listed herein.
If you are licensing this Software on behalf of the U.S. Government ("Government"), the following provisions apply to you. If the Software is supplied by the Department of Defense ("DoD"), it is classified as "Commercial Computer Software" under paragraph 252.227-7014 of the DoD Supplement to the Federal Acquisition Regulations ("DFARS") (or any successor regulations) and the Government is acquiring only the license rights granted herein (the license rights customarily provided to non-Government users). If the Software is supplied to any unit or agency of the Government other than DoD, it is classified as "Restricted Computer Software" and the Government's rights in the Software are defined in paragraph 52.227-19 of the Federal Acquisition Regulations ("FAR") (or any successor regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the NASA Supplement to the FAR (or any successor regulations).
As with most open source projects, this project would not have been possible without the valiant efforts and productive software of the Free Software Foundation and the Linux Kernel Community.
Funding for completion of the OpenSS7 OpenSS7 STREAMS Binary Compatibility Modules package was provided in part by:
| • OpenSS7 Corporation
|
Additional funding for The OpenSS7 Project was provided by:
The primary contributor to the OpenSS7 OpenSS7 STREAMS Binary Compatibility Modules package is Brian F. G. Bidulock. The following is a list of significant contributors to The OpenSS7 Project:
| − Per Berquist
| |
| − John Boyd
| |
| − Chuck Winters
| |
| − Peter Courtney
| |
| − Tom Chandler
| |
| − Gurol Ackman
| |
| − Kutluk Testicioglu
| |
| − John Wenker
| |
| − Others
|
The authors of the OpenSS7 OpenSS7 STREAMS Binary Compatibility Modules package include:
| − Brian Bidulock
|
See Author Index, for a complete listing and cross-index of authors to sections of this manual.
The maintainer of the OpenSS7 OpenSS7 STREAMS Binary Compatibility Modules package is:
| − Brian Bidulock
|
Please send bug reports to bugs@openss7.org using the send-pr script included in the package, only after reading the BUGS file in the release, or See Problem Reports.
The OpenSS7 Project provides a website dedicated to the software packages released by the OpenSS7 Project.
Please send bug reports to bugs@openss7.org using the send-pr script included in the OpenSS7 STREAMS Binary Compatibility Modules package, only after reading the BUGS file in the release, or See Problem Reports. You can access the OpenSS7 GNATS database directly via the web, however, the preferred method for sending new bug reports is via mail with the send-pr script.
The OpenSS7 Project provides a number of general discussion Mailing Lists for discussion concerning the OpenSS7 OpenSS7 STREAMS Binary Compatibility Modules package as well as other packages released by The OpenSS7 Project.
These are mailman mailing lists and so have convenient web interfaces for subscribers to control their settings. See http://www.openss7.org/mailinglist.html.
The mailing lists are as follows:
gsyc.escet.urjc.es>.
To avoid spam being sent to the members of the OpenSS7 mailing list(s), we have blocked mail from non-subscribers. Please subscribe to the mailing list before attempting to post to them. (Attempts to post when not subscribed get bounced.)
As an additional measure against spam, subscriber lists for all OpenSS7 mailing lists are not accessible to non-subscribers; for most lists subscriber lists are only accessible to the list administrator. This keeps your mailing address from being picked off our website by bulk mailers.
It is acceptable to post professional and courteous messages regarding the OpenSS7 package or any general information or questions concerning STREAMS, SS7, SIGTRAN, SCTP or telecommunications applications in general.
The mailing list is blocked from messages of greater than 40k. If you have attachments
(patches, test programs, etc.) and you mail them to the list, it will bounce to the list
administrator. If you are interested in making your patches, test programs, test results or other
large attachments available to the members of the mailing list, state in the message that you would
like them posted and the list administrator will place them in the mail archives.
Package strbcm-0.9.2.4 was released under GPLv2 2007-06-24.
The OpenSS7 STREAMS Binary Compatibility Modules package provides STREAMS modules and drivers, programs and daemons for the compilation of externally supplied source and binary STREAMS modules.
The package currently includes the following STREAMS kernel modules and drivers:
| − streams_tstdrv.ko /dev/tst
| |
| − streams_tstmod.ko module
|
tstdrv(4)tstmod(4)The OpenSS7 STREAMS Binary Compatibility Modules package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of STREAMS modules and drivers. This package contains primarily a framework for the compilation and linkage of externally supplied source and binary modules.
This package is currently incomplete. It is being released as a reference point for the community. If you are interested in completion of this package, contact info@openss7.com.
This distribution is only currently applicable to Linux 2.4 and 2.6 kernels and was targeted
at ix86, x86_64, ppc and ppc64 architectures, but should build and
install for other architectures as well.
This is the strbcm-0.9.2.4 package, released 2007-06-24. This `0.9.2.4' release, and the latest version, can be obtained from the download area of The OpenSS7 Project website using a command such as:
$> wget http://www.openss7.org/tarballs/strbcm-0.9.2.4.tar.bz2
The release is available as an autoconf(1) tarball, src.rpm or dsc, or as a set of binary rpms or debs. See the download page for the autoconf(1) tarballs, src.rpms or dscs. See the strbcm package page for tarballs, source and binary packages.
Please see the NEWS file for release notes and history of user visible changes for the current version, and the ChangeLog file for a more detailed history of implementation changes. The TODO file lists features not yet implemented and other outstanding items.
Please see the INSTALL, INSTALL-strbcm and README-make, files (or see Installation) for installation instructions.
When working from cvs(1) or git(1), please see the README-cvs, file (or see Downloading from CVS). An abbreviated installation procedure that works for most applications appears below.
This release of the package is published strictly under Version 2 of the GNU Public License which can be found in the file COPYING. Package specific licensing terms (if any) can be found in the file LICENSES. Please respect these licensing arrangements. If you are interested in different licensing terms, please contact the copyright holder, or OpenSS7 Corporation <sales@openss7.com>.
See README-alpha (if it exists) for alpha release information.
The quickest and easiest way to ensure that all prerequisites are met is to download and install this package from within the OpenSS7 Master Package, openss7-0.9.2.F, instead of separately.
Prerequisites for the OpenSS7 STREAMS Binary Compatibility Modules package are as follows:
| −
A fairly LSB compliant GNU/Linux distribution.3
| |
| −
Linux 2.4 kernel (2.4.10 - 2.4.27), or
| |
| −
Linux 2.6 kernel (2.6.3 - 2.6.21);
| |
| −
glibc2 or better.
| |
| −
GNU info (for info files).
| |
| −
GNU groff (for man pages).4
|
(Note: If you acquired strbcm a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)
When configuring and building multiple OpenSS7 Project release packages, place all of the source packages (unpacked tarballs) at the same directory level and all build directories at the same directory level (e.g. all source packages under /usr/src).
When installing packages that install as kernel modules, it is necessary to have the correct kernel development package installed. For the following distributions, use the following commands:
Ubuntu: $> apt-get install linux-headers
Debian: $> apt-get install kernel-headers
Fedora: $> yum install kernel-devel
You also need the same version of gcc(1) compiler with which the kernel was built. If it is not the default, add `CC=kgcc' on the line after `./configure', for example:
$> ../strbcm-0.9.2.4/configure CC='gcc-3.4'
The following commands will download, configure, build, check, install, validate, uninstall and remove the package:
$> wget http://www.openss7.org/tarballs/strbcm-0.9.2.4.tar.bz2
$> tar -xjvf strbcm-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strbcm-0.9.2.4/configure --enable-autotest
$> make
$> make check
$> sudo make install
$> sudo make installcheck
$> sudo make uninstall
$> popd
$> sudo rm -rf build
$> rm -rf strbcm-0.9.2.4
$> rm -f strbcm-0.9.2.4.tar.bz2
If you have problems, try building with the logging targets instead. If the make of a logging target fails, an automatic problem report will be generated that can be mailed to The OpenSS7 Project.6 Installation steps using the logging targets proceed as follows:
$> wget http://www.openss7.org/tarballs/strbcm-0.9.2.4.tar.bz2
$> tar -xjvf strbcm-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strbcm-0.9.2.4/configure --enable-autotest
$> make compile.log
$> make check.log
$> sudo make install.log
$> sudo make installcheck.log
$> sudo make uninstall.log
$> popd
$> sudo rm -rf build
$> rm -rf strbcm-0.9.2.4
$> rm -f strbcm-0.9.2.4.tar.bz2
See README-make for additional specialized make targets.
For custom applications, see the INSTALL and INSTALL-strbcm files or the see Installation, as listed below. If you encounter troubles, see Troubleshooting, before issuing a bug report.
The OpenSS7 STREAMS Binary Compatibility Modules package is available from the downloads area of The OpenSS7 Project website using a command such as:
$> wget http://www.openss7.org/tarballs/strbcm-0.9.2.4.tar.bz2
Unpack the tarball using a command such as:
$> tar -xjvf strbcm-0.9.2.4.tar.bz2
The tarball will unpack into the relative subdirectory named after the package name: strbcm-0.9.2.4.
The package builds using the GNU autoconf utilities and the configure script. To build the package, we recommend using a separate build directory as follows:
$> mkdir build
$> cd build
$> ../strbcm-0.9.2.4/configure
In general, the package configures and builds without adding any special options to the configure script. For general options to the configure script, see the GNU INSTALL file in the distribution:
$> less ../strbcm-0.9.2.4/INSTALL
For specific options to the configure script, see the INSTALL-strbcm file in the distribution, or simply execute the configure script with the --help option like so:
$> ../strbcm-0.9.2.4/configure --help
After configuring the package, the package can be compiled simply by issuing the `make' command:
$> make
Some specialized makefile targets exists, see the README-make file in the distribution or simply invoke the `help' target like so:
$> make help | less
After successfully building the package, the package can be checked by invoking the `check' make target like so:
$> make check
After successfully checking the package, the package can be installed by invoking the `install' make target (as root) like so:
$> sudo make install
The test suites that ship with the package can be invoked after the package has been installed by invoking the `installcheck' target. This target can either be invoked as root, or as a normal user, like so:
$> make installcheck
(Note: you must add the --enable-autotest flag to configure, above for the test suites to be invoked with `make installcheck'.)
The package can be cleanly removed by invoking the `uninstall' target (as root):
$> sudo make uninstall
Then the build directory and tarball can be simply removed:
$> cd ..
$> rm -rf build
$> rm -rf strbcm-0.9.2.4
$> rm -f strbcm-0.9.2.4.tar.bz2
More detailed installation instructions can be found in the Installation, contained in the distribution in `text', `info', `html' and `pdf' formats:
$> cd ../strbcm-0.9.2.4
$> less doc/manual/strbcm.txt
$> lynx doc/manual/strbcm.html
$> info doc/manual/strbcm.info
$> xpdf doc/manual/strbcm.pdf
The `text' version of the manual is always available in the MANUAL file in the release.
The current manual is also always available online from The OpenSS7 Project website at:
$> lynx http://www.openss7.org/strbcm_manual.html
This manual documents the design, implementation, installation, operation and future development schedule of the OpenSS7 STREAMS Binary Compatibility Modules package.
This manual documents the design, implementation, installation, operation and future development of the OpenSS7 STREAMS Binary Compatibility Modules package.
This manual is organized (loosely) into several sections as follows:
| Introduction. | This introduction
|
| Objective. | Objective of the package
|
| Reference. | Contents of the package
|
| Conformance. | Conformance of the package
|
| Releases. | Releases of the package
|
| Installation. | Installation of the package
|
| Troubleshooting. | Troubleshooting of the package
|
This manual uses texinfo typographic conventions.
The OpenSS7 STREAMS Binary Compatibility Modules package make provision for you to add your own STREAMS driver to the build of the strbcm package. Your drivers are built outside the strbcm source code tree. The object code and configuration information pertaining to your driver must be copied into the strbcm source code tree to be incorporated into strbcm.
The directory, strbcm/pkg is the directory where pre-compiled drivers are to be copied. This directory contains subdirectories, one for each driver to be linked in with strbcm when strbcm is built.
If you have a driver named foo then you neeed to do a mkdir strbcm/pkg/foo to create the directory that will contain the components of your driver.
Driver Components
You need a copy of the following files into your package directory (strbcm/pkg/foo):
strconf(8) utility to
produce, amoung other things, the file config.h. See the section on configuration for more
information about the Config file.
This is the OpenSS7 Release of the OpenSS7 STREAMS Binary Compatibility Modules tools, drivers and modules used with the Linux Fast-STREAMS or Linux STREAMS7 SVR 4.2 STREAMS releases.
The purpose of providing a separate release of this package was to separate the OpenSS7 STREAMS Binary Compatibility Modules tools, headers, drivers and modules from the Linux STREAMS8 package for use with both Linux STREAMS9 and Linux Fast-STREAMS in preparation for replacement of the former by the later.
The following sections provide information on OpenSS7 STREAMS Binary Compatibility Modules releases as well as compatibility information of OpenSS7 release to mainstream UNIX releases of the core, modules and drivers, as well as Linux kernel compatibility.
The quickest and easiest way to ensure that all prerequisites are met is to download and install this package from within the OpenSS7 Master Package, openss7-0.9.2.F, instead of separately.
Prerequisites for the OpenSS7 STREAMS Binary Compatibility Modules package are as follows:
| −
A fairly LSB compliant GNU/Linux distribution.10
| |
| −
Linux 2.4 kernel (2.4.10 - 2.4.27), or
| |
| −
Linux 2.6 kernel (2.6.3 - 2.6.21);
| |
| −
glibc2 or better.
| |
| −
GNU info (for info files).
| |
| −
GNU groff (for man pages).11
|
(Note: If you acquired strbcm a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)
If you need to rebuild the package from sources with modifications, you will need a larger GNU tool chain as described in See Downloading from CVS.
This section discusses compatibility with major prerequisites.
OpenSS7 STREAMS Binary Compatibility Modules is compatible with the following Linux distributions:13
When installing from the tarball (see Installing the Tar Ball), this distribution is probably compatible with a much broader array of distributions than those listed above. These are the distributions against which the current maintainer creates and tests builds.
The OpenSS7 STREAMS Binary Compatibility Modules package compiles as a Linux kernel module. It is not necessary to patch the Linux kernel to build or use the package.14 Nor do you have to recompile your kernel to build or use the package. OpenSS7 packages use autoconf scripts to adapt the package source to your existing kernel. The package builds and runs nicely against production kernels from the distributions listed above. Rather than relying on kernel versions, the autoconf scripts interrogate the kernel for specific features and variants to better adapt to distribution production kernels that have had patches applied over the official kernel.org sources.
The OpenSS7 STREAMS Binary Compatibility Modules package is compatible with 2.4 kernel series after 2.4.10 and has been tested up to and including 2.4.27. It has been tested from 2.6.3 up to and including 2.6.21 (with Fedora 7 patchsets). Please note that your mileage may vary if you use a kernel more recent than 2.6.21: it is difficult to anticipate changes that kernel developers will make in the future. Many kernels in the 2.6 series now vary widely by release version and if you encounter problems, try a kernel within the supported series.
UP validation testing for kernels is performed on all supported architectures. SMP validation testing is performed on UP machines, as well as on an Intel 3.0GHz Pentium IV 630 with HyperThreading enabled. Because HyperThreading is not as independent as multiple CPUs, SMP validation testing is limited.
The OpenSS7 STREAMS Binary Compatibility Modules package compiles and installs on a wide range of architectures. Although it is believed that the package will work on all architectures supported by the Linux kernel being used, validation testing has only been performed with the following architectures:
32-bit compatibility validation testing is performed on all 64-bit architectures supporting 32-bit compatibility. If you would like to validate an OpenSS7 package on a specific machine architecture, you are welcome to sponsor the project with a test machine.
The OpenSS7 STREAMS Binary Compatibility Modules package is currently compatible with Linux STREAMS,15 however, to use the OpenSS7 STREAMS Binary Compatibility Modules package with LiS requires use of the OpenSS7 release packages of LiS. The OpenSS7 STREAMS Binary Compatibility Modules package is compatible with the OpenSS7 LiS-2.18.6 release that is available from the The OpenSS7 Project Downloads Page. But, do not use LiS: it is buggy, unsupported and deprecated. Use Linux Fast-STREAMS instead.
The OpenSS7 STREAMS Binary Compatibility Modules package is currently compatible with Linux Fast-STREAMS (LfS). The OpenSS7 STREAMS Binary Compatibility Modules package is compatible with the OpenSS7 streams-0.9.2.3 release that is available from the The OpenSS7 Project Downloads Page.
The sections that follow provide information on OpenSS7 releases of the
OpenSS7 STREAMS Binary Compatibility Modules package.
Major features since the last internal release are as follows:
Major features since the last internal release are as follows:
ix86 as well as
x86_64. Added distribution support includes SLES 9, SLES 9
SP2, SLES 9 SP3, SLES 10, SuSE 10.1.
Initial autoconf/RPM packaging of the strbcm release.
This is the initial release of the OpenSS7 STREAMS Binary Compatibility Modules package for Linux Fast-STREAMS. The ability to include pre-compiled STREAMS binaries was formerly part of the Linux STREAMS package, however, as the ability is also applicable to Linux Fast-STREAMS, it was removed into a separate package. Once Linux Fast-STREAMS is production grade, this binary compatibility suite will be rolled back into the streams package as LiS is deprecated.
The OpenSS7 Project adheres to the following release philosophy:
Pre-alpha releases are releases that have received no testing whatsoever. Code in the release is not even known to configure or compile. The purpose of a pre-alpha release is to make code and documentation available for inspection only, and to solicit comments on the design approach or other characteristics of the software package.
Pre-alpha release packages ship containing warnings recommending that the user not even execute the contained code.
Alpha releases are releases that have received little to no testing, or that have been tested and contains known bugs or defects that make the package unsuitable even for testing. The purpose for an alpha release are the same as for the pre-alpha release, with the additional purpose that it is an early release of partially functional code that has problems that an external developer might be willing to fix themselves and contribute back to the project.
Alpha release packages ship containing warnings that executing the code can crash machines and might possibly do damage to systems upon which it is executed.
Beta releases are releases that have received some testing, but the testing to date is not exhaustive. Beta release packages do not ship with known defects. All known defects are resolved before distribution; however, as exhaustive testing has not been performed, unknown defects may exist. The purpose for a beta release is to provide a baseline for other organizations to participate in the rigorous testing of the package.
Beta release packages ship containing warnings that the package has not been exhaustively tested and that the package may cause systems to crash. Suitability of software in this category for production use is not advised by the project; however, as always, is at the discretion of the user of the software.
Gamma releases are releases that have received exhaustive testing within the project, but external testing has been minimal. Gamma release packages do not ship with known defects. As exhaustive internal testing has been performed, unknown defects should be few. Please remember that there is NO WARRANTY on public release packages.
Gamma release packages typically resolve problems in previous beta releases, and might not have had full regression testing performed. Suitability of software in this category for production use is at the discretion of the user of the software. The OpenSS7 Project recommends that the complete validation test suites provided with the package be performed and pass on target systems before considering production use.
Production releases are releases that have received exhaustive testing within the project and validated on specific distributions and architectures. Production release packages do not ship with known defects. Please remember that there is NO WARRANTY on public release packages.
Production packages ship containing a list of validated distributions and architectures. Full regression testing of any maintenance changes is performed. Suitability of software in this category for production use on the specified target distributions and architectures is at the discretion of the user. It should not be necessary to preform validation tests on the set of supported target systems before considering production use.
Unstable releases are releases that have received extensive testing within the project and validated on a a wide range of distributions and architectures; however, is has tested unstable and found to be suffering from critical problems and issues that cannot be resolved. Maintenance of the package has proved impossible. Unstable release packages ship with known defects (and loud warnings). Suitability of software in this category for production use is at the discretion of the user of the software. The OpenSS7 Project recommends that the problems and issues be closely examined before this software is used even in a non-production environment. Each failing test scenario should be completely avoided by the application. OpenSS7 beta software is more stable that software in this category.
OpenSS7 STREAMS Binary Compatibility Modules has known and unknown defects. This is a pre-alpha release. Some defects might be harmful. No validation testing whatsoever has been performed by the OpenSS7 Project on this software. The software might not even configure or compile. The OpenSS7 Project recommends that you do not use this software. Use at your own risk. Remember that there is NO WARRANTY.16
This software is pre-alpha software. As such, it will crash your kernel. Installation of the software will irreparably mangle your header files or Linux distribution in such a way as to make it unusable. Crashes will lock your system and rebooting the system will not repair the problem. You will lose all the data on your system. Because this software will crash your kernel, the resulting unstable system can destroy computer hardware or peripherals making them unusable. You will void the warranty on any system on which you run this software. YOU HAVE BEEN WARNED.
With the exception of packages not originally created by the OpenSS7 Project, the OpenSS7 Project software does not ship with known bugs in any release stage except pre-alpha. OpenSS7 STREAMS Binary Compatibility Modules had no known bugs at the time of release.
This section contains historical bugs that were encountered during development and their resolutions. This list serves two purposes:
(no items)The OpenSS7 Project has made several stabs at making this package available and providing it in a production grade form. All attempts are currently incomplete. All in all there does not appear to be sufficient interest in this capability to actually fund the work. Therefore, this package will remain incomplete until some entity can justify funding the remainder of the development. The OpenSS7 Project remains committed to the open source model and providing this support runs somewhat against that. However, if your organization has a pressing need for this capability and can offer funding for its completion, please contact the project on the openss7 mailing list.
This package; however, might has some use still outside of Linux Fast-STREAMS if only because it provides a separable way of incorporating 3rd party binary modules.
For the latest developments with regard to history of changes, please see the ChangeLog file in the release package.
The OpenSS7 STREAMS Binary Compatibility Modules package releases can be downloaded from the downloads page of The OpenSS7 Project. The package is available as a binary RPM (for popular architectures) a source RPM, Debian binary DEB and source DSC, or as a tar ball. If you are using a browsable viewer, you can obtain the OpenSS7 release of strbcm from the links in the sections that follow.
By far the easiest (most repeatable and manageable) form for installing and using OpenSS7
packages is to download and install individual packages from binary RPM or DEB. If binary RPMs or
DEBs are not available for your distribution, but your distribution supports rpm(1) or
dpkg(1), the next best method for installing and using OpenSS7 packages is to
download and rebuild the source RPMs or DSCs.
If your architecture does not support rpm(1) or dpkg(1) at all, or you have special needs (such as cross-compiling for embedded targets), the final resort method is to download, configure, build and install from tarball. In this later case, the easiest way to build and install OpenSS7 packages from tarball is to use the tarball for the OpenSS7 Master Package, openss7-0.9.2.F.
To install from binary RPM, you will need several of the RPM for a complete installation. Binary RPM fall into several categories. To download and install a complete package requires the appropriate RPM from each of the several categories below, as applicable. Some release packages do not provide RPMs in each of the several categories.
To install from Binary RPM, you will need all of the following kernel independent packages for your architecture, and one of the kernel-dependent packages from the next section.
Independent RPM are dependent on neither the Linux kernel version, nor the STREAMS package. For example, the source package `strbcm-source-0.9.2.4-1.7.2.noarch.rpm', is not dependent on kernel nor STREAMS package.
All of the following kernel and STREAMS independent RPM are required for your architecture. Binary RPMs listed here are for example only: additional binary RPMs are available from the downloads site. If your architecture is not available, you can build binary RPM from the source RPM (see see Building from the Source RPM).
STREAMS-Dependent RPM are dependent upon the specific STREAMS package being used, either Linux STREAMS or Linux Fast-STREAMS. Packages dependent upon Linux STREAMS will have LiS in the package name. Packages dependent upon Linux Fast-STREAMS will have streams in the package name. Note that some STREAMS-Dependent RPM are also Kernel-Dependent RPM as described below.
One of the following STREAMS-Dependent packages is required for your architecture. If your architecture is not on the list, you can build binary RPM from the source RPM (see see Building from the Source RPM).
Kernel-Dependent RPM are dependent on specific Linux Kernel Binary RPM releases. Packages are provided for popular released RedHat kernels. Packages dependent upon RedHat or other kernel RPM will have the `_kversion' kernel package version in the package name.
One of the following Kernel-Dependent packages is required for your architecture and kernel version. If your architecture or kernel version is not on the list, you can build binary RPM from the source RPM (see see Building from the Source RPM).20
To configure, build and install the binary RPM, See Configuring the Binary RPM.
To install from binary DEB, you will need several of the DEB for a complete installation. Binary DEB fall into several categories. To download and install a complete package requires the appropriate DEB from each of the several categories below, as applicable. Some release packages do not provide DEBs in each of the several categories.
To install from Binary DEB, you will need all of the following kernel independent packages for your architecture, and one of the kernel-dependent packages from the next section.
Independent DEB are dependent on neither the Linux kernel version, nor the STREAMS package. For example, the source package `strbcm-source_0.9.2.4-0_i386.deb', is not dependent on kernel nor STREAMS package.
All of the following kernel and STREAMS independent DEB are required for your architecture. Binary DEBs listed here are for example only: additional binary DEBs are available from the downloads site. If your architecture is not available, you can build binary DEB from the Debian DSC (see see Building from the Debian DSC).
STREAMS-Dependent DEB are dependent upon the specific STREAMS package being used, either Linux STREAMS or Linux Fast-STREAMS. Packages dependent upon Linux STREAMS will have LiS in the package name. Packages dependent upon Linux Fast-STREAMS will have streams in the package name. Note that some STREAMS-Dependent DEB are also Kernel-Dependent DEB as described below.
One of the following STREAMS-Dependent packages is required for your architecture. If your architecture is not on the list, you can build binary DEB from the Debian DSC (see see Building from the Debian DSC).
Kernel-Dependent DEB are dependent on specific Linux Kernel Binary DEB releases. Packages are provided for popular released Debian kernels. Packages dependent upon Debian or other kernel DEB will have the `_kversion' kernel package version in the package name.
One of the following Kernel-Dependent packages is required for your architecture and kernel version. If your architecture or kernel version is not on the list, you can build binary DEB from the source DEB (see see Building from the Debian DSC).33
To configure, build and install the Debian DEB, See Configuring the Debian DEB.
If you cannot obtain a binary RPM for your architecture, or would like to roll you own binary RPM, download the following source RPM.
To configure the source RPM, See Configuring the Source RPM.
If you cannot obtain a binary DEB for your architecture, or would like to roll your own DEB, download the following Debian DSC.
To configure the source RPM, See Configuring the Debian DSC.
For non-rpm(1) architectures, such as NexusWare embedded target, download the tarball as follows:
The tar ball may be downloaded easily with wget(1) as follows:
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.bz2 |
or
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.gz |
Note that you will need an OpenSS7 Project user name and password to download release candidates (which are only available to subscribers and sponsors of the OpenSS7 Project).
After downloading one of the tar balls, unpack the archive using one of the following commands:
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.gz
% tar -xzvf strbcm-0.9.2.4.tar.gz
|
or
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.bz2
% tar -xjvf strbcm-0.9.2.4.tar.bz2
|
Either will create a subdirectory name strbcm-0.9.2.4 containing all of the files and subdirectories for the strbcm package.
To configure and install the tar ball, See Configuring the Tar Ball.
If you are a subscriber or sponsor of The OpenSS7 Project with CVS archive access privileges then you can download release, mid-release or release candidate versions of the strbcm package from the project CVS archive.
The OpenSS7 STREAMS Binary Compatibility Modules package is located in the strbcm module of /var/cvs. For release tag information, see Releases.
To access the archive from the project CVS pserver, use the following commands to check out a version from the archive:
% export CVSROOT='-d:pserver:username@cvs.openss7.com:2401/var/cvs'
% cvs login
Password: *********
% cvs co -r strbcm_0.9.2.4 strbcm
% cvs logout
|
It is, of course, possible to check out by date or by other criteria. For more information, see
cvs(1).
Although public releases of the strbcm package do not require reconfiguration, creating a configurable directory from the CVS archive requires tools not normally distributed with the other releases.
The build host requires the following GNU tools:
These tools can be acquired from the FSF website in the free software directory, and also at the following locations:
It should be stressed that, in particular, the autoconf(1), and automake(1), must be at version releases 2.61 and 1.10. The versions normally distributed in some mainstream GNU/Linux distributions are, in fact, much older than these versions.43 GNU version of these packages configured and installed to default directories will install in /usr/local/ allowing them to coexist with distribution installed versions.
For building documentation, the build host also requires the following documentation tools:
Most desktop GNU/Linux distributions will have these tools; however, some server-style installations (e.g. Ubuntu-server, SLES 9 or Fedora 6 or 7) will not and they must be installed separately.44
For uncooked manual pages, the entire groff(1) package is required on Debian and Ubuntu systems (the base package does not include grefer(1) which is used extensively by uncooked manual pages). The following will get what you need:
Debian: % apt-get install groff_ext
Ubuntu: % apt-get install groff
|
In addition, the build host requires a complete tool chain for compiling for the target host,
including kernel tools such as genksyms(8) and others.
If you wish to package rpms on an rpm(1) system, or debs on a dpkg(1) system, you will need the appropriate tool chain. Systems based on rpm(1) typically have the necessary tool chain available, however, dpkg(1) systems do not. The following on a Debian or Ubuntu system will get what you need:
% apt-get install debhelper
% apt-get install fakeroot
|
To generate a configuration script and the necessary scriptlets required by the GNU autoconf(1) system, execute the following commands on the working directory:
% autoreconf -fiv strbcm |
where, strbcm is the name of the directory to where the working copy was checked out under the previous step. This command generates the configure script and other missing pieces that are normally distributed with the release Tar Balls, SRPMs and DSCs.
Make sure that `autoreconf --version' returns `2.61'. Otherwise, you may need to perform something like the following:
% PATH="/usr/local/bin:$PATH"
% autoreconf -fiv strbcm
|
After reconfiguring the directory, the package can then be configured and built using the same instructions as are used for the Tar Ball, see Configuring the Tar Ball, and Building from the Tar Ball.
Do note, however, that make(1) will rebuild the documentation that is normally released with the package. Additional tools may be necessary for building the documentation. To avoid building and installing the documentation, use the --disable-devel option to configure described in Configuring the Tar Ball.
When configuring the package in a working directory and while working a change-compile-test cycle that involves configuration macros or documentation, I find it of great advantage to invoke the GNU configure options --enable-maintainer-mode, --enable-dependency-tracking and --disable-devel. The first of these three options will add maintainer-specific targets to any generated Makefile, the second option will invoke automatic dependency tracking within the Makefile so rebuilds after changes to macro, source or documentation files will be automatically rebuilt; and the last option will suppress rebuilding and reinstalling documentation manual pages and header files. Header files will still be available under the /usr/src directory.
In general the binary RPM do not require any configuration, however, during installation it is possible to relocate some of the installation directories. This allows some degree of customization. Relocations that are available on the binary RPM are as follows:
To install the binary RPM, See Installing the Binary RPM.
In general the binary DEB do not require any configuration.
To install the Debian DEB, See Installing the Debian DEB.
When building from the source RPM (see Building from the Source RPM), the rebuild process uses a
number of macros from the user's .rpmmacros file as described in rpm(8).
Following is an example of the ~/.rpmmacros file that I use for rebuilding RPMS:
#
# RPM macros for building rpms
#
%_topdir /usr/src/openss7.rpms
%vendor OpenSS7 Corporation
%distribution OpenSS7
%disturl http://www.openss7.org/
%packager Brian Bidulock <bidulock@openss7.org>
%url http://www.openss7.org/
%_signature gpg
%_gpg_path /home/brian/.gnupg
%_gpg_name openss7@openss7.org
%_gpgbin /usr/bin/gpg
%_source_payload w9.bzdio
%_binary_payload w9.bzdio
%_unpackaged_files_terminate_build 1
%_missing_doc_files_terminate_build 1
%_enable_debug_packages 1
#
# Template for debug information sub-package.
# with our little addition of release
#
%debug_package \
%ifnarch noarch\
%global __debug_package 1\
%package debug\
Summary: Debug information for package %{name}\
Group: Development/Debug\
AutoReqProv: 0\
%{?fullrelease:Release: %{fullrelease}}\
%description debug\
This package provides debug information for package %{name}.\
Debug information is useful when developing applications that use this\
package or when debugging this package.\
%files debug -f debugfiles.list\
%defattr(-,root,root)\
%endif\
%{nil}
|
When building from the source RPM (see Building from the Source RPM), it is possible to pass a number of additional configuration options to the rpmbuild(1) process.
The additional configuration options are described below.
Note that distributions that use older versions of rpm do not have the --with or --without options defined. To achieve the same effect as:
--with someparm=somearg
do:
--define "_with_someparm --with-someparm=somearg"
This is a generic description of common rpmbuild(1) options. Not all rpmbuild(1) options are applicable to all SRPMs. Options that are kernel module specific are only applicable to SRPMs that build kernel modules. STREAMS options are only applicable to SRPMs that provide or require STREAMS.
--define "_kversion $PACKAGE_KVERSION"--with checks--without checks--with k-optimize=HOW--without k-optimize-Os, speed compiles kernel modules -O3, and quick
compiles kernel modules -O0. The default is normal. Use with care.
--with cooked-manpages--without cooked-manpages--with public--without public--with k-debug--without k-debugtest and safe below. This has the effect of removing static and inline
attributes from functions and invoking all debugging macros in the code. The default is to not
perform kernel debugging.
--with k-test--without k-testdebug above and
safe below. This has the effect of removing static and inline attributes from functions and
invoking most debugging macros in the code. The default is to not perform kernel testing.
--with k-safe--without k-safedebug and
test above. This has the effect of invoking some more pedantic assertion macros in the code.
The default is not to apply kernel safety.
--with k-inline--without k-inlineinline functions are to be placed inline. This has the effect of
adding the -finline-functions flag to CFLAGS for compiling kernel modules. Linux 2.4
kernels are normally compiled -O2 which does not respect the inline directive. This
compiles kernel modules with -finline-functions to get closer to -O3 optimization.
For better optimization controls, See Configuring the Tar Ball.
--with k-modversions--without k-modversions--with devfs--without devfs--with devel--without devel--with tools--without tools--with modules--without modules--with lis--without lis--with lfs--without lfsIn general, the default values of these options are sufficient for most purposes and no options need be provided when rebuilding the Source RPMs.
To build from the source RPM, See Building from the Source RPM.
The Debian DSC can be configured by passing options in the environment variable BUILD_DEBOPTIONS. The options placed in this variable take the same form as those passed to the configure script, See Configuring the Tar Ball. For an example, See Building from the Debian DSC.
To build from the Debian DSC, See Building from the Debian DSC.
All of the normal GNU autoconf(1) configuration options and environment variables apply. Additional options and environment variables are provided to tailor or customize the build and are described below.
This is a generic description of common configure options that are in addition to those provided by autoconf(1), automake(1), libtool(1) and gettext(1).
Not all configure options are applicable to all release packages. Options that are kernel module specific are only applicable to release packages that build kernel modules. STREAMS options are only applicable to release packages that provide or require STREAMS.
Following are the additional configure options, their meaning and use:
Although the default is to install init scripts, installation attempts to detect a System V init script configuration, and if one is not found, the init scripts are installed into the appropriate directories, but the symbolic links to the run level script directories are not generated and the script is not invoked. Therefore, it is safe to leave this option unchanged, even on distributions that do not support System V init script layout (such as NexusWare).
static and inline attributes from functions and
invoking most non-performance affecting debugging macros in the code. The default is not to perform
kernel testing.
This option has no effect for release packages that do not provide kernel modules.
static and inline attributes from functions and
invoking all debugging macros in the code (including performance-affecting debug macros). The
default is to not perform kernel debugging.
This option has no effect for release packages that do not provide kernel modules.
gpg(1) `GNUPGUSER' for signing RPMs and tarballs. The default is the
content of the environment variable GNUPGUSER. If unspecified, the gpg(1) program
will normally use the user name of the account invoking the gpg(1) program. For building
source RPMs, the RPM macro `_gpg_name' will override this setting.
-Os, speed compiles kernel modules -O3, and quick
compiles kernel modules -O0. The default is normal. Use with care. The most common
use of this option is to specify --with-k-optimize=speed --disable-k-safe to compile for
maximum performance. Nevertheless, even these setting are ricing and the resulting kernel
modules will only be about 5% faster.
Following are additional environment variables to configure, their meaning and use:
soelim(1). This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
soelim(1) command. By default, configure will search for this tool.
refer(1). This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
refer(1) command. By default, configure will search for this tool.
tbl(1). This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
tbl(1) command. By default, configure will search for this tool.
pic(1). This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
pic(1) command. By default, configure will search for this tool.
gzip(1). This is only necessary when
the option --without-compressed-manpages has not been specified and
configure cannot find the proper gzip(1) command. By default,
configure will search for this tool.
bzip2(1). This is only necessary when the option
--without-compressed-manpages has not been specified and configure cannot
find the proper bzip2(1) command. By default, configure will search for this
tool.
makewhatis(8). By default, configure
will search for this tool. By default, configure will search for this tool.
chkconfig(8). This was used for installation of init scripts. All
packages now come with init_install(8) and init_remove(8) scripts used to install and
remove init scripts on both RPM and Debian systems.
rpm(1). This is only necessary for RPM builds. By default,
configure will search for this tool.
rpmbuild(1). This is only necessary for RPM builds. By default,
configure will search for this tool. rpm(1) will be used instead of
rpmbuild(1) only if rpmbuild(1) cannot be found.
dpkg(1). This command is used for building Debian packages. By default,
configure will search for this tool.
dpkg-source(1). This command is used for building Debian dsc
packages. By default, configure will search for this tool.
dpkg-buildpackage(1). This command is used for building Debian
deb packages. By default, configure will search for this tool.
ldconfig(8). Command used to configure the loader when libraries
are installed. By default, configure will search for this tool.
depmod(8). This is used during installation of
kernel modules to a running kernel to rebuild the modules dependency database. By default,
configure will search for this tool.
modprobe(8). This is used during installation of
kernel modules to a running kernel to remove old modules. By default, configure will
search for this tool.
lsmod(8). This is used during installation of kernel modules
to a running kernel to detect old modules for removal. By default, configure will search
for this tool.
lsof(1). This is used during installation of kernel modules to a
running kernel to detect old modules for removal. Processes owning the old kernel modules will be
killed and the module removed. If the process restarts, the new module will be demand loaded. By
default, configure will search for this tool.
genksyms(8). This is used for generating module symbol
versions during build. By default, configure will search for this tool.
genksyms(8). This is used for generating module
symbol version during build. By default, configure will search for this tool.
objdump(1). This is used for listing information about object
files. By default, configure will search for this tool.
nm(1). This is used for listing information about object
files. By default, configure will search for this tool.
autom4te(1). This is the executable used by autotest for pre- and
post-installation checks. By default, configure will search for this tool.
To build from the tar ball, See Building from the Tar Ball.
If you have downloaded the necessary source RPM (see Downloading the Source RPM), then the following instructions will rebuild the binary RPMs on your system. Once the binary RPMs are rebuilt, you may install them as described above (see Installing the Binary RPM).
The source RPM is rebuilt to binary RPMs as follows:
% wget http://www.openss7.org/rpms/SRPMS/strbcm-0.9.2.4-1.src.rpm
% rpmbuild --rebuild -vv strbcm-0.9.2.4-1.src.rpm
|
The rebuild process can also recognize a number of options that can be used to tweak the resulting binaries, See Configuring the Source RPM. These options are provided on the rpm(1) command line. For example:
% rpmbuild --rebuild -vv --target athlon-redhat-linux \
--define "_kversion 2.4.20-28.7" \
--with lfs -- strbcm-0.9.2.4-1.src.rpm
|
will rebuild binary RPM for the `2.4.20-28.7' kernel for the `athlon' architecture against the Linux Fast-STREAMS STREAMS package. 49
To install the resulting binary RPM, See Installing the Binary RPM.
If you have downloaded the necessary Debian DSC (see Downloading the Debian DSC), then the following instructions will rebuild the binary DEBs on your system. Once the binary DEBs are rebuilt, you may install them as described above (see Installing the Debian DEB).
The Debian DSC is rebuilt to binary DEBs as follows:
% wget http://www.openss7.org/debian/strbcm_0.9.2.4-0.dsc
% wget http://www.openss7.org/debian/strbcm_0.9.2.4-0.tar.gz
% dpkg-buildpackage -v strbcm_0.9.2.4-0.dsc
|
The rebuild process can also recognize a number of options that can be used to tweak the resulting binaries, See Configuring the Debian DSC. These options are provided in the environment variable BUILD_DPKGOPTIONS and have the same form as the options to configure, See Configuring the Tar Ball. For example:
% BUILD_DEBOPTIONS='
--with-lfs
--with-k-release=2.4.20-28.7
--host=athlon-debian-linux-gnu'
dpkg-buildpackage -v \
strbcm_0.9.2.4-0.dsc
|
will rebuild binary DEB for the `2.4.20-28.7' kernel for the `athlon' architecture against the Linux Fast-STREAMS STREAMS package. 50
To install the resulting binary DEB, See Installing the Debian DEB.
If you have downloaded the tar ball (see Downloading the Tar Ball), then the following instructions will rebuild the package on your system. (Note that the build process does not required root privilege.)
Following is an example of a native build against the running kernel:
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.bz2
% tar -xjvf strbcm-0.9.2.4.tar.bz2
% pushd strbcm-0.9.2.4
% ./configure
% make
% popd
|
Following is an example for a cross-build. The kernel release version must always be specified for a cross-build.51 If you are cross-building, specify the root for the build with environment variable DESTDIR. The cross-compile host must also be specified if different from the build host. Either the compiler and other tools must be in the usual places where GNU autoconf(1) can find them, or they must be specified with declarations such as `CC=/u5/NexusWare24/ppc-linux/gcc' on the configure command line. Look in the file configure.nexusware in the release package for an example.
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.bz2
% tar -xjvf strbcm-0.9.2.4.tar.bz2
% pushd strbcm-0.9.2.4
% ./configure DESTDIR="/some/other/root" \
--with-k-release=2.4.18 --host sparc-linux
% make
% popd
|
Additional support is provided for cross-building for the Performance Technologies Inc. NexusWare embedded target for the CPC-384, CPC-388 and CPC-396 cards. A configuration script wrapper (configure.nexusware) is provided to simplify the cross-build operation for these targets. The following steps describe the process:
% pushd /u5/NexusWare24
% source SETUP.sh
% make
% popd
|
For more recent NexusWare releases, the method for rebuilding a kernel is a little different as follows:
% pushd /u5/NexusWare80
% ./nexus 2.4
% ./nexus 8260
% ./nexus quick
% . SETUP.sh
% popd
|
Any of the normal configure script options (see Configuring the Tar Ball) can be used on the same line as `./configure.nexusware'. One of particular interest to embedded targets is --with-k-optimize=size to attempt to reduce the size of the kernel modules.
You must specify the kernel version of the kernel for which you are configuring. Add the --with-k-release=2.4.18 option for older NexusWare releases, --with-k-release=2.4.25 or --with-k-release=2.6.12 for more current NexusWare releases.
Following is what I use for configuration and installation: (My NexusWare tree is rooted at /u5/NexusWare.)
% pushd /u5/NexusWare80
% ./nexus 2.4
% ./nexus 8260
% ./nexus quick
% . SETUP.sh
% popd
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.bz2
% tar -xjvf strbcm-0.9.2.4.tar.bz2
% pushd strbcm-0.9.2.4
% ./configure.nexusware --with-k-release=2.4.25 --with-k-optimize=size
% make
% make DESTDIR="$NEXUSWARE_PREFIX" install-strip
% popd
|
Once built and installed in the NexusWare directory, you will have to (currently) hand edit a .spec file to include the components you want in the NexusWare root file system. If you are cross-building for NexusWare you should already know what that means. Objects that you might be interested in copying to the root file system are kernel modules that were installed in $NEXUSWARE_PREFIX/lib/modules/2.4.18/strbcm, libraries installed in $NEXUSWARE_PREFIX/usr/lib and utility functions installed in $NEXUSWARE_PREFIX/usr/bin and $NEXUSWARE_PREFIX/usr/sbin and test programs in $NEXUSWARE_PREFIX/usr/libexec. If you would prefer that these programs be installed in $NEXUSWARE_PREFIX/lib, $NEXUSWARE_PREFIX/bin, $NEXUSWARE_PREFIX/sbin and $NEXUSWARE_PREFIX/libexec, (say because you want to remote mount the /usr directory after boot), then specify the --exec-prefix=/ option to `./configure.nexusware'.
Because NexusWare does not include an /etc/modules.conf file by default, it will be necessary to add one or edit your rc.4 file to insmod(8) the necessary strbcm modules at boot time.
NexusWare does not configure its kernels for CONFIG_KMOD, so any kernel modules must be loaded by the rc.4 init script at boot. On more recent NexusWare releases, the init scripts will be installed in $NEXUSWARE_PREFIX/etc/rc.d/init.d/ but you must manually edit your rc.4 script to invoke these scripts.
Once you have completed the necessary .spec and rc.4 file entries, you need to rebuild the `generic' kernel flash image once more for these objects to be included in the flash file system. It is important that this second build of the kernel image be the same as the first.
When modifying and rebuilding a NexusWare kernel, it will be necessary to rebuild and install strbcm. Simply perform the last `make install-strip' stage or start again with `./configure.nexusware'. You can place the unpacked tarball in $NEXUSWARE_PREFIX/usr/src/strbcm, and add the following to the top-level NexusWare Makefile to make the build process a single step process instead of dual pass:
all:
...
(cd kernels/generic; $(MAKE) depend)
(cd usr/src/pcmcia-cs-3.2.1; $(MAKE) config)
(cd kernels/generic; $(MAKE))
(cd usr/src/pcmcia-cs-3.2.1; $(MAKE) pti)
(cd usr/src/pti; $(MAKE))
(cd drivers; $(MAKE))
(cd utility; $(MAKE))
# uncomment for LiS build
# (cd usr/src/LiS; ./configure.nexusware; $(MAKE) install-strip)
# uncomment for LfS build
(cd usr/src/streams; ./configure.nexusware; $(MAKE) install-strip)
# uncomment for strbcm build
# (cd usr/src/strbcm; ./configure.nexusware; $(MAKE) install-strip)
(cd build/generic; $(MAKE))
...
|
Another, perhaps simpler approach, is to make the necessary edits to the NexusWare top-level Makefile and .spec and rc.4 files, download and unpack the tar ball into the NexusWare directory, and build the NexusWare flash image as normal:
% wget http://www.openss7.org/strbcm-0.9.2.4.tar.bz2
% pushd /u5/NexusWare24
% source SETUP.sh
% pushd usr/src
% tar -xjvf ${DIRSTACK[2]}/strbcm-0.9.2.4.tar.bz2
% ln -sf strbcm-0.9.2.4 strbcm
% popd
% make
% popd
|
The situation is a little more complex for recent NexusWare releases.
If you have downloaded the necessary binary RPMs (see Downloading the Binary RPM), or have
rebuilt binary RPMs using the source RPM (see Building from the Source RPM), then the following
instructions will install the RPMs on your system. For additional information on rpm(1), see
rpm(8).
% pushd RPMS/i686
% rpm -ihv strbcm-*-0.9.2.4-1.7.2.i686.rpm
|
You must have the correct binary RPMs downloaded or built for this to be successful.
Some of the packages are relocatable and can have final installation directories altered with the
--relocate option to rpm(1), see rpm(8).
For example, the following will relocate the documentation and info directories:
% pushd RPMS/i686
% rpm -ihv \
--relocate '/usr/share/doc=/usr/local/share/doc' \
--relocate '/usr/share/info=/usr/local/share/info' \
-- strbcm-doc-0.9.2.4-1.7.2.i686.rpm
|
The previous example will install the strbcm-doc package by will relocate the documentation an info directory contents to the /usr/local version.
If you have downloaded the necessary Debian DEBs (see Downloading the Debian DEB), or have
rebuild binary DEBs using the Debian DSC (see Building from the Debian DSC), then the following
instructions will install the DEBs on your system. For additional information see dpkg(8).
% pushd debian
% dpkg -iv strbcm-*_0.9.2.4-0_*.deb
|
You must have the correct .deb files downloaded or build for this to be successful.
After the build process (see Building from the Tar Ball), installation only requires execution of one of two automake(1) targets:
To remove an installed version of the binary RPMs (whether obtained from the OpenSS7 binary RPM releases, or whether created by the source RPM), execute the following command:
% rpm -evv `rpm -qa | grep '^strbcm-'` |
For more information see rpm(1).
To remove and installed version of the Debian DEB (whether obtained from the OpenSS7 binary DEB releases, or whether created by the Debian DSC), execute the following command:
% dpkg -ev `dpkg -l | grep '^strbcm-'` |
For more information see dpkg(8).
To remove all the installed binary RPM build from the source RPM, see Removing the Binary RPM. Then simply remove the binary RPM package files and source RPM file. A command such as:
% find / -name 'strbcm-*.rpm' -type f -print0 | xargs --null rm -f |
should remove all strbcm RPMs from your system.
To remove all the installed binary DEB build from the Debian DSC, see Removing the Debian DEB. Then simply remove the binary DEB package files and Debian DSC file. A command such as:
% find / \( -name 'strbcm-*.deb' \
-o -name 'strbcm-*.dsc' \
-o -name 'strbcm-*.tar.* \
\) -type f -print0 | xargs --null rm -f
|
should remove all strbcm DEBs, DSCs and TARs from your system.
To remove a version installed from tar ball, change to the build directory where the package was built and use the `uninstall' automake(1) target as follows:
% cd /usr/src/strbcm
% make uninstall
% cd ..
% rm -fr strbcm-0.9.2.4
% rm -f strbcm-0.9.2.4.tar.gz
% rm -f strbcm-0.9.2.4.tar.bz2
|
If you have inadvertently removed the build directory and, therefore, no longer have a configured directory from which to execute `make uninstall', then perform all of the steps for configuration and installation (see Installing the Tar Ball) except the final installation and then perform the steps above.
When OpenSS7 STREAMS Binary Compatibility Modules installs, modules and drivers belonging to release packages are normally configured for demand loading. The `install' and `install-strip' automake(1) targets will make the necessary changes to the /etc/modules.conf file and place the modules in an appropriate place in /lib/modules/2.4.20-28.7/strbcm. The `make install' process should have copied the kernel module files streams-*.o to the directory /lib/modules/2.4.20-28.7/strbcm. This means that to load any of these modules, you can simply execute, for example, `modprobe stream-somedriver'.53
The strbcm demand load system supports both the old kerneld and the new kmod mechanisms for demand loading kernel modules.
The convention for strbcm kernel loadable object files is:
If your kernel has been built using the kerneld daemon, then strbcm kernel modules will automatically load as soon as the STREAMS module is pushed or the driver is opened. The `make install' process makes the necessary changes to the /etc/modules.conf file. After the install, you will see lines like the following added to your /etc/modules.conf file:
prune modules.strbcm
if -f /lib/modules/`uname -r`/modules.strbcm
include /lib/modules/`uname -r`/modules.strbcm
endif
|
which will provide for demand loading of the modules if they have been built and installed for the running kernel. The /lib/modules/`uname -r`/modules.strbcm file looks like this:
alias char-major-245 streams-some_driver
alias char-major-246 streams-other_driver
|
Note that STREAMS modules are not listed in this file, but will be loaded by name using kerneld if available.
Linux Fast-STREAMS has a wider range of kernel module loading mechanisms than is provided by the deprecated LiS. For mechanisms used for kernel module loading under Linux Fast-STREAMS, See About This Manual.
Under exceptional circumstances, such as a NexusWare build, it is necessary to hand-edit a .spec and rc.4 file to load the modules at boot time.54
LiS is deprecated and this section has been deleted.
automake(1) has many targets, not all of which are obvious to the casual user. In addition, OpenSS7 automake(1) files have additional rules added to make maintaining and releasing a package somewhat easier. This list of targets provides some help with what targets can be invoked, what they do, and what they hope to achieve. The available targets are as follows:
The following are normal targets intended to be invoked by installers of the package. They are concerned with compiling, checking the compile, installing, checking the installation, and removing the package.
All OpenSS7 Project packages are configured without maintainer mode and without dependency tracking by default. This speeds compilation of the package for one-time builds. This also means that if you are developing using the source package (edit-compile-test cycle), changes made to source files will not cause the automatic rebuilding due to dependencies. There are two ways to enable dependency tracking: specify --enable-maintainer-mode to configure; or, specify --enable-dependency-tracking to configure. I use the former during my edit-compile-test cycle.
This is a standard GNU automake(1) makefile target. This target does not require root privilege.
Another way to enable the greater set of checks, without invoking maintainer mode, is to specify --enable-checks to configure. For more information, see Pre-installation Checks.
This is a standard GNU automake(1) makefile target, although the functions performed are customized for the OpenSS7 Project. This target does not require root privilege.
This is a standard GNU automake(1) makefile target. This target requires root privilege.
This is a standard GNU automake(1) makefile target. This target might require root privilege. Tests requiring root privilege will be skipped when run as a regular user. Tests requiring regular account privileges will be skipped when run as root.
This is an OpenSS7 Project specific makefile target. As with `installcheck', this target might require root privilege. Tests requiring root privilege will be skipped when run as a regular user. Tests requiring regular account privileges will be skipped when run as root.
The `uninstall' target unfortunately removes add-on packages in the same order in which they were installed. This is not good for the OpenSS7 Master Package, where the `remove' target should be used instead.
This is a standard GNU automake(1) makefile target. This target requires root privilege.
This is an OpenSS7 Project specific makefile target. This target requires root privilege.
The following targets are targets intended for use by maintainers of the package, or those responsible for release and packaging of a derivative work of the package. Some of these targets are only effective when maintainer mode has been invoked (--enable-maintainer-mode specified to configure.)
This is a standard GNU automake(1) makefile target. This target does not require root privilege.
This is a standard GNU automake(1) makefile target. This target does not require root privilege.
This is a standard GNU automake(1) makefile target. This target does not require root privilege.
This is a standard GNU automake(1) makefile target. This target might require root privilege if the `installcheck' target or the testsuite was invoked with root privilege (leaving files belonging to root).
This is a standard GNU automake(1) makefile target. This target might require root privilege if the `installcheck' target or the testsuite was invoked with root privilege (leaving files belonging to root).
This is a standard GNU automake(1) makefile target. This target might require root privilege if the `installcheck' target or the testsuite was invoked with root privilege (leaving files belonging to root).
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
The following are targets used to generate complete releases into the package distribution directory. These are good for unattended and NFS builds, which is what I use them for. Also, when building from atop multiple packages, these targets also recurse down through each package.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
For convenience, to log the output of a number of targets to a file, log targets are defined. The log file itself is used as the target to make, but make invokes the target minus a .log suffix. So, for example, to log the results of target `foo', invoke the target `foo.log'. The only target that this does not apply to is `compile.log'. When you invoke the target `compile.log' a simple automake(1) is invoked and logged to the file compile.log. The `foo.log' rule applies to all other targets. This does not work for all targets, just a selected few.59 Following are the logging targets:
Common logging targets correspond to normal user automake(1) makefile targets as follows:
Maintainer logging targets correspond to maintainer mode automake(1) makefile targets as follows:
If you want to add one, simply add it to LOGGING_TARGETS in Makefile.am.
To ease problem report generation, all logging targets will automatically generate a problem report suitable for mailing in the file target.pr for target `target.log'. This problem report file is in the form of an email and can be sent using the included send-pr script or by invoking the `send-pr' makefile target.
There are two additional problem report targets:
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege (unless the problem report file was generated as root).
The following targets are used to generate and clean distribution archive and signature files. Whereas the `dist' target affects archives in the top build directory, the `release-archive' targets affects archives in the package distribution directory (either the top build directory or that specified with --with-pkg-distdir=DIR to configure).
You can change the directory to which packages are distributed by using the --with-pkg-distdir=DIR option to configure. The default directory is the top build directory.
The files generated are named:
strbcm-0.9.2.4.tar.gz and strbcm-0.9.2.4.tar.bz2
You can change this distribution directory with the --with-pkg-distdir option to configure. See `./configure --help' for more details on options.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
`make GNUPGPASS=mypasswd release-sign-archives'
Signature files will be named:
strbcm-0.9.2.4.tar.gz.asc and strbcm-0.9.2.4.tar.bz2.asc
These files will be moved to the package distribution directory with the plain text archives.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
On rpm(1) systems, or systems sporting rpm packaging tools, the following targets are used to generate rpm(1) release packages. The epoch and release number can be controlled by the contents of the .rpmepoch and .rpmrelease files, or with the --with-rpm-epoch=EPOCH and --with-rpm-release=RELEASE options to configure. See `configure --help' for more information on options. We always use release number `1'. You can use release numbers above `1'.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
strbcm-*-0.9.2.4-1.*.rpm
where the stars indicate the subpackage and the architecture. Both the architecture specific subpackages (binary objects) and the architecture independent (.noarch) subpackages will be built unless the the former was disabled with the option --disable-arch, or the later with the option --disable-indep, passed to configure.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
On Debian systems, or systems sporting Debian packaging tools, the following targets are used to generate Debian release packages. The release number can be controlled by the contents of the .debrelease file, or with the --with-debrelease=RELEASENUMBER option to configure. See `configure --help' for more information on options.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
This is an OpenSS7 Project specific makefile target. This target does not require root privilege.
Most OpenSS7 packages, including the OpenSS7 STREAMS Binary Compatibility Modules package, ship with pre-installation checks integral to the build system. Pre-installation checks include check scripts that are shipped in the scripts subdirectory as well as specialized make targets that perform the checks.
When building and installing the package from RPM or DEB source packages (see Building from the Source RPM; and Building from the Debian DSC), a fundamental set of post-compile, pre-installation checks are performed prior to building binary packages. This is performed automatically and does not require any special actions on the part of the user creating binary packages from source packages.
When building and installing the package from tarball (see Building from the Tar Ball; and Installing the Tar Ball), however, pre-installation checks are only performed if specifically invoked by the builder of the package. Pre-installation checks are invoked after building the package and before installing the package. Pre-installation checks are performed by invoking the `check' or `check.log' target to make when building the package, as shown in testsuite:ex0.
Pre-installation checks fall into two categories: System Checks and Maintenance Checks.
System Checks are post-compilation checks that can be performed before installing the package that check to ensure that the compiled objects function and will be successfully installed. When the --enable-maintainer-mode option has not been passed to configure, only System Checks will be performed.
For example, the steps shown in testsuite:ex1 will perform System checks.
Maintenance Checks include all System Checks, but also checks to ensure that the kernel modules, applications programs, header files, development tools, test programs, documentation, and manual pages conform to OpenSS7 standards. When the --enable-maintainer-mode option has been passed to configure, Maintenance Checks will be performed.
For example, the steps shown in testsuite:ex2 will perform Maintenance checks.
A number of check scripts are provided in the scripts subdirectory of the distribution that perform both System and Maintenance checks. These are as follows:
When performing System tests, the following tests are performed:
Unless cross-compiling, or unless a program is included in AM_INSTALLCHECK_STD_OPTIONS_EXEMPT
every program in bin_PROGRAMS, sbin_PROGRAMS, and libexec_PROGRAMS is tested to
ensure that the --help, --version, and --copying options are accepted.
When cross-compiling is is not possible to execute cross-compiled binaries, and these checks are
skipped in that case.
Script executables, on the other hand, can be executed on the build host, so, unless listed in
AM_INSTALLCHECK_STD_OPTIONS_EXEMPT, every program in dist_bit_SCRIPTS,
dist_sbin_SCRIPTS, and pkglibexec_SCRIPTS are tested to ensure that the
--help, --version, and --copying options are accepted.
When performing Maintenance tests, check_commands also checks to ensure that a
manual page exists in section 1 for every executable binary or script that will be installed from
bin_PROGRAMS and dist_bin_SCRIPTS. It also checks to ensure that a manual page exists
in section 8 for every executable binary or script that will be installed from sbin_PROGRAMS,
dist_sbin_SCRIPTS, libexec_PROGRAMS, and pkglibexec_SCRIPTS.
It collects the results from the check_libs, check_modules and check_headers
check scripts and tests to ensure every declaration of a function prototype or external variable
contained in installed header files has a corresponding exported symbol from either a to be
installed shared object library or a to be installed kernel module. Declarations are exempted from
this requirement if their identifiers have been explicitly added to the EXPOSED_SYMBOL
variable. If WARN_EXCESS is set to `yes', then the check script will only warn when
excess declarations exist (without a corresponding exported symbol); otherwise, the check script
will generate an error and the check will fail.
When performing Maintenance tests, it identifies all of the declarations included in to be installed header files. It then checks to ensure that a manual page exists in sections 2, 3, 7 or 9, as appropriate, for the type of declaration. It also checks to see if a manual page source file exists in the source directory for a declaration that has not been included in the distribution. Function or prototype declarations that do not have a manual page in sections 2, 3, or 9 will cause the check to fail. Other declarations (`variable', `externvar', `macro', `enumerate', `enum', `struct', `union', `typedef', `member', etc.) will only warn if a manual page does not exist, but will not fail the check.
When performing Maintenance tests, it checks that each exported symbol in each to be installed shared object library has a manual page in section 3. It also checks that each exported symbol has a `function', `prototype' or `externvar' declaration in the to be installed header files. A missing declaration or manual page will cause this check to fail.
When performing Maintenance tests, it checks that to be install manual pages can be formatted for display without any errors or warnings from the build host man program. It also checks that required headings exist for manual pages according to the section in which the manual page will be installed. It warns if recommended headings are not included in the manual pages. Because some RPM distributions have manual pages that might conflict with the package manual pages, this check script also checks for conflicts with installed manual pages on the build host. This check script also checks to ensure that all to be installed manual pages are used in some fashion, that is, they have a declaration, or exported symbol, or are the name of a kernel module or STREAMS module or driver, possibly capitalized.
Note that checking for conflicts with the build host should probably be included in the System
checks (because System checks are performed before the source RPM %install
scriptlet).
When performing System tests, it checks each to be installed kernel module to ensure that all undefined symbols can be resolved to either the kernel or another module. It also checks whether an exported or externally declared symbol conflicts with an exported or externally declared symbol present in the kernel or another module.60
When performing Maintenance tests, this check script tests that each to be installed kernel module has a manual page in section 9 and that each exported symbol that does not begin with an underscore, and that belongs to an exported function or exported variable, has a manual page in section 9. It also checks to ensure that each exported symbol that does not begin with an underscore, and that belongs to an exported function or exported variable, has a `function', `prototype' or `externvar' declaration in the to be installed header files.
When performing Maintenance tests, it checks that for each configured STREAMS module or driver, or device node, that a manual page exists in section 4 or section 7 as appropriate.
The output of the pre-installation tests are fairly self explanatory. Each check script saves some output to name.log, where name is the name of the check script as listed above. A summary of the results of the test are display to standard output and can also be captured to the check.log file if the `check.log' target is used instead of the `check' target to make.
Because the check scripts proliferate name.log files throughout the build directory, a `make check-clean' make target has be provided to clean them out. `make check-clean' should be run before each successive run of `make check'.
Most OpenSS7 packages ship with a compatibility and conformance test suite built using the `autotest' capabilities of `autoconf'. These test suites act as a wrapper for the compatibility and conformance test programs that are shipped with the package.
Unlike the pre-installation checks, the post-installation checks are always run complete. The only check that post-installation test scripts perform is to test whether they have been invoked with root privileges or not. When invoked as root, or as a plain user, some tests might be skipped that require root privileges, or that require plain user privileges, to complete successfully.
There are several ways of invoking the conformance test suites:
Typical steps for invoking the test suites directly from make are shown in testsuite:ex3.
When performing post-installation checks for the purposes of generating a problem report, the checks should always be performed from the build directory, either with `make installcheck' or by invoking testsuite directly from the tests subdirectory of the build directory. This ensures that all of the information known to configure and pertinent to the configuration of the system for which a test case failed, will be collected in the resulting testsuite.log file deposited upon test suite failure in the tests directory. This testsuite.log file can then be attached as part of the problem report and provides rich details to maintainers of the package. See also See Problem Reports, below.
Typical steps for invoking and installed testsuite standalone are shown in testsuite:ex4.
When invoked directly, testsuite will generate a testsuite.log file in the current directory, and a testsuite.dir directory of failed tests cases and debugging scripts. For generating a problem report for failed test cases, see Stand Alone Problem Reports.
Problem reports in the following categories should include a log file as indicated in the table below:
For other problems that occur during the use of the OpenSS7 STREAMS Binary Compatibility Modules package, please
write a test case for the test suite that recreates the problem if one does not yet exist and
provide a test program patch with the problem report. Also include whatever log files are generated
by the kernel (cmn_err(9)) or by the strerr(8) or strace(1) facilities
(strlog(9)).
The OpenSS7 Project uses the GNU GNATS system for problem reporting. Although the `send-pr' tool from the GNU GNATS package can be used for bug reporting to the project's GNATS database using electronic mail, it is not always convenient to download and install the GNATS system to gain access to the `send-pr' tool.
Therefore, the OpenSS7 STREAMS Binary Compatibility Modules package provides the `send-pr' shell script that can be used for problem reporting. The `send-pr' shell script can invoked directly and is a work-alike for the GNU `send-pr' tool.
The `send-pr' tool takes the same flags and can be used in the same fashion, however, whereas `send-pr' is an interactive tool61, `send-pr' is also able to perform batch processing. Whereas `send-pr' takes its field information from local databases or from using the `query-pr' C-language program to query a remote database, the `send-pr' tool has the field database internal to the tool.
Problem reports can be generate using make, See Problem Report Targets. An example of how simple it is to generate a problem report is illustrated in autopr:ex0.
Using the `make pr' target to generate a problem report has the advantages that it will assemble any available *.log files in the build directory and attach them to the problem report.
The OpenSS7 STREAMS Binary Compatibility Modules package also provides a feature for automatic problem report generation that meets the problem report submission guidelines detailed in the preceding sections.
Whenever a logging makefile target (see Logging Targets) is invoked, if the primary target fails, the send-pr shell script is invoked to automatically generate a problem report file suitable for the corresponding target (as described above under see Problem Report Guidelines). An example is shown in autopr:ex1.
The OpenSS7 STREAMS Binary Compatibility Modules package installs the send-pr script and its configuration file send-pr.config in ${libexecdir}/strbcm along with the validation testsuite, see See Test Suites. As with the testsuite, this allows the send-pr script to be used for problem report generation on an installed system that does not have a build directory.
An example of invoking the package testsuite and then generating a problem report for failed cases is shown in autopr:ex2.
The advantage of the approach shown in the example is that the send-pr script is capable of collecting the testsuite.log file and the failed test cases and debugging scripts from the testsuite.dir directory and including them in the problem report, as well as all package pertinent information from the installed send-pr.config.
The OpenSS7 Project does not ship software with known bugs. All bugs are unknown.
Verified behaviour is that behaviour that has been verified by conformance test suites that are shipped with the OpenSS7 STREAMS Binary Compatibility Modules package.
Unverified behaviour may contain unknown bugs.
Please remember that there is NO WARRANTY.
See also Bugs, or file BUGS in the release directory.
Copyright © 1989, 1991 Free Software Foundation, Inc.
675 Mass Ave, Cambridge, MA 02139, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
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.
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.
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.
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.
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.
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.
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.
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.
one line to give the program's name and an idea of what it does.
Copyright (C) 19yy name of author
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., 675 Mass Ave, Cambridge, MA 02139, 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) 19yy 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.
signature of Ty Coon, 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.
Copyright © 1991, 1999 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.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence the
version number 2.1.]
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software—to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some specially designated software—typically libraries—of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use, 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 and use pieces of it in new free programs; and that you are informed that you can do these things.
To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others.
Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.
When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.
We call this license the Lesser General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.
For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.
Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run.
A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.
The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)
“Source code” for a work means the preferred form of the work for making modifications to it. For a library, 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 library.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.
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.
(For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, 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 Library, 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 Library.
In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of the Library into a program that is not a library.
If distribution of 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 satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.
However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.
When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself.
You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:
For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be 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.
It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute.
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.
Each version is given a distinguishing version number. If the Library 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 Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation.
If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).
To apply these terms, attach the following notices to the library. 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.
one line to give the library's name and an idea of what it does.
Copyright (C) year name of author
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or (at
your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; 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.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the library
`Frob' (a library for tweaking knobs) written by James Random Hacker.
signature of Ty Coon, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
Copyright © 2000 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.
The purpose of this License is to make a manual, textbook, or other written document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (For example, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup has been designed to thwart or discourage subsequent modification by readers is not Transparent. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ascii without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML designed for human modification. Opaque formats include PostScript, PDF, proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections entitled “History” in the various original documents, forming one section entitled “History”; likewise combine any sections entitled “Acknowledgments”, and any sections entitled “Dedications”. You must delete all sections entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an “aggregate”, and this License does not apply to the other self-contained works thus compiled with the Document, on account of their being thus compiled, if they are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document 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.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation 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. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being list their titles, with the
Front-Cover Texts being list, and with the Back-Cover Texts being list.
A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
If you have no Invariant Sections, write “with no Invariant Sections” instead of saying which ones are invariant. If you have no Front-Cover Texts, write “no Front-Cover Texts” instead of “Front-Cover Texts being list”; likewise for Back-Cover Texts.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
AUTOM4TE: Environment VariablesAUTOTEST: Environment VariablesBZIP2: Environment VariablesBZIP2_CMD: Environment VariablesCHKCONFIG: Environment VariablesDEB_BUILD_ARCH: Environment VariablesDEB_BUILD_GNU_CPU: Environment VariablesDEB_BUILD_GNU_SYSTEM: Environment VariablesDEB_BUILD_GNU_TYPE: Environment VariablesDEB_HOST_ARCH: Environment VariablesDEB_HOST_GNU_CPU: Environment VariablesDEB_HOST_GNU_SYSTEM: Environment VariablesDEB_HOST_GNU_TYPE: Environment VariablesDEPMOD: Environment VariablesDESTDIR: Environment VariablesDPKG: Environment VariablesDPKG_BUILDPACKAGE: Environment VariablesDPKG_SOURCE: Environment VariablesGENKSYMS: Environment VariablesGNUPGHOME: Environment VariablesGNUPGUSER: Environment VariablesGPG: Environment VariablesGPGPASSWD: Environment VariablesGZIP: Environment VariablesGZIP_CMD: Environment VariablesKGENKSYMS: Environment VariablesLDCONFIG: Environment VariablesLSMOD: Environment VariablesLSOF: Environment VariablesMAKEWHATIS: Environment VariablesMODPOST_CACHE: Environment VariablesMODPROBE: Environment VariablesNM: Environment VariablesOBJDUMP: Environment VariablesPACKAGE_KVERSION: Configuring the Source RPMPIC: Environment VariablesREFER: Environment VariablesRPM: Environment VariablesRPMBUILD: Environment VariablesSOELIM: Environment VariablesTBL: Environment Variables32bit-libs: Configure Optionsarch: Configure Optionsautotest: Configure Optionsbase-major: Configure Optionschecks: Configure Optionschecks: Configuring the Source RPMcompress-manpages: Configure Optionscooked-manpages: Configure Optionscooked-manpages: Configuring the Source RPMdeb-epoch: Configure Optionsdeb-release: Configure Optionsdeb-topdir: Configure Optionsdevel: Configure Optionsdevel: Configuring the Source RPMdevfs: Configure Optionsgpg-home: Configure Optionsgpg-user: Configure Optionsindep: Configure Optionsinitscripts: Configure Optionsk-archdir: Configure Optionsk-build: Configure Optionsk-config: Configure Optionsk-debug: Configure Optionsk-debug: Configuring the Source RPMk-inline: Configure Optionsk-inline: Configuring the Source RPMk-linkage: Configure Optionsk-machdir: Configure Optionsk-modules: Configure Optionsk-modversions: Configure Optionsk-modversions: Configuring the Source RPMk-optimize: Configure Optionsk-optimize: Configuring the Source RPMk-release: Configure Optionsk-release: Configuring the Source RPMk-safe: Configure Optionsk-safe: Configuring the Source RPMk-sysmap: Configure Optionsk-test: Configure Optionsk-test: Configuring the Source RPMlfs: Configure Optionslfs: Configuring the Source RPMlis: Configure Optionslis: Configuring the Source RPMmodules: Configure Optionsmodules: Configuring the Source RPMpkg-distdir: Configure Optionspkg-epoch: Configure Optionspkg-release: Configure Optionspublic: Configure Optionspublic: Configuring the Source RPMrpm-epoch: Configure Optionsrpm-extra: Configure Optionsrpm-release: Configure Optionsrpm-topdir: Configure Optionsstrconf-master: Configure Optionstools: Configure Optionstools: Configuring the Source RPMall: User Targetsall: Loadingcheck: User Targetscheck-clean: Clean Targetscheck.log: Logging Targetsclean: Clean Targetscompile.log: Logging Targetscsig: Debian Build Targetsdebs: Debian Build Targetsdist: Maintainer Targetsdist.log: Logging Targetsdistcheck: Maintainer Targetsdistcheck.log: Logging Targetsdistclean: Clean Targetsdsc: Debian Build Targetsforced-release: Release Targetsforced-release-sign: Release Targetsinstall: User Targetsinstall: Loadinginstall-strip: User Targetsinstall-strip: Loadinginstall.log: Logging Targetsinstallcheck: User Targetsinstallcheck.log: Logging Targetsmaintainer-clean: Clean Targetsmostlyclean: Clean Targetspr: Generating Problem Reportspr: Problem Report Targetsrebuild: RPM Build Targetsrebuild.log: Logging Targetsrelease: Release Targetsrelease-archives: Release Archive Targetsrelease-clean: Release Targetsrelease-clean-archives: Release Archive Targetsrelease-sign: Release Targetsrelease-sign-archives: Release Archive Targetsrelease-sign.log: Logging Targetsrelease.log: Logging Targetsremove: User Targetsremove.log: Logging Targetsresign: RPM Build Targetsresign.log: Logging Targetsretest: User Targetsrpms: RPM Build Targetssend-pr: Problem Report Targetssign: RPM Build Targetssigs: Debian Build Targetssrpm: RPM Build Targetssrpm-sign: RPM Build Targetssrpm.log: Logging Targetsuninstall: User Targetsuninstall.log: Logging Targetsautoconf(1): Footnotesautoconf(1): User Targetsautoconf(1): Building from the Tar Ballautoconf(1): Configure Optionsautoconf(1): Configuring the Tar Ballautoconf(1): Downloading from CVSautoconf(1): Downloading the Tar Ballautoconf(1): Downloading the Debian DEBautoconf(1): Downloading the Binary RPMautoconf(1): Quick Start Guideautom4te(1): Environment Variablesautomake(1): Footnotesautomake(1): Footnotesautomake(1): Logging Targetsautomake(1): Clean Targetsautomake(1): Maintainer Targetsautomake(1): User Targetsautomake(1): Makefile Targetsautomake(1): Loadingautomake(1): Removing the Tar Ballautomake(1): Installing the Tar Ballautomake(1): Building from the Tar Ballautomake(1): Configure Optionsautomake(1): Configuring the Source RPMautomake(1): Downloading from CVSautoreconf(1): User Targetsbzip2(1): Environment Variableschkconfig(8): Environment Variablescvs(1): Downloading from CVScvs(1): Quick Start Guidedepmod(8): Environment Variablesdevfsd(1): Configuring the Source RPMdevfsd(8): Configure Optionsdpkg(1): User Targetsdpkg(1): Environment Variablesdpkg(1): Configure Optionsdpkg(1): Downloading from CVSdpkg(1): Downloading the Tar Balldpkg(1): Downloadingdpkg(8): Removing the Debian DEBdpkg(8): Installing the Debian DEBdpkg-buildpackage(1): Environment Variablesdpkg-source(1): Environment Variablesgcc(1): Quick Start Guidegenksyms(8): Environment Variablesgenksyms(8): Downloading from CVSgettext(1): Configure Optionsgit(1): Quick Start Guidegpg(1): Configure Optionsgrefer(1): Footnotesgrefer(1): Footnotesgrefer(1): Configure Optionsgrefer(1): Configuring the Source RPMgrefer(1): Downloading from CVSgroff(1): Footnotesgroff(1): Footnotesgroff(1): Configure Optionsgroff(1): Configuring the Source RPMgroff(1): Downloading from CVSgzip(1): Environment Variablesinit_install(8): Environment Variablesinit_remove(8): Environment Variablesinsmod(8): Building from the Tar Ballldconfig(8): Environment Variableslibtool(1): Configure Optionslsmod(8): Environment Variableslsof(1): Environment Variablesmake(1): Configure Optionsmake(1): Downloading from CVSmakewhatis(8): Environment Variablesmodpost(1): Environment Variablesmodprobe(8): Environment Variablesnm(1): Environment Variablesobjdump(1): Environment Variablespic(1): Environment Variablespic(1): Configure Optionspic(1): Configuring the Source RPMrefer(1): Environment Variablesrefer(1): Configure Optionsrefer(1): Configuring the Source RPMrpm(1): Footnotesrpm(1): RPM Build Targetsrpm(1): Release Targetsrpm(1): User Targetsrpm(1): Removing the Binary RPMrpm(1): Installing the Binary RPMrpm(1): Building from the Source RPMrpm(1): Environment Variablesrpm(1): Configure Optionsrpm(1): Downloading from CVSrpm(1): Downloading the Tar Ballrpm(1): Downloadingrpm(8): Installing the Binary RPMrpm(8): Configuring the Source RPMrpmbuild(1): Environment Variablesrpmbuild(1): Configuring the Source RPMsoelim(1): Environment Variablessoelim(1): Configure Optionssoelim(1): Configuring the Source RPMstrconf(8): DevelopmentSTREAMS(9): Abstracttar(1): Maintainer Targetstar(1): Downloading the Tar Balltbl(1): Environment Variablestbl(1): Configure Optionstbl(1): Configuring the Source RPMtee(1): Footnotestexinfo(1): Configure Optionstexinfo(1): Configuring the Source RPMtstdrv(4): Quick Start Guidetstmod(4): Quick Start Guidewget(1): Downloading the Tar Ball[1] Formerly X/Open and UNIX International.
[2] http://www.openss7.org/tarballs/strbcm-0.9.2.4.tar.bz2
[3] See GNU/Linux Distributions, for more information.
[4] If you are using a Debian release, please make sure to install the groff extension package (`groff_ext'), as it contains the refer or grefer commands necessary for including references in the manual pages.
[5] Although, at one time, this package supported LiS, LiS is now deprecated and unsupported.
[6] Please see Problem Reports, or the file PROBLEMS in the release directory for more information on filing a proper Problem Report.
[7] Linux STREAMS is buggy, unsupported and deprecated. Do not use it.
[8] Linux STREAMS is buggy, unsupported and deprecated. Do not use it.
[9] Linux STREAMS is buggy, unsupported and deprecated. Do not use it.
[10] See GNU/Linux Distributions, for more information.
[11] If you are using a Debian release, please make sure to install the groff extension package (`groff_ext'), as it contains the refer or grefer commands necessary for including references in the manual pages.
[12] Although, at one time, this package supported LiS, LiS is now deprecated and unsupported.
[13] Items marked as `TBD' are scheduled to have support deprecated. That is, in a future release, the distributions marked `TBD' will not longer be validated before release.
[14] At a later date, it is possible to move this package into the kernel, however, with continued resistance to STREAMS from within the Linux developer community, this is currently unlikely.
[15] Linux STREAMS is buggy, unsupported and deprecated. Do not use it.
[16] See section NO WARRANTY under GNU General Public License.
[17] Not all distributions support the `%dev' RPM macro: a case in point is the SuSE 8.0 distribution which uses an older version of rpm(1). Distributions that do not support the `%dev' macro will build devices as a `%post' operation. Note also that not all release packages contain devices. Only packages that provide STREAMS character device drivers need devices, and then only when the `specfs' or `devfsd' is not being used.
[18] Note that not all releases have source RPM packages. Release packages that do not contain kernel modules do not generate a source RPM package.
[19] Note that not all release packages contain shared libraries, and, therefore, not all release packages contain this package.
[20] Note that on Mandrakelinux, unlike other RPM kernel distributions, kernel packages for the ix86 architectures are always placed in i586 architecture packages regardless of the true processor architecture of the kernel package. configure detects this and builds the appropriate packages.
[21] Note that the `_kversion' of `2.4.20-28.7' is only an example. Note also that only release packages that contain kernel modules will contain a core subpackage.
[22] Note that only release packages that contain kernel modules and that export versioned symbols will contain a info subpackage. Also, this subpackage is only applicable to 2.4 series kernels and is not necessary and not built for 2.6 series kernels.
[23] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[24] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[25] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[26] Note that only release packages that contain kernel modules and that export versioned symbols will contain a LiS-info subpackage.
[27] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[28] Note that only release packages that contain kernel modules and that export versioned symbols will contain a streams-info subpackage.
[29] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[30] Note that not all release packages contain devices. Only packages that provide STREAMS character device drivers need devices, and then only when the `specfs' or `devfsd' is not being used.
[31] Note that not all releases have source DEB packages. Release packages that do not contain kernel modules do not generate a source DEB package.
[32] Note that not all release packages contain shared libraries, and, therefore, not all release packages contain this package.
[33] Note that on Mandrakelinux, unlike other DEB kernel distributions, kernel packages for the ix86 architectures are always placed in i586 architecture packages regardless of the true processor architecture of the kernel package. configure detects this and builds the appropriate packages.
[34] Note that the `_kversion' of `2.4.20-28.7' is only an example. Note also that only release packages that contain kernel modules will contain a core subpackage.
[35] Note that only release packages that contain kernel modules and that export versioned symbols will contain a info subpackage. Also, this subpackage is only applicable to 2.4 series kernels and is not necessary and not built for 2.6 series kernels.
[36] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[37] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[38] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[39] Note that only release packages that contain kernel modules and that export versioned symbols will contain a LiS-info subpackage.
[40] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[41] Note that only release packages that contain kernel modules and that export versioned symbols will contain a streams-info subpackage.
[42] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[43] A notable exception is Debian and Fedora 7. Note that on Fedora 7 the gettext-devel package must be installed.
[44] In particular, for CentOS, Fedora 6 or 7, the tetex-latex and gnuplot packages must be loaded as well.
[45] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[46] Note that the `_kversion' of `2.4.20-28.7' is only an example. Also, note that the `info' subpackage is only applicable to the 2.4 kernel series.
[47] In particular, some Debian systems do not load the groff(1) extensions package and do not have grefer(1) installed. Although this is an oversight on the configuration of the particular Debian system, we accomodate such misconfiguration with this feature.
[48] In particular, some Debian or Ubuntu systems do not load the groff(1) extensions package and do not have grefer(1) installed. Although this is an oversight on the configuration of the particular Debian or Ubuntu system, we accomodate such misconfiguration with this feature.
[49] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[50] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[51] Because it is a cross-build, the kernel version on the build machine is unlikely to be the kernel version of the target machine, except by coincidence.
[52] Although I have not tried it, because we use GNU autoconf(1) for configuration, these instructions should work equally well for the Solaris NexusWare cross-building environment as it does for the Linux NexusWare cross-building environment.
[53] Note that the `_kversion' of `2.4.20-28.7' is only an example.
[54] At some time I expect to create an `install-nexusware' target that will make the necessary modifications to the .spec and rc.4 files automatically.
[55] /usr/libexec/strbcm is just an example, the actual location is ${libexecdir}/${PACKAGE}, which varies from distribution to distribution (as some distributions such as Mandriva do not have a libexec directory).
[56] Therefore, it is possible to download the package, configure it, and then uninstall it. This is handy if you do not have the sources used to build and install the package immediately available.
[57] This is useful from the OpenSS7 Master Package.
[58] Theoretically this is true, however, the OpenSS7 Project does not use any maintainer programs that are not generally available (i.e. open source).
[59] Note that because logging targets invoke a pipe, automake(1) does not return the correct return status (always returns success if the tee(1) operation is successful). Therefore, these targets should not be invoked by scripts that need to use the return value from automake(1).
[60] This particular check has caught some name space pollution that has occurred in the 2.6.11 kernel.
[61] `send-pr' launches the user's EDITOR to edit the problem report before submitting it.