OpenSS7 STREAMS Terminals

OpenSS7 STREAMS Terminals Installation and Reference Manual

About This Manual

This is Edition 3, last updated 2007-06-24, of The OpenSS7 STREAMS Terminals Installation and Reference Manual, for Version 0.9.2 release 3 of the OpenSS7 STREAMS Terminals package.

Preface

Notice

This package is released and distributed under the GNU General Public License (see GPL). Please note, however, that there are different licensing terms for the manual pages and some of the documentation (derived from OpenGroup¹ publications and other sources). Consult the permission notices contained in the documentation for more information.

Also note that parts of this software, as identified in Possible BSD Sources, may be derived from software developed by the University of California, Berkeley covered under the Combined USL BSD License (see BSD/USL Combined License).

This manual is released under the FDL (see GNU Free Documentation License) with all sections invariant.

Abstract

This manual provides a Installation and Reference Manual for OpenSS7 STREAMS Terminals.

Objective

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 Terminals.

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.

Intent

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 Terminals 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 Terminals package, OpenSS7 Corporation is under no obligation to provide any software, system or feature listed herein.

Audience

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.

Revisions

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 Terminals package.

Version Control

     
     strtty.texi,v
     Revision 0.9.2.10  2007/02/28 06:31:32  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.9  2007/01/03 14:53:53  brian
     - documentation updates for release
     
     Revision 0.9.2.8  2006/12/31 13:52:30  brian
     - updated documentation for release
     
     Revision 0.9.2.7  2006/12/31 11:20:20  brian
     - documentation updates for release
     
     Revision 0.9.2.6  2006/09/18 01:07:20  brian
     - updated manuals and release texi docs
     
     Revision 0.9.2.5  2006/08/28 10:47:11  brian
     - correction
     
     Revision 0.9.2.4  2006/08/28 10:32:59  brian
     - updated references
     
     Revision 0.9.2.3  2006/08/27 12:27:14  brian
     - finalizing auto release files
     
     Revision 0.9.2.2  2006/08/26 09:19:34  brian
     - better release file generation
     
     Revision 0.9.2.1  2006/08/23 09:53:14  brian
     - started STREAMS Terminals package
     
     

ISO 9000 Compliance

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.

Disclaimer

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.

U.S. Government Restricted Rights

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).

Acknowledgements

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.

Sponsors

Funding for completion of the OpenSS7 OpenSS7 STREAMS Terminals package was provided in part by:

Additional funding for The OpenSS7 Project was provided by:

Contributors

The primary contributor to the OpenSS7 OpenSS7 STREAMS Terminals package is Brian F. G. Bidulock. The following is a list of significant contributors to The OpenSS7 Project:

Authors

The authors of the OpenSS7 OpenSS7 STREAMS Terminals package include:

See Author Index, for a complete listing and cross-index of authors to sections of this manual.

Maintainer

The maintainer of the OpenSS7 OpenSS7 STREAMS Terminals package is:

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.

Web Resources

The OpenSS7 Project provides a website dedicated to the software packages released by the OpenSS7 Project.

Bug Reports

Please send bug reports to bugs@openss7.org using the send-pr script included in the OpenSS7 STREAMS Terminals 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.

Mailing Lists

The OpenSS7 Project provides a number of general discussion Mailing Lists for discussion concerning the OpenSS7 OpenSS7 STREAMS Terminals 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:

openss7

The openss7 mailing list is for general enquiries, information exchange and announcements regarding the OpenSS7 Project. This is our original mailing list and takes the highest amount of traffic.

openss7-announce

The openss7-announce mailing list is for announcements related to the OpenSS7 Project. This list will accept announcements posted by subscribers. Subscribe to this list if you are interested in announcements from the OpenSS7 Project, subscribers and sponsors, related to the OpenSS7 Project or STREAMS, SS7, SIGTRAN or SCTP in general.

openss7-cvs

The openss7-cvs mailing list is for automatic CVS log reporting. You must get permission of the owner to subscribe to this list. Subscribers are not allowed to post to this list, this is merely for distributing notification of changes to the CVS repository.h

openss7-develop

The openss7-develop mailing list is for email exchange related to the development projects under the OpenSS7 Project. This includes development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the OpenSS7 Project.

openss7-test

