File: //usr/local/share/man/man1/cpandb.1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CPANDB 1"
.TH CPANDB 1 "2011-09-16" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
cpandb \- interface to \f(CW\*(C`CPAN::SQLite\*(C'\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This script is an interface to the routines of
CPAN::SQLite for setting up, maintaining and
searching a \f(CW\*(C`DBD::SQLite\*(C'\fR database
of \s-1CPAN\s0. Available options can be grouped into
three categories.
.Sh "Common options"
.IX Subsection "Common options"
These are options which are common to both setting up
and maintaining the database or performing queries on it.
These are
.ie n .IP "* ""\-\-CPAN '/path/to/CPAN'""" 3
.el .IP "* \f(CW\-\-CPAN '/path/to/CPAN'\fR" 3
.IX Item "--CPAN '/path/to/CPAN'"
This specifies the path to where the index files are
to be stored. This could be a local \s-1CPAN\s0 mirror,
defined here by the presence of a \fI\s-1MIRRORED\s0.BY\fR file beneath
this directory, or a local directory in which to store
these files from a remote \s-1CPAN\s0 mirror. In the latter case,
the index files are fetched from a remote \s-1CPAN\s0 mirror,
using the same list that \f(CW\*(C`CPAN.pm\*(C'\fR uses, if this is
configured, and are updated if they are more than one
day old.
.Sp
If the \f(CW\*(C`CPAN\*(C'\fR option is not given, it will default
to \f(CW\*(C`cpan_home\*(C'\fR of \s-1CPAN::\s0, if this is configured,
with the sources being found under \f(CW\*(C`keep_source_where\*(C'\fR.
A fatal error results if such a directory isn't found.
Updates to these index files are assumed here to be
handled by \f(CW\*(C`CPAN.pm\*(C'\fR.
.ie n .IP "* ""\-\-db_name 'cpan\-sqlite'""" 3
.el .IP "* \f(CW\-\-db_name 'cpan\-sqlite'\fR" 3
.IX Item "--db_name 'cpan-sqlite'"
This is the name of the database that \f(CW\*(C`DBD::SQLite\*(C'\fR
will use. If not given, this defaults to \f(CW\*(C`cpandb\-sqlite\*(C'\fR.
.ie n .IP "* ""\-\-db_dir '/path/to/db/dir'""" 3
.el .IP "* \f(CW\-\-db_dir '/path/to/db/dir'\fR" 3
.IX Item "--db_dir '/path/to/db/dir'"
This specifies the path to where the database file is
found. If not given, it defaults to the
\&\f(CW\*(C`cpan_home\*(C'\fR directory of \f(CW\*(C`CPAN.pm\*(C'\fR, if present, or to
the directory in which the script was invoked.
.Sh "Indexing options"
.IX Subsection "Indexing options"
These are options which are used for setting up and
maintaining the database. These include
.ie n .IP "* ""\-\-setup""" 3
.el .IP "* \f(CW\-\-setup\fR" 3
.IX Item "--setup"
This specifies that the database is to be created and
populated from the \s-1CPAN\s0 indices; any exisiting database
will be overwritten.
.ie n .IP "* ""\-\-update""" 3
.el .IP "* \f(CW\-\-update\fR" 3
.IX Item "--update"
This is used to update an exisiting database,
which must have first been created with the \f(CW\*(C`setup\*(C'\fR
option.
.ie n .IP "* ""\-\-reindex 'dist_name'""" 3
.el .IP "* \f(CW\-\-reindex 'dist_name'\fR" 3
.IX Item "--reindex 'dist_name'"
This specifies that the \s-1CPAN\s0 distribution \f(CW\*(C`dist_name\*(C'\fR
is to be reindexed.
.Sh "Querying options"
.IX Subsection "Querying options"
These options are used to query the database. Available
options are
.ie n .IP "* ""\-\-module Mod::Name""" 3
.el .IP "* \f(CW\-\-module Mod::Name\fR" 3
.IX Item "--module Mod::Name"
This provides information on the specified module name.
.ie n .IP "* ""\-\-dist Dist\-Name""" 3
.el .IP "* \f(CW\-\-dist Dist\-Name\fR" 3
.IX Item "--dist Dist-Name"
This provides information on the specified distribution name.
.ie n .IP "* ""\-\-cpanid CPANID""" 3
.el .IP "* \f(CW\-\-cpanid CPANID\fR" 3
.IX Item "--cpanid CPANID"
This provides information on the specified \s-1CPAN\s0 author id
.PP
All search terms are assumed to be exact matches in a
case-insensitive manner.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CPAN::SQLite.