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 May 27, 2018
 18  .Dt PKG-CLEAN 8
 19  .Os
 20  .Sh NAME
 21  .Nm "pkg clean"
 22  .Nd clean the local cache of fetched remote packages
 23  .Sh SYNOPSIS
 24  .Nm
 25  .Op Fl anqy
 26  .Pp
 27  .Nm
 28  .Op Fl -{all,dry-run,quiet,yes}
 29  .Sh DESCRIPTION
 30  .Nm
 31  is used to cleanup the local cache of packages downloaded from remote
 32  repositories.
 33  It removes packages that have been superseded by newer versions, and
 34  any packages that are no longer provided.
 35  .Sh OPTIONS
 36  The following options are supported by
 37  .Nm :
 38  .Bl -tag -width F1
 39  .It Fl a , Fl -all
 40  Delete all cached packages including those which have not been superseded by
 41  newer versions yet and are still in use.
 42  .It Fl n , Fl -dry-run
 43  Do not delete any package files from the cache, but show what
 44  would be done instead.
 45  Forces the preview of the packages that would be deleted to be shown,
 46  even when used with
 47  .Fl y .
 48  Note: the package cache file permissions only permit root access.
 49  Results will be disappointing for any other user.
 50  .It Fl q , Fl -quiet
 51  Be quiet.
 52  Suppress most output.
 53  All output is suppressed if
 54  .Fl y
 55  is also used.
 56  .It Fl y , Fl -yes
 57  Assume a yes answer instead of asking for confirmation before deleting
 58  any out of date or redundant packages from the cache.
 59  .El
 60  .Sh ENVIRONMENT
 61  The following environment variables affect the execution of
 62  .Nm .
 63  See
 64  .Xr pkg.conf 5
 65  for further description.
 66  .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 67  .It Ev DEFAULT_ALWAYS_YES
 68  .It Ev ASSUME_ALWAYS_YES
 69  .It Ev PKG_DBDIR
 70  .It Ev PKG_CONFIG_CACHEDIR
 71  .El
 72  .Sh FILES
 73  See
 74  .Xr pkg.conf 5 .
 75  .Sh SEE ALSO
 76  .Xr pkg_create 3 ,
 77  .Xr pkg_printf 3 ,
 78  .Xr pkg_repo_create 3 ,
 79  .Xr pkg_repos 3 ,
 80  .Xr pkg-keywords 5 ,
 81  .Xr pkg-lua-script 5 ,
 82  .Xr pkg-repository 5 ,
 83  .Xr pkg-script 5 ,
 84  .Xr pkg-triggers 5 ,
 85  .Xr pkg.conf 5 ,
 86  .Xr pkg 8 ,
 87  .Xr pkg-add 8 ,
 88  .Xr pkg-alias 8 ,
 89  .Xr pkg-annotate 8 ,
 90  .Xr pkg-audit 8 ,
 91  .Xr pkg-autoremove 8 ,
 92  .Xr pkg-check 8 ,
 93  .Xr pkg-config 8 ,
 94  .Xr pkg-create 8 ,
 95  .Xr pkg-delete 8 ,
 96  .Xr pkg-fetch 8 ,
 97  .Xr pkg-help 8 ,
 98  .Xr pkg-info 8 ,
 99  .Xr pkg-install 8 ,
100  .Xr pkg-key 8 ,
101  .Xr pkg-lock 8 ,
102  .Xr pkg-plugins 8 ,
103  .Xr pkg-query 8 ,
104  .Xr pkg-register 8 ,
105  .Xr pkg-repo 8 ,
106  .Xr pkg-repositories 8 ,
107  .Xr pkg-rquery 8 ,
108  .Xr pkg-search 8 ,
109  .Xr pkg-set 8 ,
110  .Xr pkg-shell 8 ,
111  .Xr pkg-shlib 8 ,
112  .Xr pkg-ssh 8 ,
113  .Xr pkg-stats 8 ,
114  .Xr pkg-triggers 8 ,
115  .Xr pkg-unregister 8 ,
116  .Xr pkg-update 8 ,
117  .Xr pkg-updating 8 ,
118  .Xr pkg-upgrade 8 ,
119  .Xr pkg-version 8 ,
120  .Xr pkg-which 8