The openss7-test mailing list is for email exchange related to the testing of code under the OpenSS7 Project. This specifically relates to conformance testing, verification testing, interoperability testing and beta testing. Subscribe to this list if you are interested in participating in and receiving ongoing details of test activities under the OpenSS7 Project.

openss7-bugs

The openss7-bugs mailing list is specifically tailored to bug tracking. The mailing list takes a feed from the OpenSS7 GNATS bug tracking system and accepts posting of responses to bug reports, tracking and resolution. Subscribe to this list if you are interested in receiving detailed OpenSS7 release code bug tracking information. This list is not archived; for historical information on problem reports, see our GNATS databases.

openss7-updates

The openss7-updates mailing list provides updates on OpenSS7 Project code releases and ongoing activities. Subscribers are not allowed to post to this list; this list is for official OpenSS7 Project announcements only. Subscribe to this list if you are interested in receiving updates concerning official releases and activities of the OpenSS7 Project.

openss7-streams

The openss7-streams mailing list is for email exchange related to the STREAMS development projects under the OpenSS7 Project. This includes development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the OpenSS7 Project STREAMS components.

linux-streams

The linux-streams mailing list is for mail exchange related to Linux Fast-STREAMS or Linux STREAMS. This includes patches, development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the STREAMS for Linux components. This is the the new (September 2006) home of the linux-streams list formerly of <gsyc.escet.urjc.es>.

Spam

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.

Acceptable Use Policy

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.

Large Attachments

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.

Quick Start Guide

OpenSS7 STREAMS Terminals

Package strtty-0.9.2.3 was released under GPLv2 2007-06-24.

The OpenSS7 STREAMS Terminals package provides STREAMS modules and drivers, libraries, programs, init scripts, and daemons that implement the classical SVR 4 Terminal Subsystem.

The OpenSS7 STREAMS Terminals package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of OpenSS7 STREAMS Terminals components and applications for the SVR 4.2 STREAMS environment. It provides true STREAMS-based Pseudo-Terminals for Linux.

The package builds and installs the following STREAMS kernel modules and drivers:

pty(4)

The pty(4) driver is a Pseudo-Terminal Driver that provides the classical UNIX® master and slave pseudo-terminals.

This driver is complete but untested.

ptem(4)

The ptem(4) module is a Pseudo-Terminal Emulation Module that provide hardware terminal emulation for the slave side of a Pseudo-Terminal provided by the pty(4) driver. This module is pushed over the slave side of a pseudo-terminal before pushing ldterm(4).

This module is complete but untested.

pckt(4)

The pckt(4) module is a Packet Module. This is the classical UNIX® packetization module that is pushed over the master side of a pseudo-terminal to allow the master to view the detailed state of the pseudo-terminal.

This module is complete but untested.

ldterm(4)

The ldterm(4) module is a Line Discipline Terminal Module. This is the classical UNIX® line discipline module for terminals. This module is pushed last on the slave side of a psuedo-terminal, after ptem(4) and provides the POSIX terminal interface to the user.

This module is incomplete.

ttcompat(4)

The ttcompat(4) module is a TTY Compatibility Module. This is a module that provides UNIX® Version 7 and 4BSD compatible terminal interfaces. These interfaces are no longer in use and this module has only marginal value.

This module is complete but untested.

The package builds and installs the following shared object libraries:

libtty(3)

The libtty(3) library provides replacements for POSIX terminal handling functions that are not properly implemented in glibc. These functions are:

openpt(3tty)	– open a master pseudo-terminal
ptsname(3tty)	– obtain name for slave device
grantpt(3tty)	– grant access to the slave device
unlockpt(3tty)	– unlock the pseudo-terminal

This library is incomplete.

The OpenSS7 STREAMS Terminals package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of OpenSS7 STREAMS Terminals components and applications for the SVR 4.2 STREAMS environment.

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.

Release

