OS Manuals

/usr/bin/hwloc-ls

Portable abstraction of hierarchical hardware architectures with CUDA support

From hwloc-cuda-12.4 2.15.0-r0 (enterprise-packages), captured 2026-11-08 by running hwloc-ls --help (exit 0). permalink

Usage: hwloc-ls [ options ] ... [ filename.format ]

See lstopo(1) for more details.

Default output is console.
Supported output file formats: console, ascii, tikz, fig, svg(native), xml, synthetic

Formatting options:
  -l --logical          Display hwloc logical object indexes
  -p --physical         Display OS/physical object indexes
Output options:
  --output-format <format>
  --of <format>         Force the output to use the given format
  -f --force            Overwrite the output file if it exists
Textual output options:
  --only <type>         Only show objects of the given type in the textual output
  -v --verbose          Include additional details
  -q --quiet -s         Reduce the amount of details to show
  --distances           Only show distance matrices
  --distances-transform <links|merge-switch-ports|transitive-closure>
                        Transform distances before displaying them
  --memattrs            Only show memory attributes
  --cpukinds            Only show CPU kinds
  -c --cpuset           Show the cpuset of each object
  -C --cpuset-only      Only show the cpuset of each object
  --cpuset-output-format <hwloc|list|taskset>
  --cof <hwloc|list|taskset>
                        Change the format of cpuset outputs
