Zim::Store::Man.3pm

Langue: en

Version: 2009-03-16 (fedora - 05/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Zim::Store::Man - Man page store for zim

DESCRIPTION

This module can be used to read man pages in zim. It assumes that you have the GNU man program, if not it fails silently.

It derives from Zim::Store.

METHODS

"list_pages(NAMESPACE)"
Lists all manpages in a certain section.
"list_sections()"
Used by "list_pages()" when no section is given.
"get_page(NAME)"
Returns a page object for man page NAME.
"resolve_name(NAME, REF, EXIST)"
Case in-sensitive check whether a page exists or not. REF is ignored since man pages don't have relative links.
"man(ARGS)"
Runs the ``man'' command and returns output.
"open_man(ARGS)"
Runs the ``man'' command and returns a file handle.
"get_parse_tree()"
Returns parse tree for man page.
"set_parse_tree(TREE)"
Man pages can not be saved, thus it throws away all data.
"parse_link(LINK)"
Man pages contain no relative links, only absolute in same namespace.

AUTHOR

Jaap Karssenberg (Pardus) <pardus@cpan.org>

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

SEE ALSO

Zim::Store