Unverified Commit 0b108bf1 authored by Gavin Brown's avatar Gavin Brown
Browse files

update documentation

parent e5997d4d
...@@ -55,8 +55,19 @@ Use `help COMMAND` at any time to get information about that command. Where a co ...@@ -55,8 +55,19 @@ Use `help COMMAND` at any time to get information about that command. Where a co
## Query Commands ## Query Commands
- `check TYPE OBJECT` - checks the availability of an object. `TYPE` is one of `domain`, `host`, `contact`, `claims` or `fee`. See ["Claims and fee Checks"](#claims-and-fee-checks) for more information about the latter two. ### Availability Checks
- `info TYPE OBJECT` - get object information. `TYPE` is one of `domain`, `host`, `contact`.
check TYPE OBJECT
This checks the availability of an object. `TYPE` is one of `domain`, `host`, `contact`, `claims` or `fee`. See ["Claims and fee Checks"](#claims-and-fee-checks) for more information about the latter two.
### Object Information
info TYPE OBJECT [PARAMS]
Get object information. `TYPE` is one of `domain`, `host`, `contact`. For domain objects, `PARAMS` can be `AUTHINFO HOSTS`, where `AUTHINFO` is the domain's authInfo code, and `HOSTS` is the value of the "hosts" attribute (ie `all`, `del`, `sub` or `none`). If you want to set `HOSTS` but don't know the authinfo, use an empty quoted string (ie `""`) as `AUTHINFO`.
For contact objects, `PARAMS` can be the contact's authInfo.
## Transform Commands ## Transform Commands
...@@ -217,3 +228,11 @@ They can be installed using one of the various CPAN clients, or as packages from ...@@ -217,3 +228,11 @@ 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
...@@ -1178,11 +1178,19 @@ Use C<help COMMAND> at any time to get information about that command. Where a c ...@@ -1178,11 +1178,19 @@ Use C<help COMMAND> at any time to get information about that command. Where a c
=head2 Query Commands =head2 Query Commands
=over =head3 Availability Checks
check TYPE OBJECT
This checks the availability of an object. C<TYPE> is one of C<domain>, C<host>, C<contact>, C<claims> or C<fee>. See L<Claims and fee Checks> for more information about the latter two.
=head3 Object Information
info TYPE OBJECT [PARAMS]
=item C<check TYPE OBJECT> - checks the availability of an object. C<TYPE> is one of C<domain>, C<host>, C<contact>, C<claims> or C<fee>. See L<Claims and fee Checks> for more information about the latter two. Get object information. C<TYPE> is one of C<domain>, C<host>, C<contact>. For domain objects, C<PARAMS> can be C<AUTHINFO HOSTS>, where C<AUTHINFO> is the domain's authInfo code, and C<HOSTS> is the value of the "hosts" attribute (ie C<all>, C<del>, C<sub> or C<none>). If you want to set C<HOSTS> but don't know the authinfo, use an empty quoted string (ie C<"">) as C<AUTHINFO>.
=item C<info TYPE OBJECT> - get object information. C<TYPE> is one of C<domain>, C<host>, C<contact>. For contact objects, C<PARAMS> can be the contact's authInfo.
=back =back
......
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