README.textile

   1 h1. Ruby sendfile(2) Interface
   2
   3 This module allows Ruby programs to access their OS's native <code>sendfile(2)</code> system call from any IO object. Your kernel must export a recognized signature for the <code>sendfile(2)</code> system call to use this module. Currently, that includes Linux, Solaris and FreeBSD.
   4
   5 h2. Installation
   6
   7 Download and install the latest package from the rubyforge.org RubyGems repository.
   8
   9 <code>
  10   $ gem install sendfile
  11 </code>
  12
  13 If the tests all pass, you're ready to start using sendfile!
  14
  15 h2. Usage
  16
  17 Here's a small example of a use of <code>IO#sendfile</code>.
  18
  19 bc.. require 'socket'
  20 require 'rubygems'
  21 require 'sendfile'
  22 s = TCPSocket.new 'yourdomain.com', 5000
  23 File.open 'somefile.txt' { |f| s.sendfile f }
  24 s.close
  25
  26 p. See the test scripts for more examples on how to use this module.
  27