doc/wait3.txt in proc-wait3-1.5.3 vs doc/wait3.txt in proc-wait3-1.5.4

- old
+ new

@@ -2,11 +2,11 @@ Adds the wait3, wait4, waitid, pause, sigsend, and getrusage methods to the Process module. For Ruby 1.8.4 or earlier, it also adds the getrlimit and setrlimit methods. == Synopsis - require "proc/wait3" + require 'proc/wait3' pid = fork{ sleep 1; exit 2 } p Time.now Process.wait3 p $? @@ -21,39 +21,39 @@ use 'INT', not 'SIGINT'. Returns the result of the pause() function, which should always be -1. Process.sigsend(idtype, id, signal=0) - Sends a signal of type "idtype" to a process or process group "id". This + Sends a signal of type "idtype" to a process or process group "id". This is more versatile method of sending signals to processes than Process.kill. For a list of valid idtype values, see the "Process type constants" below. Not supported on all platforms. Proc.wait3(flags=0) Delays its caller until a signal is received or one of its child processes terminates or stops due to tracing. - The return value is a ProcStat structure. The special global $? is also - set. Raises a SystemError if there are no child processes. + The return value is a ProcStat structure. The special global $? is also + set. Raises a SystemError if there are no child processes. Proc.wait4(pid, flags=0) - Waits for the given child process to exit. Returns a ProcStat structure. + Waits for the given child process to exit. Returns a ProcStat structure. Also sets the $? special global variable. Proc.waitid(id_type, id_num=nil, options=nil) Suspends the calling process until one of its children changes state, returning immediately if a child process changed state prior to the call. The state of a child process will change if it terminates, stops because of a signal, becomes trapped or reaches a breakpoint. - The id_num corresponds to a pid or pgid, depending on the value of id_type, - which may be Process::P_PID, Process::P_PGID or Process::P_ALL. If - Process::P_ALL, then the id_num is ignored. + The id_num corresponds to a process ID or process group ID, depending on + the value of +id_type+, which may be Process::P_PID, Process::P_PGID or + Process::P_ALL. If +id_type+ is Process::P_ALL, then the +id_num+ is ignored. The options argument is used to specify which state changes are to be - waited for. It is constructed from the bitwise-OR of one or more of the + waited for. It is constructed from the bitwise-OR of one or more of the following constants: Process::WCONTINUED Process::WEXITED Process::WNOHANG @@ -104,17 +104,17 @@ Process::P_GID Any non-system effective process group id. Process::P_PROJID - A project process id. Solaris 8 or later only. + A project process id. Solaris 8 or later only. Process::P_SID A session process id. Process::P_TASKID - A task process id. Solaris 8 or later only. + A task process id. Solaris 8 or later only. Process::P_UID Any non-system effective process user id. === The following additional constants are defined if the waitid function is @@ -177,17 +177,17 @@ The wait3 and wait4 methods are similar to the wait2 and waitpid2 methods, except that they return much more information via the rusage struct. == Known Bugs - None that I'm aware of. Please log any bugs on the RubyForge project + None that I'm aware of. Please log any bugs on the RubyForge project page at http://www.rubyforge.org/projects/shards. == License Ruby's == Copyright - (C) 2003-2006 Daniel J. Berger + (C) 2003-2008 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