README.md
1RadeonTop
2=========
3
4View your GPU utilization, both for the total activity percent and individual blocks.
5
6Requires access to /dev/dri/cardN files or /dev/mem (root privileges).
7
8
9
10Supported cards
11---------------
12
13R600 and up, even Southern Islands should work fine.
14Works with both the open drivers and AMD Catalyst.
15
16For the Catalyst driver, only the mem path is currently supported - this
17means it won't run on the default Ubuntu kernels that block /dev/mem.
18
19The total GPU utilization is also valid for OpenCL loads; the other blocks
20are only useful in GL loads.
21
22Translations
23------------
24
25If you'd like to translate RadeonTop to your own language, please go here:
26
27https://translations.launchpad.net/radeontop
28
29Running
30-------
31
32#### Prerequisites
33
34* libdrm
35* libncurses
36* libpciaccess
37* libxcb
38
39
40Simply start radeontop and it auto-selects the first supported GPU:
41
42 ./radeontop
43
44
45Running radeontop on a bus 0f:
46
47 ./radeontop -b 0f
48
49
50Writing values to stdout instead of showing a GUI:
51
52 ./radeontop -d -
53
54
55Getting all options:
56
57 ./radeontop --help
58
59
60Building
61--------
62
63#### Prerequisites
64* all run time prerequisites with dev files
65* gcc / clang
66* pkgconf
67
68### Building
69If all prerequisites are fullfilled, it can be build by simply running:
70
71 make
72
73#### Build options
74
75Build options can be specified to having the following variables being set to "1"
76
77 nls enable translations, default on
78 debug enable debug symbols, default off
79 nostrip disable stripping, default off
80 plain apply neither gcc's -g nor -s.
81 xcb enable libxcb to run unprivileged in Xorg, default on
82 amdgpu enable amdgpu usage reporting, default auto (requires libdrm >= 2.4.63)
83
84
85Example:
86
87 make amdgpu=1 xcb=1
88
89This will build radeontop with amdgpu reporting and xcb support.
90
){kind=link}