sys-proctable 0.7.3 → 0.7.4

data/CHANGES

@@ -1,9 +1,13 @@
-== 0.8.0 - ???
-* Added preliminary support for Darwin (OS X). Thanks go to David Felstead
-  for the code contribution.
+== 0.7.4 - 20-Nov-2006
+* Added a patch that deals with the large file compilation issue on Solaris.
+  You no longer need to build Ruby with --disable-largefile, or build a
+  64 bit Ruby, in order for this package to work.  Thanks go to Steven Jenkins
+  for the information that led to the patch.
 * Added inline rdoc to the source code.
 * Added a gemspec.
 * Fixed some potential 64 bit issues (struct declarations).
+* Added preliminary support for Darwin (OS X). The code was provided by
+  David Felstead, but does not appear to compile successfully.  Help wanted.
 
 == 0.7.3 - 27-Oct-2005
 * Fix for 1.8.3 and later (rb_pid_t). This should have only affected

data/MANIFEST

@@ -0,0 +1,41 @@
+CHANGES
+INSTALL
+MANIFEST
+install.rb
+sys-proctable.gemspec
+
+doc/freebsd.txt
+doc/hpux.txt
+doc/linux.txt
+doc/solaris.txt
+doc/top.txt
+doc/windows.txt
+
+ext/extconf.rb
+ext/bsd/bsd.c
+ext/darwin/darwin.c
+ext/freebsd/freebsd.c
+ext/freebsd/freebsd.h
+ext/hpux/hpux.c
+ext/hpux/hpux.h
+ext/linux/linux.c
+ext/linux/linux.h
+ext/sunos/sunos.c
+ext/sunos/sunos.h
+ext/version.h
+
+examples/test_ps.rb
+
+lib/top.rb
+
+lib/sys/windows.rb
+
+test/tc_all.rb
+test/tc_freebsd.rb
+test/tc_hpux.rb
+test/tc_linux.rb
+test/tc_sunos.rb
+test/tc_top.rb
+test/tc_windows.rb
+test/tc_kvm_bsd.rb
+test/test_memleak.rb

data/README

@@ -1,68 +1,131 @@
-== Prerequisites
-Unix: Ruby 1.8.0 or later.
-Win32: Ruby 1.8.2 or later.
+= Description
+   A Ruby interface for gathering process information.
 
-== Supported Platforms
+= Prerequisites
+=== Unix
+   Ruby 1.8.0 or later.
+=== MS Windows
+   Ruby 1.8.2 or later.
+
+= Supported Platforms
 * Windows NT family (NT, 2000, XP, etc)
 * Linux
 * FreeBSD (/proc or kvm)
 * Solaris
-* NetBSD (kvm only)
 * HP-UX
 
-== Installation
-Unix:
-   ruby extconf.rb
+= Installation
+=== UNIX
+   cd ext; ruby extconf.rb
    make
-   ruby test.rb (optional)
-   make site-install
+   cd ..; ruby test/ts_all.rb (optional)
+   make install
    
-Windows:
+=== MS Windows
    ruby test/tc_windows.rb (optional)
    ruby install.rb
 
