1  .\"
  2  .\" FreeBSD pkg - a next generation package for the installation and
  3  .\" maintenance 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 July 7, 2024
 18  .Dt PKG-UPDATE 8
 19  .Os
 20  .Sh NAME
 21  .Nm "pkg update"
 22  .Nd update the local catalogues of the enabled package repositories
 23  .Sh SYNOPSIS
 24  .Nm
 25  .Op Fl fq
 26  .Op Fl r Ar reponame ...
 27  .Pp
 28  .Nm
 29  .Op Cm --{force,quiet}
 30  .Op Cm --repository Ar reponame ...
 31  .Sh DESCRIPTION
 32  .Nm
 33  is used for updating the local copy of the repository catalogues
 34  from the remote package repository databases.
 35  Updates to catalogues are normally downloaded only when the master
 36  copy on the remote package repository is newer than the local copy.
 37  .Pp
 38  The repository catalogues to be updated are defined in the
 39  .Xr pkg.conf 5
 40  file or by the entries in
 41  .Pa /usr/local/etc/pkg/repos .
 42  See
 43  .Xr pkg.conf 5
 44  for details.
 45  .Pp
 46  It is best practice to ensure your package repository catalogues are
 47  up to date before doing any package installation (via
 48  .Xr pkg-install 8 )
 49  or upgrades (via
 50  .Xr pkg-upgrade 8 ) .
 51  However, explicitly running
 52  .Nm
 53  is not normally necessary.
 54  By default invoking either of
 55  .Nm pkg install
 56  or
 57  .Nm pkg upgrade
 58  will cause repository
 59  catalogues to be updated automatically, unless disabled by setting
 60  .Ev REPO_AUTOUPDATE
 61  to false in
 62  .Xr pkg.conf 5 .
 63  .Pp
 64  .Ss Signed repositories
 65  If the repository catalogue is signed and
 66  .Ev PUBKEY
 67  is defined for the repository, the signature will be verified after download.
 68  See
 69  .Xr pkg.conf 5
 70  for more information.
 71  .Sh OPTIONS
 72  The following options are supported by
 73  .Nm :
 74  .Bl -tag -width quiet
 75  .It Fl q , Cm --quiet
 76  Force quiet output.
 77  .It Fl f , Cm --force
 78  Force a full download of the repository catalogue without regard to the
 79  respective ages of the local and remote copies of the catalogue.
 80  .It Fl r Ar reponame , Cm --repository Ar reponame
 81  Download the catalogue for the named repository only.
 82  This option can be specified multiple times to update several repositories.
 83  This will update only the named repositories, irrespective of the configured
 84  .Dq enabled
 85  status from
 86  .Pa repo.conf .
 87  .El
 88  .Sh ENVIRONMENT
 89  The following environment variables affect the execution of
 90  .Nm .
 91  See
 92  .Xr pkg.conf 5
 93  for further description.
 94  .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 95  .It Ev PKG_DBDIR
 96  .It Ev REPO_AUTOUPDATE
 97  .El
 98  .Sh FILES
 99  See
100  .Xr pkg.conf 5 .
101  .Sh SEE ALSO
102  .Xr pkg_create 3 ,
103  .Xr pkg_printf 3 ,
104  .Xr pkg_repo_create 3 ,
105  .Xr pkg_repos 3 ,
106  .Xr pkg-keywords 5 ,
107  .Xr pkg-lua-script 5 ,
108  .Xr pkg-repository 5 ,
109  .Xr pkg-script 5 ,
110  .Xr pkg-triggers 5 ,
111  .Xr pkg.conf 5 ,
112  .Xr pkg 8 ,
113  .Xr pkg-add 8 ,
114  .Xr pkg-alias 8 ,
115  .Xr pkg-annotate 8 ,
116  .Xr pkg-audit 8 ,
117  .Xr pkg-autoremove 8 ,
118  .Xr pkg-check 8 ,
119  .Xr pkg-clean 8 ,
120  .Xr pkg-config 8 ,
121  .Xr pkg-create 8 ,
122  .Xr pkg-delete 8 ,
123  .Xr pkg-fetch 8 ,
124  .Xr pkg-help 8 ,
125  .Xr pkg-info 8 ,
126  .Xr pkg-install 8 ,
127  .Xr pkg-key 8 ,
128  .Xr pkg-lock 8 ,
129  .Xr pkg-plugins 8 ,
130  .Xr pkg-query 8 ,
131  .Xr pkg-register 8 ,
132  .Xr pkg-repo 8 ,
133  .Xr pkg-repositories 8 ,
134  .Xr pkg-rquery 8 ,
135  .Xr pkg-search 8 ,
136  .Xr pkg-set 8 ,
137  .Xr pkg-shell 8 ,
138  .Xr pkg-shlib 8 ,
139  .Xr pkg-ssh 8 ,
140  .Xr pkg-stats 8 ,
141  .Xr pkg-triggers 8 ,
142  .Xr pkg-unregister 8 ,
143  .Xr pkg-updating 8 ,
144  .Xr pkg-upgrade 8 ,
145  .Xr pkg-version 8 ,
146  .Xr pkg-which 8