Ubuntu Manpage: hwloc-annotate - Modify attributes in a XML topology

NAME

       hwloc-annotate - Modify attributes in a XML topology

SYNOPSIS

       hwloc-annotate [options] <input.xml> <output.xml> -- <location1> <location2> ... -- <mode> <annotation>

       hwloc-annotate [options] <input.xml> <output.xml> <location> <mode> <annotation>

       Note  that  hwloc(7) provides a detailed explanation of the hwloc system and of valid <location> formats;
       it should be read before reading this man page.

OPTIONS

       --ri      Remove all info attributes that exist with the same name  before  adding  the  new  one.   This
                 option  is  only  accepted  in  "info"  mode.  If the info value is omitted, existing infos are
                 replaced with nothing.

       --ci      Clear the existing info attributes  in  the  target  objects  before  annotating.   If  no  new
                 annotation has to be added after clearing, mode should be set to none.

       --cu      Clear the existing userdata from the target objects.  If nothing else has to be performed after
                 clearing, mode should be set to none.

       --cd      Clear  the  existing  distances  from  the topology.  If nothing else has to be performed after
                 clearing, mode should be set to none.

       -h --help Display help message and exit.

DESCRIPTION

hwloc-annotate loads a topology from a XML file, adds some annotations, and export the resulting topology
to another XML file. The input and output files may be the same.

The annotation may be string info attributes. This is specified by the mode:

info <name> <value>
Specifies a new string info attribute whose name is name and value is value.

misc <name>
Specifies a new Misc object name.

distances <filename> [<flags>]
Specifies new distances to be added to the topology using specifications in <filename>. The
optional flags (0 unless specified) corresponds to the flags given to the function
hwloc_distances_set(). location is ignored in this mode.

The first line of the pointed file must be a integer representing a distances kind as defined in
hwloc/distances.h. The second line is the number of objects involved in the distances. The next
lines contain one object each. The next lines contain one distance value each, or a single line
may be given with a integer combination of format x*y or x*y*z.

none No new annotation is added. This is useful when clearing existing attributes.

Annotations may be added to one specific object in the topology, all of them, or all of a given type.
This is specified by the location (see also EXAMPLES below). Multiple locations may be affected if they
are specified between --. Objects may be specified as location tuples, as explained in hwloc(7).
However hexadecimal bitmasks are not accepted since they may correspond to multiple objects.

NOTE: The existing annotations may be listed with hwloc-info.

NOTE: It is highly recommended that you read the hwloc(7) overview page before reading this man page.
Most of the concepts described in hwloc(7) directly apply to the hwloc-annotate utility.

EXAMPLES

       hwloc-annotate's operation is best described through several examples.

       Add an info attribute to all Core and PU objects:

           $ hwloc-annotate input.xml output.xml -- Core:all PU:all -- info infoname infovalue

       Only add to all Core objects:

           $ hwloc-annotate input.xml output.xml Core:all info infoname infovalue

       Add a Misc object named "foobar" under the root object of the topology and modify the input XML directly:

           $ hwloc-annotate file.xml file.xml root misc foobar

       Add an info attribute to OS device #2 and #3:

           $ hwloc-annotate input.xml output.xml os:2-3 info infoname infovalue

       Change package objects to green with red text in the lstopo graphical output:

           $ hwloc-annotate topo.xml topo.xml package:all info lstopoStyle "Background=#00ff00;Text=#ff0000"
           $ lstopo -i topo.xml

RETURN VALUE