dub-describe(1)

1DUB-DESCRIBE(1)            The D Language Foundation           DUB-DESCRIBE(1)
2
3
4

NAME

6       dub - Package and build management system for D
7

SYNOPSIS

9       dub describe [<package>[@<version-spec>]] OPTIONS...
10

DESCRIPTION

12       Prints  a  JSON  build description for the root package an all of their
13       dependencies in a format similar to a JSON  package  description  file.
14       This is useful mostly for IDEs.
15
16
17
18       All usual options that are also used for build/run/generate apply.
19
20
21
22       When  --data=VALUE  is  supplied, specific build settings for a project
23       will be printed instead (by default, formatted  for  the  current  com‐
24       piler).
25
26
27
28       The  --data=VALUE  option  can  be specified multiple times to retrieve
29       several pieces of information at once. A comma-separated list  is  also
30       acceptable  (ex:  --data=dflags,libs).  The  data will be output in the
31       same order requested on the command line.
32
33
34
35       The accepted values for --data=VALUE are:
36
37
38
39       main-source-file, dflags,  lflags,  libs,  linker-files,  source-files,
40       versions,  debug-versions,  import-paths,  string-import-paths, import-
41       files, options
42
43
44
45       The following are also accepted by --data if --data-list is used:
46
47
48
49       target-type, target-path, target-name,  working-directory,  copy-files,
50       string-import-files,   pre-generate-commands,   post-generate-commands,
51       pre-build-commands, post-build-commands, requirements
52

OPTIONS

54       -b,    Specifies the type of build to perform. Note  that  setting  the
55              DFLAGS  environment  variable  will override the build type with
56              custom flags.  Possible names:
57                debug  (default),  plain,  release,  release-debug,   release-
58              nobounds,   unittest,  profile,  profile-gc,  docs,  ddox,  cov,
59              unittest-cov, syntax and custom types
60
61       -c,    Builds the specified configuration. Configurations  can  be  de‐
62              fined in dub.json
63
64       --override-config=VALUE
65              Uses  the  specified configuration for a certain dependency. Can
66              be specified multiple times.  Format:  --override-config=<depen‐
67              dency>/<config>
68
69       --compiler=VALUE
70              Specifies the compiler binary to use (can be a path).  Arbitrary
71              pre- and suffixes to the identifiers below are recognized  (e.g.
72              ldc2 or dmd-2.063) and matched to the proper compiler type:
73                dmd, gdc, ldc, gdmd, ldmd
74
75       -a,    Force a different architecture (e.g. x86 or x86_64)
76
77       -d,    Define  the  specified  debug version identifier when building -
78              can be used multiple times
79
80       --nodeps
81              Do not resolve missing dependencies before building
82
83       --build-mode=VALUE
84              Specifies the way the compiler and  linker  are  invoked.  Valid
85              values:
86                separate (default), allAtOnce, singleFile
87
88       --single
89              Treats  the  package name as a filename. The file must contain a
90              package recipe comment.
91
92       --force-remove
93              Deprecated option that does nothing.
94
95       --filter-versions
96              [Experimental] Filter  version  identifiers  and  debug  version
97              identifiers to improve build cache efficiency.
98
99       --import-paths
100              Shortcut for --data=import-paths --data-list
101
102       --string-import-paths
103              Shortcut for --data=string-import-paths --data-list
104
105       --data=VALUE
106              Just  list  the values of a particular build setting, either for
107              this package alone or recursively  including  all  dependencies.
108              Accepts  a  comma-separated list. See above for more details and
109              accepted possibilities for VALUE.
110
111       --data-list
112              Output --data information in list format (line-by-line), instead
113              of formatting for a compiler command line.
114
115       --data-0
116              Output  --data  information  using  null-delimiters, rather than
117              spaces or newlines. Result is usable with, ex., xargs -0.
118

FILES

120       dub.sdl, dub.json
121

AUTHOR

123       Copyright (c) 1999-2022 by The D Language Foundation
124

ONLINE DOCUMENTATION

126       ⟨http://code.dlang.org/docs/commandline⟩http://code.dlang.org/docs/commandline
127