Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
bpkg-pkg-clean(1)	    General Commands Manual	     bpkg-pkg-clean(1)

NAME
       bpkg-pkg-clean -	clean package

SYNOPSIS
       bpkg pkg-clean|clean [options] [vars] pkg...
       bpkg pkg-clean|clean [options] [vars] --all|-a
       bpkg pkg-clean|clean [options] [vars] (--all-pattern <pattern>)...

DESCRIPTION
       The  pkg-clean  command cleans the specified packages (the first	form),
       all the held packages (the second form, see bpkg-pkg-status(1)),	or all
       the held	packages that match any	of  the	 specified  wildcard  patterns
       (the  third form). Additionally,	immediate or all dependencies of these
       packages	can be also cleaned by specifying the --immediate|-i or	 --re-
       cursive|-r  options,  respectively. Underneath, this command doesn't do
       much more than run b clean. In the first	form  the  specified  packages
       must  have  been	 previously configured with bpkg-pkg-build(1) or bpkg-
       pkg-configure(1).

       Additional command line variables  (vars,  normally  config.*)  can  be
       passed  to  the build system. Such variables apply to all the specified
       packages	but can	also be	specified to only apply	to  specific  packages
       using  the  argument  grouping mechanism	(see bpkg-argument-grouping(1)
       for details).

PKG-CLEAN OPTIONS
       --all|-a
	      Clean all	held packages.

       --all-pattern pattern
	      Clean held packages that match the specified  wildcard  pattern.
	      Repeat this option to match multiple patterns. Note that you may
	      need to quote the	pattern	to prevent expansion by	your shell.

       --immediate|-i
	      Also clean immediate dependencies.

       --recursive|-r
	      Also clean all dependencies, recursively.

       --directory|-d dir
	      Assume  configuration is in dir rather than in the current work-
	      ing directory.

COMMON OPTIONS
       The common options are summarized below with a more  detailed  descrip-
       tion available in bpkg-common-options(1).

       -v     Print essential underlying commands being	executed.

       -V     Print all	underlying commands being executed.

       --quiet|-q
	      Run quietly, only	printing error messages.

       --verbose level
	      Set the diagnostics verbosity to level between 0 and 6.

       --stdout-format format
	      Representation format to use for printing	to stdout.

       --jobs|-j num
	      Number of	jobs to	perform	in parallel.

       --no-result
	      Don't print informational	messages about the outcome of perform-
	      ing a command or some of its parts.

       --structured-result fmt
	      Write the	result of performing a command in a structured form.

       --progress
	      Display progress indicators for long-lasting operations, such as
	      network transfers, building, etc.

       --no-progress
	      Suppress	progress  indicators for long-lasting operations, such
	      as network transfers, building, etc.

       --diag-color
	      Use color	in diagnostics.

       --no-diag-color
	      Don't use	color in diagnostics.

       --build path
	      The build	program	to be used to build packages.

       --build-option opt
	      Additional option	to be passed to	the build program.

       --fetch path
	      The fetch	program	to be used to download resources.

       --fetch-option opt
	      Additional option	to be passed to	the fetch program.

       --fetch-timeout sec
	      The fetch	and fetch-like (for example, git) program timeout.

       --pkg-proxy url
	      HTTP proxy server	to use when  fetching  package	manifests  and
	      archives from remote pkg repositories.

       --git path
	      The git program to be used to fetch git repositories.

       --git-option opt
	      Additional common	option to be passed to the git program.

       --sha256	path
	      The sha256 program to be used to calculate SHA256	sums.

       --sha256-option opt
	      Additional option	to be passed to	the sha256 program.

       --tar path
	      The tar program to be used to extract package archives.

       --tar-option opt
	      Additional option	to be passed to	the tar	program.

       --openssl path
	      The openssl program to be	used for crypto	operations.

       --openssl-option	opt
	      Additional option	to be passed to	the openssl program.

       --auth type
	      Types of repositories to authenticate.

       --trust fingerprint
	      Trust repository certificate with	a SHA256 fingerprint.

       --trust-yes
	      Assume the answer	to all authentication prompts is yes.

       --trust-no
	      Assume the answer	to all authentication prompts is no.

       --git-capabilities up=pc
	      Protocol capabilities (pc) for a git repository URL prefix (up).

       --pager path
	      The pager	program	to be used to show long	text.

       --pager-option opt
	      Additional option	to be passed to	the pager program.

       --options-file file
	      Read additional options from file.

       --default-options dir
	      The directory to load additional default options files from.

       --no-default-options
	      Don't load default options files.

       --keep-tmp
	      Don't  remove  the  bpkg's temporary directory at	the end	of the
	      command execution	and print its path at the verbosity level 2 or
	      higher.

DEFAULT	OPTIONS	FILES
       See bpkg-default-options-files(1) for an	overview of  the  default  op-
       tions  files.  For  the pkg-clean command the search start directory is
       the configuration directory. The	following options files	 are  searched
       for in each directory and, if found, loaded in the order	listed:

       bpkg.options
       bpkg-pkg-clean.options

       The  following pkg-clean	command	options	cannot be specified in the de-
       fault options files:

       --directory|-d

BUGS
       Send bug	reports	to the users@build2.org	mailing	list.

COPYRIGHT
       Copyright (c) 2014-2024 the build2 authors.

       Permission is granted to	copy, distribute and/or	modify	this  document
       under the terms of the MIT License.

bpkg 0.17.0			   June	2024		     bpkg-pkg-clean(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bpkg-pkg-clean&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help