aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README68
1 files changed, 68 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..9d8c127c
--- /dev/null
+++ b/README
@@ -0,0 +1,68 @@
+
+
+ For more information on contributing please see: https://www.trace-cmd.org
+
+Note: The official repositiory for trace-cmd and KernelShark is here:
+
+ git://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git
+
+For bug reports and issues, please file it here:
+
+ https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---
+
+These files make up the code that create the trace-cmd programs.
+This includes the GUI interface application kernelshark as well
+as trace-graph and trace-view.
+
+These files also make up the code to create the libtracecmd library.
+
+The applications are licensed under the GNU General Public License 2.0
+(see COPYING) and the libraries are licensed under the GNU
+Lesser General Public License 2.1 (See COPYING.LIB).
+
+BUILDING:
+
+In order to install build dependencies on Debian / Ubuntu do the following:
+ sudo apt-get install build-essential git pkg-config -y
+ sudo apt-get install libtracefs-dev libtraceevent-dev -y
+
+In order to install build dependencies on Fedora, as root do the following:
+ dnf install gcc make git pkg-config -y
+ dnf install libtracefs-devel libtraceevent-devel -y
+
+In case your distribution does not have the required libtracefs and
+libtraceevent libraries, build and install them manually:
+
+ git clone https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
+ cd libtraceevent
+ make
+ sudo make install
+
+ git clone https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
+ cd libtracefs
+ make
+ sudo make install
+
+To make trace-cmd
+ make
+
+To make the gui
+ make gui
+
+INSTALL:
+
+To install trace-cmd
+ make install
+
+To install the gui
+ make install_gui
+
+Note: The default install is relative to /usr/local
+ The default install directory is /usr/local/bin
+ The default plugin directory is /usr/local/lib/trace-cmd/plugins
+
+To change the default, you can set 'prefix', eg
+mkdir $HOME/test-trace
+make prefix=$HOME/test-trace
+make prefix=$HOME/test-trace install
+