Debian Codegraph @

README

raw
1 Package Proc::Background Version 1.30
2
3 This is the Proc::Background package. It provides a generic interface
4 to running background processes. Through this interface, users can
5 run background processes on different operating systems without
6 concerning themselves about the specifics of doing this. Users of
7 this package create new Proc::Background objects that provide an
8 object oriented interface to process management. The following
9 methods are provided to users of the Proc::Background package:
10
11 new: start a new background process.
12 alive: test to see if the process is still alive.
13 suspend: pause the process
14 resume: resume a paused process
15 terminate: reliably try to kill the process.
16 wait: wait for the process to exit and return the exit status.
17 start_time: return the time that the process started.
18 end_time: return the time when the exit status was retrieved.
19
20 A generic function, timed_system, is also included that lets a
21 background process run for a specified amount of time, and if the
22 process did not exit, then the process is killed.
23
24 AVAILABILITY
25
26 The latest released version of this package is available for download
27 from a CPAN (Comprehensive Perl Archive Network) archive near you in
28
29 https://metacpan.org/pod/Proc::Background
30
31 The package's source code is hosted in a Git repository at
32
33 https://github.com/nrdvana/perl-Proc-Background
34
35 INSTALLATION
36
37 In order to use this package you will need Perl version 5.004_04 or
38 better.
39
40 On Win32 systems Proc::Background requires the Win32::Process and
41 Win32::ShellQuote modules. To check if your Perl has Win32::Process
42 installed on it, run
43
44 perl Makefile.PL
45
46 If this command does not complain about missing Win32::Process, then
47 you have the module installed. If you receive an error message, you
48 can do two things to resolve this. If you have not performed
49 extensive customization and installation of modules into your Perl,
50 the easier path is to upgrade to the latest version of ActiveState
51 Perl at
52
53 http://aspn.activestate.com/ASPN/Downloads/ActivePerl/
54
55 which includes Win32::Process. If you want to use your current Perl
56 installation, then download the latest version of the libwin32 package
57 by Gurusamy Sarathy available at:
58
59 http://www.perl.com/CPAN/authors/id/G/GS/GSAR/
60
61 Once that is completed, you install Proc::Background as you would
62 install any perl module library, by running these commands:
63
64 perl Makefile.PL
65 make
66 make test
67 make install
68
69 You can edit the configuration section of Makefile.PL to select which
70 programs to install in addition to the library itself. If you don't
71 want to install any programs (only the library files) and don't want
72 to mess with the Makefile.PL then pass the '-n' option to Makefile.PL:
73
74 perl Makefile.PL -n
75
76 If you want to install a private copy of this package in some other
77 directory, then you should try to produce the initial Makefile with
78 something like this command:
79
80 perl Makefile.PL LIB=~/perl
81
82 DOCUMENTATION
83
84 See the CHANGES file for a list of recent changes. POD style
85 documentation is included in all modules and scripts. These are
86 normally converted to manual pages end installed as part of the "make
87 install" process. You should also be able to use the 'perldoc'
88 utility to extract documentation from the module files directly.
89
90 COPYRIGHT
91
92 Copyright (C) 1998-2005 Blair Zajac, 2019-2021 Michael Conrad.
93 All rights reserved. This package is free software; you can
94 redistribute it and/or modify it under the same terms as Perl itself.