2b6a0771ca872e14fe9c989807e37e8af1ae48bb
[pkgsrc.git] / pkgtools / pkg_install / files / view / pkg_view.cat1
1 PKG_VIEW(1)             NetBSD General Commands Manual             PKG_VIEW(1)
2
3 N\bNA\bAM\bME\bE
4      p\bpk\bkg\bg_\b_v\bvi\bie\bew\bw -- add and delete instances of depoted packages in views
5
6 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
7      p\bpk\bkg\bg_\b_v\bvi\bie\bew\bw [-\b-n\bnV\bVv\bv] [-\b-d\bd _\bs_\bt_\bo_\bw_\bd_\bi_\br] [-\b-i\bi _\bi_\bg_\bn_\bo_\br_\be] [-\b-k\bk _\bp_\bk_\bg_\b__\bd_\bb_\bd_\bi_\br] [-\b-W\bW _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be]
8               [-\b-w\bw _\bv_\bi_\be_\bw] _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bp_\ba_\bc_\bk_\ba_\bg_\be _\b._\b._\b.
9
10 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
11      The p\bpk\bkg\bg_\b_v\bvi\bie\bew\bw command is used to add and delete instances of depoted pack-
12      ages in _\bs_\bt_\bo_\bw_\bd_\bi_\br in a _\bv_\bi_\be_\bw in the _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be directory.
13
14 W\bWA\bAR\bRN\bNI\bIN\bNG\bG
15      _\bS_\bi_\bn_\bc_\be _\bt_\bh_\be p\bpk\bkg\bg_\b_v\bvi\bie\bew\bw _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bm_\ba_\by _\be_\bx_\be_\bc_\bu_\bt_\be _\bs_\bc_\br_\bi_\bp_\bt_\bs _\bo_\br _\bp_\br_\bo_\bg_\br_\ba_\bm_\bs _\bp_\br_\bo_\bv_\bi_\bd_\be_\bd _\bb_\by _\ba
16      _\bp_\ba_\bc_\bk_\ba_\bg_\be _\bf_\bi_\bl_\be_\b, _\by_\bo_\bu_\br _\bs_\by_\bs_\bt_\be_\bm _\bm_\ba_\by _\bb_\be _\bs_\bu_\bs_\bc_\be_\bp_\bt_\bi_\bb_\bl_\be _\bt_\bo _\b`_\b`_\bT_\br_\bo_\bj_\ba_\bn _\bh_\bo_\br_\bs_\be_\bs_\b'_\b' _\bo_\br
17      _\bo_\bt_\bh_\be_\br _\bs_\bu_\bb_\bt_\bl_\be _\ba_\bt_\bt_\ba_\bc_\bk_\bs _\bf_\br_\bo_\bm _\bm_\bi_\bs_\bc_\br_\be_\ba_\bn_\bt_\bs _\bw_\bh_\bo _\bc_\br_\be_\ba_\bt_\be _\bd_\ba_\bn_\bg_\be_\br_\bo_\bu_\bs _\bp_\ba_\bc_\bk_\ba_\bg_\be _\bf_\bi_\bl_\be_\bs_\b.
18
19      _\bY_\bo_\bu _\ba_\br_\be _\ba_\bd_\bv_\bi_\bs_\be_\bd _\bt_\bo _\bv_\be_\br_\bi_\bf_\by _\bt_\bh_\be _\bc_\bo_\bm_\bp_\be_\bt_\be_\bn_\bc_\be _\ba_\bn_\bd _\bi_\bd_\be_\bn_\bt_\bi_\bt_\by _\bo_\bf _\bt_\bh_\bo_\bs_\be _\bw_\bh_\bo _\bp_\br_\bo_\b-
20      _\bv_\bi_\bd_\be _\bi_\bn_\bs_\bt_\ba_\bl_\bl_\ba_\bb_\bl_\be _\bp_\ba_\bc_\bk_\ba_\bg_\be _\bf_\bi_\bl_\be_\bs_\b.  _\bF_\bo_\br _\be_\bx_\bt_\br_\ba _\bp_\br_\bo_\bt_\be_\bc_\bt_\bi_\bo_\bn_\b, _\be_\bx_\ba_\bm_\bi_\bn_\be _\ba_\bl_\bl _\bt_\bh_\be
21      _\bp_\ba_\bc_\bk_\ba_\bg_\be _\bc_\bo_\bn_\bt_\br_\bo_\bl _\bf_\bi_\bl_\be_\bs _\bi_\bn _\bt_\bh_\be _\bp_\ba_\bc_\bk_\ba_\bg_\be _\bd_\ba_\bt_\ba_\bb_\ba_\bs_\be _\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\by
22      _\b(_\b/_\bu_\bs_\br_\b/_\bp_\bk_\bg_\b/_\bp_\ba_\bc_\bk_\ba_\bg_\be_\bs_\b/_\b<_\bp_\bk_\bg_\b-_\bn_\ba_\bm_\be_\b>_\b/_\b)_\b.  _\bP_\ba_\by _\bp_\ba_\br_\bt_\bi_\bc_\bu_\bl_\ba_\br _\ba_\bt_\bt_\be_\bn_\bt_\bi_\bo_\bn _\bt_\bo _\ba_\bn_\by
23      _\b+_\bI_\bN_\bS_\bT_\bA_\bL_\bL _\bo_\br _\b+_\bD_\bE_\bI_\bN_\bS_\bT_\bA_\bL_\bL _\bf_\bi_\bl_\be_\bs_\b, _\ba_\bn_\bd _\bi_\bn_\bs_\bp_\be_\bc_\bt _\bt_\bh_\be _\b+_\bC_\bO_\bN_\bT_\bE_\bN_\bT_\bS _\bf_\bi_\bl_\be _\bf_\bo_\br @\b@c\bcw\bwd\bd_\b,
24      @\b@m\bmo\bod\bde\be _\b(_\bc_\bh_\be_\bc_\bk _\bf_\bo_\br _\bs_\be_\bt_\bu_\bi_\bd_\b)_\b, @\b@d\bdi\bir\brr\brm\bm_\b, @\b@e\bex\bxe\bec\bc_\b, _\ba_\bn_\bd @\b@u\bun\bne\bex\bxe\bec\bc _\bd_\bi_\br_\be_\bc_\bt_\bi_\bv_\be_\bs_\b, _\ba_\bn_\bd_\b/_\bo_\br
25      _\bu_\bs_\be _\bt_\bh_\be pkg_info(_\b1) _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bt_\bo _\be_\bx_\ba_\bm_\bi_\bn_\be _\bt_\bh_\be _\bi_\bn_\bs_\bt_\ba_\bl_\bl_\be_\bd _\bp_\ba_\bc_\bk_\ba_\bg_\be _\bc_\bo_\bn_\bt_\br_\bo_\bl
26      _\bf_\bi_\bl_\be_\bs_\b.
27
28 O\bOP\bPT\bTI\bIO\bON\bNS\bS
29      The following command-line options are supported:
30
31      -\b-d\bd _\bs_\bt_\bo_\bw_\bd_\bi_\br
32              Set _\bs_\bt_\bo_\bw_\bd_\bi_\br as the directory in which the depoted packages can be
33              found.  If this option isn't specified, then the _\bs_\bt_\bo_\bw_\bd_\bi_\br is taken
34              from the value of the environment variable DEPOTBASE if it's set,
35              otherwise the default _\bs_\bt_\bo_\bw_\bd_\bi_\br is the path to the _\bp_\ba_\bc_\bk_\ba_\bg_\be_\bs direc-
36              tory under _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be.
37
38      -\b-i\bi _\bi_\bg_\bn_\bo_\br_\be
39              Add _\bi_\bg_\bn_\bo_\br_\be to the list of files in _\bp_\ba_\bc_\bk_\ba_\bg_\be that should ignored
40              when adding or removing the package instance from _\bv_\bi_\be_\bw.
41
42      -\b-k\bk _\bp_\bk_\bg_\b__\bd_\bb_\bd_\bi_\br
43              Set _\bp_\bk_\bg_\b__\bd_\bb_\bd_\bi_\br as the package database directory for the default
44              (empty) view.  If this option isn't specified, then the package
45              database directory is taken from the value of the environment
46              variable PKG_DBDIR, otherwise it defaults to _\b/_\bv_\ba_\br_\b/_\bd_\bb_\b/_\bp_\bk_\bg.
47
48      -\b-n\bn      Don't actually execute the commands for manipulating the package
49              instances.
50
51      -\b-V\bV      Print the version number and exit.
52
53      -\b-v\bv      Turn on verbose output.  Specifying -\b-v\bv multiple times increases
54              the level of verbosity.
55
56      -\b-W\bW _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be
57              Set _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be as the directory in which all the views are managed.
58              The default _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be directory is _\b/_\bu_\bs_\br_\b/_\bp_\bk_\bg but may be overridden
59              by the LOCALBASE environment variable.
60
61      -\b-w\bw _\bv_\bi_\be_\bw
62              Set _\bv_\bi_\be_\bw as the directory in _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be in which the package
63              instances should be added or deleted.  The default _\bv_\bi_\be_\bw is the
64              empty view but may be overridden by the PKG_VIEW environment
65              variable.
66
67      The following commands are supported:
68
69      a\bad\bdd\bd     Add the listed package instances into _\bv_\bi_\be_\bw.
70
71      c\bch\bhe\bec\bck\bk   Check whether the listed package instances are present in _\bv_\bi_\be_\bw.
72              If they are not present, then return 0, otherwise return 1.
73
74      d\bde\bel\ble\bet\bte\be  Delete the listed package instances from _\bv_\bi_\be_\bw.
75
76 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
77      DEPOTBASE
78              This is the location of the _\bs_\bt_\bo_\bw_\bd_\bi_\br directory inside which all
79              depoted packages are kept.  The default _\bs_\bt_\bo_\bw_\bd_\bi_\br is the _\bp_\ba_\bc_\bk_\ba_\bg_\be_\bs
80              directory under _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be.
81
82      LOCALBASE
83              This is the location of the _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be directory in which all the
84              views are managed.  The default _\bv_\bi_\be_\bw_\bb_\ba_\bs_\be directory is _\b/_\bu_\bs_\br_\b/_\bp_\bk_\bg.
85
86      PKG_DBDIR
87              If the -\b-k\bk flag isn't given, then the value of the environment
88              variable PKG_DBDIR is the package database directory for the
89              default view, otherwise it defaults to _\b/_\bv_\ba_\br_\b/_\bd_\bb_\b/_\bp_\bk_\bg.
90
91      PLIST_IGNORE_FILES
92              This can be used to specify files in _\bp_\ba_\bc_\bk_\ba_\bg_\be that should ignored
93              when adding or removing the package instance from _\bv_\bi_\be_\bw.
94              PLIST_IGNORE_FILES is a space-separated list of shell glob pat-
95              terns that match files relative to the _\bp_\ba_\bc_\bk_\ba_\bg_\be depot directory,
96              and it defaults to "info/dir *[~#] *.OLD *.orig *,v".  This is
97              overridden by any _PLIST_IGNORE_FILES setting in a package's
98              _\bb_\bu_\bi_\bl_\bd_\b-_\bi_\bn_\bf_\bo_\b-_\bf_\bi_\bl_\be (see pkg_create(1)) if it exists.
99
100      PKG_VIEW
101              The default view can be specified in the PKG_VIEW environment
102              variable.
103
104 F\bFI\bIL\bLE\bES\bS
105      <pkg-dbdir>/<package>/+INSTALL
106              If the package contains an _\bi_\bn_\bs_\bt_\ba_\bl_\bl script (see pkg_create(1)),
107              then after the package instance is added into a view, the script
108              is executed with the following arguments:
109
110              _\bp_\ba_\bc_\bk_\ba_\bg_\be  The name of the package instance being added.
111
112              V\bVI\bIE\bEW\bW-\b-I\bIN\bNS\bST\bTA\bAL\bLL\bL
113                       Keyword denoting that the script is to perform any
114                       actions needed after the package instance is added to a
115                       view.
116
117              If the _\bi_\bn_\bs_\bt_\ba_\bl_\bl script exits with a non-zero status code, the
118              installation is terminated.
119
120      <pkg-dbdir>/<package>/+DEINSTALL
121              If the package contains an _\bd_\be_\bi_\bn_\bs_\bt_\ba_\bl_\bl script (see pkg_create(1)),
122              then before the package instance is deleted from a view, the
123              script is executed with the following arguments:
124
125              _\bp_\ba_\bc_\bk_\ba_\bg_\be  The name of the package instance being deleted.
126
127              V\bVI\bIE\bEW\bW-\b-D\bDE\bEI\bIN\bNS\bST\bTA\bAL\bLL\bL
128                       Keyword denoting that the script is to perform any
129                       actions needed before the package instance is deleted
130                       from a view.
131
132              If the _\bd_\be_\bi_\bn_\bs_\bt_\ba_\bl_\bl script exits with a non-zero status code, the
133              de-installation is terminated.
134
135      The _\bi_\bn_\bs_\bt_\ba_\bl_\bl and _\bd_\be_\bi_\bn_\bs_\bt_\ba_\bl_\bl scripts are called with the environment vari-
136      able PKG_PREFIX set to the path to the _\bv_\bi_\be_\bw directory.
137
138 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
139      linkfarm(1), pkg_delete(1)
140
141 A\bAU\bUT\bTH\bHO\bOR\bRS\bS
142      The p\bpk\bkg\bg_\b_v\bvi\bie\bew\bw utility was written by Alistair G. Crooks <agc@NetBSD.org>.
143
144 NetBSD 4.0                     September 8, 2003                    NetBSD 4.0