paf(1p) [debian man page]

PAF(1p) 						User Contributed Perl Documentation						   PAF(1p)

NAME

       paf - Pod Abstract Filter. Transform Pod documents from the command line.

SYNOPSIS

	sh$>
	 paf summary /usr/bin/paf
	 paf add_podcmds SomeModule.pm
	 paf sort -heading=METHODS Pod/Abstract/Node.pm # METHODS is default
	 paf sort summary Pod/Abstract/Node.pm

	 # See Pod::Abstract::Filter::overlay
	 paf overlay sort cut clear_podcmds SomeClass.pm

	 # -p will emit pod source, instead of spawning perldoc.
	 paf -p sort Pod::Abstract::Node
	 paf -p find hoist Pod::Abstract::Node

DESCRIPTION

       Paf is a small but powerful, modular Pod filter and transformation tool. It allows full round-trip transformation of Pod documents using
       the Pod::Abstract library, with multiple filter chains without having to serialise/re-parse the document at each step.

       Paf comes with a small set of useful filters, but can be extended by simply writing new classes in the "Pod::Abstract::Filter" namespace.

FILTERS

   add_podcmds
       Add explicit =pod commands at the end of each cut section, so that all pod sections are started with an =pod command.

   clear_podcmds
       Remove all =pod commands that are not ending cut blocks. This will clean up documents that have been reduced using the "cut" filter too.

   cut
       Remove all cut nodes, so that only the pod remains.

   overlay
	paf overlay Source.pm

       For overlay to work, there must be a "begin :overlay/end :overlay" section in the Source file, with "=overlay SECTION Module" definitions
       inside. The net effect is that any missing subheadings in SECTION are added from the same section in the specified Modules.

       Note that this will overlay the whole subheading, INCLUDING CUT NODES, so it can add code to the source document. Use "cut" if you don't
       want this.

       Each overlaid section will include a "=for overlay from" marker, so that it can be replaced by a subsequent overlay from the same
       file/module. These sections will be replaced in-place, so ordering of sections once first overlaid will be preserved.

   unoverlay
	paf unoverlay Source.pm

       Strips all sections marked as overlaid and matching the overlay spec from the source.

   sort
	paf sort [-heading=METHODS] Source.pm

       Sort all of the subheadings in the named heading (METHODS if not provided).

       This will move cut nodes around with their headings, so your code will mutate. Use "cut" if you only want pod in the output.

       Alternatively, you can also cause sorting of headings to occur by including "=for sorting" at the start of your section (before the first
       subheading).

   summary
       Provide an abbreviated summary of the document. If there is a verbatim node in the body of a heading containing the heading name, it will
       be considered an example and expanded as part of the summary.

   find
	paf find [-f=]name Source.pm

       Find specific sub-sections or list items mentioning name. Used to restrict a larger document down to a smaller set that you're interested
       in. If no -f is specified, then the word following find will be the search term.

   uncut
	paf uncut Source.pm

       Convert cut nodes in the source into verbatim text. Not the inverse of cut!

   number_sections
	paf number_sections Source.pm

       Applies simple multipart (3.1.2) section numbering to head1 through head4 headings.

       Note that number_sections will currently stuff up some of the cleverness in things like summary, as the section names won't match function
       names any more.

perl v5.10.1							    2010-01-03								   PAF(1p)

Check Out this Related Man Page

Pod::Tree::Pod(3pm)					User Contributed Perl Documentation				       Pod::Tree::Pod(3pm)

NAME

       Pod::Tree::Pod - Convert a Pod::Tree back to a POD

SYNOPSIS

	 use Pod::Tree::Pod;

	 $tree =  new Pod::Tree;

	 $dest =  new IO::File;
	 $dest = "file.pod";

	 $pod  =  new Pod::Tree::Pod $tree, $dest;

	 $pod->translate;

DESCRIPTION

       "Pod::Tree::Pod" converts a Pod::Tree back to a POD.  The destination is fixed when the object is created.  The "translate" method does the
       actual translation.

       For convenience, Pod::Tree::Pod can write the POD to a variety of destinations.	The "new" method resolves the $dest argument.

   Destination resolution
       "Pod::Tree::Pod" can write HTML to either of 2 destinations.  "new" resolves $dest by checking these things, in order:

       1.  If $dest is a reference, then it is taken to be an "IO::File" object that is already open on the file where the POD will be written.

       2.  If $dest is not a reference, then it is taken to be the name of the file where the POD will be written.

METHODS

       $pod = "new" "Pod::Tree::Pod" $tree, $dest
	   Creates a new "Pod::Tree::Pod" object.

	   $tree is a "Pod::Tree" object that represents a POD.  $pod writes the POD to $dest.	See "Destination resolution" for details.

       $pod->"translate"
	   Writes the text of the POD.	This method should only be called once.

DIAGNOSTICS

       "Pod::Tree::Pod::new: not enough arguments"
	   (F) "new" called with fewer than 2 arguments.

       "Pod::Tree::HTML::new: Can't open $dest: $!"
	   (F) The destination file couldn't be opened.

NOTES

       o   The destination doesn't actually have to be an "IO::File" object.  It may be any object that has a "print" method.

SEE ALSO

       perl(1), "Pod::Tree", "Pod::Tree::Node"

AUTHOR

       Steven McDougall, swmcd@world.std.com

COPYRIGHT

       Copyright (c) 2000-2003 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as
       Perl itself.

perl v5.10.1							    2004-10-11						       Pod::Tree::Pod(3pm)

Linux and UNIX Man Pages

paf(1p) [debian man page]

Check Out this Related Man Page