1bdep-clean(1)               General Commands Manual              bdep-clean(1)
2
3
4

NAME

6       bdep-clean - clean project in build configurations
7

SYNOPSIS

9       bdep clean [options] [pkg-spec] [cfg-spec] [cfg-var...]
10
11       cfg-spec = (@cfg-name | --config|-c cfg-dir)... | --all|-a
12       pkg-spec = (--directory|-d pkg-dir)... | prj-spec
13       prj-spec = --directory|-d prj-dir
14

DESCRIPTION

16       The clean command cleans the project packages in one or more build con‐
17       figurations. Additionally, immediate or all dependencies of the project
18       packages  can  be  cleaned by specifying the --immediate|-i or --recur‐
19       sive|-r options, respectively.
20
21       Underneath clean executes the bpkg-pkg-clean(1) command which itself is
22       not  much  more than the build system clean operation (see b(1) for de‐
23       tails). As a result, the main utility of this command is the ability to
24       refer  to build configurations by names and to project packages implic‐
25       itly via the current working directory as well as  to  clean  dependen‐
26       cies.
27
28       If no project or package directory is specified, then the current work‐
29       ing directory is assumed. If no configuration is  specified,  then  the
30       default  configurations  are  assumed. See bdep-projects-configs(1) for
31       details on specifying projects and configurations. Optional  cfg-var...
32       are the additional configuration variables to pass to the build system.
33

CLEAN OPTIONS

35       --immediate|-i
36              Also clean immediate dependencies.
37
38       --recursive|-r
39              Also clean all dependencies, recursively.
40
41       --all|-a
42              Use all build configurations.
43
44       --config|-c dir
45              Specify the build configuration as a directory.
46
47       --directory|-d dir
48              Assume project/package is in the specified directory rather than
49              in the current working directory.
50
51       --config-name|-n name
52              Specify the build configuration as a name.
53
54       --config-id num
55              Specify the build configuration as an id.
56

COMMON OPTIONS

58       The common options are summarized below with a more  detailed  descrip‐
59       tion available in bdep-common-options(1).
60
61       -v     Print essential underlying commands being executed.
62
63       -V     Print all underlying commands being executed.
64
65       --quiet|-q
66              Run quietly, only printing error messages.
67
68       --verbose level
69              Set the diagnostics verbosity to level between 0 and 6.
70
71       --stdout-format format
72              Representation format to use for printing to stdout.
73
74       --jobs|-j num
75              Number of jobs to perform in parallel.
76
77       --progress
78              Display progress indicators for long-lasting operations, such as
79              network transfers, building, etc.
80
81       --no-progress
82              Suppress progress indicators for long-lasting  operations,  such
83              as network transfers, building, etc.
84
85       --diag-color
86              Use color in diagnostics.
87
88       --no-diag-color
89              Don't use color in diagnostics.
90
91       --bpkg path
92              The  package  manager program to be used for build configuration
93              management.
94
95       --bpkg-option opt
96              Additional option to be passed to the package manager program.
97
98       --build path
99              The build program to be used to build packages.
100
101       --build-option opt
102              Additional option to be passed to the build program.
103
104       --curl path
105              The curl program to be used for network operations.
106
107       --curl-option opt
108              Additional option to be passed to the curl program.
109
110       --pager path
111              The pager program to be used to show long text.
112
113       --pager-option opt
114              Additional option to be passed to the pager program.
115
116       --options-file file
117              Read additional options from file.
118
119       --default-options dir
120              The directory to load additional default options files from.
121
122       --no-default-options
123              Don't load default options files.
124

DEFAULT OPTIONS FILES

126       See bdep-default-options-files(1) for an overview of  the  default  op‐
127       tions  files.  For  the clean command the search start directory is the
128       project directory. The following options files are searched for in each
129       directory and, if found, loaded in the order listed:
130
131       bdep.options
132       bdep-clean.options
133
134       The  following clean command options cannot be specified in the default
135       options files:
136
137       --directory|-d
138

BUGS

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

143       Copyright (c) 2014-2023 the build2 authors.
144
145       Permission is granted to copy, distribute and/or modify  this  document
146       under the terms of the MIT License.
147
148
149
150bdep 0.16.0                        June 2023                     bdep-clean(1)
Impressum