/ docs / pkg-shell.8
pkg-shell.8
 1  .\"
 2  .\" FreeBSD pkg - a next generation package for the installation and maintenance
 3  .\" of non-core utilities.
 4  .\"
 5  .\" Redistribution and use in source and binary forms, with or without
 6  .\" modification, are permitted provided that the following conditions
 7  .\" are met:
 8  .\" 1. Redistributions of source code must retain the above copyright
 9  .\"    notice, this list of conditions and the following disclaimer.
10  .\" 2. Redistributions in binary form must reproduce the above copyright
11  .\"    notice, this list of conditions and the following disclaimer in the
12  .\"    documentation and/or other materials provided with the distribution.
13  .\"
14  .\"
15  .\"     @(#)pkg.8
16  .\"
17  .Dd November 18, 2014
18  .Dt PKG-SHELL 8
19  .Os
20  .Sh NAME
21  .Nm "pkg shell"
22  .Nd interact with the pkg database
23  .Sh SYNOPSIS
24  .Nm
25  .Sh DESCRIPTION
26  .Nm
27  is used to interact with the local or remote database through a sqlite3 console.
28  Extreme care should be taken when using this command.
29  .Pp
30  Do not rely on this command.
31  The underlying schema is subject to change on any release.
32  Use
33  .Xr pkg-query 8 ,
34  .Xr pkg-rquery 8 ,
35  .Xr pkg-search 8
36  and
37  .Xr pkg-set 8
38  instead for querying and modifying the database.
39  These commands are expected to have a stable API, unlike the database schema.
40  .Sh ENVIRONMENT
41  The following environment variables affect the execution of
42  .Nm .
43  See
44  .Xr pkg.conf 5
45  for further description.
46  .Bl -tag -width ".Ev NO_DESCRIPTIONS"
47  .It Ev PKG_DBDIR
48  .El
49  .Sh FILES
50  See
51  .Xr pkg.conf 5 .
52  .Sh SEE ALSO
53  .Xr pkg_create 3 ,
54  .Xr pkg_printf 3 ,
55  .Xr pkg_repo_create 3 ,
56  .Xr pkg_repos 3 ,
57  .Xr pkg-keywords 5 ,
58  .Xr pkg-lua-script 5 ,
59  .Xr pkg-repository 5 ,
60  .Xr pkg-script 5 ,
61  .Xr pkg-triggers 5 ,
62  .Xr pkg.conf 5 ,
63  .Xr pkg 8 ,
64  .Xr pkg-add 8 ,
65  .Xr pkg-alias 8 ,
66  .Xr pkg-annotate 8 ,
67  .Xr pkg-audit 8 ,
68  .Xr pkg-autoremove 8 ,
69  .Xr pkg-check 8 ,
70  .Xr pkg-clean 8 ,
71  .Xr pkg-config 8 ,
72  .Xr pkg-create 8 ,
73  .Xr pkg-delete 8 ,
74  .Xr pkg-fetch 8 ,
75  .Xr pkg-help 8 ,
76  .Xr pkg-info 8 ,
77  .Xr pkg-install 8 ,
78  .Xr pkg-key 8 ,
79  .Xr pkg-lock 8 ,
80  .Xr pkg-plugins 8 ,
81  .Xr pkg-query 8 ,
82  .Xr pkg-register 8 ,
83  .Xr pkg-repo 8 ,
84  .Xr pkg-repositories 8 ,
85  .Xr pkg-rquery 8 ,
86  .Xr pkg-search 8 ,
87  .Xr pkg-set 8 ,
88  .Xr pkg-shlib 8 ,
89  .Xr pkg-ssh 8 ,
90  .Xr pkg-stats 8 ,
91  .Xr pkg-triggers 8 ,
92  .Xr pkg-unregister 8 ,
93  .Xr pkg-update 8 ,
94  .Xr pkg-updating 8 ,
95  .Xr pkg-upgrade 8 ,
96  .Xr pkg-version 8 ,
97  .Xr pkg-which 8