aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CommandGuide
diff options
context:
space:
mode:
authorShih-wei Liao <sliao@google.com>2010-04-07 12:21:42 -0700
committerShih-wei Liao <sliao@google.com>2010-04-07 12:21:42 -0700
commite4454320b3cfffe926a487c33fbeb454366de2f8 (patch)
tree133c05da684edf4a3b2529bcacfa996298c455f6 /docs/CommandGuide
parent20570085304f0a4ab4f112a01d77958bbd2827a1 (diff)
downloadexternal_llvm-e4454320b3cfffe926a487c33fbeb454366de2f8.tar.gz
external_llvm-e4454320b3cfffe926a487c33fbeb454366de2f8.tar.bz2
external_llvm-e4454320b3cfffe926a487c33fbeb454366de2f8.zip
libbcc
Change-Id: Ieaa3ebd5a38f370752495549f8870b534eeedfc5
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r--docs/CommandGuide/FileCheck.pod2
-rw-r--r--docs/CommandGuide/Makefile6
-rw-r--r--docs/CommandGuide/bugpoint.pod6
-rw-r--r--docs/CommandGuide/index.html4
-rw-r--r--docs/CommandGuide/llc.pod4
-rw-r--r--docs/CommandGuide/lli.pod6
-rw-r--r--docs/CommandGuide/llvm-as.pod2
-rw-r--r--docs/CommandGuide/llvm-bcanalyzer.pod2
-rw-r--r--docs/CommandGuide/llvm-config.pod2
-rw-r--r--docs/CommandGuide/llvm-db.pod16
-rw-r--r--docs/CommandGuide/llvm-dis.pod2
-rw-r--r--docs/CommandGuide/llvm-extract.pod10
-rw-r--r--docs/CommandGuide/llvm-link.pod2
-rw-r--r--docs/CommandGuide/llvm-nm.pod2
-rw-r--r--docs/CommandGuide/llvm-prof.pod2
-rw-r--r--docs/CommandGuide/llvm-ranlib.pod4
-rw-r--r--docs/CommandGuide/llvmc.pod4
-rw-r--r--docs/CommandGuide/tblgen.pod2
18 files changed, 34 insertions, 44 deletions
diff --git a/docs/CommandGuide/FileCheck.pod b/docs/CommandGuide/FileCheck.pod
index 32516ad87b..433979a871 100644
--- a/docs/CommandGuide/FileCheck.pod
+++ b/docs/CommandGuide/FileCheck.pod
@@ -25,7 +25,7 @@ match. The file to verify is always read from standard input.
=over
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
diff --git a/docs/CommandGuide/Makefile b/docs/CommandGuide/Makefile
index 3b65183107..2c2d0760e7 100644
--- a/docs/CommandGuide/Makefile
+++ b/docs/CommandGuide/Makefile
@@ -77,9 +77,9 @@ EXTRA_DIST := $(POD) index.html
clean-local::
$(Verb) $(RM) -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
-HTML_DIR := $(PROJ_docsdir)/html/CommandGuide
-MAN_DIR := $(PROJ_mandir)/man1
-PS_DIR := $(PROJ_docsdir)/ps
+HTML_DIR := $(DESTDIR)$(PROJ_docsdir)/html/CommandGuide
+MAN_DIR := $(DESTDIR)$(PROJ_mandir)/man1
+PS_DIR := $(DESTDIR)$(PROJ_docsdir)/ps
install-local:: $(HTML) $(INSTALL_MANS) $(PS)
$(Echo) Installing HTML CommandGuide Documentation
diff --git a/docs/CommandGuide/bugpoint.pod b/docs/CommandGuide/bugpoint.pod
index 204ea4d3d3..7afeea1aba 100644
--- a/docs/CommandGuide/bugpoint.pod
+++ b/docs/CommandGuide/bugpoint.pod
@@ -85,7 +85,7 @@ mis-management.
Continually randomize the specified passes and run them on the test program
until a bug is found or the user kills B<bugpoint>.
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
@@ -99,9 +99,9 @@ it runs, to come from that file.
Load the dynamic object F<plugin> into B<bugpoint> itself. This object should
register new optimization passes. Once loaded, the object will add new command
line options to enable various optimizations. To see the new complete list of
-optimizations, use the B<--help> and B<--load> options together; for example:
+optimizations, use the B<-help> and B<--load> options together; for example:
- bugpoint --load myNewPass.so --help
+ bugpoint --load myNewPass.so -help
=item B<--mlimit> F<megabytes>
diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html
index 88bb87c5df..0bdba7ea5d 100644
--- a/docs/CommandGuide/index.html
+++ b/docs/CommandGuide/index.html
@@ -17,7 +17,7 @@
for all of the LLVM tools. These pages describe how to use the LLVM commands
and what their options are. Note that these pages do not describe all of the
options available for all tools. To get a complete listing, pass the
-<tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging
+<tt>-help</tt> (general options) or <tt>-help-hidden</tt> (general+debugging
options) arguments to the tool you are interested in.</p>
</div>
@@ -148,7 +148,7 @@ options) arguments to the tool you are interested in.</p>
src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
<a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
- Last modified: $Date: 2009-10-18 20:54:13 -0700 (Sun, 18 Oct 2009) $
+ Last modified: $Date: 2010-02-18 22:08:13 +0800 (四, 18 2月 2010) $
</address>
</body>
diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod
index 8adfb682be..ac24aab4ff 100644
--- a/docs/CommandGuide/llc.pod
+++ b/docs/CommandGuide/llc.pod
@@ -38,7 +38,7 @@ Other B<llc> options are as follows:
=over
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
@@ -56,7 +56,7 @@ string.
=item B<-march>=I<arch>
Specify the architecture for which to generate assembly, overriding the target
-encoded in the input file. See the output of B<llc --help> for a list of
+encoded in the input file. See the output of B<llc -help> for a list of
valid architectures. By default this is inferred from the target triple or
autodetected to the current architecture.
diff --git a/docs/CommandGuide/lli.pod b/docs/CommandGuide/lli.pod
index e9fdf74fe5..6d1e1c65d4 100644
--- a/docs/CommandGuide/lli.pod
+++ b/docs/CommandGuide/lli.pod
@@ -73,7 +73,7 @@ architecture which is not compatible with the current system.
=item B<-march>=I<arch>
Specify the architecture for which to generate assembly, overriding the target
-encoded in the bitcode file. See the output of B<llc --help> for a list of
+encoded in the bitcode file. See the output of B<llc -help> for a list of
valid architectures. By default this is inferred from the target triple or
autodetected to the current architecture.
@@ -170,7 +170,7 @@ Instruction schedulers available (before register allocation):
=item B<-regalloc>=I<allocator>
-Register allocator to use: (default = linearscan)
+Register allocator to use (default=linearscan)
=bigblock: Big-block register allocator
=linearscan: linear scan register allocator =local - local register allocator
@@ -186,7 +186,7 @@ Choose relocation model from:
=item B<-spiller>
-Spiller to use: (default: local)
+Spiller to use (default=local)
=simple: simple spiller
=local: local spiller
diff --git a/docs/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod
index 045a9245b6..185c009698 100644
--- a/docs/CommandGuide/llvm-as.pod
+++ b/docs/CommandGuide/llvm-as.pod
@@ -50,7 +50,7 @@ Enable binary output on terminals. Normally, B<llvm-as> will refuse to
write raw bitcode output if the output stream is a terminal. With this option,
B<llvm-as> will write raw bitcode regardless of the output device.
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
diff --git a/docs/CommandGuide/llvm-bcanalyzer.pod b/docs/CommandGuide/llvm-bcanalyzer.pod
index f60b513822..b0bc0cddba 100644
--- a/docs/CommandGuide/llvm-bcanalyzer.pod
+++ b/docs/CommandGuide/llvm-bcanalyzer.pod
@@ -43,7 +43,7 @@ Causes B<llvm-bcanalyzer> to verify the module produced by reading the
bitcode. This ensures that the statistics generated are based on a consistent
module.
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
diff --git a/docs/CommandGuide/llvm-config.pod b/docs/CommandGuide/llvm-config.pod
index 06f10de221..4e38dae3df 100644
--- a/docs/CommandGuide/llvm-config.pod
+++ b/docs/CommandGuide/llvm-config.pod
@@ -30,7 +30,7 @@ To link against the JIT:
Print the version number of LLVM.
-=item B<--help>
+=item B<-help>
Print a summary of B<llvm-config> arguments.
diff --git a/docs/CommandGuide/llvm-db.pod b/docs/CommandGuide/llvm-db.pod
deleted file mode 100644
index 132417685c..0000000000
--- a/docs/CommandGuide/llvm-db.pod
+++ /dev/null
@@ -1,16 +0,0 @@
-=pod
-
-=head1 NAME
-
-llvm-db - LLVM debugger (alpha)
-
-=head1 SYNOPSIS
-
-Details coming soon. Please see
-L<http://llvm.org/docs/SourceLevelDebugging.html> in the meantime.
-
-=head1 AUTHORS
-
-Maintained by the LLVM Team (L<http://llvm.org>).
-
-=cut
diff --git a/docs/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod
index 2b83290c9b..5b2f4ef4e9 100644
--- a/docs/CommandGuide/llvm-dis.pod
+++ b/docs/CommandGuide/llvm-dis.pod
@@ -33,7 +33,7 @@ Enable binary output on terminals. Normally, B<llvm-dis> will refuse to
write raw bitcode output if the output stream is a terminal. With this option,
B<llvm-dis> will write raw bitcode regardless of the output device.
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod
index b62e8ae312..d4baab7399 100644
--- a/docs/CommandGuide/llvm-extract.pod
+++ b/docs/CommandGuide/llvm-extract.pod
@@ -34,9 +34,15 @@ B<llvm-extract> will write raw bitcode regardless of the output device.
=item B<--func> I<function-name>
-Extract the function named I<function-name> from the LLVM bitcode.
+Extract the function named I<function-name> from the LLVM bitcode. May be
+specified multiple times to extract multiple functions at once.
-=item B<--help>
+=item B<--glob> I<global-name>
+
+Extract the global variable named I<global-name> from the LLVM bitcode. May be
+specified multiple times to extract multiple global variables at once.
+
+=item B<-help>
Print a summary of command line options.
diff --git a/docs/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod
index e1a1267c52..8d06cc9d9d 100644
--- a/docs/CommandGuide/llvm-link.pod
+++ b/docs/CommandGuide/llvm-link.pod
@@ -51,7 +51,7 @@ Write output in LLVM intermediate language (instead of bitcode).
If specified, B<llvm-link> prints a human-readable version of the output
bitcode file to standard error.
-=item B<--help>
+=item B<-help>
Print a summary of command line options.
diff --git a/docs/CommandGuide/llvm-nm.pod b/docs/CommandGuide/llvm-nm.pod
index 995ac08139..a580d3f5ca 100644
--- a/docs/CommandGuide/llvm-nm.pod
+++ b/docs/CommandGuide/llvm-nm.pod
@@ -77,7 +77,7 @@ Use POSIX.2 output format. Alias for B<--format=posix>.
Use BSD output format. Alias for B<--format=bsd>.
-=item B<--help>
+=item B<-help>
Print a summary of command-line options and their meanings.
diff --git a/docs/CommandGuide/llvm-prof.pod b/docs/CommandGuide/llvm-prof.pod
index 381387d7db..9541b05dca 100644
--- a/docs/CommandGuide/llvm-prof.pod
+++ b/docs/CommandGuide/llvm-prof.pod
@@ -18,7 +18,7 @@ where the program hotspots are.
This program is often used in conjunction with the F<utils/profile.pl>
script. This script automatically instruments a program, runs it with the JIT,
then runs B<llvm-prof> to format a report. To get more information about
-F<utils/profile.pl>, execute it with the B<--help> option.
+F<utils/profile.pl>, execute it with the B<-help> option.
=head1 OPTIONS
diff --git a/docs/CommandGuide/llvm-ranlib.pod b/docs/CommandGuide/llvm-ranlib.pod
index 130edb0771..53cd34bbb5 100644
--- a/docs/CommandGuide/llvm-ranlib.pod
+++ b/docs/CommandGuide/llvm-ranlib.pod
@@ -6,7 +6,7 @@ llvm-ranlib - Generate index for LLVM archive
=head1 SYNOPSIS
-B<llvm-ranlib> [--version] [--help] <archive-file>
+B<llvm-ranlib> [--version] [-help] <archive-file>
=head1 DESCRIPTION
@@ -30,7 +30,7 @@ Specifies the archive-file to which the symbol table is added or updated.
Print the version of B<llvm-ranlib> and exit without building a symbol table.
-=item F<--help>
+=item F<-help>
Print usage help for B<llvm-ranlib> and exit without building a symbol table.
diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod
index e5e0651161..d237ca4c14 100644
--- a/docs/CommandGuide/llvmc.pod
+++ b/docs/CommandGuide/llvmc.pod
@@ -77,11 +77,11 @@ Store temporary files in the given directory. This directory is deleted on exit
unless I<--save-temps> is specified. If I<--save-temps=obj> is also specified,
I<--temp-dir> is given the precedence.
-=item B<--help>
+=item B<-help>
Print a summary of command-line options and exit.
-=item B<--help-hidden>
+=item B<-help-hidden>
Print a summary of command-line options and exit. Print help even for
options intended for developers.
diff --git a/docs/CommandGuide/tblgen.pod b/docs/CommandGuide/tblgen.pod
index c8244af5ce..d127492a91 100644
--- a/docs/CommandGuide/tblgen.pod
+++ b/docs/CommandGuide/tblgen.pod
@@ -26,7 +26,7 @@ to read as input.
=over
-=item B<--help>
+=item B<-help>
Print a summary of command line options.