-== Notes 
-Windows users may pass a host name as a second argument to get process
-information from a different host.  This relies on the WMI service running.
-
-If you're building C source code, the test.rb file is autogenerated for you.
-
-== BSD Issues
-If you're building on FreeBSD, a standard /proc filesystem read approach is
-used if mounted.  Otherwise, a kvm interface is used.  There are more fields
-available with the kvm interface, but keep in mind that you need to be a
-member of the kvm group (or root) to use this.  You can tweak the
-extconf.rb file manually if you want to force the issue.
-
-Not all fields are available on FreeBSD 5.x (yet).  OpenBSD and NetBSD are
-not yet supported.
-
-Research has indicated that the kvm approach is less favored than a sysctl
-approach.  I will try to add this interface in the 0.8.0 release.
-
-== Solaris Issues
-The cmdline member on solaris is limited to 80 characters unless you (or
-your program) own the process.  This is a Solaris design flaw, er, feature.
-
-== Other Issues
-If you build your library as a C extension (mandatory on all platforms
-except MS Windows at the moment), then the windows.rb file under 'lib/os/'
-is renamed to 'windows.orig'.  This is to prevent mkmf from auto-installing
-it during the 'make site-install' phase.
-
-== Thread Safety
-I am not currently using a thread-safe version of readdir().  I am not especially
-concerned about it either.  If you are trying to read information out of /proc
-from different threads at the same time there is something seriously wrong with
-your code logic.  Using readdir_r() still won't solve all potential thread safety
-issues anyway.
-
-== Future Plans
-I think I'm going to replace the version for Linux with a pure Ruby version.
-
-== Help Wanted
-I do not have access to all platforms.  There are a few other major platforms
-out there, namely OS X, AIX, OpenBSD, and IRIX, among others, that I would
-like to see ports for.  There are two ways you can help - either submit code
-for your particular platform or give me an account on your platform so I can
-develop on it.
+= Synopsis
+   require 'sys/proctable'
+   include Sys
+
+   # Everything
+   ProcTable.ps{ |p|
+      puts p.pid.to_s
+      puts p.comm
+      ...
+   }
+
+   or
+
+   # Just one process
+   s = ProcTable.ps(2123)
+   puts s.pid.to_s
+   puts s.comm
+   ...
+
+   # Return the results as an array of ProcTableStructs
+   a = ProcTable.ps
+   a.each do |p|
+      puts a.pid
+      ...
+   end
+
+= Notes 
+   Windows users may pass a host name as a second argument to get process
+   information from a different host.  This relies on the WMI service running.
+
+   If you're building C source code, the ts_all.rb file is autogenerated for
+   you.
+
+= Known Issues
+=== BSD
+   If you're building on FreeBSD, a standard /proc filesystem read approach is
+   used if mounted.  Otherwise, a kvm interface is used.  There are more fields
+   available with the kvm interface, but keep in mind that you need to be a
+   member of the kvm group (or root) to use this.  You can tweak the
+   extconf.rb file manually if you want to force the issue.
+
+   Not all fields are available on FreeBSD 5.x (yet).  OpenBSD and NetBSD are
+   not yet supported.
+
+   Research has indicated that the kvm approach is less favored than a sysctl
+   approach.  I will try to add this interface in the 0.8.0 release.
+
+=== Solaris
+   The cmdline member on solaris is limited to 80 characters unless you (or
+   your program) own the process.  This is a Solaris design flaw/feature.
+
+=== Misc
+   If you build your library as a C extension (mandatory on all platforms
+   except MS Windows at the moment), then the windows.rb file under 'lib/sys/'
+   is renamed to 'windows.orig'.  This is to prevent mkmf from auto-installing
+   it during the 'make install' phase.
+
+=== Thread Safety
+   I am not currently using a thread-safe version of readdir().  I am not
+   especially concerned about it either.  If you are trying to read information
+   out of /proc from different threads at the same time there is something
+   seriously wrong with your code logic.  Using readdir_r() still won't solve
+   all potential thread safety issues anyway.
+
+= Future Plans
+   I'm considering using a pure Ruby version for Linux. 
+
+= Acknowledgements
+   This package is largely based on the Perl module Proc::ProcessTable by
+   Dan Urist.  Many ideas, as well as large chunks of code, were taken
+   from his work.  So, a big THANK YOU goes out to Dan Urist.
+
+   A big thanks also goes out to Mike Hall who was very helpful with ideas,
+   logic and testing.
+
+   Thanks also go to Sean Chittenden for providing an account on one of his
+   FreeBSD machines.  This is how the FreeBSD support was (initially) added.
+
+   Thanks go to James Hranicky for providing a patch that grabs name, eid,
+   euid, gid and guid info in the Linux version, along with some general
+   debugging help.
+
+= Help Wanted
+   I do not have access to all platforms.  There are a few other major platforms
+   out there, namely OS X, AIX, OpenBSD, and IRIX, among others, that I would
+   like to see ports for.  There are two ways you can help - either submit code
+   for your particular platform or give me an account on your platform so I can
+   develop on it.
+
+= More documentation
+   See the documentation under the 'doc' directory for your platform for more
+   information, including platform specific notes and issues.
+
+= License
+   Ruby's
+    
+= Copyright
+   (C) 2003-2006 Daniel J. Berger
+   All Rights Reserved.
+
+= Author
+   Daniel J. Berger
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)

