Add a README.cygwin for Cygwin specific build/install instructions
[lttng-tools.git] / README.cygwin
CommitLineData
55924ad2
CB
1CYGWIN LTTNG-TOOLS PORT INSTALLATION & USAGE INSTRUCTIONS
2---------------------------------------------------------
3
4The Cygwin lttng-tools port is an *experimental* development branch based on
5the lttng-ust 2.0 stable version. This port is a *prototype* and should not be
6deployed in production.
7
8The latest version of the development branch can be found at:
9 * lttng-tools: git://git.lttng.org/lttng-tools.git -b cygwin-2.0-experimental
10
11PREREQUISITES
12
13- Cygwin 1.7.x available here: http://cygwin.com/setup.exe
14
15- lttng-tools dependencies (Cygwin packages available through setup.exe)
16 * autoconf
17 * automake
18 * gcc4
19 * libpopt0
20 * libtool
21 * popt
22
23INSTALLATION INSTRUCTIONS:
24
25The Cygwin lttng-tools port should be installed by carefully following the
26outlined instructions below:
27
28* lttng-tools
29
30 - Start a Cygwin shell.
31
32 - Download lttng-tools sources:
33
34 git clone git://git.lttng.org/lttng-tools.git -b cygwin-2.0-experimental
35
36 - Change directory and run the bootstrap script:
37
38 cd lttng-tools
39 ./bootstrap
40
41 - Run the configure script with these parameters:
42 LDFLAGS="-no-undefined" ./configure --prefix=/usr
43
44 - Run the make command and install lttng-tools
45 make
46 make install
47
48INSTRUMENTATION:
49
50Refer the to the lttng-ust(3) man page
51(Online version: http://lttng.org/files/doc/man-pages/man3/lttng-ust.3.html).
52
53CYGWIN PORT LIMITATIONS:
54
55- Since Cygwin doesn't support file descriptor passing over UNIX socket,
56 the SHMs (shared memory) and wait pipes are exposed via the filesystem in
57 /tmp/lttng-fds. This is a potential security issue.
58
59 For more information see commit 6684bfa4a76f566ff024d4f2159f59f2e783d8c2
60 in lttng-tools.
This page took 0.024624 seconds and 4 git commands to generate.