PMAINT(1)

NAME
pmaint - Wrapper for running commandline scripts.

SYNOPSIS

pmaint [-h] [--version] [--debug] [-q] [-v] [--color BOOLEAN] [--config CONFIG_PATH] {sync,copy,regen,env-update,eclass} ...

BASE OPTIONS

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

link https://docs.python.org/3/using/cmdline.html#cmdoption-version'--version link'
    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.

SUBCOMMANDS

general system maintenance

  pmaint sync - synchronize a local repository with its defined remote

  Synopsis

pmaint sync [-h] [--debug] [-q] [-v] [--color BOOLEAN] [-f] [repo ...]

  Positional Arguments

repo
    repo(s) to sync

  Options

-f, --force
    force syncing to occur regardless of staleness checks

  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.

  pmaint copy - copy binpkgs between repos; primarily useful for quickpkging a livefs pkg

  Synopsis

pmaint copy [--domain DOMAIN] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [-s SOURCE_REPO] [-i] target_repo query [query ...]

  Positional Arguments

target_repo
    repository to add packages to

query
    packages matching any of these restrictions will be selected for copying

  Config Options

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

  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.

  Subcommand Options

-s SOURCE_REPO, --source-repo SOURCE_REPO
    copy strictly from the supplied repository; else it copies from wherever a match is found

-i, --ignore-existing
    if a matching pkg already exists in the target, don't update it

  pmaint regen - regenerate repository caches

  Synopsis

pmaint regen [--domain DOMAIN] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [--disable-eclass-caching] [-t THREADS] [--force] [--dir CACHE_DIR] [--rsync] [--use-local-desc] [--pkg-desc-index] [repo ...]

  Positional Arguments

repo
    repo(s) to regenerate caches for

  Config Options

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

  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.

  Subcommand Options

--disable-eclass-caching

For regen operation, pkgcore internally turns on an optimization that
    caches eclasses into individual functions thus parsing the eclass only twice max per EBD processor. Disabling this optimization via this option results in ~2x slower regeneration. Disable it only if you suspect the optimization is somehow causing issues.

-t THREADS, --threads THREADS
    Number of threads to use for regeneration, defaults to using all available processors.

--force
    force regeneration to occur regardless of staleness checks or repo settings

--dir CACHE_DIR
    use separate directory to store repository caches

--rsync
    perform actions necessary for rsync repos (update metadata/timestamp.chk)

--use-local-desc
    update local USE flag description cache (profiles/use.local.desc)

--pkg-desc-index
    update package description cache (metadata/pkg_desc_index)

  pmaint env-update - update env.d and ldconfig

  Synopsis

pmaint env-update [--domain DOMAIN] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [--skip-ldconfig]

  Config Options

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

  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.

  Subcommand Options

--skip-ldconfig
    do not update etc/ldso.conf and ld.so.cache

  pmaint eclass - generate eclass docs

  Synopsis

pmaint eclass [--domain DOMAIN] [-h] [--debug] [-q] [-v] [--color BOOLEAN] [--dir OUTPUT_DIR] [-o OUTPUT_FORMAT] [-f {rst,man,html,devbook}] [-r REPO] [eclasses ...]

  Positional Arguments

eclasses
    eclasses to target

  Config Options

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

  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.

  Subcommand Options

--dir OUTPUT_DIR
    output directory

-o OUTPUT_FORMAT, --output OUTPUT_FORMAT
    Output file name format. Defaults to {eclass}.eclass.{format}. You can use {eclass} and {format} placeholders to customize the output file name. The filename can have path separator, for example: {eclass}/{eclass}.eclass.{format}.

-f {rst,man,html,devbook}, --format {rst,man,html,devbook}
    output format

-r REPO, --repo REPO
    Target repository to search for eclasses. If no repo is specified the default repo is used.

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

COPYRIGHT
2006-2022, pkgcore contributors