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  -  POD::ABSTRACT::FILTER::FIND (3)

.ds Aq ’

NAME

Pod::Abstract::Filter::find - paf command to find specific nodes that contain a string.

CONTENTS

DESCRIPTION

The intention of this filter is to allow a reduction of large Pod documents to find a specific function or method. You call paf find -f=function YourModule, and you get a small subset of nodes matching function.

For this to work, there has to be some assumptions about Pod structure. I am presuming that find is not useful if it returns anything higher than a head2, so as long as your module wraps function doco in a head2, head3, head4 or list item, we’re fine. If you use head1 then it won’t be useful.

In order to be useful as an end user tool, head1 nodes (...) are added between the found nodes. This stops perldoc from dying with no documentation. These can be easily stripped using: $pa->select(/head1), then hoist and detach, or reparent to other Node types.

A good example of this working as intended is:



 paf find select Pod::Abstract::Node



AUTHOR

Ben Lilburne <bnej@mac.com>

COPYRIGHT AND LICENSE

Copyright (C) 2009 Ben Lilburne

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

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


perl v5.20.3 POD::ABSTRACT::FILTER::FIND (3) 2010-01-03

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