pmaint eclass - generate eclass docs¶

Synopsis¶

pmaint eclass [--domain DOMAIN] [-h] [--debug] [-q] [-v]
              [--color BOOLEAN] [--dir OUTPUT_DIR] [--sandbox BOOLEAN]
              [-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

--sandbox BOOLEAN¶: Confine the run with Landlock where the kernel supports it: writes are limited to the paths the command legitimately needs, and outgoing TCP is denied. Enabled by default; ‘y’ turns an unsupported kernel into an error instead of continuing unconfined, and ‘n’ disables it.

-o, --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, --format {rst,man,html,devbook}¶: output format

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