This is the strtty-0.9.2.3 package, released 2007-06-24. This `0.9.2.3' 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/strtty-0.9.2.3.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 strtty 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-strtty 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.

Prerequisites

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 Terminals package are as follows:

1. Linux distribution, somewhat Linux Standards Base compliant, with a 2.4 or 2.6 kernel and the appropriate tool chain for compiling out-of-tree kernel modules. Most recent Linux distributions are usable out of the box, but some development packages must be installed. For more information, see Compatibility.

   	− A fairly LSB compliant GNU/Linux distribution.2
   	− 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).3

(Note: If you acquired strtty a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)

2. OpenSS7 Linux Fast-STREAMS, streams-0.9.2.3. ⁴
3. OpenSS7 STREAMS Compatibility Modules, strcompat-0.9.2.6.

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:

     $> ../strtty-0.9.2.3/configure CC='gcc-3.4'

Installation

The following commands will download, configure, build, check, install, validate, uninstall and remove the package:

     $> wget http://www.openss7.org/tarballs/strtty-0.9.2.3.tar.bz2
     $> tar -xjvf strtty-0.9.2.3.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../strtty-0.9.2.3/configure --enable-autotest
     $> make
     $> make check
     $> sudo make install
     $> sudo make installcheck
     $> sudo make uninstall
     $> popd
     $> sudo rm -rf build
     $> rm -rf strtty-0.9.2.3
     $> rm -f strtty-0.9.2.3.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.⁵ Installation steps using the logging targets proceed as follows:

     $> wget http://www.openss7.org/tarballs/strtty-0.9.2.3.tar.bz2
     $> tar -xjvf strtty-0.9.2.3.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../strtty-0.9.2.3/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 strtty-0.9.2.3
     $> rm -f strtty-0.9.2.3.tar.bz2

See README-make for additional specialized make targets.

For custom applications, see the INSTALL and INSTALL-strtty files or the see Installation, as listed below. If you encounter troubles, see Troubleshooting, before issuing a bug report.

Brief Installation Instructions

The OpenSS7 STREAMS Terminals package is available from the downloads area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/strtty-0.9.2.3.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf strtty-0.9.2.3.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: strtty-0.9.2.3.

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
     $> ../strtty-0.9.2.3/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 ../strtty-0.9.2.3/INSTALL

For specific options to the configure script, see the INSTALL-strtty file in the distribution, or simply execute the configure script with the --help option like so:

     $> ../strtty-0.9.2.3/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 strtty-0.9.2.3
     $> rm -f strtty-0.9.2.3.tar.bz2

Detailed Installation Instructions

More detailed installation instructions can be found in the Installation, contained in the distribution in `text', `info', `html' and `pdf' formats:

     $> cd ../strtty-0.9.2.3
     $> less doc/manual/strtty.txt
     $> lynx doc/manual/strtty.html
     $> info doc/manual/strtty.info
     $> xpdf doc/manual/strtty.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/strtty_manual.html

1 Introduction

This manual documents the design, implementation, installation, operation and future development schedule of the OpenSS7 STREAMS Terminals package.

1.1 Overview

This manual documents the design, implementation, installation, operation and future development of the OpenSS7 STREAMS Terminals package.

1.2 Organization of this Manual

This manual is organized (loosely) into several sections as follows:

1.3 Conventions and Definitions

This manual uses texinfo typographic conventions.

2 Objective

The objective for creating the OpenSS7 STREAMS Terminals package was initially one of completeness. A number of STREAMS implementations provide the capability to include the SVR 4 style Terminal Subsystem based on STREAMS in the operating system. For completeness, Linux Fast-STREAMS package should also include such a capability and it was for that initial purpose that this package was written.⁶

Having a complete Terminal Subsystem based on STREAMS for Linux has other advantages. With a terminal subsystem based on STREAMS available, that at least implements pseudo-terminal devices and associated modules, permits rapid porting of UNIX applications programs that rely upon STREAMS-based terminals to the Linux Fast-STREAMS environment.

The OpenSS7 Project currently does not have any applications or STREAMS modules that depend upon the availability of the Terminal Subsystem, and this is one of the reasons that the package is initially incomplete (missing a complete ldterm(4) module) and untested (the test-tty(8) test suite is incomplete). Nevertheless, it has a most of the components of a fully functional terminal subsystem for pseudo-terminals and can easily be completed. If you have applications or modules that require the Terminal Subsystem, contact The OpenSS7 Project about advancing the completion of this package.

3 Reference

This chapter provides a reference to the contents of the STRTTY package. Please note that this texinfo documentation is not updated as regularly as the manual pages. For a more up to date package reference, please begin with the strtty(5) manual page (that documents the package).

3.1 Files

STRTTY creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:⁷

modules.strtty

STRTTY installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/strtty/:⁸

streams_pckt.ko

kernel module containing the pckt(4) STREAMS module.

streams_ptem.ko

kernel module containing the ptem(4) STREAMS module.

streams_ttcompat.ko

kernel module containing the ttcompat(4) STREAMS module.

streams_ldterm.ko

kernel module containing the ldterm(4) STREAMS module.

streams_pty.ko

kernel module containing the pty(4) STREAMS driver.

STRTTY installs the following header files in the system include directory, /usr/include/strtty/:

sys/strtty/config.h

strtty configuration header.

sys/strtty/version.h

strtty module version header.

sys/ttydev.h

replacement SVR 4 terminal subsystem header file.

sys/termios.h

replacement SVR 4 terminal subsystem header file.

sys/termio.h

replacement SVR 4 terminal subsystem header file.

sys/sgtty.h

replacement SVR 4 terminal subsystem header file.

sys/ttyio.h

replacement SVR 4 terminal subsystem header file.

sys/strtty.h

replacement SVR 4 terminal subsystem header file.

sys/ttychars.h

replacement SVR 4 terminal subsystem header file.

sys/pty.h

standard PTY header for use with the pty(4) STREAMS module.

ttychars.h

replacement SVR 4 terminal subsystem header file.

ttcompat.h

standard TTY compatibility header for use with the ttcompat(4) STREAMS module.

sgtty.h

replacement SVR 4 terminal subsystem header file.

termios.h

replacement SVR 4 terminal subsystem header file.

termio.h

replacement SVR 4 terminal subsystem header file.

STRTTY installs the following test programs in the system libexec directory, /usr/libexec/strtty/:⁹

send-pr

send-pr.config

The send-pr stand-alone shell script can be used for the automatic generation of problem reports for the OpenSS7 STREAMS Terminals package. The send-pr.config file provides localized definitions used by the send-pr program. For more information on problem reports, See Problem Reports, and, in particular, See Stand Alone Problem Reports.

test-tty

test program.

testsuite

atlocal

The testsuite stand-alone shell script invokes test cases in the test programs above as compiled into a comprehensive regression, troubleshooting and validation test suite for the OpenSS7 STREAMS Terminals drivers. The atlocal file provides localized definitions used by the testsuite program. For more information on test suites, See Test Suites, and, in particular, See Running Test Suites.

STRTTY installs the following utility programs in the system binary directory, /usr/sbin/:

strtty_mknod

This utility can be used by init scripts or administrative users to create or remove device nodes in the /dev directory for OpenSS7 STREAMS Terminals drivers.

STRTTY installs the following static and shared object libraries in the system library directory, /usr/lib/ (32-bit libraries) and /usr/lib64/ (64-bit libraries):

libtty.so.0.0.1

libtty.so.0

libtty.so

libtty.a

libtty.la

STRTTY installs the following internationalization catalogues in the internationalization directory, /usr/share/locale/:

de/LC_MESSAGES/strtty.mo

STRTTY installs the following init scripts in the system init directory, /etc/rc.d/init.d/ (non-Debian) or /etc/init.d/ (Debian):

strtty

This is the name of the system init script on non-Debian based systems.

strtty.sh

This is the name of the system init script on Debian based systems.

STRTTY installs the following system configuration files in the configuration directory, /etc/:

strtty.conf

This file provided configuration information for any system controls affected by the `strtty' package.

modutils/strtty

This file provides module definitions and demand loading aliases for the strtty package. This file is really only applicable to older 2.4 kernels.

STRTTY installs the following system configuration file in the system configuration directory, /etc/sysconfig/ (non-Debian) or /etc/default/ (Debian):

strtty

This file provides system configuration information used by init scripts for the `strtty' package. Some options of init script execution can be controlled by this file.

STRTTY installs the following info files in the system info directory, /usr/share/info/:

strtty.info

strtty.info-1

strtty.info-2

These files contain this manual in GNU info format.

STRTTY installs the following manual page macros and reference database files in the system man directory, /usr/share/man/:¹⁰

strtty.macros

This file contains manual page macro definitions included by the manual pages included in the package.

strtty.refs

This file contains a reference database referenced by the manual pages included in the package.

STRTTY installs the following manual pages in the system man directory, /usr/share/man/man3/:

grantpt.3tty

