hwloc-diff.1 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. .\" -*- nroff -*-
  2. .\" Copyright © 2013-2018 Inria. All rights reserved.
  3. .\" See COPYING in top-level directory.
  4. .TH HWLOC-DIFF "1" "Sep 07, 2023" "2.9.3" "hwloc"
  5. .SH NAME
  6. hwloc-diff \- Compute differences between two XML topologies
  7. .
  8. .\" **************************
  9. .\" Synopsis Section
  10. .\" **************************
  11. .SH SYNOPSIS
  12. .
  13. .PP
  14. .B hwloc-diff
  15. [\fIoptions\fR]
  16. \fI<input1.xml>\fR
  17. \fI<input2.xml>\fR
  18. .PP
  19. .B hwloc-diff
  20. [\fIoptions\fR]
  21. \fI<input1.xml>\fR
  22. \fI<input2.xml>\fR
  23. \fI<output.xml>\fR
  24. .
  25. .\" **************************
  26. .\" Options Section
  27. .\" **************************
  28. .SH OPTIONS
  29. .
  30. .TP 10
  31. \fB\-\-refname\fR <name>
  32. Use <name> as the identifier for the reference topology
  33. in the output XML difference.
  34. It is meant to tell which topology should be used when applying
  35. the resulting difference.
  36. hwloc-patch may use that name to automatically load the relevant
  37. reference topology XML.
  38. By default, <input1.xml> is used without its full path.
  39. .TP
  40. \fB\-\-version\fR
  41. Report version and exit.
  42. .TP
  43. \fB\-h\fR \fB\-\-help\fR
  44. Display help message and exit.
  45. .
  46. .\" **************************
  47. .\" Description Section
  48. .\" **************************
  49. .SH DESCRIPTION
  50. .
  51. hwloc-diff computes the difference between two XML topologies
  52. and stores the result into <output.xml> if any, or dumps it
  53. to stdout otherwise.
  54. .
  55. .PP
  56. The output difference may later be applied to another topology
  57. with hwloc-patch.
  58. .
  59. .PP
  60. hwloc-compress-dir may be used for computing the diffs between
  61. all XML files in a directory.
  62. .
  63. .PP
  64. .B NOTE:
  65. If some application-specific userdata were been exported to the input XMLs,
  66. they will be ignored and discarded from the output because hwloc has no way
  67. to understand and compare them.
  68. .
  69. .PP
  70. .B NOTE:
  71. It is highly recommended that you read the hwloc(7) overview page
  72. before reading this man page. Most of the concepts described in
  73. hwloc(7) directly apply to the hwloc-diff utility.
  74. .
  75. .\" **************************
  76. .\" Examples Section
  77. .\" **************************
  78. .SH EXAMPLES
  79. .PP
  80. hwloc-diff's operation is best described through several examples.
  81. .
  82. .PP
  83. Compute the difference between two XML topologies and output it to stdout:
  84. $ hwloc-diff fourmi023.xml fourmi024.xml
  85. Found 11 differences, exporting to stdout
  86. <?xml version="1.0" encoding="UTF-8"?>
  87. ...
  88. Output the difference to file diff.xml instead:
  89. $ hwloc-diff fourmi023.xml fourmi024.xml diff.xml
  90. Found 11 differences, exporting to diff.xml
  91. When the difference is too complex to be represented:
  92. $ hwloc-diff fourmi023.xml avakas-frontend1.xml
  93. Found 1 differences, including 1 too complex ones.
  94. Cannot export differences to stdout
  95. Directly compute the difference between two topologies and apply it
  96. to another one:
  97. $ hwloc-diff fourmi023.xml fourmi024.xml | hwloc-patch fourmi025.xml -
  98. .
  99. .\" **************************
  100. .\" Return value section
  101. .\" **************************
  102. .SH RETURN VALUE
  103. Upon successful execution, hwloc-diff outputs the difference.
  104. The return value is 0.
  105. .
  106. .PP
  107. If the difference is too complex to be represented, an error is returned
  108. and the output is not generated.
  109. .
  110. .PP
  111. hwloc-diff also returns nonzero if any kind of error occurs, such as
  112. (but not limited to) failure to parse the command line.
  113. .
  114. .\" **************************
  115. .\" See also section
  116. .\" **************************
  117. .SH SEE ALSO
  118. .
  119. .ft R
  120. hwloc(7), lstopo(1), hwloc-patch(1), hwloc-compress-dir(1)
  121. .sp