diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2016-01-11 15:14:32 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2016-01-11 15:14:32 +0200 |
| commit | 1c13ae4ed5d84b32c2c1a0698f9e688c312de989 (patch) | |
| tree | 4977cf7df549e275205e9ced6ae283ac89c685c4 /bpkg/pkg-purge.cli | |
| parent | ad257079568746d71d913c6fca96852da6fe3bd6 (diff) | |
Documentation improvements
Diffstat (limited to 'bpkg/pkg-purge.cli')
| -rw-r--r-- | bpkg/pkg-purge.cli | 45 |
1 files changed, 24 insertions, 21 deletions
diff --git a/bpkg/pkg-purge.cli b/bpkg/pkg-purge.cli index da618d3..490f316 100644 --- a/bpkg/pkg-purge.cli +++ b/bpkg/pkg-purge.cli @@ -8,39 +8,42 @@ include <bpkg/configuration.cli>; "\name=bpkg-pkg-purge" "\summary=purge package" -/* -"\h{SYNOPSIS} +namespace bpkg +{ + { + "<options> <pkg>", -bpkg pkg-purge [<options>] <pkg>" + "\h|SYNOPSIS| -"\h{DESCRIPTION} + \c{\b{bpkg pkg-purge} [<options>] <pkg>} -The \cb{pkg-purge} command removes the package directory and archive -from the filesystem and removes the package from the configuration's -database. Only packages in the \cb{fetched} and \cb{unpacked} state can -be purged plus \cb{broken} packages if the \cb{-f|--force} options is -specified (see this option's description for details on purging broken -packages). If the \cb{-k|--keep} option is specified, then the package -archive is not removed (see this option's description for details on -this mode)." -*/ + \h|DESCRIPTION| + + The \cb{pkg-purge} command removes the package directory and archive from + the filesystem and removes the package from the configuration. Only + packages in the \cb{fetched} and \cb{unpacked} state + (\l{bpkg-pkg-status(1)}) can be purged plus \cb{broken} packages if the + \cb{--force|-f} option is specified (see the option's description for + details on purging broken packages). If the \cb{--keep|-k} option is + specified, then the package archive is not removed (see the option's + description for details on this mode)." + } -namespace bpkg -{ class pkg_purge_options: configuration_options { + "\h|PKG-PURGE OPTIONS|" + bool --keep|-k { - "Keep the package archive. Note that in this mode the package is - still retained in the configuration's database in the \cb{fetched} - state." + "Keep the package archive. Note that in this mode the package is still + retained in the configuration's database in the \cb{fetched} state." } bool --force|-f { - "Purge a broken package. In this mode \cb{bpkg} will verify that - the package directory and archive no longer exist and will remove - the package from the configuration's database." + "Purge a broken package. In this mode \cb{bpkg} will verify that the + package directory and archive no longer exist and then remove the + package from the configuration." } }; } |