Thank you for considering contributing to this distribution. This file
contains instructions that will help you work with the source code.
+PLEASE NOTE that if you have any questions or difficulties, you can reach the
+maintainer(s) through the bug queue described later in this document
+(preferred), or by emailing the releaser directly. You are not required to
+follow any of the steps in this document to submit a patch or bug report;
+these are just recommendations, intended to help you (and help us help you
+faster).
+
+This distribution has a TODO file in the repository; you may want to check
+there to see if your issue or patch idea is mentioned.
+
The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
This means than many of the usual files you might expect are not in the
repository, but are generated at release time (e.g. Makefile.PL).
can submit an issue report here:
https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-REPL
or via bug-Devel-REPL@rt.cpan.org.
-This is a good place to send your questions about the usage of this distribution.
+
+There is also an irc channel available for users of this distribution, at
+irc://irc.perl.org/#devel-repl.
+
+If you send me a patch or pull request, your name and email address will be
+included in the documentation as a contributor (using the attribution on the
+commit or patch), unless you specifically request for it not to be. If you
+wish to be listed under a different name or address, you should submit a pull
+request to the .mailmap file to contain the correct mapping.
-This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a
-template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.065.
+This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.006 from a
+template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.102.
Revision history for Devel-REPL
-{{ $NEXT }}
+1.003027 2015-08-16 05:18:24Z
- updated some bits of the distribution packaging
1.003026 2014-07-16 01:20:41Z
--- /dev/null
+This is the Perl distribution Devel-REPL.
+
+Installing Devel-REPL is straightforward.
+
+## Installation with cpanm
+
+If you have cpanm, you only need one line:
+
+ % cpanm Devel::REPL
+
+If you are installing into a system-wide directory, you may need to pass the
+"-S" flag to cpanm, which uses sudo to install the module:
+
+ % cpanm -S Devel::REPL
+
+## Installing with the CPAN shell
+
+Alternatively, if your CPAN shell is set up, you should just be able to do:
+
+ % cpan Devel::REPL
+
+## Manual installation
+
+As a last resort, you can manually install it. Download the tarball, untar it,
+then build it:
+
+ % perl Makefile.PL
+ % make && make test
+
+Then install it:
+
+ % make install
+
+If you are installing into a system-wide directory, you may need to run:
+
+ % sudo make install
+
+## Documentation
+
+Devel-REPL documentation is available as POD.
+You can run perldoc from a shell to read the documentation:
+
+ % perldoc Devel::REPL
+++ /dev/null
-# NAME
-
-Devel::REPL - a modern perl interactive shell
-
-# VERSION
-
-version 1.003026
-
-# SYNOPSIS
-
- my $repl = Devel::REPL->new;
- $repl->load_plugin($_) for qw(History LexEnv);
- $repl->run
-
-Alternatively, use the 're.pl' script installed with the distribution
-
- system$ re.pl
-
-# DESCRIPTION
-
-This is an interactive shell for Perl, commonly known as a REPL - Read,
-Evaluate, Print, Loop. The shell provides for rapid development or testing
-of code without the need to create a temporary source code file.
-
-Through a plugin system, many features are available on demand. You can also
-tailor the environment through the use of profiles and run control files, for
-example to pre-load certain Perl modules when working on a particular project.
-
-# USAGE
-
-To start a shell, follow one of the examples in the ["SYNOPSIS"](#synopsis) above.
-
-Once running, the shell accepts and will attempt to execute any code given. If
-the code executes successfully you'll be shown the result, otherwise an error
-message will be returned. Here are a few examples:
-
- $_ print "Hello, world!\n"
- Hello, world!
- 1
- $_ nosuchfunction
- Compile error: Bareword "nosuchfunction" not allowed while "strict subs" in use at (eval 130) line 5.
-
- $_
-
-In the first example above you see the output of the command (`Hello,
-world!`), if any, and then the return value of the statement (`1`). Following
-that example, an error is returned when the execution of some code fails.
-
-Note that the lack of semicolon on the end is not a mistake - the code is
-run inside a Block structure (to protect the REPL in case the code blows up),
-which means a single statement doesn't require the semicolon. You can add one
-if you like, though.
-
-If you followed the first example in the ["SYNOPSIS"](#synopsis) above, you'll have the
-[History](https://metacpan.org/pod/Devel::REPL::Plugin::History) and [LexEnv](https://metacpan.org/pod/Devel::REPL::Plugin::LexEnv)
-plugins loaded (and there are many more available).
-Although the shell might support "up-arrow" history, the History plugin adds
-"bang" history to that so you can re-execute chosen commands (with e.g.
-`!53`). The LexEnv plugin ensures that lexical variables declared with the
-`my` keyword will automatically persist between statements executed in the
-REPL shell.
-
-When you `use` any Perl module, the `import()` will work as expected - the
-exported functions from that module are available for immediate use:
-
- $_ carp "I'm dieeeing!\n"
- String found where operator expected at (eval 129) line 5, near "carp "I'm dieeeing!\n""
- (Do you need to predeclare carp?)
- Compile error: syntax error at (eval 129) line 5, near "carp "I'm dieeeing!\n""
- BEGIN not safe after errors--compilation aborted at (eval 129) line 5.
-
- $_ use Carp
-
- $_ carp "I'm dieeeing!\n"
- I'm dieeeing!
- at /usr/share/perl5/Lexical/Persistence.pm line 327
- 1
- $_
-
-To quit from the shell, hit `Ctrl+D` or `Ctrl+C`.
-
- MSWin32 NOTE: control keys won't work if TERM=dumb
- because readline functionality will be disabled.
-
-## Run Control Files
-
-For particular projects you might well end up running the same commands each
-time the REPL shell starts up - loading Perl modules, setting configuration,
-and so on. A run control file lets you have this done automatically, and you
-can have multiple files for different projects.
-
-By default the `re.pl` program looks for `$HOME/.re.pl/repl.rc`, and
-runs whatever code is in there as if you had entered it at the REPL shell
-yourself.
-
-To set a new run control file that's also in that directory, pass it as a
-filename like so:
-
- system$ re.pl --rcfile myproject.pc
-
-If the filename happens to contain a forward slash, then it's used absolutely,
-or realive to the current working directory:
-
- system$ re.pl --rcfile /path/to/my/project/repl.rc
-
-Within the run control file you might want to load plugins. This is covered in
-["The REPL shell object"](#the-repl-shell-object) section, below.
-
-## Profiles
-
-To allow for the sharing of run control files, you can fashion them into a
-Perl module for distribution (perhaps via the CPAN). For more information on
-this feature, please see the [Devel::REPL::Profile](https://metacpan.org/pod/Devel::REPL::Profile) manual page.
-
-A `Standard` profile ships with `Devel::REPL`; it loads the following plugins
-(note that some of these require optional features -- or you can also use the
-`Minimal` profile):
-
-- [Devel::REPL::Plugin::History](https://metacpan.org/pod/Devel::REPL::Plugin::History)
-- [Devel::REPL::Plugin::LexEnv](https://metacpan.org/pod/Devel::REPL::Plugin::LexEnv)
-- [Devel::REPL::Plugin::DDS](https://metacpan.org/pod/Devel::REPL::Plugin::DDS)
-- [Devel::REPL::Plugin::Packages](https://metacpan.org/pod/Devel::REPL::Plugin::Packages)
-- [Devel::REPL::Plugin::Commands](https://metacpan.org/pod/Devel::REPL::Plugin::Commands)
-- [Devel::REPL::Plugin::MultiLine::PPI](https://metacpan.org/pod/Devel::REPL::Plugin::MultiLine::PPI)
-- [Devel::REPL::Plugin::Colors](https://metacpan.org/pod/Devel::REPL::Plugin::Colors)
-- [Devel::REPL::Plugin::Completion](https://metacpan.org/pod/Devel::REPL::Plugin::Completion)
-- [Devel::REPL::Plugin::CompletionDriver::INC](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::INC)
-- [Devel::REPL::Plugin::CompletionDriver::LexEnv](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::LexEnv)
-- [Devel::REPL::Plugin::CompletionDriver::Keywords](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::Keywords)
-- [Devel::REPL::Plugin::CompletionDriver::Methods](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::Methods)
-- [Devel::REPL::Plugin::ReadlineHistory](https://metacpan.org/pod/Devel::REPL::Plugin::ReadlineHistory)
-
-## Plugins
-
-Plugins are a way to add functionality to the REPL shell, and take advantage of
-`Devel::REPL` being based on the [Moose](https://metacpan.org/pod/Moose) object system for Perl 5. This
-means it's simple to 'hook into' many steps of the R-E-P-L process. Plugins
-can change the way commands are interpreted, or the way their results are
-output, or even add commands to the shell environment.
-
-A number of plugins ship with `Devel::REPL`, and more are available on the
-CPAN. Some of the shipped plugins are loaded in the default profile, mentioned
-above. These plugins can be loaded in your ` $HOME/.re.pl/repl.rc ` like:
-
- load_plugin qw( CompletionDriver::Global DumpHistory );
-
-Writing your own plugins is not difficult, and is discussed in the
-[Devel::REPL::Plugin](https://metacpan.org/pod/Devel::REPL::Plugin) manual page, along with links to the manual pages of
-all the plugins shipped with `Devel::REPL`.
-
-## The REPL shell object
-
-From time to time you'll want to interact with or manipulate the
-`Devel::REPL` shell object itself; that is, the instance of the shell you're
-currently running.
-
-The object is always available through the `$_REPL` variable. One common
-requirement is to load an additional plugin, after your profile and run
-control files have already been executed:
-
- $_ $_REPL->load_plugin('Timing');
- 1
- $_ print "Hello again, world!\n"
- Hello again, world!
- Took 0.00148296356201172 seconds.
- 1
- $_
-
-# OPTIONAL FEATURES
-
-In addition to the prerequisites declared in this distribution, which should be automatically installed by your [CPAN](https://metacpan.org/pod/CPAN) client, there are a number of optional features, used by
-additional plugins. You can install any of these features by installing this
-distribution interactively (e.g. `cpanm --interactive Devel::REPL`).
-
-- Completion plugin - extensible tab completion
-- DDS plugin - better format results with Data::Dump::Streamer
-- DDC plugin - even better format results with Data::Dumper::Concise
-- INC completion driver - tab complete module names in use and require
-- Interrupt plugin - traps SIGINT to kill long-running lines
-- Keywords completion driver - tab complete Perl keywords and operators
-- LexEnv plugin - variables declared with "my" persist between statements
-- MultiLine::PPI plugin - continue reading lines until all blocks are closed
-- Nopaste plugin - upload a session\\'s input and output to a Pastebin
-- PPI plugin - PPI dumping of Perl code
-- Refresh plugin - automatically reload libraries with Module::Refresh
-
-# AUTHOR
-
-Matt S Trout - mst (at) shadowcatsystems.co.uk ([http://www.shadowcatsystems.co.uk/](http://www.shadowcatsystems.co.uk/))
-
-# CONTRIBUTORS
-
-- Stevan Little - stevan (at) iinteractive.com
-- Alexis Sukrieh - sukria+perl (at) sukria.net
-- epitaph
-- mgrimes - mgrimes (at) cpan dot org
-- Shawn M Moore - sartak (at) gmail.com
-- Oliver Gorwits - oliver on irc.perl.org
-- Andrew Moore - `<amoore@cpan.org>`
-- Norbert Buchmuller `<norbi@nix.hu>`
-- Dave Houston `<dhouston@cpan.org>`
-- Chris Marshall
-- Karen Etheridge `<ether@cpan.org>`
-
-# LICENSE
-
-This library is free software under the same terms as perl itself
--- /dev/null
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Devel::REPL - A modern perl interactive shell
+
+=head1 VERSION
+
+version 1.003027
+
+=head1 SYNOPSIS
+
+ my $repl = Devel::REPL->new;
+ $repl->load_plugin($_) for qw(History LexEnv);
+ $repl->run
+
+Alternatively, use the 're.pl' script installed with the distribution
+
+ system$ re.pl
+
+=head1 DESCRIPTION
+
+This is an interactive shell for Perl, commonly known as a REPL - Read,
+Evaluate, Print, Loop. The shell provides for rapid development or testing
+of code without the need to create a temporary source code file.
+
+Through a plugin system, many features are available on demand. You can also
+tailor the environment through the use of profiles and run control files, for
+example to pre-load certain Perl modules when working on a particular project.
+
+=head1 USAGE
+
+To start a shell, follow one of the examples in the L</"SYNOPSIS"> above.
+
+Once running, the shell accepts and will attempt to execute any code given. If
+the code executes successfully you'll be shown the result, otherwise an error
+message will be returned. Here are a few examples:
+
+ $_ print "Hello, world!\n"
+ Hello, world!
+ 1
+ $_ nosuchfunction
+ Compile error: Bareword "nosuchfunction" not allowed while "strict subs" in use at (eval 130) line 5.
+
+ $_
+
+In the first example above you see the output of the command (C<Hello,
+world!>), if any, and then the return value of the statement (C<1>). Following
+that example, an error is returned when the execution of some code fails.
+
+Note that the lack of semicolon on the end is not a mistake - the code is
+run inside a Block structure (to protect the REPL in case the code blows up),
+which means a single statement doesn't require the semicolon. You can add one
+if you like, though.
+
+If you followed the first example in the L</"SYNOPSIS"> above, you'll have the
+L<History|Devel::REPL::Plugin::History> and L<LexEnv|Devel::REPL::Plugin::LexEnv>
+plugins loaded (and there are many more available).
+Although the shell might support "up-arrow" history, the History plugin adds
+"bang" history to that so you can re-execute chosen commands (with e.g.
+C<!53>). The LexEnv plugin ensures that lexical variables declared with the
+C<my> keyword will automatically persist between statements executed in the
+REPL shell.
+
+When you C<use> any Perl module, the C<import()> will work as expected - the
+exported functions from that module are available for immediate use:
+
+ $_ carp "I'm dieeeing!\n"
+ String found where operator expected at (eval 129) line 5, near "carp "I'm dieeeing!\n""
+ (Do you need to predeclare carp?)
+ Compile error: syntax error at (eval 129) line 5, near "carp "I'm dieeeing!\n""
+ BEGIN not safe after errors--compilation aborted at (eval 129) line 5.
+
+ $_ use Carp
+
+ $_ carp "I'm dieeeing!\n"
+ I'm dieeeing!
+ at /usr/share/perl5/Lexical/Persistence.pm line 327
+ 1
+ $_
+
+To quit from the shell, hit C<Ctrl+D> or C<Ctrl+C>.
+
+ MSWin32 NOTE: control keys won't work if TERM=dumb
+ because readline functionality will be disabled.
+
+=head2 Run Control Files
+
+For particular projects you might well end up running the same commands each
+time the REPL shell starts up - loading Perl modules, setting configuration,
+and so on. A run control file lets you have this done automatically, and you
+can have multiple files for different projects.
+
+By default the C<re.pl> program looks for C<< $HOME/.re.pl/repl.rc >>, and
+runs whatever code is in there as if you had entered it at the REPL shell
+yourself.
+
+To set a new run control file that's also in that directory, pass it as a
+filename like so:
+
+ system$ re.pl --rcfile myproject.pc
+
+If the filename happens to contain a forward slash, then it's used absolutely,
+or realive to the current working directory:
+
+ system$ re.pl --rcfile /path/to/my/project/repl.rc
+
+Within the run control file you might want to load plugins. This is covered in
+L</"The REPL shell object"> section, below.
+
+=head2 Profiles
+
+To allow for the sharing of run control files, you can fashion them into a
+Perl module for distribution (perhaps via the CPAN). For more information on
+this feature, please see the L<Devel::REPL::Profile> manual page.
+
+A C<Standard> profile ships with C<Devel::REPL>; it loads the following plugins
+(note that some of these require optional features -- or you can also use the
+C<Minimal> profile):
+
+=over 4
+
+=item *
+
+L<Devel::REPL::Plugin::History>
+
+=item *
+
+L<Devel::REPL::Plugin::LexEnv>
+
+=item *
+
+L<Devel::REPL::Plugin::DDS>
+
+=item *
+
+L<Devel::REPL::Plugin::Packages>
+
+=item *
+
+L<Devel::REPL::Plugin::Commands>
+
+=item *
+
+L<Devel::REPL::Plugin::MultiLine::PPI>
+
+=item *
+
+L<Devel::REPL::Plugin::Colors>
+
+=item *
+
+L<Devel::REPL::Plugin::Completion>
+
+=item *
+
+L<Devel::REPL::Plugin::CompletionDriver::INC>
+
+=item *
+
+L<Devel::REPL::Plugin::CompletionDriver::LexEnv>
+
+=item *
+
+L<Devel::REPL::Plugin::CompletionDriver::Keywords>
+
+=item *
+
+L<Devel::REPL::Plugin::CompletionDriver::Methods>
+
+=item *
+
+L<Devel::REPL::Plugin::ReadlineHistory>
+
+=back
+
+=head2 Plugins
+
+Plugins are a way to add functionality to the REPL shell, and take advantage of
+C<Devel::REPL> being based on the L<Moose> object system for Perl 5. This
+means it's simple to 'hook into' many steps of the R-E-P-L process. Plugins
+can change the way commands are interpreted, or the way their results are
+output, or even add commands to the shell environment.
+
+A number of plugins ship with C<Devel::REPL>, and more are available on the
+CPAN. Some of the shipped plugins are loaded in the default profile, mentioned
+above. These plugins can be loaded in your F< $HOME/.re.pl/repl.rc > like:
+
+ load_plugin qw( CompletionDriver::Global DumpHistory );
+
+Writing your own plugins is not difficult, and is discussed in the
+L<Devel::REPL::Plugin> manual page, along with links to the manual pages of
+all the plugins shipped with C<Devel::REPL>.
+
+=head2 The REPL shell object
+
+From time to time you'll want to interact with or manipulate the
+C<Devel::REPL> shell object itself; that is, the instance of the shell you're
+currently running.
+
+The object is always available through the C<$_REPL> variable. One common
+requirement is to load an additional plugin, after your profile and run
+control files have already been executed:
+
+ $_ $_REPL->load_plugin('Timing');
+ 1
+ $_ print "Hello again, world!\n"
+ Hello again, world!
+ Took 0.00148296356201172 seconds.
+ 1
+ $_
+
+=head1 OPTIONAL FEATURES
+
+In addition to the prerequisites declared in this distribution, which should be automatically installed by your L<CPAN> client, there are a number of optional features, used by
+additional plugins. You can install any of these features by installing this
+distribution interactively (e.g. C<cpanm --interactive Devel::REPL>).
+
+=for comment I hope to automatically generate this data via a Pod::Weaver section
+
+=over 4
+
+=item *
+
+Completion plugin - extensible tab completion
+
+=item *
+
+DDS plugin - better format results with Data::Dump::Streamer
+
+=item *
+
+DDC plugin - even better format results with Data::Dumper::Concise
+
+=item *
+
+INC completion driver - tab complete module names in use and require
+
+=item *
+
+Interrupt plugin - traps SIGINT to kill long-running lines
+
+=item *
+
+Keywords completion driver - tab complete Perl keywords and operators
+
+=item *
+
+LexEnv plugin - variables declared with "my" persist between statements
+
+=item *
+
+MultiLine::PPI plugin - continue reading lines until all blocks are closed
+
+=item *
+
+Nopaste plugin - upload a session\'s input and output to a Pastebin
+
+=item *
+
+PPI plugin - PPI dumping of Perl code
+
+=item *
+
+Refresh plugin - automatically reload libraries with Module::Refresh
+
+=back
+
+=head1 AUTHOR
+
+Matt S Trout - mst (at) shadowcatsystems.co.uk (L<http://www.shadowcatsystems.co.uk/>)
+
+=head1 CONTRIBUTORS
+
+=for stopwords Karen Etheridge Shawn M Moore Chris Marshall Matt S Trout Oliver Gorwits יובל קוג'מן (Yuval Kogman) Arthur Axel 'fREW' Schmidt Andrew Alexis Sukrieh Tomas Doran (t0m) epitaph Norbert Buchmuller Jesse Luehrs Dave Houston Dagfinn Ilmari Mannsåker Zakariyya Mughal Ryan Niebur Justin Hunter Ash Berlin naquad Stevan Little
+
+=over 4
+
+=item *
+
+Karen Etheridge <ether@cpan.org>
+
+=item *
+
+Shawn M Moore <code@sartak.org>
+
+=item *
+
+Chris Marshall <devel.chm.01@gmail.com>
+
+=item *
+
+Matt S Trout <mst@shadowcat.co.uk>
+
+=item *
+
+Oliver Gorwits <oliver@cpan.org>
+
+=item *
+
+יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
+
+=item *
+
+Arthur Axel 'fREW' Schmidt <frioux@gmail.com>
+
+=item *
+
+Andrew Moore <amoore@cpan.org>
+
+=item *
+
+Alexis Sukrieh <sukria+perl@sukria.net>
+
+=item *
+
+Tomas Doran (t0m) <bobtfish@bobtfish.net>
+
+=item *
+
+epitaph <unknown>
+
+=item *
+
+Norbert Buchmuller <norbi@nix.hu>
+
+=item *
+
+Jesse Luehrs <doy@tozt.net>
+
+=item *
+
+Dave Houston <dhouston@cpan.org>
+
+=item *
+
+Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
+
+=item *
+
+Zakariyya Mughal <zaki.mughal@gmail.com>
+
+=item *
+
+Ryan Niebur <ryan@debian.org>
+
+=item *
+
+Justin Hunter <justin.d.hunter@gmail.com>
+
+=item *
+
+Ash Berlin <ash_github@firemirror.com>
+
+=item *
+
+naquad <naquad@bd8105ee-0ff8-0310-8827-fb3f25b6796d>
+
+=item *
+
+Stevan Little <stevan.little@iinteractive.com>
+
+=back
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2007 by Matt S Trout - mst (at) shadowcatsystems.co.uk (L<http://www.shadowcatsystems.co.uk/>).
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut
projects / p5sagit/Devel-REPL.git / commitdiff