data/doc/freebsd.txt

@@ -1,10 +1,10 @@
-== Description
+= Description
    sys-proctable
 
    A Ruby interface to the 'ps' command.  This is a C extension, not parsed
    output.  For FreeBSD, data is read directly out of the /proc filesystem.
 
-== Synopsis
+= Synopsis
    require 'sys/proctable'
    include Sys
 
@@ -32,70 +32,59 @@
       ...
    end
 
-== Constants
+= Constants
 VERSION
-    Returns the current version number for this package (as a string).
+   Returns the current version number for this package (as a string).
 
-== Class Methods
+= Class Methods
 ProcTable.fields
-    Returns a list of fields available on the current OS. Also takes a block.
+   Returns a list of fields available on the current OS. Also takes a block.
 
 ProcTable.ps(pid = nil)
 ProcTable.ps{ |s| ... }
-    If no pid's or processes are included as arguments, in block form it
-    returns a struct of type ProcTableStruct for every process in the proc
-    table.  Otherwise it returns an array of ProcTableStruct's.
+   If no pid's or processes are included as arguments, in block form it
+   returns a struct of type ProcTableStruct for every process in the proc
+   table.  Otherwise it returns an array of ProcTableStruct's.
 
-    If a pid argument is provided, a single ProcTable struct is returned, or
-    nil if the pid is not found.
+   If a pid argument is provided, a single ProcTable struct is returned, or
+   nil if the pid is not found.
 
-== Exception Classes
+= Exception Classes
 ProcTableError < StandardError
-    Raised if the /proc field is unreadable and/or unmounted.
+   Raised if the /proc field is unreadable and/or unmounted.
 
-== Supported fields
-    You can view the supported fields with the "fields()" class method.
+= Supported fields
+   You can view the supported fields with the "fields()" class method.
     
-== Future Plans
-    Add a pure-ruby version as an alternative
-    Add support for other *BSD flavors
-    Add ttydev info
-    Add a sysctl version
-
-== Known Bugs
-    The kvm version for FreeBSD 5.x does not support all of the fields that
-    the 4.x version supports.
+= Future Plans
+   Add a pure-ruby version as an alternative
+   Add support for other *BSD flavors
+   Add ttydev info
+   Add a sysctl version
+
+= Known Bugs
+   The kvm version for FreeBSD 5.x does not support all of the fields that
+   the 4.x version supports.
     
-    If you find any other bugs please log them on the project
-    page at http://www.rubyforge.org/projects/sysutils
+   If you find any other bugs please log them on the project
+   page at http://www.rubyforge.org/projects/sysutils
 
-== License
-    Ruby's
+= License
+   Ruby's
 
-== Copyright
-    (C) 2003-2005 Daniel J. Berger
-    All Rights Reserved
+= Copyright
+   (C) 2003-2006 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
-
-== Author
-    Daniel J. Berger
-    djberg96 at yahoo dot com
-    imperator/rubyhacker1 on IRC (Freenode)
-
-== Credits
-    This module is largely based on the Perl module Proc::ProcessTable by
-    Dan Urist.  Many ideas, as well as large chunks of code, were taken
-    from his work.  So, a big THANK YOU goes out to Dan Urist.
-
-    A big thanks also goes out to Mike Hall who was very helpful with ideas,
-    logic and testing.
-
-    Thanks also go to Sean Chittenden for providing an account on one of his
-    FreeBSD machines.  This is how the FreeBSD support was (originally) added.
-
-== See Also
-    ps, proc
+= 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
+
+= Author
+   Daniel J. Berger
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)
+
+= See Also
+   ps, proc

