Unverified Commit 8a4fe230 authored by Gavin Brown's avatar Gavin Brown
Browse files

documentation update etc

parent a9388171
# NAME # NAME
Pepper - A command line EPP client Pepper - A command-line EPP client.
# DESCRIPTION # DESCRIPTION
Pepper is a command-line client for the EPP protocol. It's written in Perl and uses the Net::EPP module. Pepper is a command-line client for the EPP protocol. It's written in Perl and uses the [Net::EPP](https://metacpan.org/pod/Net::EPP) module.
# USAGE # USAGE
...@@ -12,11 +12,13 @@ Pepper is a command-line client for the EPP protocol. It's written in Perl and u ...@@ -12,11 +12,13 @@ Pepper is a command-line client for the EPP protocol. It's written in Perl and u
Available command-line options: Available command-line options:
- `--help` - show help and exit.
- `--host=HOST` - sets the host to connect to. - `--host=HOST` - sets the host to connect to.
- `--port=PORT` - sets the port. Defaults to 700. - `--port=PORT` - sets the port. Defaults to 700.
- `--timeout=TIMEOUT` - sets the timeout. Defaults to 3. - `--timeout=TIMEOUT` - sets the timeout. Defaults to 3.
- `--user=USER` - sets the client ID. - `--user=USER` - sets the client ID.
- `--pass=PASS` - sets the client password. - `--pass=PASS` - sets the client password.
- `--newpw=PASS` - specify a new password to replace the current password.
- `--cert=FILE` - specify the client certificate to use to connect. - `--cert=FILE` - specify the client certificate to use to connect.
- `--key=FILE` - specify the private key for the client certificate. - `--key=FILE` - specify the private key for the client certificate.
- `--exec=COMMAND` - specify a command to execute. If not provided, pepper goes into interactive mode. - `--exec=COMMAND` - specify a command to execute. If not provided, pepper goes into interactive mode.
...@@ -26,7 +28,7 @@ Available command-line options: ...@@ -26,7 +28,7 @@ Available command-line options:
# 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.
## Getting Help ## Getting Help
...@@ -215,7 +217,7 @@ where: ...@@ -215,7 +217,7 @@ where:
Pepper uses these modules: Pepper uses these modules:
- [Term::ANSIColor](https://metacpan.org/pod/Term::ANSIColor) - [Term::ANSIColor](https://metacpan.org/pod/Term::ANSIColor) (version 2.01 or higher)
- [Term::ReadLine::Gnu](https://metacpan.org/pod/Term::ReadLine::Gnu) (and [Term::ReadLine](https://metacpan.org/pod/Term::ReadLine)) - [Term::ReadLine::Gnu](https://metacpan.org/pod/Term::ReadLine::Gnu) (and [Term::ReadLine](https://metacpan.org/pod/Term::ReadLine))
- [Net::EPP::Simple](https://metacpan.org/pod/Net::EPP::Simple) (from [Net::EPP](https://metacpan.org/pod/Net::EPP), which in turn uses [IO::Socket::SSL](https://metacpan.org/pod/IO::Socket::SSL) and [XML::LibXML](https://metacpan.org/pod/XML::LibXML)). Pepper usually requires the most recent "unstable" version which can be obtained from [https://gitlab.centralnic.com/centralnic/perl-net-epp](https://gitlab.centralnic.com/centralnic/perl-net-epp). - [Net::EPP::Simple](https://metacpan.org/pod/Net::EPP::Simple) (from [Net::EPP](https://metacpan.org/pod/Net::EPP), which in turn uses [IO::Socket::SSL](https://metacpan.org/pod/IO::Socket::SSL) and [XML::LibXML](https://metacpan.org/pod/XML::LibXML)). Pepper usually requires the most recent "unstable" version which can be obtained from [https://gitlab.centralnic.com/centralnic/perl-net-epp](https://gitlab.centralnic.com/centralnic/perl-net-epp).
- [Text::ParseWords](https://metacpan.org/pod/Text::ParseWords) - [Text::ParseWords](https://metacpan.org/pod/Text::ParseWords)
...@@ -228,11 +230,3 @@ They can be installed using one of the various CPAN clients, or as packages from ...@@ -228,11 +230,3 @@ They can be installed using one of the various CPAN clients, or as packages from
Copyright CentralNic Group plc. Copyright CentralNic Group plc.
This program is Free Software; you can use it and/or modify it under the same terms as Perl itself. This program is Free Software; you can use it and/or modify it under the same terms as Perl itself.
# POD ERRORS
Hey! **The above document had some coding errors, which are explained below:**
- Around line 1195:
=back without =over
...@@ -18,7 +18,7 @@ sub new { ...@@ -18,7 +18,7 @@ sub new {
$self->{'pretty_parser'} = XML::Parser->new( $self->{'pretty_parser'} = XML::Parser->new(
'Style' => 'Stream', 'Style' => 'Stream',
'Pkg' => 'Pepper::Higlighter', 'Pkg' => 'Pepper::Highlighter',
); );
return $self; return $self;
...@@ -42,9 +42,9 @@ sub send_frame { ...@@ -42,9 +42,9 @@ sub send_frame {
} }
# #
# Pepper::Higlighter implements an XML parser which pretty-prints XML using ANSI color codes # Pepper::Highlighter implements an XML parser which pretty-prints XML using ANSI color codes
# #
package Pepper::Higlighter; package Pepper::Highlighter;
use Term::ANSIColor; use Term::ANSIColor;
use HTML::Entities qw(encode_entities_numeric); use HTML::Entities qw(encode_entities_numeric);
use vars qw($buffer $depth $indent $tag $end); use vars qw($buffer $depth $indent $tag $end);
...@@ -303,7 +303,6 @@ while (1) { ...@@ -303,7 +303,6 @@ while (1) {
execute_command($command); execute_command($command);
} }
} }
} }
...@@ -1177,11 +1176,11 @@ sub fatal { ...@@ -1177,11 +1176,11 @@ sub fatal {
=head1 NAME =head1 NAME
Pepper - A command line EPP client Pepper - A command-line EPP client.
=head1 DESCRIPTION =head1 DESCRIPTION
Pepper is a command-line client for the EPP protocol. It's written in Perl and uses the Net::EPP module. Pepper is a command-line client for the EPP protocol. It's written in Perl and uses the L<Net::EPP> module.
=head1 USAGE =head1 USAGE
...@@ -1191,6 +1190,8 @@ Available command-line options: ...@@ -1191,6 +1190,8 @@ Available command-line options:
=over =over
=item C<--help> - show help and exit.
=item C<--host=HOST> - sets the host to connect to. =item C<--host=HOST> - sets the host to connect to.
=item C<--port=PORT> - sets the port. Defaults to 700. =item C<--port=PORT> - sets the port. Defaults to 700.
...@@ -1201,6 +1202,8 @@ Available command-line options: ...@@ -1201,6 +1202,8 @@ Available command-line options:
=item C<--pass=PASS> - sets the client password. =item C<--pass=PASS> - sets the client password.
=item C<--newpw=PASS> - specify a new password to replace the current password.
=item C<--cert=FILE> - specify the client certificate to use to connect. =item C<--cert=FILE> - specify the client certificate to use to connect.
=item C<--key=FILE> - specify the private key for the client certificate. =item C<--key=FILE> - specify the private key for the client certificate.
...@@ -1217,7 +1220,7 @@ Available command-line options: ...@@ -1217,7 +1220,7 @@ Available command-line options:
=head1 SYNTAX =head1 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.
=head2 Getting Help =head2 Getting Help
...@@ -1281,8 +1284,6 @@ Get object information. C<TYPE> is one of C<domain>, C<host>, C<contact>. For do ...@@ -1281,8 +1284,6 @@ Get object information. C<TYPE> is one of C<domain>, C<host>, C<contact>. For do
For contact objects, C<PARAMS> can be the contact's authInfo. For contact objects, C<PARAMS> can be the contact's authInfo.
=back
=head2 Transform Commands =head2 Transform Commands
=over =over
...@@ -1464,7 +1465,7 @@ Pepper uses these modules: ...@@ -1464,7 +1465,7 @@ Pepper uses these modules:
=over =over
=item L<Term::ANSIColor> =item L<Term::ANSIColor> (version 2.01 or higher)
=item L<Term::ReadLine::Gnu> (and L<Term::ReadLine>) =item L<Term::ReadLine::Gnu> (and L<Term::ReadLine>)
......
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