manual page for the grantpt(3tty) library function.

ptsname.3tty

manual page for the ptsname(3tty) library function.

unlockpt.3tty

manual page for the unlockpt(3tty) library function.

STRTTY installs the following manual pages in the system man directory, /usr/share/man/man4/:

ldterm.4

manual page for the ldterm(4) STREAMS module.

pckt.4

manual page for the pckt(4) STREAMS module.

ptc.4

manual page for the ptc(4) STREAMS device.

ptem.4

manual page for the ptem(4) STREAMS module.

ptm.4

manual page for the ptm(4) STREAMS driver.

ptmx.4tty

manual page for the ptmx(4tty) STREAMS device.

pts.4tty

manual page for the pts(4tty) STREAMS driver.

pty.4

manual page for the pty(4) STREAMS driver.

ttcompat.4

manual page for the ttcompat(4) STREAMS module.

STRTTY installs the following manual pages in the system man directory, /usr/share/man/man5/:

strtty.5

manual page for the strtty(5) package.

STRTTY installs the following manual pages in the system man directory, /usr/share/man/man8/:

strtty_mknod.8

Documentation for the strtty_mknod(8) utility program.

test-tty.8

manual page for the test-tty(8) program.

3.2 Drivers

The configuration of STREAMS drivers is performed when compiling the OpenSS7 STREAMS Terminals subsystem. The TTY subsystem, core drivers are part of every OpenSS7 STREAMS Terminals system.

Kernel modules are installed by the OpenSS7 STREAMS Terminals package in the /lib/modules/2.4.20-28.7/strtty/ directory, with either a `.o' or `.ko' extension.¹¹

The following lists the core drivers, STREAMS kernel tunable parameters, and STREAMS configuration information:¹²

pty(4) (streams-pty)

See pty(4) for more information.

pts(4) (streams-pty)

See pts(4) for more information.

ptm(4) (streams-pty)

See ptm(4) for more information.

3.3 Modules

The configuration of STREAMS modules is performed when compiling the OpenSS7 STREAMS Terminals subsystem. The TTY subsystem, core modules are part of every OpenSS7 STREAMS Terminals system.

Kernel modules are installed by the OpenSS7 STREAMS Terminals package in the /lib/modules/2.4.20-28.7/strtty/ directory, with either a `.o' or `.ko' extension.¹³

The following lists the core modules, STREAMS kernel tunable parameters, and STREAMS configuration information:¹⁴

pckt(4) (streams-pckt)

See pckt(4) for more information.

ptem(4) (streams-ptem)

See ptem(4) for more information.

ttcompat(4) (streams-ttcompat)

See ttcompat(4) for more information.

ldterm(4) (streams-ldterm)

See ldterm(4) for more information.

3.4 Libraries

The Terminal Subsystem includes several library functions intended to assist application developers with the user of pseudo-terminals. Under Linux, the equivalent POSIX functions for BSD-style pseudo-terminals are contained in the libc library. The OpenSS7 STREAMS Terminals package provides these functions in the following libraries:

libtty(3) (/usr/lib/libtty.so, /usr/lib/libtty.a)

This is the libtty(3) library that provides pseudo-terminal utilities: granpt(3tty), ptsname(3tty) and unlockpt(3tty).

See libtty(3) for more information.

3.5 Utilities

3.5.1 Init Scripts

Following are System V Init Scripts that are installed by the package:

strtty(8) (/etc/init.d/strtty)

strtty.sh(8) (/etc/init.d/strtty.sh)

System V Init Script for the TTY Subsystem. The strtty(8) init script provides the ability to initialize, configure and mount the TTY subsystem, strtty(5). The strtty(8) script provides the RedHat-style init script, whereas the strtty.sh(8) script provides the Debian-style init script.

See strtty(8) for more information.

3.5.2 User Utilities

Following are user utilities for manipulating Streams:

The STRTTY package does not currently contain any user utilities.

3.5.3 Administrative Utilities

Following are administrative utilities for manipulating and examining the TTY subsystem:

The STRTTY package does not currently contain any administrative utilities.

3.5.4 Performance Test Programs

Following are performance test programs:

The STRTTY package does not currently contain any performance test programs.

3.5.5 Conformance Test Programs

Following and conformance and validation testing programs:

test-tty(8) (/usr/libexec/strtty/test-tty)

