Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod::index::search(3pm) [debian man page]

Pod::Index::Search(3pm) 				User Contributed Perl Documentation				   Pod::Index::Search(3pm)

NAME

       Pod::Index::Search - Search for keywords in an indexed pod

SYNOPSIS

	   use Pod::Index::Search;

	   my $q = Pod::Index::Search->new;

	   my @results = $q->search('getprotobyname');

	   for my $r (@results) {
	       printf "%s	%s
", $r->podname, $r->line;
	       print $r->pod;
	   }

	   my @subtopics = $q->subtopics('operator');

DESCRIPTION

       This module searches an index created by Pod::Index::Builder. Search results are returned as Pod::Index::Entry objects.

       It is also possible to search for subtopics for a keyword. For example, a search for "operator" might return things like

	   operator, conditional
	   operator, filetest
	   operator, logical
	   operator, precedence
	   operator, relational

       The subtopics returned are simple strings.

METHODS

       new
	       my $q = Pod::Index::Search->new(%args);

	   Create a new search object. Possible arguments are:

	   "fh"
	       The filehandle of the index to use. If omitted, "perlindex::DATA" is used.

	   "filename"
	       The filename of the index to use. Note that you can specify either "fh" or filename, but not both.

	   "filemap"
	       A subroutine reference that takes a podname and returns a filename. A simple example might be:

		   sub {
		       my $podname = shift;
		       return "/usr/lib/perl5/5.8.7/pod/$podname.pod";
		   }

	       The podname is in colon-delimited Perl package syntax.

	       The default "filemap" returns the first file in @INC that seems to have the proper documentation (either a .pod or .pm file).

	   "nocase"
	       If true, the search will be case-insensitive.

       search($keyword)
	   Do the actual search in the index.  Returns a list of search results, as Pod::Index::Entry objects.

       subtopics($keyword, %options)
	       my @topics = $q->subtopics('operator');
	       my @topics = $q->subtopics('operator', deep => 1);

	   Lists the subtopics for a given keyword. If "deep" is given, it includes all subtopics; otherwise, only the first level of subtopics is
	   included.

VERSION

       0.14

SEE ALSO

       Pod::Index::Entry, Pod::Index::Builder

AUTHOR

       Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

       Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is free software; you can redistribute it and/or modify it under
       the same terms as Perl itself.

perl v5.10.0							    2005-10-16						   Pod::Index::Search(3pm)

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)
Man Page