bdep-common-options(1)

📦
version 0.17.0 · 2 versions
, in fedora 43, fedora 44, nixos 26.05

💖 bdep-common-options 💖

okay bestie, welcome to bdep-common-options(1) — yes, that's the manual page name, and it lives in the General Commands Manual section. this is the page that explains all the little flags every bdep command shares, so like… it's the group chat of options. let's get into it 🫶

✨ NAME ✨

bdep-common-options — the deets on the common options, no cap 💅

🌸 SYNOPSIS 🌸

bdep [common-options] ...

🦋 DESCRIPTION 🦋

so the common options are the ones that control behavior that's common to all or most of the bdep commands. and the slay part? you can put them either before the command or after it, hanging out with the command-specific options. literally your choice, she's flexible 💁‍♀️

💅 COMMON OPTIONS 💅

  • -v — print the essential underlying commands that are being executed. this is exactly the same as --verbose 2. iconic.
  • -V — print ALL the underlying commands being executed. this is equivalent to --verbose 3. she's chatty and we love her.
  • --quiet, -q — run quietly, only printing error messages. equivalent to --verbose 0. shhh 🤫
  • --verbose level — set the diagnostics verbosity to level, somewhere between 0 and 6. level 0 disables any non-error messages, while level 6 produces lots of information, with level 1 being the default. here's the extra tea you get at each level:
    1. High-level information messages.
    2. Essential underlying commands being executed.
    3. All underlying commands being executed.
    4. Information that could be helpful to the user.
    5. Information that could be helpful to the developer.
    6. Even more detailed information.
  • --stdout-format format — the representation format to use when printing to stdout. valid values for this option are lines (the default) and json. head down to the JSON OUTPUT section below for the whole story on the json format 👇
  • --jobs, -j num — how many jobs to perform in parallel. if you don't specify this option at all, or you specify it with the value 0, then the number of available hardware threads gets used instead. this option also gets propagated when executing package manager commands like bpkg-pkg-update(1), bpkg-pkg-test(1), etc., which then propagate it on to the build system. teamwork fr fr 🫶
  • --progress — display progress indicators for long-lasting operations, like network transfers, building, etc. if you're printing to a terminal, the progress is displayed by default for low verbosity levels. use --no-progress to suppress it. (yes, it's giving loading screen energy ✨)
  • --no-progress — suppress progress indicators for long-lasting operations, such as network transfers, building, etc. bye bye little spinner 😭
  • --diag-color — use color in diagnostics. if printing to a terminal, the color is used by default, provided the terminal is not dumb. use --no-diag-color to suppress it. rainbow diagnostics? yes pls 🌈
  • --no-diag-color — don't use color in diagnostics. monochrome era 🖤
  • --bpkg path — the package manager program to be used for build configuration management. this should be the path to the bpkg executable. you can also specify additional options that should be passed to the package manager program with --bpkg-option.

if the package manager program is not explicitly specified, then bdep will by default use bpkg plus an executable suffix if one was specified when building bdep. so, for example, if bdep name was set to bdep-1.0, then it will look for bpkg-1.0. cute, right? 🎀

  • --bpkg-option opt — an additional option to be passed to the package manager program. see --bpkg for more info on the package manager program. repeat this option to specify multiple package manager options. 🔁
  • --build path — the build program to be used to build packages. this should be the path to the build2 b executable. you can also specify additional options that should be passed to the build program with --build-option.

if the build program is not explicitly specified, then bdep will by default use b plus an executable suffix if one was specified when building bdep. so, for example, if bdep name was set to bdep-1.0, then it will look for b-1.0. same energy, different program 💫

  • --build-option opt — an additional option to be passed to the build program. see --build for more info on the build program. repeat this option to specify multiple build options. 🔁
  • --curl path — the curl program to be used for network operations. you can also specify additional options that should be passed to the curl program with --curl-option.

if the curl program is not explicitly specified, then bdep will use curl by default. note that this program will also be used by the underlying bpkg invocations unless overridden. she shares, she's generous 💖

  • --curl-option opt — an additional option to be passed to the curl program. see --curl for more info on the curl program. repeat this option to specify multiple curl options.

note that these options will also be used by the underlying bpkg invocations provided that curl is used. 🔁

  • --pager path — the pager program to be used to show long text. commonly used pager programs are less and more. you can also specify additional options that should be passed to the pager program with --pager-option. if an empty string is specified as the pager program, then no pager will be used. if the pager program is not explicitly specified, then bdep will try to use less. if it's not available, then no pager will be used. ngl less really said "main character" 📜
  • --pager-option opt — an additional option to be passed to the pager program. see --pager for more info on the pager program. repeat this option to specify multiple pager options. 🔁
  • --options-file file — read additional options from file. each option should appear on a separate line, optionally followed by a space or an equal sign (=) and an option value. empty lines and lines starting with # are ignored. option values can be enclosed in double (") or single (') quotes to preserve leading and trailing whitespaces, as well as to specify empty values. if the value itself contains trailing or leading quotes, enclose it with an extra pair of quotes, for example '"x"'. non-leading and non-trailing quotes are interpreted as being part of the option value.

the semantics of providing options in a file is equivalent to providing the same set of options in the same order on the command line at the point where the --options-file option is specified — except that the shell escaping and quoting is not required. repeat this option to specify more than one options file. so many files, so many options, we stan 🗂️

  • --default-options dir — the directory to load additional default options files from.
  • --no-default-options — don't load default options files. hard pass 🙅‍♀️

🌈 JSON OUTPUT 🌈

commands that support the JSON output specify their formats as a serialized representation of a C++ struct or an array thereof. for example:

struct package
{
  string name;
};

struct configuration
{
  uint64_t         id;
  string           path;
  optional<string> name;
  bool             default;
  vector<package>  packages;
};

here's an example of the serialized JSON representation of struct configuration:

{
  "id": 1,
  "path": "/tmp/hello-gcc",
  "name": "gcc",
  "default": true,
  "packages": [
    {
      "name": "hello"
    }
  ]
}

this section provides all the details on the overall properties of such formats and the semantics of the struct serialization. 🧚

the order of members in a JSON object is fixed as specified in the corresponding struct. while new members may be added in the future (and should be ignored by older consumers), the semantics of the existing members (including whether the top-level entry is an object or an array) may not change. periodt.

an object member is required unless its type is optional<>, bool, or vector<> (array). for bool members, absent means false. for vector<> members, absent means empty. an empty top-level array is always present. noted 📝

for example, the following JSON text is a possible serialization of the above struct configuration:

{
  "id": 1,
  "path": "/tmp/hello-gcc"
}

💀 BUGS 💀

send bug reports to the users@build2.org mailing list. found a bug? tell the girlies, they'll fix it 🐛

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.

and that's the whole page bestie, you ate it up 💅 this was bdep-common-options(1) from the General Commands Manual, brought to you by bdep 0.17.0, dated June 2024. go forth and flag responsibly, ily 🫶✨🌸

📦 where this page comes from