The test-tty(8) C-language program is a conformance and validation test program, in the OpenSS7 Project style, for the pty(4) STREAMS driver.

See test-tty(8) for more information.

For the proper way to execute these validation test programs in a conformance and validation test suite, see Running Test Suites.

3.6 Development

The STRTTY package contains the necessary header files, shared and static libraries, manuals and manual pages necessary for the development of kernel modules, STREAMS modules and drivers, and applications programs based on the STRTTY package.

3.6.1 Header Files

Header files are installed, typically, in the /usr/include/strtty subdirectory.¹⁵ To use the header files from the package, `-I/usr/include/strtty' must be included in the gcc command line as a compile option. This is true regardless of whether user space or kernel space programs are being compiled.

In general, `-I' include directives on the gcc command line should be ordered in the reverse order of the dependencies between packages. So, for example, if the include files from all add-on packages are required, the order of these directives would be: `-I/usr/include/strss7 -I/usr/include/strsctp -I/usr/include/strinet -I/usr/include/strxnet -I/usr/include/strxns -I/usr/include/strcompat -I/usr/include/streams'.

Following are the user visible header files provided by the strtty-0.9.2.3 package in directory /usr/include/strtty:

sys/ttydev.h

This is a replacement for the standard SVR 4 header file.

sys/termios.h

This is a replacement for the standard SVR 4 header file.

sys/termio.h

This is a replacement for the standard SVR 4 header file.

sys/sgtty.h

This is a replacement for the standard SVR 4 header file.

sys/ttyio.h

This is a replacement for the standard SVR 4 header file.

sys/strtty.h

This is a replacement for the standard SVR 4 header file.

sys/ttychars.h

This is a replacement for the standard SVR 4 header file.

sys/pty.h

See pty(4) for more information.

ttychars.h

This is a replacement for the standard SVR 4 header file.

ttcompat.h

See ttcompat(4) for more information.

sgtty.h

This is a replacement for the standard SVR 4 header file.

termios.h

This is a replacement for the standard SVR 4 header file.

termio.h

This is a replacement for the standard SVR 4 header file.

3.6.1.1 User Space Programs

Typical include files for interacting with STREAMS from user space include the stropts.h header file. Additional header files for interacting with specific drivers or modules may also be required.

3.6.1.2 Kernel Space Drivers and Modules

Typical include files for writing STREAMS modules and drivers for kernel space include the sys/cmn_err.h, sys/kmem.h, sys/dki.h, sys/stream.h, sys/ddi.h, and sys/strconf.h header files. Additional header files for interacting with specific drivers or modules may also be required.

3.6.2 Libraries

Shared or static versions of the libstreams library must be linked when using the strtty-0.9.2.3 package. This library must either be specified on the gcc command line as a shared library (e.g. `-lstreams') or as a static library (e.g. `/usr/lib/libstreams.a').

If the shared library is linked, include the following options on the gcc command line:

If the static library is linked, include the following options on the gcc command line:

3.6.3 Kernel Modules

Developing STREAMS kernel modules is similar to user space programs with regard to header files. /usr/include/strtty should be placed as an include directory to search in the gcc command line. The rules for compiling Linux kernel modules should be followed. In particular, several important intricacies should be considered:

• The gcc compiler used to compile the kernel modules must be the same version of compiler that was used to compile the kernel.
• The gcc command line must have the same compile flags that were used to compile the kernel.
• The gcc command line must define several important kernel defines including `-DLINUX', `-D__KERNEL__', as well as the base name of the module.
• The gcc command line must include several important include files directly on the command line such as `--include /lib/modules/2.4.20-28.7/build/include/linux/autoconf.h' and maybe even `--include /lib/modules/2.4.20-28.7/build/include/linux/modversions.h'.¹⁶

3.6.4 Manual Pages

The strtty-0.9.2.3 package installs the following manual pages in the /usr/share/man/ subdirectory:

4 Conformance

When developing the OpenSS7 STREAMS Terminals package, an attempt was made to maintain compatibility and conformance across as many documented implementations of the SVR 4 Terminal Subsystem as possible. It is intended that conformance to specifications for the terminal subsystem be tested using the test-tty(8) test case executable and the package autotest test suite; however, at the time of writing these test programs are incomplete.

5 Releases