hwloc-annotate(1) [centos man page]

HWLOC-ANNOTATE(1)						       hwloc							 HWLOC-ANNOTATE(1)

NAME

       hwloc-annotate - Add info attributes to a XML topology

SYNOPSIS

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

OPTIONS

       --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.

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.

       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:

       all    annotates all objects in the topology.

       root   annotates the root object of the topology.

       <type>:all
	      annotates all objects of the given type.

       <type>:<index>
	      annotates the object of the given type and index.  The index is logical.

       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 objects:

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

       Add an info attribute to the root object of the topology and modify the input XML directly:

	   $ hwloc-annotate file.xml file.xml root infoname infovalue

RETURN VALUE

       Upon successful execution, hwloc-annotate generates the output topology.  The return value is 0.

       hwloc-annotate will return nonzero if any kind of error occurs, such as (but not limited to) failure to parse the command line.

SEE ALSO

       hwloc(7), lstopo(1), hwloc-info(1)

1.7								   Apr 07, 2013 						 HWLOC-ANNOTATE(1)

HWLOC-DISTANCES(1)						       hwloc							HWLOC-DISTANCES(1)

NAME

       hwloc-distances - Displays distance matrices

SYNOPSIS

       hwloc-distances [options]

OPTIONS

       -l --logical
	      Display hwloc logical indexes (default) instead of physical/OS indexes.

       -p --physical
	      Display OS/physical indexes instead of hwloc logical indexes.

       -i <file>, --input <file>
	      Read topology from XML file <file> (instead of discovering the topology on the local machine).  If <file> is "-", the standard input
	      is used.	XML support must have been compiled in to hwloc for this option to be usable.

       -i <directory>, --input <directory>
	      Read topology from the chroot specified by <directory> (instead of discovering the topology on the local machine).  This	option	is
	      generally only available on Linux.  The chroot was usually created by gathering another machine topology with hwloc-gather-topology.

       -i <specification>, --input <specification>
	      Simulate	a  fake  hierarchy  (instead  of  discovering the topology on the local machine). If <specification> is "node:2 pu:3", the
	      topology will contain two NUMA nodes with 3 processing units in each of them.  The <specification> string must end with a number	of
	      PUs.

       --if <format>, --input-format <format>
	      Enforce the input in the given format, among xml, fsroot and synthetic.

       --restrict <cpuset>
	      Restrict the topology to the given cpuset.

       -v --verbose
	      Verbose messages.

       --version
	      Report version and exit.

DESCRIPTION

       hwloc-distances	displays also distance matrices attached to the topology.  A breadth-first traversal of the topology is performed starting
       from the root to find all distance matrices.

       NOTE: lstopo may also display distance matrices in its verbose textual output.  However lstopo only prints matrices that cover  the  entire
       topology while hwloc-distances also displays matrices that ignore part of the topology.

EXAMPLES

       On a quad-socket opteron machine:

	   $ hwloc-distances
	   Latency matrix between 4 NUMANodes (depth 2) by logical indexes:
	     index     0     1	   2	 3
		 0 1.000 1.600 2.200 2.200
		 1 1.600 1.000 2.200 2.200
		 2 2.200 2.200 1.000 1.600
		 3 2.200 2.200 1.600 1.000

RETURN VALUE

       Upon successful execution, hwloc-distances returns 0.

       hwloc-distances will return nonzero if any kind of error occurs, such as (but not limited to) failure to parse the command line.

SEE ALSO

       hwloc(7), lstopo(1)

1.7								   Apr 07, 2013 						HWLOC-DISTANCES(1)