Object filtering options:
  --filter <type>:<knd> Filter objects of the given type, or all.
     <knd> may be `all' (keep all), `none' (remove all), `structure' or `important'
  --ignore <type>       Ignore objects of the given type
  --no-smt              Ignore PUs
  --no-caches           Do not show caches
  --no-useless-caches   Do not show caches which do not have a hierarchical
                        impact
  --no-icaches          Do not show instruction caches
  --merge               Do not show levels that do not have a hierarchical
                        impact
  --no-collapse         Do not collapse identical PCI devices
  --restrict [nodeset=]<bitmap>
                        Restrict the topology to some processors or NUMA nodes.
  --restrict binding    Restrict the topology to the current process binding
  --restrict-flags <n>  Set the flags to be used during restrict
  --no-io               Do not show any I/O device or bridge
  --no-bridges          Do not any I/O bridge except hostbridges
  --whole-io            Show all I/O devices and bridges
Input options:
  --input <XML file>
  -i <XML file>         Read topology from XML file <path>
  --input <directory>
  -i <directory>        Read topology from chroot containing the /proc and /sys
                        of another system
  --input <directory>
  -i <directory>        Read topology from directory containing a CPUID dump
  --input "node:2 2"
  -i "node:2 2"         Simulate a fake hierarchy, here with 2 NUMA nodes of 2
                        processors
  --input-format <format>
  --if <format>         Enforce input format among xml, fsroot, cpuid, synthetic
  --thissystem          Assume that the input topology provides the topology
                        for the system on which we are running
  --pid <pid>           Detect topology as seen by process <pid>
  --disallowed          Include objects disallowed by administrative limitations
  --allow <all|local|...>   Change the set of objects marked as allowed
  --flags <n>           Set the topology flags
Graphical output options:
  --children-order <memory:above|io:right:vert|...|plain>
                        Change the layout of Memory, I/O or Misc children
  --no-factorize        Do not factorize identical objects
  --no-factorize=<type> Do not factorize identical objects of type <type>
  --factorize           Factorize identical objects (default)
  --factorize=[<type>,]<N>[,<L>[,<F>]]
                        Set the minimum number <N> of objects to factorize,
                        the numbers of first <F> and last <L> to keep,
                        for all or only the given object type <type>
  --no-cpukinds         Do not show CPU kinds
  --fontsize 10         Set size of text font
  --gridsize 7          Set size of margin between elements
  --linespacing 4       Set spacing between lines of text
  --thickness 1         Set thickness of lines and boxes
  --horiz[=<type,...>]  Horizontal graphical layout instead of nearly 4/3 ratio
  --vert[=<type,...>]   Vertical graphical layout instead of nearly 4/3 ratio
  --rect[=<type,...>]   Rectangular graphical layout with nearly 4/3 ratio
  --text[=<type,...>]   Display text for the given object types
  --no-text[=<type,..>] Do not display text for the given object types
  --index=[<type,...>]  Display indexes for the given object types
  --no-index=[<type,.>] Do not display indexes for the given object types
  --attrs=[<type,...>]  Display attributes for the given object types
  --no-attrs=[<type,.>] Do not display attributes for the given object types
  --no-legend           Remove all text legend lines at the bottom
  --no-default-legend   Remove default text legend lines at the bottom
  --append-legend <s>   Append a new line of text at the bottom of the legend
  --grey --palette grey Use greyscale instead of colors
  --palette white       Use white instead of colors for background
  --palette <type>=<#xxyyzz>
                        Replace the color for object of the given type
  --binding-color <none|#xxyyzz>
                        Disable or change binding PU and NUMA nodes color
  --disallowed-color <none|#xxyyzz>
                        Disable or change disallowed PU and NUMA nodes color
  --top-color <none|#xxyyzz>
                        Disable or change task background color for --top
Miscellaneous options:
  --logical-index-prefix <s> --os-index-prefix <s>
                        Use <s> as a prefix for logical or physical/OS indexes
  --export-xml-flags <n>
                        Set flags during the XML topology export
  --export-synthetic-flags <n>
                        Set flags during the synthetic topology export
  --ps --top            Display processes within the hierarchy
  --misc-from <file>    Create Misc objects as defined in <file>  --version             Report version and exit
  -h --help             Show this usage
Options (72)
OptionDescriptionSource
-l --logicalDisplay hwloc logical indexes of all objects, with prefix "L#".help + man
-p --physicalDisplay OS/physical indexes of all objects, with prefix "P#".help + man
--output-format formathelp
--of formatForce the output to use the given formathelp + man
-f --forceIf the destination file already exists, overwrite it.help + man
--only typeOnly show objects of the given type in the textual output.help + man
-v --verboseInclude additional detailshelp + man
-q --quietReduce the amount of details to show.help + man
--distancesOnly display distance matrices.help + man
--distances-transformTry applying a transformation to distances structures before displaying them.help + man
--memattrsOnly display memory attributes.help + man
--cpukindsOnly display CPU kinds.help + man
-c --cpusetDisplay the cpuset of each object.help + man
-C --cpuset-onlyOnly display the cpuset of each object;help + man
--cpuset-output-format hwloc|list|tasksetChange the format of displayed CPU set strings.help + man
--cof hwloc|list|tasksetChange the format of cpuset outputshelp
--ignore typeThis is the old way to specify --filter <type>:none.help + man
--no-smtIgnore PUs.help + man
--no-cachesDo not show caches.help + man
--no-useless-cachesDo not show caches which do not have a hierarchical impacthelp + man
--no-icachesThis is identical to --filter icache:none.help + man
--mergeDo not show levels that do not have a hierarchical impact.help + man
--no-collapseDo not collapse identical PCI devices.help + man
--restrict nodeset=]<bitmapRestrict the topology to some processors or NUMA nodes.help + man
--restrict-flags nEnforce flags when restricting the topology.help + man
--no-ioDo not show any I/O device or bridge.help + man
--no-bridgesDo not show any I/O bridge except hostbridges.help + man
--whole-ioShow all I/O devices and bridges.help + man
-i XMLRead the topology from <path> instead of discovering the topology of the local machine.help + man
--input directoryhelp
--input-format formathelp
--if formatEnforce the input in the given format, among xml, fsroot, cpuid and synthetic.help + man
--thissystemAssume that the selected backend provides the topology for the system on which we are running.help + man
--pid pidDetect topology as seen by process <pid>, i.e. as if process <pid> did the discovery itself.help + man
--disallowedInclude objects disallowed by administrative limitations (e.g Cgroups on Linux).help + man
--allow all|local|...Include objects disallowed by administrative limitations (implies --disallowed) and also change the set of allowed ones.help + man
--flags nEnforce topology flags.help + man
--children-order memory:above|io:right:vert|...|plainChange the order of the different kinds of children with respect to their parent in the graphical output.help + man
--no-factorize --no-factorize=<typeNever factorize identical objects in the graphical output.help + man
--factorizeFactorize identical objects (default)help
--no-cpukindsDo not show different kinds of CPUs in the graphical output.help + man
--fontsize 10Set the size of text font in the graphical output.help + man
--gridsize 7Set the margin between elements in the graphical output.help + man
--linespacing 4Set the spacing between lines of text in the graphical output.help + man
--thickness 1Set the thickness of lines and boxes in the graphical output.help + man
--horiz typeForce a horizontal graphical layout instead of nearly 4/3 ratio in the graphical output.help + man
--vert typeForce a vertical graphical layout instead of nearly 4/3 ratio in the graphical output.help + man
--rect typeForce a rectangular graphical layout with nearly 4/3 ratio in the graphical output.help + man
--text typeDisplay text in boxes in the graphical output (default).help + man
--index typeShow object indexes in the graphical output (default).help + man
--attrs typeShow object attributes (such as memory size, cache size, PCI bus ID, PCI link speed, etc.) in the graphical output (default).help + man
--no-legendRemove all text legend lines at the bottom of the graphical output.help + man
--no-default-legendRemove default text legend lines at the bottom of the graphical output.help + man
--append-legend sAppend the line of text to the bottom of the legend in the graphical output.help + man
--palette whiteUse white instead of colors for backgroundhelp + man
--binding-color none|#xxyyzzDo not colorize PUs and NUMA nodes according to the binding in the graphical output.help + man
--disallowed-color none|#xxyyzzDo not colorize disallowed PUs and NUMA nodes in the graphical output.help + man
--top-color none|#xxyyzzDo not colorize task objects in the graphical output when --top is given.help + man
--export-xml-flags nEnforce flags when exporting to the XML format.help + man
--export-synthetic-flags nEnforce flags when exporting to the synthetic format.help + man
--ps --topShow existing processes as misc objects in the output.help + man
--misc-from fileCreate Misc objects as defined in <file> --version Report version and exithelp + man
-h --helpDisplay help message and exit.help + man
--windows-processor-groupsOn Windows, only show information about processor groups. (in the manual page but not in --help)man
--logical-index-prefix prefixReplace " L#" with the given prefix for logical indexes. (in the manual page but not in --help)man
--os-index-prefix prefixReplace " P#" with the given prefix for physical/OS indexes. (in the manual page but not in --help)man
--filter, --filter type>:<kindFilter objects of type <type>, or of any type if <type> is "all". (in the manual page but not in --help)man
--no-text, --no-text type1Do not display any text in boxes in the graphical output. (in the manual page but not in --help)man
--no-index, --no-index type1Do not show object indexes in the graphical output. (in the manual page but not in --help)man
--no-attrs, --no-attrs type1Do not show object attributes (such as memory size, cache size, PCI bus ID, PCI link speed, etc.) in the graphical output. (in the manual page but not in --help)man
--grey, --greyscaleUse greyscale instead of colors in the graphical output. (in the manual page but not in --help)man
--versionReport version and exit. (in the manual page but not in --help)man
Examples (4) from the manual page, untested

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.