Unverified Commit f8a84bea authored by Gavin Brown's avatar Gavin Brown
Browse files

fixed POD, updated README, added installation requirements

parent a39f1970
...@@ -34,6 +34,10 @@ Pepper is a command-line client for the EPP protocol. It's written in Perl and u ...@@ -34,6 +34,10 @@ Pepper is a command-line client for the EPP protocol. It's written in Perl and u
Specify command to execute. May be used multiple times. See [SYNTAX](https://metacpan.org/pod/SYNTAX) for more details. Specify command to execute. May be used multiple times. See [SYNTAX](https://metacpan.org/pod/SYNTAX) for more details.
- `--insecure`
Disable SSL certificate checks.
# SYNTAX # SYNTAX
Once running, Pepper provides a simple command line interface. The available commands are listed below: Once running, Pepper provides a simple command line interface. The available commands are listed below:
...@@ -173,12 +177,14 @@ Pepper provides limited support for the the launch and fee extensions: ...@@ -173,12 +177,14 @@ Pepper provides limited support for the the launch and fee extensions:
### CLAIMS CHECK ### CLAIMS CHECK
The following command will extend the standard <check> command to perform The following command will extend the standard &lt;check> command to perform
a claims check as per Section 3.1.1. of [draft-ietf-eppext-launchphase](https://metacpan.org/pod/draft-ietf-eppext-launchphase). a claims check as per Section 3.1.1. of [draft-ietf-eppext-launchphase](https://metacpan.org/pod/draft-ietf-eppext-launchphase).
pepper> check claims example.xyz pepper> check claims example.xyz
The following command will extend the standard <check> command to perform ### FEE CHECK
The following command will extend the standard &lt;check> command to perform
a fee check as per Section 3.1.1. of [draft-brown-epp-fees-02](https://metacpan.org/pod/draft-brown-epp-fees-02). a fee check as per Section 3.1.1. of [draft-brown-epp-fees-02](https://metacpan.org/pod/draft-brown-epp-fees-02).
pepper> check fee example.xyz COMMAND [CURRENCY [PERIOD]] pepper> check fee example.xyz COMMAND [CURRENCY [PERIOD]]
...@@ -200,16 +206,19 @@ Syntax: ...@@ -200,16 +206,19 @@ Syntax:
Create a host object with the specified `HOSTNAME`. IP address may also be Create a host object with the specified `HOSTNAME`. IP address may also be
specified: IPv4 and IPv6 addresses are automatically detected. specified: IPv4 and IPv6 addresses are automatically detected.
# LICENSE # INSTALLATION
Copyright CentralNic Group plc. Pepper requires that the following Perl modules be installed:
This program is Free Software; you can use it and/or modify it under the same terms as Perl itself. - `Term::ReadLine::Gnu` (and `Term::ReadLine`)
- `Net::EPP::Simple` (from `Net::EPP`, in turn requires `IO::Socket::SSL` and `XML::LibXML`)
- `Text::ParseWords`
- `Mozilla::CA`
# POD ERRORS This can be installed using one of the various CPAN clients, or as packages from your operating system vendor.
Hey! __The above document had some coding errors, which are explained below:__ # LICENSE
- Around line 768: Copyright CentralNic Group plc.
Unknown directive: =head This program is Free Software; you can use it and/or modify it under the same terms as Perl itself.
...@@ -788,7 +788,7 @@ a claims check as per Section 3.1.1. of L<draft-ietf-eppext-launchphase>. ...@@ -788,7 +788,7 @@ a claims check as per Section 3.1.1. of L<draft-ietf-eppext-launchphase>.
pepper> check claims example.xyz pepper> check claims example.xyz
=head 3 FEE CHECK =head3 FEE CHECK
The following command will extend the standard E<lt>checkE<gt> command to perform The following command will extend the standard E<lt>checkE<gt> command to perform
a fee check as per Section 3.1.1. of L<draft-brown-epp-fees-02>. a fee check as per Section 3.1.1. of L<draft-brown-epp-fees-02>.
...@@ -812,6 +812,24 @@ Syntax: ...@@ -812,6 +812,24 @@ Syntax:
Create a host object with the specified C<HOSTNAME>. IP address may also be Create a host object with the specified C<HOSTNAME>. IP address may also be
specified: IPv4 and IPv6 addresses are automatically detected. specified: IPv4 and IPv6 addresses are automatically detected.
=head1 INSTALLATION
Pepper requires that the following Perl modules be installed:
=over
=item C<Term::ReadLine::Gnu> (and C<Term::ReadLine>)
=item C<Net::EPP::Simple> (from C<Net::EPP>, in turn requires C<IO::Socket::SSL> and C<XML::LibXML>)
=item C<Text::ParseWords>
=item C<Mozilla::CA>
=back
This can be installed using one of the various CPAN clients, or as packages from your operating system vendor.
=head1 LICENSE =head1 LICENSE
Copyright CentralNic Group plc. Copyright CentralNic Group plc.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment