diff options
Diffstat (limited to 'bpkg/pkg-clean.cli')
| -rw-r--r-- | bpkg/pkg-clean.cli | 36 |
1 files changed, 30 insertions, 6 deletions
diff --git a/bpkg/pkg-clean.cli b/bpkg/pkg-clean.cli index b4cb05f..ea5b0c1 100644 --- a/bpkg/pkg-clean.cli +++ b/bpkg/pkg-clean.cli @@ -15,15 +15,21 @@ namespace bpkg "\h|SYNOPSIS| \c{\b{bpkg pkg-clean}|\b{clean} [<options>] [<vars>] <pkg>...\n - \b{bpkg pkg-clean}|\b{clean} [<options>] [<vars>] \b{--all}|\b{-a}} + \b{bpkg pkg-clean}|\b{clean} [<options>] [<vars>] \b{--all}|\b{-a}\n + \b{bpkg pkg-clean}|\b{clean} [<options>] [<vars>] (\b{--all-pattern} <pattern>)...} \h|DESCRIPTION| - The \cb{pkg-clean} command cleans the specified packages (the first form) - or all the held packages (the second form, see \l{bpkg-pkg-status(1)}). - Underneath, this command doesn't do much more than run \cb{b clean}. In - the first form the specified packages must have been previously - configured with \l{bpkg-pkg-build(1)} or \l{bpkg-pkg-configure(1)}. + The \cb{pkg-clean} command cleans the specified packages (the first + form), all the held packages (the second form, see + \l{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 \c{\b{--immediate}|\b{-i}} or \c{\b{--recursive}|\b{-r}} options, + respectively. Underneath, this command doesn't do much more than run + \cb{b clean}. In the first form the specified packages must have been + previously configured with \l{bpkg-pkg-build(1)} or + \l{bpkg-pkg-configure(1)}. Additional command line variables (<vars>, normally \cb{config.*}) can be passed to the build system. Such variables apply to all the specified @@ -40,6 +46,24 @@ namespace bpkg { "Clean all held packages." } + + strings --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." + } + + bool --immediate|-i + { + "Also clean immediate dependencies." + } + + bool --recursive|-r + { + "Also clean all dependencies, recursively." + } }; " |