Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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_

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

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.

       none   No  new annotation is added. This	is useful when clearing	exist-
	      ing 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).  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 objects:

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

       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	 info-
       value

       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
       Upon  successful	 execution, hwloc-annotate generates the output	topol-
       ogy.  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.11.7				 Apr 27, 2017		     HWLOC-ANNOTATE(1)

NAME | SYNOPSIS | OPTIONS | DESCRIPTION | EXAMPLES | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=hwloc-annotate&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help