.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PERLDIG 1p"
.TH PERLDIG 1p "2021-01-05" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
.Vb 1
\&    perldig \- Dig up keywords in the local Perl documentation
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&       # Update the index (required before first start)
\&    perldig \-u
\&
\&       # Search for a keyword
\&    perldig keyword(s)
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
When using \f(CW\*(C`perldig\*(C'\fR for the first time, a new index needs to be
created. Just call
.PP
.Vb 1
\&    $ perldig \-u
.Ve
.PP
and everything happens automatically: A crawler will detect locally
installed Perl documentation pages, rummage through the \s-1POD\s0 and index
them. When this initial run has been completed, \f(CW\*(C`perldig\*(C'\fR is ready to
process search requests:
.PP
.Vb 1
\&  $ perldig frobnicate
\&
\&  1) pod/perlguts.pod    2) pod/perlxstut.pod   3) pod/perlnewmod.pod
\&
\&  Enter number of choice:
.Ve
.PP
The command above shows a search for the keyword \f(CW\*(C`frobnicate\*(C'\fR. Yes,
that's a word used in the Perl documentation! It shows three hits and
asks the user to enter a number between 1 and 3 to open the selected
documentation page in a pager program (typically \f(CW\*(C`less\*(C'\fR). In there,
an in-text search for the expression can be started by using the \f(CW\*(C`/\*(C'\fR
(slash) command.
.PP
If two or more keywords are given, the search will yield pages that
contain all of them. When searching for phrases, please include quotes
(make sure to quote the quotes so the shell doesn't eat them):
.PP
.Vb 1
\&   $ perldig \*(Aq"floating point"\*(Aq
.Ve
.PP
The underlying \fIswish-e\fR search engine also understands expressions
connected via \s-1AND\s0 and \s-1OR:\s0
.PP
.Vb 1
\&  $ perldig "\*(Aqfloating point\*(Aq AND approximate AND \*(Aqreal number\*(Aq"
.Ve
.PP
To keep the index up to date, it is probably a good idea to run a
cronjob every morning:
.PP
.Vb 1
\&    00 4 * * * /usr/bin/perldig \-u >/dev/null 2>&1
.Ve
.PP
If you can read German, please check out this article in the \*(L"Linux\-
Magazin\*(R", where this script was originally published:
.PP
.Vb 1
\&    http://www.linux\-magazin.de/Artikel/ausgabe/2003/10/perl/perl.html
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\&    # Update/create the index 
\&  $ perldig \-u
\&  
\&  $ perldig frobnicate
\&
\&  1) pod/perlguts.pod    2) pod/perlxstut.pod   3) pod/perlnewmod.pod  
\&
\&  Enter number of choice: 1
\&  [ ... perlguts man page shows ... ]
.Ve
.SH "FILES"
.IX Header "FILES"
\&\f(CW\*(C`perldig\*(C'\fR puts the \fIswish-e\fR index files into the folder \f(CW\*(C`.perldig\*(C'\fR
in the user's home directory.
.SH "LEGALESE"
.IX Header "LEGALESE"
Copyright 2003\-2005 by Mike Schilli, all rights reserved.
This program is free software, you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
2003, Mike Schilli <m@perlmeister.com>