1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/search.pod Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,84 @@
1.4 +##
1.5 +## search.pod -- OpenPKG Package Searching
1.6 +## Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>
1.7 +##
1.8 +## This software is property of the OpenPKG GmbH, DE MUC HRB 160208.
1.9 +## All rights reserved. Licenses which grant limited permission to use,
1.10 +## copy, modify and distribute this software are available from the
1.11 +## OpenPKG GmbH.
1.12 +##
1.13 +## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
1.14 +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.15 +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1.16 +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
1.17 +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.18 +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.19 +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1.20 +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
1.21 +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.22 +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
1.23 +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.24 +## SUCH DAMAGE.
1.25 +##
1.26 +
1.27 +=pod
1.28 +
1.29 +=head1 NAME
1.30 +
1.31 +B<openpkg search> - B<OpenPKG> Package Searching
1.32 +
1.33 +=head1 SYNOPSIS
1.34 +
1.35 +B<openpkg>
1.36 +B<search>
1.37 +[B<-r> I<resource>]
1.38 +[B<-v>]
1.39 +I<regex> ...
1.40 +
1.41 +=head1 DESCRIPTION
1.42 +
1.43 +The B<openpkg search> tool is a frontend for searching indexed RPM
1.44 +packages. It downloads XML/RDF based resource index files from an RPM
1.45 +package repository and does a regular expression based search on each
1.46 +package's name, summary and description texts.
1.47 +
1.48 +=head1 OPTIONS
1.49 +
1.50 +The following command line options exist:
1.51 +
1.52 +=over 4
1.53 +
1.54 +=item B<-r> I<repository>
1.55 +
1.56 +Specify the path to an OpenPKG RPM package repository.
1.57 +This can be a URL (including "file://") to download packages from or
1.58 +an absolute directory path (identified by leading "/") or
1.59 +a relative directory path (identified by leading "./") to access packages directly.
1.60 +The name of the package file is appended to this path.
1.61 +The default is to use a URL pointing to the B<OpenPKG> download service
1.62 +as determined by the "B<openpkg release>" command.
1.63 +
1.64 +=item B<-v>
1.65 +
1.66 +Produces itemized verbose output instead of the default brief tabular
1.67 +output.
1.68 +
1.69 +=back
1.70 +
1.71 +=head1 SEE ALSO
1.72 +
1.73 +index(8), build(8).
1.74 +
1.75 +=head1 HISTORY
1.76 +
1.77 +The B<openpkg search> command was invented in May 2012 by I<Ralf S.
1.78 +Engelschall> E<lt>rse@engelschall.comE<gt> for use inside the B<OpenPKG>
1.79 +project E<lt>http://www.openpkg.org/E<gt>.
1.80 +
1.81 +=head1 AUTHORS
1.82 +
1.83 + Ralf S. Engelschall
1.84 + rse@engelschall.com
1.85 +
1.86 +=cut
1.87 +
