Radish alpha
H
HardenedBSD-pkg
rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9
HardenedBSD Package Manager
Radicle
Git
Commits › ab7b488
Improve documentation on repo catalogue auto-update behaviour and -U flag.
Matthew Seaman committed 12 years ago
commit ab7b48835ec517a034ea7d1f4f4d3b8c26de9ef1
parent e050366
6 files changed +86 -38
modified docs/pkg-fetch.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd June 30, 2013
+ 
.Dd April 18, 2014

.Dt PKG-FETCH 8

.Os

.Sh NAME
@@ -41,11 +41,17 @@ is used to download binary packages from a remote repository.
.Pp

One or more packages, or patterns can be specified.

.Pp
- 
Repository catalogues will be updated automatically using
- 
.Xr pkg-update 8 .
- 
This can be disabled with the
+ 
Package repository catalogues will be automatically updated whenever
+ 
.Nm
+ 
is run by a user ID with write access to the package database,
+ 
unless disabled by the

.Fl U
- 
flag.
+ 
flag or setting
+ 
.Cm REPO_AUTOUPDATE
+ 
to
+ 
.Sy NO
+ 
in
+ 
.Xr pkg.conf 5 .

.Sh OPTIONS

The following options are supported by

.Nm :
@@ -76,9 +82,11 @@ See
.It Fl u

Fetch all available updates for the currently installed packages.

.It Fl U
- 
Skip updating the repository catalogues with
- 
.Xr pkg-update 8 .
- 
Use the local cache only.
+ 
Suppress the automatic update of the local copy of the repository catalogue
+ 
from remote.
+ 
Automatic repository catalogue updates are only attempted when the
+ 
effective UID of the process has write access to the package database.
+ 
Otherwise they are silently ignored.

.It Fl x

Treat

.Ar pkg-name
modified docs/pkg-install.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd April 17, 2014
+ 
.Dd April 18, 2014

.Dt PKG-INSTALL 8

.Os

.Sh NAME
@@ -92,12 +92,15 @@ for details.
.Pp

Package repository catalogues will be automatically updated whenever

.Nm
- 
is run, unless disabled by the
+ 
is run by a user ID with write access to the package database,
+ 
unless disabled by the

.Fl U
- 
flag.
- 
Updating repository catalogues is highly recommended before doing any
- 
package installation with
- 
.Nm .
+ 
flag  or setting
+ 
.Cm REPO_AUTOUPDATE
+ 
to
+ 
.Sy NO
+ 
in
+ 
.Xr pkg.conf 5 .

.Sh OPTIONS

The following options are supported by

.Nm :
@@ -148,9 +151,11 @@ irrespective of the configured
status from

.Pa repo.conf .

.It Fl U
- 
Skip updating the repository catalogues with
- 
.Xr pkg-update 8 .
- 
Use the locally cached copies only.
+ 
Suppress the automatic update of the local copy of the repository catalogue
+ 
from remote.
+ 
Automatic repository catalogue updates are only attempted when the
+ 
effective UID of the process has write access to the package database.
+ 
Otherwise they are silently ignored.

.It Fl x

Treat the package names as regular expressions according to the

"modern" or "extended" syntax of
modified docs/pkg-rquery.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd April 17, 2014
+ 
.Dd April 18, 2014

.Dt PKG-RQUERY 8

.Os

.Sh NAME
@@ -43,9 +43,15 @@ is used for displaying information about remote packages.
.Pp

Package repository catalogues will be automatically updated whenever

.Nm
- 
is run, unless disabled by the
+ 
is run by a user ID with write access to the package database,
+ 
unless disabled by the

.Fl U
- 
flag.
+ 
flag  or setting
+ 
.Cm REPO_AUTOUPDATE
+ 
to
+ 
.Sy NO
+ 
in
+ 
.Xr pkg.conf 5 .

.Sh OPTIONS

The following options are supported by

.Nm :
@@ -76,9 +82,11 @@ matching against
.Ar pkg-name

case insensitive.