data/doc/hpux.txt

@@ -1,10 +1,10 @@
-== Description
+= Description
    sys-proctable
 
    A Ruby version of the 'ps' command.  This is a C extension, not parsed
    output.  For HP-UX, proc structs are grabbed via the pstat_getproc() call.
 
-== Synopsis
+= Synopsis
    require 'sys/proctable'
    include Sys
 
@@ -24,67 +24,55 @@
       ...
    end
 
-== Constants
+= Constants
 VERSION
-    Returns the current version number for this package (as a string).
+   Returns the current version number for this package (as a string).
 
-== Class Methods
+= Class Methods
 ProcTable.fields
-    Returns a list of fields available on the current OS.  May also take
-    a block.
+   Returns a list of fields available on the current OS.  May also take
+   a block.
 
 ProcTable.ps(pid=nil)
 ProcTable.ps{ |s| ... }
-    Returns a struct of type ProcTableStruct for every process in the proc
-    table in block form.  Otherwise it returns an array of ProcTableStruct's.
+   Returns a struct of type ProcTableStruct for every process in the proc
+   table in block form.  Otherwise it returns an array of ProcTableStruct's.
 
-    If a pid is provided then a single ProcTable struct is returned, or nil
-    if the pid is not found.
+   If a pid is provided then a single ProcTable struct is returned, or nil
+   if the pid is not found.
 
-== Supported fields
+= Supported fields
+   You can view the supported fields with the "fields()" class method.
 
-    You can view the supported fields with the "fields()" class method.
+= Future Plans
+   Have the flags field return a meaningful value.
 
-== Future Plans
-    Have the flags field return a meaningful value.
+= Notes
+   The "comm" field isn't really part of the psinfo struct.  It is just a copy
+   (i.e. is identical to) the "fname" field.  I added it to provide a degree
+   of consistency between all of the platforms.  I will also make a point
+   of adding it to any future platform releases.
 
-== Notes
-    The "comm" field isn't really part of the psinfo struct.  It is just a copy
-    (i.e. is identical to) the "fname" field.  I added it to provide a degree
-    of consistency between all of the platforms.  I will also make a point
-    of adding it to any future platform releases.
+= Known Bugs
+   None that I'm aware of.  Please log any bugs on the project page at
+   http://www.rubyforge.org/projects/sysutils
 
-== Known Bugs
-    None that I'm aware of.  Please log any bugs on the project page at
-	http://www.rubyforge.org/projects/sysutils
+= License
+   Ruby's
 
-== License
-    Ruby's
-
-== Copyright
-    (C) 2003-2005 Daniel J. Berger
-    All Rights Reserved.
+= Copyright
+   (C) 2003-2006 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.
-
-== Author
-    Daniel J. Berger
-    djberg96 at yahoo dot com
-    imperator/rubyhacker1 on IRC (Freenode)
-
-== Credits
-    This module is largely based on the Perl module Proc::ProcessTable by
-    Dan Urist.  Many ideas, as well as large chunks of code, were taken
-    from his work.  So, a big THANK YOU goes out to Dan Urist.
-
-    A big thanks also goes out to Mike Hall who was very helpful with ideas,
-    logic and testing.
-
-    Thanks also go to Sean Chittenden for providing an account on one of his
-    FreeBSD machines.  This is how the FreeBSD support was (initially) added.
-
-== See Also
-    ps, proc
+= 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.
+
+= Author
+   Daniel J. Berger
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)
+
+= See Also
+   ps, proc