.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "ODFFILESEARCH 1p"
.TH ODFFILESEARCH 1p "2022-06-16" "perl v5.34.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
\&        odffilesearch \- File selection by keywords
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        odffilesearch \-R "D:\eDocuments\e*.odt" openoffice desktop XML
\&        
\&        produces the list of the ODF Text documents present in the given
\&        directory and its subdirectories, and containing the words
\&        "openoffice", "desktop" AND "XML"
\&        
\&        odffilesearch \-command "rm \-f %f" "*.ods *.odt" lost dismiss cancel
\&
\&        executes the "rm \-f filename" (i.e. deletes the file in a Unix system)
\&        for each ODT or ODS file present in the current directory
\&        and containing the words "lost", "dismiss" AND "cancel"
.Ve
.SH "USAGE"
.IX Header "USAGE"
.Vb 1
\&        odffilesearch [\-options] <file filter> <keyword list>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 4
\&        This utility allows the user to retrieve a list of files matching
\&        a given set of keywords or regular expressions. A file is selected
\&        when it contains, in its text and/or in its metadata (title, subject,
\&        keywords or description), all the given search strings.
\&
\&        The selected files are echoed to the standard output (one file per
\&        line), so this utility can be used as a filter piping its results
\&        to another program. Alternatively, a given shell command can be
\&        launched by the script each time a file matches, allowing on\-the\-fly
\&        processing of the selected documents.
\&
\&        The files filter may content one or more space\-separated paths.
\&        Each path may content jokers. So it\*(Aqs possible to explore several
\&        directories and/or several filename patterns. 
\&
\&        All the arguments after the file filter are processed as search
\&        criteria.
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.Vb 10
\&        \-R \-recursive
\&                include the subdirectories of each given search directory
\&        \-verbose \-trace \-debug
\&                echo some processing comments
\&        \-warnings
\&                activate the warning messages of the OpenOffice::OODoc API
\&        \-log <file>
\&                like \-verbose, but then messages are sent to the given file
\&                and don\*(Aqt pollute the standard output
\&        \-result <file>
\&        \-output <file>
\&                send the list of matching files to the given file and not
\&                to the standard output
\&        \-criteria <file>
\&                get search criteria from a file (one per line); the loaded
\&                search keywords may be combined with additional criteria
\&                passed with the command line, if any.
\&        \-command <command> \-exec <command>
\&                execute a shell command for each matching file ; if the
\&                command string contains "%f", this substring is replaced
\&                with the name of the selected file ; if this option is
\&                provided, the selection list is not echoed to the standard
\&                output ; if \-verbose is on, the value returned by the
\&                command is echoed
\&        \-encoding <encoding>
\&                selects the user\*(Aqs character set ; this option is mandatory
\&                if one or more search criteria contain characters not
\&                belonging to the default character set
.Ve