.It Fl U
- 
Skip updating the repository catalogues with
- 
.Xr pkg-update 8 .
- 
Use the locally cached copies only.
+ 
Suppress the automatic update of the local copy of the repository catalogue
+ 
from remote.
+ 
Automatic repository catalogue updates are only attempted when the
+ 
effective UID of the process has write access to the package database.
+ 
Otherwise they are silently ignored.

.It Fl x

Treat

.Ao pattern Ac
modified docs/pkg-search.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd April 17, 2014
+ 
.Dd April 18, 2014

.Dt PKG-SEARCH 8

.Os

.Sh NAME
@@ -46,9 +46,15 @@ data available from the repository catalogues.
.Pp

Package repository catalogues will be automatically updated whenever

.Nm
- 
is run, unless disabled by the
+ 
is run by a user ID with write access to the package database,
+ 
unless disabled by the

.Fl U
- 
flag.
+ 
flag  or setting
+ 
.Cm REPO_AUTOUPDATE
+ 
to
+ 
.Sy NO
+ 
in
+ 
.Xr pkg.conf 5 .

.Pp

Package repositories are defined in the

.Fa pkg.conf
@@ -163,9 +169,11 @@ Display the installed size of matched packages.
Equivalent to

.Fl "Q size" .

.It Fl U
- 
Skip updating the repository catalogues with
- 
.Xr pkg-update 8 .
- 
Use the locally cached copies only.
+ 
Suppress the automatic update of the local copy of the repository catalogue
+ 
from remote.
+ 
Automatic repository catalogue updates are only attempted when the
+ 
effective UID of the process has write access to the package database.
+ 
Otherwise they are silently ignored.

.It Fl x

Treat

.Ar pattern
modified docs/pkg-upgrade.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd April 17, 2014
+ 
.Dd April 18, 2014

.Dt PKG-UPGRADE 8

.Os

.Sh NAME
@@ -82,9 +82,10 @@ See
.Xr pkg-repository 5

for details.

.Pp
- 
Repository catalogues will automatically be updated whenever
+ 
Package repository catalogues will be automatically updated whenever

.Nm
- 
is run, unless disabled by the
+ 
is run by a user ID with write access to the package database,
+ 
unless disabled by the

.Fl U

flag or setting

.Cm REPO_AUTOUPDATE
@@ -122,11 +123,11 @@ Force quiet output, except when
.Fl n

is used, where a summary of the work list is always displayed.

.It Fl U
- 
Skip updating the repository catalogues with
- 
.Xr pkg-update 8 .
- 
Use the local cache only.
- 
.Nm
- 
will always print out the list of packages with available updates.
+ 
Suppress the automatic update of the local copy of the repository catalogue
+ 
from remote.
+ 
Automatic repository catalogue updates are only attempted when the
+ 
effective UID of the process has write access to the package database.
+ 
Otherwise they are silently ignored.

.It Fl r Ar reponame

Install packages from only the named repository,

irrespective of the configured
modified docs/pkg-version.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd April 13, 2014
+ 
.Dd April 18, 2014

.Dt PKG-VERSION 8

.Os

.Sh NAME
@@ -60,6 +60,21 @@ where
.Sy N

is the OS major version number.)

.Pp
+ 
When
+ 
.Fl U
+ 
is used,
+ 
package repository catalogues will be automatically updated whenever
+ 
.Nm
+ 
is run by a user ID with write access to the package database,
+ 
unless disabled by the
+ 
.Fl U
+ 
flag or setting
+ 
.Cm REPO_AUTOUPDATE
+ 
to
+ 
.Sy NO
+ 
in
+ 
.Xr pkg.conf 5 .
+ 
.Pp

When comparing package versions the package name and a comparison character are printed:

.Bl -tag -width indent

.It Li =
@@ -108,6 +123,9 @@ from remote.
This only has any effect in combination with the

.Fl R

option.
+ 
Automatic repository catalogue updates are only attempted when the
+ 
effective UID of the process has write access to the package database.
+ 
Otherwise they are silently ignored.

.It Fl r Ar reponame

When using

.Fl R