lib/ruby-1.9.1-rc1/ext/pty/README

   1 pty extension version 0.3 by A.ito
   2
   3 1. Introduction
   4
   5 This extension module adds ruby a functionality to execute an
   6 arbitrary command through pseudo tty (pty).
   7
   8 2. Install
   9
  10 Follow the instruction below.
  11
  12 (1) Execute
  13
  14       ruby extconf.rb
  15
  16     then Makefile is generated.
  17
  18 (3) Do make; make install.
  19
  20 3. What you can do
  21
  22 This extension module defines a module named PTY, which contains
  23 following module fungtions:
  24
  25    getpty(command)
  26    spawn(command)
  27
  28       This function reserves a pty, executes command over the pty
  29       and returns an array. The return value is an array with three
  30       elements. The first element in the array is for reading and the
  31       second for writing. The third element is the process ID of the
  32       child process. If this function is called with an iterator block,
  33       the array is passed to the block as block parameters, and the
  34       function itself returns nil.
  35
  36       When the child process is suspended or finished, an exception is
  37       raised.  If this function is called with an iterator block,
  38       exception is raised only within the block.  Child process
  39       monitor is terminated on block exit.
  40
  41    protect_signal
  42    reset_signal
  43
  44       These functions are obsolete in this version of pty.
  45
  46 4. License
  47
  48 (C) Copyright 1998 by Akinori Ito.
  49
  50 This software may be redistributed freely for this purpose, in full
  51 or in part, provided that this entire copyright notice is included
  52 on any copies of this software and applications and derivations thereof.
  53
  54 This software is provided on an "as is" basis, without warranty of any
  55 kind, either expressed or implied, as to any matter including, but not
  56 limited to warranty of fitness of purpose, or merchantability, or
  57 results obtained from use of this software.
  58
  59 5. Bug report
  60
  61 Please feel free to send E-mail to
  62
  63    aito@ei5sun.yz.yamagata-u.ac.jp
  64
  65 for any bug report, opinion, contribution, etc.