1TOPOLOGY()                                                          TOPOLOGY()
2
3
4

Command 'topology'

6   General options
7       -h     Show a short help message and exit.
8
9       -q     Be quiet.
10
11       -d     Print debugging information.
12
13       --version
14              Print version and exit.
15
16       -H HOSTNAME, --host HOSTNAME
17              Name of the host to run the command on.
18
19       -U USERNAME, --username USERNAME
20              Name  of  the  user to use for logging into the remote host over
21              SSH.  The default user name is 'root'.
22
23       -K PRIVKEY, --priv-key PRIVKEY
24              Path to the private SSH key that should be used for logging into
25              the remote host.  By default the key is automatically found from
26              standard paths like '$HOME/.ssh'.
27
28       -T TIMEOUT, --timeout TIMEOUT
29              SSH connection timeout in seconds, default is 8.
30
31       -D DATASET, --dataset DATASET
32              This option is for debugging and testing purposes only,  it  de‐
33              fines  the  dataset that will be used to emulate a host for run‐
34              ning the command on.  This option is typically used when running
35              'pepc'  from  the  source directory, which includes datasets for
36              many different systems.
37
38              The argument can be the  dataset  path,  'all'  to  specify  all
39              available  dataset or name in which case the following locations
40              will be searched for.
41
42              1. './tests/data', in the directory of the running program
43
44              2. '$PEPC_DATA_PATH/tests/data'
45
46              3. '$HOME/.local/share/pepc/tests/data'
47
48              4. '/usr/local/share/pepc/tests/data'
49
50              5. '/usr/share/pepc/tests/data'
51
52       --force-color
53              Force coloring of the text output.
54
55   Subcommand 'info'
56       Print CPU topology information.
57
58       Note, Linux kernel provides topology information only for online  CPUs,
59       but  not  for offline CPUs.  Therefore, unknown topology numbers (e.g.,
60       package number) for offline CPUs are substituted with "?".
61
62       --cpus CPUS
63              List of CPUs to print topology information for.   The  list  can
64              include individual CPU numbers and CPU number ranges.  For exam‐
65              ple,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to
66              12.  Use the special keyword 'all' to specify all CPUs.
67
68       --cores CORES
69              List  of  cores to print topology information for.  The list can
70              include individual core numbers and core number ranges.  For ex‐
71              ample,  '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and
72              10 to 12.  Use the special keyword 'all' to specify  all  cores.
73              This option has to be accompanied by '--package' option, because
74              core numbers are per-package.
75
76       --packages PACKAGES
77              List of packages to print topology information  for.   The  list
78              can  include  individual  package  numbers  and  package  number
79              ranges.  For example, '0,2-4' would mean package 0 and  packages
80              2 to 4.  Use the special keyword 'all' to specify all packages.
81
82       --core-siblings CORE_SIBLINGS
83              List  of core sibling indices to print topology information for.
84              The list can include individual core sibling  indices  or  index
85              ranges.   For  example,  core x includes CPUs 3 and 4, '0' would
86              mean CPU 3 and '1' would mean CPU 4.  This option  can  only  be
87              used  to  reference  online CPUs, because Linux does not provide
88              topology information for offline CPUs.  In the previous  example
89              if CPU 3 was offline, then '0' would mean CPU 4.
90
91       --order ORDER
92              By  default,  the topology table is printed in CPU number order.
93              Use this option to print it in a different order (e.g., core  or
94              package number order).  Here are the supported order names: cpu,
95              core, module, die, node, package.
96
97       --online-only
98              Include only online CPUs.  By default offline  and  online  CPUs
99              are included.
100
101       --columns COLUMNS
102              By  default,  the  topology columns are "CPU", "core", "module",
103              "die", "node", and "package".  The "die"  and  "module"  columns
104              are not printed if there is only one die per package and no mod‐
105              ules.  Use this option to select topology columns names and  or‐
106              der (e.g.'--columns Package,Core,CPU').
107
108
109
110                                  09-03-2023                        TOPOLOGY()
Impressum