• NAME
• SYNOPSYS
• DESCRIPTION
• SEE ALSO
• AUTHOR
• COPYRIGHT

NAME

annopod - a perldoc with annotations

SYNOPSYS

annopod [-h] [-v] [-t] [-u] [-m] [-l] [-F] [-i] [-V] [-T] [-r] [-ddestination_file] [-oformatname] [-MFormatterClassName] [-wformatteroption:value] [-nnroff-replacement] [-X] PageName|ModuleName|ProgramName

annopod -f BuiltinFunction

annopod -q FAQ Keyword

DESCRIPTION

The annopod program works exactly the same as perldoc, except that it looks for a local annotation database and inserts the annotations just before rendering the POD.

It works by using a local note database that can be downloaded from

    http://annocpan.org/annopod.db

This is an SQLite3 database; the file should be saved in one of these locations:

$HOME $USERPROFILE $ALLUSERSPROFILE /var/annocpan

It can also be called .annopod.db, to hide it in Unix-like systems. It is your resposibility to keep this file as up-to-date as you want. Future versions may include an automatic update feature (which will require network connectivity).

SEE ALSO

AnnoCPAN, AnnoCPAN::Perldoc, Pod::Perldoc

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.