Importing IPC-MorseSignals-0.10.tar.gz

[perl/modules/IPC-MorseSignals.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..aa1abb9
--- /dev/null
+++ b/README
@@ -0,0 +1,79 @@
+NAME
+    IPC::MorseSignals - Communicate between processes with Morse signals.
+
+VERSION
+    Version 0.10
+
+SYNOPSIS
+        # In the sender process
+        use IPC::MorseSignals::Emitter;
+
+        my $deuce = new IPC::MorseSignals::Emitter speed => 1024;
+        $deuce->post('HLAGH') for 1 .. 3;
+        $deuce->send($pid);
+
+        ...
+
+        # In the receiver process
+        use IPC::MorseSignals::Receiver;
+
+        local %SIG;
+        my $pants = new IPC::MorseSignals::Receiver \%SIG, done => sub {
+         print STDERR "GOT $_[1]\n";
+        };
+
+    head1 DESCRIPTION
+
+    This module implements a rare form of IPC by sending Morse-like signals
+    through "SIGUSR1" and "SIGUSR2". Both of those signals are used, so you
+    won't be able to keep them for something else when you use this module.
+
+    IPC::MorseSignals::Emitter is a base class for emitters ;
+    IPC::MorseSignals::Receiver is a base class for receivers ;
+
+    But, seriously, use something else for your IPC. :)
+
+DEPENDENCIES
+    You need the complete Bit::MorseSignals distribution.
+
+    Carp (standard since perl 5), POSIX (idem) and Time::HiRes (since perl
+    5.7.3) are also required.
+
+SEE ALSO
+    IPC::MorseSignals::Emitter, IPC::MorseSignals::Receiver.
+
+    Bit::MorseSignals, Bit::MorseSignals::Emitter,
+    Bit::MorseSignals::Receiver.
+
+    perlipc for information about signals in perl.
+
+    For truly useful IPC, search for shared memory, pipes and semaphores.
+
+AUTHOR
+    Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
+
+    You can contact me by mail or on #perl @ FreeNode (vincent or
+    Prof_Vince).
+
+BUGS
+    Please report any bugs or feature requests to "bug-ipc-morsesignals at
+    rt.cpan.org", or through the web interface at
+    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IPC-MorseSignals>. I
+    will be notified, and then you'll automatically be notified of progress
+    on your bug as I make changes.
+
+SUPPORT
+    You can find documentation for this module with the perldoc command.
+
+        perldoc IPC::MorseSignals
+
+ACKNOWLEDGEMENTS
+    Thanks for the inspiration, mofino ! I hope this module will fill all
+    your IPC needs. :)
+
+COPYRIGHT & LICENSE
+    Copyright 2007-2008 Vincent Pit, all rights reserved.
+
+    This program is free software; you can redistribute it and/or modify it
+    under the same terms as Perl itself.
+