hwloc-patch.1 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. .\" -*- nroff -*-
  2. .\" Copyright © 2013-2018 Inria. All rights reserved.
  3. .\" See COPYING in top-level directory.
  4. .TH HWLOC-PATCH "1" "Sep 07, 2023" "2.9.3" "hwloc"
  5. .SH NAME
  6. hwloc-patch \- Apply a topology difference to an existing XML topology
  7. .
  8. .\" **************************
  9. .\" Synopsis Section
  10. .\" **************************
  11. .SH SYNOPSIS
  12. .
  13. .PP
  14. .B hwloc-patch
  15. [\fIoptions\fR]
  16. \fI[<topology.xml> | refname]\fR
  17. \fI[<diff.xml> | -]\fR
  18. \fI<output.xml>\fR
  19. .PP
  20. .B hwloc-patch
  21. [\fIoptions\fR]
  22. \fI[<topology.xml> | refname]\fR
  23. \fI[<diff.xml> | -]\fR
  24. .
  25. .\" **************************
  26. .\" Options Section
  27. .\" **************************
  28. .SH OPTIONS
  29. .
  30. .TP 10
  31. \fB\-R \-\-reverse\fR
  32. Reverse the sense the difference file.
  33. .TP
  34. \fB\-\-version\fR
  35. Report version and exit.
  36. .TP
  37. \fB\-h\fR \fB\-\-help\fR
  38. Display help message and exit.
  39. .
  40. .\" **************************
  41. .\" Description Section
  42. .\" **************************
  43. .SH DESCRIPTION
  44. .
  45. hwloc-patch loads the difference between two topologies from a XML file
  46. (or from the standard input) and applies it to an
  47. existing topology, generating a new, modified one.
  48. .
  49. .PP
  50. The XML difference may have been computed earlier with hwloc-diff
  51. or hwloc-compress-dir.
  52. .
  53. .PP
  54. If <output.xml> is given, the new, modified topology is stored in that
  55. new file. Otherwise, <topology.xml> is modified in place.
  56. .
  57. .PP
  58. If \fBrefname\fR is given instead of <topology.xml>, the input topology filename
  59. is automatically guessed by reading the refname field of the XML diff file.
  60. By default hwloc-diff generates XML diffs with the right reference topology
  61. filename (without any path prefix).
  62. .
  63. .PP
  64. If \fB-\fR is given instead of <diff.xml>, the topology difference is read from
  65. the standard input.
  66. .
  67. .PP
  68. .B NOTE:
  69. If some application-specific userdata were been exported to the input XMLs,
  70. they will be ignored and discarded from the output because hwloc has no way
  71. to understand and patch them.
  72. .
  73. .PP
  74. .B NOTE:
  75. It is highly recommended that you read the hwloc(7) overview page
  76. before reading this man page. Most of the concepts described in
  77. hwloc(7) directly apply to the hwloc-patch utility.
  78. .
  79. .\" **************************
  80. .\" Examples Section
  81. .\" **************************
  82. .SH EXAMPLES
  83. .PP
  84. hwloc-patch's operation is best described through several examples.
  85. .
  86. .PP
  87. Apply a XML topology difference file to an existing topology:
  88. $ hwloc-patch fourmi023.xml diff.xml fourmi023-new.xml
  89. Apply a XML topology difference file whole refname field contains the right input topology:
  90. $ hwloc-patch refname diff.xml fourmi023-new.xml
  91. Apply a XML topology from the standard intput:
  92. $ cat diff.xml | hwloc-patch fourmi023.xml - fourmi023-new.xml
  93. Directly compute the difference between two topologies and apply it
  94. to another one, in place:
  95. $ hwloc-diff fourmi023.xml fourmi024.xml | hwloc-patch fourmi025.xml -
  96. .
  97. .\" **************************
  98. .\" Return value section
  99. .\" **************************
  100. .SH RETURN VALUE
  101. Upon successful execution, hwloc-patch outputs the modified topology.
  102. The return value is 0.
  103. .
  104. .PP
  105. hwloc-patch also returns nonzero if any kind of error occurs, such as
  106. (but not limited to) failure to parse the command line.
  107. .
  108. .\" **************************
  109. .\" See also section
  110. .\" **************************
  111. .SH SEE ALSO
  112. .
  113. .ft R
  114. hwloc(7), lstopo(1), hwloc-diff(1), hwloc-compress-dir(1)
  115. .sp