POWERCAP-INFO(1)

πŸ“¦
version 0.6.0 Β· 2 versions
  • 0.6.0 Β· debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 0.5.0 Β· ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ‘‘ POWERCAP-INFO(1) β€” the powercap-info page, but make it cute πŸ’…

okay bestie, welcome to powercap-info from the powercap manual β€” yes it's the Linux power capping framework info-getter and yes it's iconic. sit down, grab a strawberry πŸ“, we're doing this.


✨ NAME ✨

powercap-info β€” get information from the Linux power capping framework. that's it, that's the girl. she prints, she doesn't set. periodt.


🌸 SYNOPSIS 🌸

powercap-info [NAME [OPTION]...] [-hv]

πŸ’– DESCRIPTION πŸ’–

She prints the configurations for powercap control types. that's her whole job and she eats every time.

You can filter the output by handing her a control type NAME and/or some OPTION flags, like a little build-your-own-query moment.

⚠️ a control type NAME must not be empty and must not contain a . or a /. not negotiable, she's picky about her names.

πŸŽ€ OPTIONS πŸŽ€

the general girlies (no control type needed)

  • -h, --help β€” prints the help screen 🫢
  • -v, --verbose β€” print errors when files cannot be read (aka: tell me when things go wrong instead of staying silent about it πŸ’€)
  • -p, --control-type=NAME β€” deprecated, bestie. just pass NAME as the first positional argument instead, it's giving 2021. πŸ™ˆ

everything below this line needs a control type NAME

  • -z, --zone=ZONE(S) β€” the zone/subzone numbers in the control type's powercap tree (defaults to the control type's root). separate zones/subzones with a colon. e.g., for zone 0, subzone 2: -z 0:2. ending with a colon prevents output for subzones β€” e.g., for zone 0 but not subzones: -z 0: ✨
  • -c, --constraint=CONSTRAINT β€” the constraint number

everything below this is mutually exclusive (pick ONE, she's not doing polyamory)

  • -E, --enabled β€” print control type enabled/disabled status
  • -n, --nzones β€” print the number of zones (control type's root by default; within the -z/--zone level, if set)

zone-level arguments β€” these need -z/--zone 🌈

  • -N, --nconstraints β€” print the number of zone constraints
  • -j, --z-energy β€” print zone energy counter
  • -J, --z-max-energy-range β€” print zone maximum energy counter range
  • -w, --z-power β€” print zone current power
  • -W, --z-max-power-range β€” print zone maximum current power range
  • -e, --z-enabled β€” print zone enabled/disabled status
  • -x, --z-name β€” print zone name

constraint-level arguments β€” these need BOTH -z/--zone AND -c/--constraint πŸ’…

  • -l, --c-power-limit β€” print constraint power limit
  • -s, --c-time-window β€” print constraint time window
  • -U, --c-max-power β€” print constraint maximum allowed power
  • -u, --c-min-power β€” print constraint minimum allowed power
  • -T, --c-max-time-window β€” print constraint maximum allowed time window
  • -t, --c-min-time-window β€” print constraint minimum allowed time window
  • -y, --c-name β€” print constraint name

πŸ¦‹ EXAMPLES πŸ¦‹

no cap, this is the fun part. copy-paste these and watch her go:

powercap-info print all zones for all control types.

powercap-info intel-rapl print all zones for the intel-rapl control type.

powercap-info intel-rapl -z 0 print only zone 0 for the intel-rapl control type.

powercap-info intel-rapl -z 0:1 print zone 0, subzone 1 for the intel-rapl control type.

powercap-info intel-rapl -z 0 -c 1 print zone 0, constraint 1 for the intel-rapl control type.

powercap-info intel-rapl -z 0 -j print the energy counter for zone 0 for the intel-rapl control type.

powercap-info intel-rapl -z 1:0 -c 0 -l print the power limit for zone 1, subzone 0, constraint 0 for the intel-rapl control type.


🌟 REMARKS 🌟

okay so a few things you need to know, bestie:

  • some fields are optional and/or may need administrative (super-user) privileges to read πŸ‘‘
  • fields will only be printed if they are available and readable, unless -v/--verbose is set
  • if no subzone/constraint-specific outputs are requested, all available zones and constraints will be shown β€” she's generous like that

and the units, because units matter and guessing is not the vibe:

  • Energy units: microjoules (uJ)
  • Power units: microwatts (uW)
  • Time units: microseconds (us)

πŸ’€ BUGS πŸ’€

found a bug? report bugs upstream at <https://github.com/powercap/powercap> β€” she'd love that for her, fr fr.


🧚 FILES 🧚

  • /sys/devices/virtual/powercap/*
  • /sys/class/powercap/*

πŸ’œ AUTHORS πŸ’œ

Connor Imes <connor.k.imes@gmail.com> β€” the main character who wrote this. respect.


πŸ”₯ SEE ALSO πŸ”₯

powercap-set(1) β€” her sister. go say hi.


and that's the whole page, bestie!! 🌈 this was powercap, dated 2021-12-12, version powercap-info(1) β€” ate and left no crumbs πŸ’…βœ¨ no notes, go read your /sys/class/powercap/* and slay πŸŽ€