-
-
22 Jul 2005 02:43:17 UTC
- Distribution: AnnoCPAN-Perldoc
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (2)
- Testers (556 / 88 / 0)
- Kwalitee
Bus factor: 0- 28.21% Coverage
- License: unknown
- Activity
24 month- Tools
- Download (3.77KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- DBD::SQLite
- DBI
- Digest::MD5
- IO::String
- Pod::Perldoc
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
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.
Module Install Instructions
To install AnnoCPAN::Perldoc, copy and paste the appropriate command in to your terminal.
cpanm AnnoCPAN::Perldoc
perl -MCPAN -e shell install AnnoCPAN::Perldoc
For more information on module installation, please visit the detailed CPAN module installation guide.