Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 193 lines (192 sloc) 5.113 kb
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
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:
34fd706 @dnaeon Fix man pages license numbering and dates after moving to section 8
dnaeon authored
8 .\" 1. Redistributions of source code must retain the above copyright
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
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 .\"
5aebcc7 @bapt s/pkg.1/pkg.8/g
bapt authored
15 .\" @(#)pkg.8
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
16 .\" $FreeBSD$
17 .\"
32323b7 @bdrewery Add pkg install -d to register the installed packages as automatic.
bdrewery authored
18 .Dd July 26, 2012
3556541 @bapt man pages should be in section 8, not 1
bapt authored
19 .Dt PKG-INSTALL 8
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
20 .Os
21 .Sh NAME
22 .Nm "pkg install"
4bd4310 @toddnni Reworked man pages
toddnni authored
23 .Nd installs packages from remote package repositories
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
24 .Sh SYNOPSIS
25 .Nm
4c22b8a @bdrewery Use -A for registering automatic in pkg install
bdrewery authored
26 .Op Fl AfgLnqRXxy
d658628 @namore syncs pkg install help message with pkg-install.8 man page
namore authored
27 .Op Fl r Ar reponame
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
28 .Ar <pkg-origin> ...
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
29 .Sh DESCRIPTION
30 .Nm
31 is used for installation of packages from a remote package
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
32 repository.
33 Multiple package names can be specified on the command line, either
34 explicitly or by matching against package names in the repository
35 catalogues using shell globbing; standard- or extended regular
36 expressions.
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
37 .Pp
e74fca4 @bdrewery Whitespace cleanup
bdrewery authored
38 .Nm
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
39 creates a work-list of all the package installations to do.
40 Any already installed and up to date packages will be dropped from the
41 list unless the
42 .Fl f
43 (force) option is supplied, in which case those packages will be
44 reinstalled.
45 The dependencies of packages in the list are examined and any missing
46 packages are added to the list for installation.
47 Such implicitly added packages are flagged as candidates for
48 autoremoval.
49 See
50 .Xr pkg-autoremove 8
51 for details.
52 Any already installed but out of date packages, either named on the
53 command line or from the sum of all their dependencies are added to
54 the work list as upgrade jobs.
55 The work list is sorted into dependency order and
56 .Nm
57 will present it to the user for approval before proceeding, unless
58 overridden by the
59 .Fl y
60 option or the
e74fca4 @bdrewery Whitespace cleanup
bdrewery authored
61 .Cm ASSUME_ALWAYS_YES
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
62 setting in
63 .Fa pkg.conf .
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
64 .Pp
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
65 Autoremoval flags are sticky, and will persist over reinstallation or
66 upgrade of the packages concerned, even if subsequently the packages
67 are named explicitly on a command line.
68 See
69 .Xr pkg-query 8
70 for finding the autoremoval status of a package, and
71 .Xr pkg-set 8
72 for modifying it.
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
73 .Pp
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
74 Currently
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
75 .Nm
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
76 will only use one repository to install packages from.
77 When
78 .Ev PACKAGESITE
79 is set in the environment, or the equivalent
80 .Cm PACKAGESITE
81 setting is present in
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
82 .Fa pkg.conf
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
83 only that site will be used.
84 .Pp
85 Alternatively, when in multi-repo mode, the
86 .Fl r
87 option may be used to select one of the package repositories listed
88 in the configuration file.
89 Otherwise the default repository will be used.
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
90 .Pp
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
91 Multiple package repository support is only activated when neither the
92 environment variable
2abfe49 @yuripankov Some manpage fixes:
yuripankov authored
93 .Ev PACKAGESITE
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
94 nor the equivalent
95 .Cm PACKAGESITE
96 configuration setting are defined.
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
97 .Pp
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
98 Package repository catalogues will be automatically updated whenever
99 .Xr pkg-update 8
100 is run, unless disabled by the
b4f28cf @bdrewery Add -L flag to skip auto update for pkg-{fetch,upgrade,install}
bdrewery authored
101 .Fl L
102 flag.
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
103 Updating repository catalogues is highly recommended before doing any
104 package installation with
105 .Nm .
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
106 .Sh OPTIONS
107 The following options are supported by
108 .Nm :
109 .Bl -tag -width F1
4c22b8a @bdrewery Use -A for registering automatic in pkg install
bdrewery authored
110 .It Fl A
32323b7 @bdrewery Add pkg install -d to register the installed packages as automatic.
bdrewery authored
111 Mark the installed packages as orphan.
112 Will be automatically removed if no other packages depend on them.
113 For more information please refer to
114 .Xr pkg-autoremove 8
c9339f0 @bapt Forced reinstallation/upgrade now possible
bapt authored
115 .It Fl f
116 Force the reinstallation of the package if already installed.
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
117 .It Fl g
118 Treat the package names as shell glob patterns.
b4f28cf @bdrewery Add -L flag to skip auto update for pkg-{fetch,upgrade,install}
bdrewery authored
119 .It Fl L
3e5f950 @bdrewery Reword -L description
bdrewery authored
120 Skip updating the repository catalogues with
b4f28cf @bdrewery Add -L flag to skip auto update for pkg-{fetch,upgrade,install}
bdrewery authored
121 .Xr pkg-update 8 .
3325b42 @infracaninophile Revamp and expand the pkg-install man page
infracaninophile authored
122 Use the locally cached copies only.
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
123 .It Fl n
6bf9c48 @bdrewery Man page cleanup: Sentences begin on newline
bdrewery authored
124 Dry-run mode.
125 The list of changes to packages is always printed, but
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
126 no changes are actually made.
127 .It Fl q
128 Force quiet output, except when
129 .Fl n
130 is used, where
131 .Nm
132 will always show packages to be installed, upgraded or deleted.
07248f6 @bdrewery Add -R to pkg-install to allow -fR to reinstall upwards recursively
bdrewery authored
133 .It Fl R
134 When used with
135 .Fl f ,
73eae7f @infracaninophile Fix bus error, revert previous change to man page.
infracaninophile authored
136 reinstalls any packages that require the given package.
83d4963 @infracaninophile Add dry-run mode to pkg install
infracaninophile authored
137 .It Fl r Ar reponame
138 In multi-repo mode, override the
139 .Fa pkg.conf
140 ordering and only attempt to download packages from the named
141 repository.
142 .It Fl X
143 Treat the package names as extended regular expressions.
144 .It Fl x
145 Treat the package names as regular expressions.
146 .It Fl y
147 Assume yes when asked for confirmation before package installation.
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
148 .El
f05c0b5 @toddnni Changed envrioment to environment in man pages.
toddnni authored
149 .Sh ENVIRONMENT
150 The following environment variables affect the execution of
204131a @toddnni Refined ENVIRONMENT sections in manpages
toddnni authored
151 .Nm .
2abfe49 @yuripankov Some manpage fixes:
yuripankov authored
152 See
4bd4310 @toddnni Reworked man pages
toddnni authored
153 .Xr pkg.conf 5
204131a @toddnni Refined ENVIRONMENT sections in manpages
toddnni authored
154 for further description.
155 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
1670f90 @dnaeon Add ASSUME_ALWAYS_YES to the man pages
dnaeon authored
156 .It Ev ASSUME_ALWAYS_YES
204131a @toddnni Refined ENVIRONMENT sections in manpages
toddnni authored
157 .It Ev HANDLE_RC_SCRIPTS
158 .It Ev PACKAGESITE
159 .It Ev PKG_CACHEDIR
160 .It Ev PKG_DBDIR
161 .It Ev PKG_MULTIREPOS
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
162 .El
163 .Sh FILES
2abfe49 @yuripankov Some manpage fixes:
yuripankov authored
164 See
204131a @toddnni Refined ENVIRONMENT sections in manpages
toddnni authored
165 .Xr pkg.conf 5 .
abb24a8 @dnaeon Initial commit of the pkg-install(1) man page
dnaeon authored
166 .Sh SEE ALSO
3556541 @bapt man pages should be in section 8, not 1
bapt authored
167 .Xr pkg 8 ,
168 .Xr pkg-add 8 ,
31d5d6c @bdrewery Add pkg-audit(8) to other man page references
bdrewery authored
169 .Xr pkg-audit 8 ,
5ac95b4 @bdrewery Sort all manpage SEE ALSO sections
bdrewery authored
170 .Xr pkg-autoremove 8 ,
3556541 @bapt man pages should be in section 8, not 1
bapt authored
171 .Xr pkg-backup 8 ,
5ac95b4 @bdrewery Sort all manpage SEE ALSO sections
bdrewery authored
172 .Xr pkg-check 8 ,
34843c0 @bdrewery Add missing pkg-clean(8)
bdrewery authored
173 .Xr pkg-clean 8 ,
3556541 @bapt man pages should be in section 8, not 1
bapt authored
174 .Xr pkg-create 8 ,
175 .Xr pkg-delete 8 ,
dd7b086 @bdrewery Add missing pkg-fetch(8)
bdrewery authored
176 .Xr pkg-fetch 8 ,
3556541 @bapt man pages should be in section 8, not 1
bapt authored
177 .Xr pkg-info 8 ,
7f74d80 @bdrewery Add missing page references in SEE ALSO
bdrewery authored
178 .Xr pkg-query 8 ,
3556541 @bapt man pages should be in section 8, not 1
bapt authored
179 .Xr pkg-register 8 ,
180 .Xr pkg-repo 8 ,
2a01f7b @bdrewery pkg-rquery: Initial implementation
bdrewery authored
181 .Xr pkg-rquery 8 ,
5ac95b4 @bdrewery Sort all manpage SEE ALSO sections
bdrewery authored
182 .Xr pkg-search 8 ,
074f1d8 @infracaninophile Fix cross references in man pages
infracaninophile authored
183 .Xr pkg-set 8 ,
3f68bc7 @bdrewery Add missing pkg-shell(8)
bdrewery authored
184 .Xr pkg-shell 8 ,
7f74d80 @bdrewery Add missing page references in SEE ALSO
bdrewery authored
185 .Xr pkg-shlib 8 ,
dc09219 @dnaeon Mention pkg-stats(8) in the other man pages as well
dnaeon authored
186 .Xr pkg-stats 8 ,
3556541 @bapt man pages should be in section 8, not 1
bapt authored
187 .Xr pkg-update 8 ,
188 .Xr pkg-updating 8 ,
189 .Xr pkg-upgrade 8 ,
190 .Xr pkg-version 8 ,
191 .Xr pkg-which 8 ,
fcbd264 @dnaeon List the missing man pages in 'SEE ALSO' section
dnaeon authored
192 .Xr pkg.conf 5
Something went wrong with that request. Please try again.