ac0b44dde58f98b65d90b3f0e1b299296513ab4a
[dragonfly.git] / usr.bin / pkg_search / pkg_search.1
1 .\"-
2 .\" Copyright (c) 2007-09 The DragonFly Project.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to The DragonFly Project
5 .\" by Matthias Schmidt <matthias@dragonflybsd.org>, University of Marburg.
6 .\"
7 .\" All rights reserved.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions are met:
11 .\"
12 .\" - Redistributions of source code must retain the above copyright notice,
13 .\"   this list of conditions and the following disclaimer.
14 .\" - Redistributions in binary form must reproduce the above copyright notice,
15 .\"   this list of conditions and the following disclaimer in the documentation
16 .\"   and/or other materials provided with the distribution.
17 .\" - Neither the name of The DragonFly Project nor the names of its
18 .\"   contributors may be used to endorse or promote products derived
19 .\"   from this software without specific, prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 .\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 .\"
33 .\" $DragonFly: src/usr.bin/pkg_search/pkg_search.1,v 1.11 2008/09/04 10:33:50 matthias Exp $
34 .\"
35 .Dd February 8, 2009
36 .Dt PKG_SEARCH 1
37 .Os
38 .Sh NAME
39 .Nm pkg_search
40 .Nd print information about a package
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl kv
44 .Ar package
45 .Nm
46 .Fl s
47 .Ar package
48 .Nm
49 .Fl d
50 .Sh DESCRIPTION
51 .Nm
52 queries the
53 .Xr pkgsrc 7
54 index for a given
55 .Ar package .
56 If the
57 .Xr pkgsrc 7
58 index is not available
59 .Nm
60 fetches the
61 .Xr pkg_summary 5
62 file.
63 This file contains information about each package in a binary repository.
64 .Pp
65 The options are as follows:
66 .Bl -tag -width indent
67 .It Fl d
68 Download the
69 .Xr pkg_summary 5
70 file.
71 It gets overwritten if it is already installed.
72 .It Fl k
73 Also query the Info and WWW field.
74 .It Fl s
75 Show the description of a package.
76 .It Fl v
77 Print verbose information (Ports directory, URL, depencies)
78 .El
79 .Sh EXAMPLES
80 The following is an example of a typical usage
81 of the
82 .Nm
83 command:
84 .Pp
85 .Dl "pkg_search -v fvwm"
86 .Sh SEE ALSO
87 .Xr pkg_add 1 ,
88 .Xr pkg_create 1 ,
89 .Xr pkg_delete 1 ,
90 .Xr pkg_info 1 ,
91 .Xr pkg_summary 5 ,
92 .Xr pkgsrc 7
93 .Sh AUTHORS
94 .Nm
95 was written by
96 .An Matthias Schmidt Aq matthias@dragonflybsd.org .
97 .Sh HISTORY
98 The
99 .Nm
100 utility first appeared in
101 .Dx 1.11 .