]> granicus.if.org Git - sysstat/blob - README
30f32bb05f1751e465aeb0585aab236008db4b0b
[sysstat] / README
1 sysstat: System performance tools for the Linux operating system...
2 --
3 (C) 1999-2015 Sebastien GODARD (sysstat <at> orange.fr)
4
5 The latest version of sysstat can always be found on my web site at:
6
7 http://pagesperso-orange.fr/sebastien.godard/
8
9 See the CHANGES file to know the new features/improvements/bug fixes added
10 in this release of sysstat.
11
12 You can also track sysstat development on GitHub:
13
14 https://github.com/sysstat/sysstat
15
16 and clone its public repository with:
17
18 git clone git://github.com/sysstat/sysstat
19
20
21 INSTALLATION
22 ------------
23
24 The sysstat utilities are a collection of performance monitoring tools for
25 Linux. These include mpstat, iostat, tapestat, nfsiostat-sysstat, cifsiostat,
26 pidstat, sar, sadc, sadf and sa tools. 
27
28 The first stage is to configure sysstat for your system:
29
30         ./configure
31
32 You can set several variables and parameters on the command line.
33 Please enter "./configure --help" to display them.
34 There is another way to configure sysstat instead of entering "./configure":
35 this is the Interactive Configuration script (iconfig) which will ask you
36 for the value of the main sysstat variables and parameters.
37 Enter "./iconfig" then answer the questions or enter Return to accept
38 the (sane) default values. For yes/no questions, please answer 'y' or 'n'
39 (without the quotes): It is case sensitive! You can also enter '?' to get
40 a help message that will explain the meaning of each variable or parameter.
41
42 The next stage is to build the various binary files. Enter:
43
44         make
45
46 Then log in as root and enter:
47
48         make install
49
50 (see next section to know the files that are installed).
51 That's all!
52
53 Of course tell me if there are any problems. This is the only way I can improve
54 'sysstat'. Please also remember to read the FAQ included in this package.
55
56 Patches and suggestions for improvements are always welcome!
57 Send them to (sysstat <at> orange.fr).
58
59
60 FILES THAT ARE INSTALLED
61 ------------------------
62
63 Here is the list of files installed by sysstat, when you ask for a
64 complete installation.
65 ${PREFIX} is the value of the PREFIX variable defined in the Makefile
66 (usually set to /usr/local or /usr).
67
68 ${PREFIX}/lib/sa/sadc
69 ${PREFIX}/lib/sa/sa1
70 ${PREFIX}/lib/sa/sa2
71 ${PREFIX}/bin/sar
72 ${PREFIX}/bin/sadf
73 ${PREFIX}/bin/iostat
74 ${PREFIX}/bin/tapestat
75 ${PREFIX}/bin/mpstat
76 ${PREFIX}/bin/pidstat
77 ${PREFIX}/bin/nfsiostat-sysstat
78 ${PREFIX}/bin/cifsiostat
79 ${PREFIX}(/share)/man/man8/sadc.8
80 ${PREFIX}(/share)/man/man8/sa1.8
81 ${PREFIX}(/share)/man/man8/sa2.8
82 ${PREFIX}(/share)/man/man1/sar.1
83 ${PREFIX}(/share)/man/man1/sadf.1
84 ${PREFIX}(/share)/man/man1/iostat.1
85 ${PREFIX}(/share)/man/man1/tapestat.1
86 ${PREFIX}(/share)/man/man1/mpstat.1
87 ${PREFIX}(/share)/man/man1/pidstat.1
88 ${PREFIX}(/share)/man/man1/nfsiostat-sysstat.1
89 ${PREFIX}(/share)/man/man1/cifsiostat.1
90 ${PREFIX}/share/locale/*/LC_MESSAGES/sysstat.mo
91 ${PREFIX}/share/doc/sysstat-x.y.z/*
92 /var/log/sa
93 ${INIT_DIR}/sysstat
94 /lib/systemd/system/sysstat.service             if OS uses systemd
95 /lib/systemd/system/sysstat-collect.service     if OS uses systemd
96 /lib/systemd/system/sysstat-collect.timer       if OS uses systemd
97 /lib/systemd/system/sysstat-summary.service     if OS uses systemd
98 /lib/systemd/system/sysstat-summary.timer       if OS uses systemd
99 /etc/sysconfig/sysstat
100 /etc/sysconfig/sysstat.ioconf
101 /etc/cron.d/sysstat
102 /etc/rc.d/rc.sysstat                    (depending on your distro)
103 ${RC_DIR}/rc2.d/S03sysstat
104 ${RC_DIR}/rc3.d/S03sysstat
105 ${RC_DIR}/rc5.d/S03sysstat
106
107 sysstat may also install some links in ${RC_DIR}/rc[0146].d/ directory
108 if chkconfig is used.
109
110 MISCELLANEOUS
111 -------------
112
113 The sysstat commands are only front-ends to the kernel proc filesystem...
114 They cannot display statistics that Linux does not
115 provide, nor can they be more accurate than Linux is.
116 The sysstat package no longer supports 2.4.x and older kernels.
117 Note that all kernels do not necessarily have all the statistics that
118 sysstat commands can display, depending on their version or their
119 configuration options.
120
121 It has been designed with National Language Support (NLS) in mind, using
122 the GNU gettext package (available at http://www.gnu.org).
123 sysstat has been translated into several languages.
124 Anyway you are welcome if you want to make other translations available ;-)
125 Please read the README-nls file in the nls directory before.
126
127 --
128 Sebastien GODARD (sysstat <at> orange.fr)
129