diff options
author | Boris Kolpackov <boris@codesynthesis.com> | 2016-01-11 10:04:02 +0200 |
---|---|---|
committer | Boris Kolpackov <boris@codesynthesis.com> | 2016-01-11 10:04:02 +0200 |
commit | ad257079568746d71d913c6fca96852da6fe3bd6 (patch) | |
tree | d7a59392a1159c630c4fd0ccad816e9fd3acadf3 /bpkg/pkg-drop.cli | |
parent | 302834a875804ff943dfb005682949fd3d404d01 (diff) |
Reorganize .cli files, add man/xhtml page generation (via script for now)
Diffstat (limited to 'bpkg/pkg-drop.cli')
-rw-r--r-- | bpkg/pkg-drop.cli | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/bpkg/pkg-drop.cli b/bpkg/pkg-drop.cli new file mode 100644 index 0000000..6ec7130 --- /dev/null +++ b/bpkg/pkg-drop.cli @@ -0,0 +1,62 @@ +// file : bpkg/pkg-drop.cli +// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd +// license : MIT; see accompanying LICENSE file + +include <bpkg/configuration.cli>; + +"\section=1" +"\name=bpkg-pkg-drop" +"\summary=drop one or more packages" + +/* +"\h{SYNOPSIS} + +bpkg pkg-drop [<options>] <pkg>..." + +"\h{DESCRIPTION} + +The \cb{pkg-drop} command drops one or more packages from the configuration. +If the packages being dropped still have dependents, then those will have +to be drop as well and you will be prompted for a confirmation. Similarly, +if the packages being dropped have prerequisites that are no longer needed, +you will be offered to drop those as well. + +The \cb{pkg-drop} command also supports several \cb{--*-only} options that +allow you to limit the amount of work that will be done. +*/ + +namespace bpkg +{ + class pkg_drop_options: configuration_options + { + bool --yes|-y + { + "Assume the answer to all prompts is \cb{yes}. Note that this option + does not apply to the dropping of dependents; use \cb{--drop-dependent} + for that." + } + + bool --no|-n + { + "Assume the answer to all prompts is \cb{no}. Only makes sense together + with \cb{--print-only|-p}." + } + + bool --drop-dependent + { + "Don't warn about or ask for confirmation of dropping dependent + packages." + } + + bool --disfigure-only + { + "Disfigure all the packages but don't purge." + } + + bool --print-only|-p + { + "Print to \cb{STDOUT} what would be done without actually doing + anything." + } + }; +} |