Fix link to llvmgcc.
[oota-llvm.git] / docs / CommandGuide / llvm-abcd.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <HTML><HEAD><TITLE>LLVM: llvm-abcd tool</TITLE>
3 <META http-equiv=Content-Type content="text/html; charset=iso-8859-1">
4 <BODY bgColor=white>
5 <CENTER>
6 <H1>LLVM: <TT>llvm-abcd</TT> tool</H1></CENTER>
7 <HR>
8 <H3>NAME</H3><TT>llvm-abcd</TT> 
9 <H3>SYNOPSIS</H3><TT>llvm-abcd [options] [filename]</TT> 
10 <H3>DESCRIPTION</H3>The <TT>llvm-abcd</TT> command is a small utility for analyzing
11 bytecode files. The <TT>abcd</TT> acronym stands for <u>a</u>nalysis of 
12 <u>b</u>yte<u>c</u>ode <u>d</u>isplayer. The tool reads a bytecode file (such as 
13 generated with the <TT>llvm-abcd</TT> tool) and produces statistical and low level 
14 bytecode format dumps. This tool is probably not of much interest or utility except
15 for those working directly with the bytecode format. Most LLVM users can just ignore
16 this tool.  
17 <P>If filename is omitted or is -, then <TT>llvm-abcd</TT> reads its input from 
18 standard input. This is useful for combining <TT>llvm-abcd</TT> in a pipeline.
19 <P>
20 <H3>OPTIONS</H3>
21 <UL>
22   <LI>-nodetails <BR>Causes <TT>llvm-abcd</TT> to abbreviate its output by writing
23   out only a module level summary. The details for individual functions are not 
24   displayed.
25   <P></P>
26   <LI>-dump <BR>Causes <TT>llvm-abcd</TT> to dump the bytecode in a human readable 
27   format. This format is significantly different from LLVM assembly and provides
28   details about the encoding of the bytecode file. 
29   <P></P>
30   <LI>-verify <BR>Causes <TT>llvm-abcd</TT> to verify the module produced by
31   by reading the bytecode. This ensures that the statistics generated are reliable.
32   <P></P>
33   <LI>-help <BR>Print a summary of command line options. 
34   <P></P></LI></UL>
35 <H3>EXIT STATUS</H3>If <TT>llvm-abcd</TT> succeeds, it will exit with 0. 
36 Otherwise, if an error occurs, it will exit with a non-zero value, usually 1.
37 <H3>SEE ALSO</H3>
38 <A href="llvm-dis.html"><TT>llvm-dis</TT></A>
39 <A href="../docs/BytecodeFormat.html"><TT>LLVM Bytecode File Format</TT></A> 
40
41 <HR>
42 Maintained by <a href="mailto:rspencer@x10sys.com">Reid Spencer</A>. 
43 </BODY></HTML>