15 Jun 2018 12:27:36 UTC
- Distribution: Pod-Sub-Usage
- Module version: 0.02001
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (458 / 0 / 44)
- KwaliteeBus factor: 0
- 88.46% Coverage
- License: artistic_2
- Perl: v5.10.0
- Activity24 month
- Download (7.77KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionMZIESCHA Mario Zieschang
- BUGS AND LIMITATIONS
- CONFIGURATION AND ENVIRONMENT
- SEE ALSO
- LICENSE AND COPYRIGHT
Pod::Sub::Usage - Module to print sub documentaion from pod!
use Pod::Sub::Usage qw/sub2usage/; # print header from 'your_sub' in current package sub2usage('your_sub'); # same here sub2usage('your_sub', __PACKAGE__); # print header from 'your_sub' in some other package sub2usage('your_sub', 'Use::Some::Package' );
Nothing is exported by default. You can ask for specific subroutines (described below) or ask for all subroutines at once:
use Pod::Sub::Usage qw/sub2usage/; # or use Pod::Sub::Usage qw/all/;
Print out the header information by given sub.
Returns the string from pod
<mziescha at cpan.org>
Please report any bugs or feature requests to
bug-pod-sub-usage at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Sub-Usage. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
AnnoCPAN: Annotated CPAN documentation
This package was partly inspired by on Pod::Usage by Marek Rouchal.
Copyright 2017 Mario Zieschang.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Module Install Instructions
To install Pod::Sub::Usage, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Pod::Sub::Usage
For more information on module installation, please visit the detailed CPAN module installation guide.