GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOOX::OPTIONS::MANUAL::MAN (3)

.ds Aq ’

NAME

MooX::Options::Manual::Man - More documentation for the man option

CONTENTS

VERSION

version 4.008

DESCRIPTION

You can add more documentation for the man option. This is the long option.

SYNOPSIS



  myTool --man



PARAMETERS

    description

The description of your tool.



  use MooX::Options description => Description of your tools



    authors

The list of authors of your tool.



  use MooX::Options authors => Celogeek <me@celogeek.com>
  use MooX::Options authors => [Celogeek <me@celogeek.com, Jens Rehsack]



    synopsis

You can define a full example in pod format. This will be placed in the synopsis section



  use MooX::Options synopsis => 
    A example of my tools

      myTool --run
  



This should not be very easy to do it this way, but you can also extract it from your own script :



  use Moo;
  use Pod::POM;
  my $synopsis = "";
  BEGIN {
      my $parser = Pod::POM->new;
      my $pom = $parser->parse(__FILE__) or die $parser->error();
      for my $head1 ($pom->head1) {
          if ($head1->title eq SYNOPSIS) {
              $synopsis = $head1->content;
              last;
          }
      }
  }
  use MooX::Options synopsis => $synopsis;



OPTIONS

    long_doc

If a ’long_doc’ parameter is present, it will replace the ’doc’ or ’documentation’ to generate a long doc for the man page.



  option foo => (
    is => ro,
    doc => bar,
    long_doc => this is a bar example that will appear in my man page,
  );



The ’long_doc’ will be write in place of the pod documentation. All the rules of pod, is applied. For instance, to add a new paragraph, you need to let a empty line.



  option foo => (
    is => ro,
    doc => bar,
    long_doc => join("\n\n", "first paragraph", "second paragraph"),
  );



See the perlpod for more explanation.

SEE ALSO

MooX::Options

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/celogeek/MooX-Options/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

celogeek <me@celogeek.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by celogeek <me@celogeek.com>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOOX::OPTIONS::MANUAL::MAN (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.