1  .\"	$OpenBSD$
  2  .\"
  3  .\" Copyright (c) 2022 Aaron Bieber <abieber@openbsd.org>
  4  .\"
  5  .\" Permission to use, copy, modify, and distribute this software for any
  6  .\" purpose with or without fee is hereby granted, provided that the above
  7  .\" copyright notice and this permission notice appear in all copies.
  8  .\"
  9  .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 10  .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 11  .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 12  .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 13  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 14  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 15  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 16  .\"
 17  .Dd April 7, 2022
 18  .Dt PKG 8
 19  .Os
 20  .Sh NAME
 21  .Nm pkg
 22  .Nd a wraper for OpenBSD's pkg* tools
 23  .Sh SYNOPSIS
 24  .Nm
 25  .Op Ar delete Ar package
 26  .Op Ar info Ar package
 27  .Op Ar install Ar package
 28  .Op Ar pkginfo Ar package
 29  .Op Ar regen
 30  .Op Ar search Ar string
 31  .Sh DESCRIPTION
 32  .Nm
 33  is a
 34  .Xr perl 1
 35  script that allows easier package management and more extensive searching.
 36  .Pp
 37  .Nm
 38  uses
 39  .Xr sqlports 5 for quicker, full text searching of COMMENT and DESCR fields.
 40  .Pp
 41  The options are as follows:
 42  .Bl -tag -width Ds
 43  .It Ar delete package
 44  Deletes
 45  .Nm package .
 46  This is a wrapper for
 47  .Xr pkg_delete 1 .
 48  It is also aliased to
 49  .Nm del ,
 50  and
 51  .Nm rm .
 52  .It Ar info package
 53  Fetches
 54  .Nm package
 55  information.
 56  This is a wrapper for
 57  .Xr pkg_info 1
 58  .
 59  It is aliased to
 60  .Nm inf .
 61  .It Ar install package
 62  A wrapper for
 63  .Xr pkg_add 1 .
 64  Aliased to
 65  .Nm i .
 66  .It Ar pkginfo FULLPKGNAME
 67  Intended for use with tools like
 68  .Xr fzf 1 .
 69  This lets one quickly look up
 70  .Nm COMMENT
 71  and
 72  .Nm DESCRIPTION
 73  for a given
 74  .Nm FULLPKGNAME .
 75  Aliased to
 76  .Nm pi .
 77  .It Ar regen
 78  Regenerate the full text index.
 79  Aliased to
 80  .Nm re .
 81  .It Ar search string
 82  Search a packages
 83  .Nm COMMENT
 84  and
 85  .Nm DESCR
 86  for an arbitrary string.
 87  Returns
 88  .Nm FULLPKGNAME .
 89  .El
 90  .Sh HISTORY
 91  .Nm
 92  was written in 2001, removed from base in 2012, revived and enhanced in 2018
 93  and 2022.
 94  .Sh AUTHORS
 95  .An -nosplit
 96  .Nm
 97  was originally written by
 98  .An Marc Espie Aq Mt espie@openbsd.org .
 99  Rewrite by
100  .An Aaron Bieber Aq Mt abieber@openbsd.org .