PCLEAN(1)

NAME
pclean - Wrapper for running commandline scripts.

SYNOPSIS

pclean [-h] [--version] [--debug] [-q] [-v] [--color BOOLEAN] [--config CONFIG_PATH] [--domain DOMAIN] {config,dist,pkg,tmp} ...

BASE OPTIONS

-h, --help
    Show this help message and exit. To get more information see the related man page.

--version <https://docs.python.org/3/using/cmdline.html#cmdoption-version>
    Show this program's version information and exit.

    When running from within a git repo or a version installed from git the latest commit hash and date will be shown.

--debug
    Enable debug checks and show verbose debug output.

-q, --quiet
    Suppress non-error, informational messages.

-v, --verbose
    Increase the verbosity of various output.

--color BOOLEAN
    Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

CONFIG OPTIONS

--config CONFIG_PATH
    The path to a custom pkgcore config file or portage config directory can be given to override loading the default system config.

    Alternatively, an argument of 'false' or 'no' will skip loading the system config entirely if one exists.

--domain DOMAIN
    custom pkgcore domain to use for this operation

SUBCOMMANDS

cleaning applets

  pclean config - remove config file settings

  Synopsis

pclean config [-p] [-x EXCLUDE] [-X EXCLUDE_FILE] [-S PKGSET] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [TARGET ...]

  Generic Cleaning Options

TARGET
    packages to target for cleaning

-p, --pretend
    dry run without performing any changes

-x, --exclude EXCLUDE
    list of packages to exclude from removal

-X, --exclude-file EXCLUDE_FILE
    path to exclusion file

-S, --pkgsets PKGSET
    list of pkgsets to include or exclude from removal

  Base Options

-h, --help
    Show this help message and exit. To get more information see the related man page.

--debug
    Enable debug checks and show verbose debug output.

-q, --quiet
    Suppress non-error, informational messages.

-v, --verbose
    Increase the verbosity of various output.

--color BOOLEAN
    Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

  pclean dist - remove distfiles

  Synopsis

pclean dist [-p] [-x EXCLUDE] [-X EXCLUDE_FILE] [-S PKGSET] [-m TIME] [-s SIZE] [-I] [-E] [-f] [-r REPO] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [TARGET ...]

  Generic Cleaning Options

TARGET
    packages to target for cleaning

-p, --pretend
    dry run without performing any changes

-x, --exclude EXCLUDE
    list of packages to exclude from removal

-X, --exclude-file EXCLUDE_FILE
    path to exclusion file

-S, --pkgsets PKGSET
    list of pkgsets to include or exclude from removal

  File Cleaning Options

-m, --modified TIME
    Don't remove files that have been modified since a given time. For example, to skip files newer than a year use "1y" as an argument to this option. this option.

    Supported units are y, m, w, and d, and s representing years, months, weeks, days, and seconds, respectively.

-s, --size SIZE
    Don't remove files bigger than a given size. For example, to skip files larger than 100 megabytes use "100M" as an argument to this option.

    Supported units are B, K, M, and G representing bytes, kilobytes, megabytes, and gigabytes, respectively.

  Repo Cleaning Options

-I, --installed
    skip files for packages that are currently installed

-E, --exists
    skip files for packages that relate to ebuilds in the tree

-f, --fetch-restricted
    skip fetch-restricted files

-r, --repo REPO
    Target repository to search for matches. If no repo is specified all relevant repos are used.

  Base Options

-h, --help
    Show this help message and exit. To get more information see the related man page.

--debug
    Enable debug checks and show verbose debug output.

-q, --quiet
    Suppress non-error, informational messages.

-v, --verbose
    Increase the verbosity of various output.

--color BOOLEAN
    Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

  pclean pkg - remove binpkgs

  Synopsis

pclean pkg [-p] [-x EXCLUDE] [-X EXCLUDE_FILE] [-S PKGSET] [-m TIME] [-s SIZE] [-I] [-E] [-f] [-r REPO] [--source-repo REPO] [-b] [-c CHANGED] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [TARGET ...]

  Generic Cleaning Options

TARGET
    packages to target for cleaning

-p, --pretend
    dry run without performing any changes

-x, --exclude EXCLUDE
    list of packages to exclude from removal

-X, --exclude-file EXCLUDE_FILE
    path to exclusion file

-S, --pkgsets PKGSET
    list of pkgsets to include or exclude from removal

  File Cleaning Options

-m, --modified TIME
    Don't remove files that have been modified since a given time. For example, to skip files newer than a year use "1y" as an argument to this option. this option.

    Supported units are y, m, w, and d, and s representing years, months, weeks, days, and seconds, respectively.

-s, --size SIZE
    Don't remove files bigger than a given size. For example, to skip files larger than 100 megabytes use "100M" as an argument to this option.

    Supported units are B, K, M, and G representing bytes, kilobytes, megabytes, and gigabytes, respectively.

  Repo Cleaning Options

-I, --installed
    skip files for packages that are currently installed

-E, --exists
    skip files for packages that relate to ebuilds in the tree

-f, --fetch-restricted
    skip fetch-restricted files

-r, --repo REPO
    Target repository to search for matches. If no repo is specified all relevant repos are used.

  Binpkg Cleaning Options

--source-repo REPO
    remove binpkgs with matching source repo

-b, --bindist
    only remove binpkgs that restrict distribution

-c, --changed CHANGED
    comma separated list of package attributes to check for ebuild changes

  Base Options

-h, --help
    Show this help message and exit. To get more information see the related man page.

--debug
    Enable debug checks and show verbose debug output.

-q, --quiet
    Suppress non-error, informational messages.

-v, --verbose
    Increase the verbosity of various output.

--color BOOLEAN
    Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

  pclean tmp - remove tmpdir entries

  Synopsis

pclean tmp [-p] [-x EXCLUDE] [-X EXCLUDE_FILE] [-S PKGSET] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [-a] [TARGET ...]

  Generic Cleaning Options

TARGET
    packages to target for cleaning

-p, --pretend
    dry run without performing any changes

-x, --exclude EXCLUDE
    list of packages to exclude from removal

-X, --exclude-file EXCLUDE_FILE
    path to exclusion file

-S, --pkgsets PKGSET
    list of pkgsets to include or exclude from removal

  Base Options

-h, --help
    Show this help message and exit. To get more information see the related man page.

--debug
    Enable debug checks and show verbose debug output.

-q, --quiet
    Suppress non-error, informational messages.

-v, --verbose
    Increase the verbosity of various output.

--color BOOLEAN
    Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

  Tmpfile Options

-a, --all
    Force the entire tmpdir to be wiped. Note that this overrides any restrictions that have been specified.

Author
Michał Górny <mgorny@gentoo.org>, Tim Harder <radhermit@gmail.com>, Brian Harring <ferringb@gmail.com>, Arthur Zamarin <arthurzam@gentoo.org>, Marien Zwart <marienz@gentoo.org>

Copyright
2006-2022, pkgcore contributors