Contents

= Description
   Sys::CPU - An interface for various cpu statistics
   
= Synopsis
   require "sys/cpu"
   include Sys

   # BSD and OS X
   puts "Architecture: " + CPU.architecture
   puts "Machine: " + CPU.machine
   puts "Mhz: " + CPU.cpu_freq.to_s
   puts "Number of cpu's on this system: " + CPU.num_cpu.to_s
   puts "CPU model: " + CPU.model
   puts "Load averages: " + CPU.load_avg.join(", ")
   
= Constants
VERSION
   Returns the current version number for this package.
    
= Class Methods
CPU.architecture
   Returns the cpu's architecture.

CPU.freq
   Returns an integer indicating the speed (i.e. frequency in Mhz) of
   the cpu.
   
   Not supported on OS X.
    
CPU.load_avg
   Returns an array of three floats indicating the 1, 5 and 15 minute load
   average.
    
CPU.machine
   Returns the class of cpu (probably identical to the architecture).

CPU.model
   Returns a string indicating the cpu model.
    
CPU.num_cpu
   Returns an integer indicating the number of cpu's on the system.
    
= Error Classes
CPU::Error < StandardError
   Raised is response to internal function errors, usually relating to an
   invalid cpu number.
    
= Known Bugs
   None known.  Please post bug reports to the SourceForge home page at
   http://www.rubyforge.org/projects/sysutils 
    
= Copyright
   (C) 2003-2007 Daniel J. Berger
   All Rights Reserved
    
= Warranty
   This package is provided "as is" and without any express or
   implied warranties, including, without limitation, the implied
   warranties of merchantability and fitness for a particular purpose.

= License
   Ruby's
    
= Author
   Daniel J. Berger
   djberg96 at nospam at gmail dot com
   imperator on IRC (Freenode)

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
sys-cpu-0.6.0-mswin32	doc/bsd.txt
sys-cpu-0.6.1-x86-mswin32-60	doc/bsd.txt