1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 4<title>4.�README</title> 5<link rel="stylesheet" type="text/css" href="vg_basic.css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="Valgrind Documentation"> 8<link rel="up" href="dist.html" title="Valgrind Distribution Documents"> 9<link rel="prev" href="dist.news.old.html" title="3.�OLDER NEWS"> 10<link rel="next" href="dist.readme-missing.html" title="5.�README_MISSING_SYSCALL_OR_IOCTL"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<div><table class="nav" width="100%" cellspacing="3" cellpadding="3" border="0" summary="Navigation header"><tr> 14<td width="22px" align="center" valign="middle"><a accesskey="p" href="dist.news.old.html"><img src="images/prev.png" width="18" height="21" border="0" alt="Prev"></a></td> 15<td width="25px" align="center" valign="middle"><a accesskey="u" href="dist.html"><img src="images/up.png" width="21" height="18" border="0" alt="Up"></a></td> 16<td width="31px" align="center" valign="middle"><a accesskey="h" href="index.html"><img src="images/home.png" width="27" height="20" border="0" alt="Up"></a></td> 17<th align="center" valign="middle">Valgrind Distribution Documents</th> 18<td width="22px" align="center" valign="middle"><a accesskey="n" href="dist.readme-missing.html"><img src="images/next.png" width="18" height="21" border="0" alt="Next"></a></td> 19</tr></table></div> 20<div class="chapter"> 21<div class="titlepage"><div><div><h1 class="title"> 22<a name="dist.readme"></a>4.�README</h1></div></div></div> 23<div class="literallayout"><p><br> 24������<br> 25Release�notes�for�Valgrind<br> 26~~~~~~~~~~~~~~~~~~~~~~~~~~<br> 27If�you�are�building�a�binary�package�of�Valgrind�for�distribution,<br> 28please�read�README_PACKAGERS.��It�contains�some�important�information.<br> 29<br> 30If�you�are�developing�Valgrind,�please�read�README_DEVELOPERS.��It�contains<br> 31some�useful�information.<br> 32<br> 33For�instructions�on�how�to�build/install,�see�the�end�of�this�file.<br> 34<br> 35If�you�have�problems,�consult�the�FAQ�to�see�if�there�are�workarounds.<br> 36<br> 37<br> 38Executive�Summary<br> 39~~~~~~~~~~~~~~~~~<br> 40Valgrind�is�a�framework�for�building�dynamic�analysis�tools.�There�are<br> 41Valgrind�tools�that�can�automatically�detect�many�memory�management<br> 42and�threading�bugs,�and�profile�your�programs�in�detail.�You�can�also<br> 43use�Valgrind�to�build�new�tools.<br> 44<br> 45The�Valgrind�distribution�currently�includes�six�production-quality<br> 46tools:�a�memory�error�detector,�two�thread�error�detectors,�a�cache<br> 47and�branch-prediction�profiler,�a�call-graph�generating�cache�abd<br> 48branch-prediction�profiler,�and�a�heap�profiler.�It�also�includes<br> 49three�experimental�tools:�a�heap/stack/global�array�overrun�detector,<br> 50a�different�kind�of�heap�profiler,�and�a�SimPoint�basic�block�vector<br> 51generator.<br> 52<br> 53Valgrind�is�closely�tied�to�details�of�the�CPU,�operating�system�and�to<br> 54a�lesser�extent,�compiler�and�basic�C�libraries.�This�makes�it�difficult<br> 55to�make�it�portable.��Nonetheless,�it�is�available�for�the�following<br> 56platforms:�<br> 57<br> 58-�X86/Linux<br> 59-�AMD64/Linux<br> 60-�PPC32/Linux<br> 61-�PPC64/Linux<br> 62-�ARM/Linux<br> 63-�x86/MacOSX<br> 64-�AMD64/MacOSX<br> 65-�S390X/Linux<br> 66-�MIPS32/Linux<br> 67-�MIPS64/Linux<br> 68-�X86/Solaris<br> 69-�AMD64/Solaris<br> 70<br> 71Note�that�AMD64�is�just�another�name�for�x86_64,�and�Valgrind�runs�fine<br> 72on�Intel�processors.��Also�note�that�the�core�of�MacOSX�is�called<br> 73"Darwin"�and�this�name�is�used�sometimes.<br> 74<br> 75Valgrind�is�licensed�under�the�GNU�General�Public�License,�version�2.�<br> 76Read�the�file�COPYING�in�the�source�distribution�for�details.<br> 77<br> 78However:�if�you�contribute�code,�you�need�to�make�it�available�as�GPL<br> 79version�2�or�later,�and�not�2-only.<br> 80<br> 81<br> 82Documentation<br> 83~~~~~~~~~~~~~<br> 84A�comprehensive�user�guide�is�supplied.��Point�your�browser�at<br> 85$PREFIX/share/doc/valgrind/manual.html,�where�$PREFIX�is�whatever�you<br> 86specified�with�--prefix=�when�building.<br> 87<br> 88<br> 89Building�and�installing�it<br> 90~~~~~~~~~~~~~~~~~~~~~~~~~~<br> 91To�install�from�the�Subversion�repository�:<br> 92<br> 93��0.�Check�out�the�code�from�SVN,�following�the�instructions�at<br> 94�����http://www.valgrind.org/downloads/repository.html.<br> 95<br> 96��1.�cd�into�the�source�directory.<br> 97<br> 98��2.�Run�./autogen.sh�to�setup�the�environment�(you�need�the�standard<br> 99�����autoconf�tools�to�do�so).<br> 100<br> 101��3.�Continue�with�the�following�instructions...<br> 102<br> 103To�install�from�a�tar.bz2�distribution:<br> 104<br> 105��4.�Run�./configure,�with�some�options�if�you�wish.��The�only�interesting<br> 106�����one�is�the�usual�--prefix=/where/you/want/it/installed.<br> 107<br> 108��5.�Run�"make".<br> 109<br> 110��6.�Run�"make�install",�possibly�as�root�if�the�destination�permissions<br> 111�����require�that.<br> 112<br> 113��7.�See�if�it�works.��Try�"valgrind�ls�-l".��Either�this�works,�or�it<br> 114�����bombs�out�with�some�complaint.��In�that�case,�please�let�us�know<br> 115�����(see�www.valgrind.org).<br> 116<br> 117Important!��Do�not�move�the�valgrind�installation�into�a�place<br> 118different�from�that�specified�by�--prefix�at�build�time.��This�will<br> 119cause�things�to�break�in�subtle�ways,�mostly�when�Valgrind�handles<br> 120fork/exec�calls.<br> 121<br> 122<br> 123The�Valgrind�Developers<br> 124<br> 125����</p></div> 126</div> 127<div> 128<br><table class="nav" width="100%" cellspacing="3" cellpadding="2" border="0" summary="Navigation footer"> 129<tr> 130<td rowspan="2" width="40%" align="left"> 131<a accesskey="p" href="dist.news.old.html"><<�3.�OLDER NEWS</a>�</td> 132<td width="20%" align="center"><a accesskey="u" href="dist.html">Up</a></td> 133<td rowspan="2" width="40%" align="right">�<a accesskey="n" href="dist.readme-missing.html">5.�README_MISSING_SYSCALL_OR_IOCTL�>></a> 134</td> 135</tr> 136<tr><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td></tr> 137</table> 138</div> 139</body> 140</html> 141
