9f8ee59edaf5b259d6cea4abfb8e18a4cdb792dd
[dragonfly.git] / usr.bin / pkg_search / pkg_search.1
1 .\"-
2 .\" Copyright (c) 2007-08 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 August 29, 2008
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 .Sh DESCRIPTION
49 .Nm
50 queries the
51 .Xr pkgsrc 7
52 index for a given
53 .Ar package .
54 If the
55 .Xr pkgsrc 7
56 index is not available
57 .Nm
58 fetches the
59 .Xr pkg_summary 5
60 file.
61 This file contains information about each package in a binary repository.
62 .Pp
63 The options are as follows:
64 .Bl -tag -width indent
65 .It Fl k
66 Also query the Info and WWW field.
67 .It Fl s
68 Show the description of a package.
69 .It Fl v
70 Print verbose information (Ports directory, URL, depencies)
71 .El
72 .Sh EXAMPLES
73 The following is an example of a typical usage
74 of the
75 .Nm
76 command:
77 .Pp
78 .Dl "pkg_search -v fvwm"
79 .Sh SEE ALSO
80 .Xr pkg_add 1 ,
81 .Xr pkg_create 1 ,
82 .Xr pkg_delete 1 ,
83 .Xr pkg_info 1 ,
84 .Xr pkg_summary 5 ,
85 .Xr pkgsrc 7
86 .Sh AUTHORS
87 .Nm
88 was written by
89 .An Matthias Schmidt Aq matthias@dragonflybsd.org .
90 .Sh HISTORY
91 The
92 .Nm
93 utility first appeared in
94 .Dx 1.11 .