# ruby-termios-0.9.6 Documentation

## Description

This extension library provides Termios module. It enables you to use termios(3) interface.

Termios module is simple wrapper of termios(3). It can be included into IO-family classes and can extend IO-family objects. In addition, the methods can use as module function.

## Requires

This extension library can use with Ruby 1.6, 1.8 or 1.9. (Ruby-termios can build with Ruby 1.6 but it has not yet been tested enough.)

## Installation

    ruby extconf.rb
    make
    make install

## Copyright

Ruby-termios for Ruby is copyrighted free software by akira yamada <akira@arika.org>. You can redistribute it and/or modify it under either the terms of the GPL, or the conditions below:

    1. You may make and give away verbatim copies of the source form of the
       software without restriction, provided that you duplicate all of the
       original copyright notices and associated disclaimers.

    2. You may modify your copy of the software in any way, provided that
       you do at least ONE of the following:

         a) place your modifications in the Public Domain or otherwise
            make them Freely Available, such as by posting said
            modifications to Usenet or an equivalent medium, or by allowing
            the author to include your modifications in the software.

         b) use the modified software only within your corporation or
            organization.

         c) rename any non-standard executables so the names do not conflict
            with standard executables, which must also be provided.

         d) make other distribution arrangements with the author.

    3. You may distribute the software in object code or executable
       form, provided that you do at least ONE of the following:

         a) distribute the executables and library files of the software,
            together with instructions (in the manual page or equivalent)
            on where to get the original distribution.

         b) accompany the distribution with the machine-readable source of
            the software.

         c) give non-standard executables non-standard names, with
            instructions on where to get the original software distribution.

         d) make other distribution arrangements with the author.

    4. You may modify and include the part of the software into any other
       software (possibly commercial).  But some files in the distribution
       are not written by the author, so that they are not under this terms.
       They are gc.c(partly), utils.c(partly), regex.[ch], fnmatch.[ch],
       glob.c, st.[ch] and some files under the ./missing directory.  See
       each file for the copying condition.

    5. The scripts and library files supplied as input to or produced as
       output from the software do not automatically fall under the
       copyright of the software, but belong to whomever generated them,
       and may be sold commercially, and may be aggregated with this
       software.

    6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
       IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
       WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
       PURPOSE.

## Files

- ChangeLog
- Makefile
- README

## Classes/Modules

- Termios
- Termios::Termios
- Object

## Methods

- ::drain — Termios
- ::flow — Termios
- ::flush — Termios
- ::getattr — Termios
- ::getpgrp — Termios
- ::new — Termios::Termios
- ::new_termios — Termios
- ::sendbreak — Termios
- ::setattr — Termios
- ::setpgrp — Termios
- ::tcdrain — Termios
- ::tcflow — Termios
- ::tcflush — Termios
- ::tcgetattr — Termios
- ::tcgetpgrp — Termios
- ::tcsendbreak — Termios
- ::tcsetattr — Termios
- ::tcsetpgrp — Termios
- #c_cc= — Termios::Termios
- #c_cflag= — Termios::Termios
- #c_iflag= — Termios::Termios
- #c_ispeed= — Termios::Termios
- #c_lflag= — Termios::Termios
- #c_oflag= — Termios::Termios
- #c_ospeed= — Termios::Termios
- #cc= — Termios::Termios
- #cflag= — Termios::Termios
- #clone — Termios::Termios
- #dev_open — Object
- #dump_termios — Object
- #dup — Termios::Termios
- #iflag= — Termios::Termios
- #inspect — Termios::Termios
- #ispeed= — Termios::Termios
- #lflag= — Termios::Termios
- #oflag= — Termios::Termios
- #ospeed= — Termios::Termios
- #tcdrain — Termios
- #tcflow — Termios
- #tcflush — Termios
- #tcgetattr — Termios
- #tcgetpgrp — Termios
- #tcsendbreak — Termios
- #tcsetattr — Termios
- #tcsetpgrp — Termios

[Validate]

Generated with the Darkfish Rdoc Generator 2.