aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CommandGuide
diff options
context:
space:
mode:
authorMikhail Glushenkov <foldr@codedgers.com>2008-11-26 13:40:08 +0000
committerMikhail Glushenkov <foldr@codedgers.com>2008-11-26 13:40:08 +0000
commitdbb61d1bac9c3070f82c7e022d9218d188f3c43d (patch)
tree6afee89376229ee3359c1028b039db351c4779e7 /docs/CommandGuide
parent3cef08848497212e9fe3f2596ee24c17acf56d8a (diff)
downloadexternal_llvm-dbb61d1bac9c3070f82c7e022d9218d188f3c43d.zip
external_llvm-dbb61d1bac9c3070f82c7e022d9218d188f3c43d.tar.gz
external_llvm-dbb61d1bac9c3070f82c7e022d9218d188f3c43d.tar.bz2
Describe some more options in the man page.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60105 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r--docs/CommandGuide/llvmc.pod70
1 files changed, 62 insertions, 8 deletions
diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod
index fccd6f7..c81031b 100644
--- a/docs/CommandGuide/llvmc.pod
+++ b/docs/CommandGuide/llvmc.pod
@@ -17,15 +17,69 @@ B<llvmc> is considered an experimental tool.
=head1 OPTIONS
+=head2 Built-in Options
+
+LLVMC has some built-in options that can't be overridden in the
+configuration libraries.
+
=over
+=item B<-o> I<filename>
+
+Output file name.
+
+=item B<-x> I<language>
+
+Specify the language of the following input files until the next B<-x>
+option.
+
+=item B<-load> I<plugin_name>
+
+Load the specified plugin DLL. Example:
+S<-load $LLVM_DIR/Release/lib/LLVMCSimple.so>.
+
+=item B<-v> or B<--verbose>
+
+Enable verbose mode, i.e. print out all executed commands.
+
+=item B<--view-graph>
+
+Show a graphical representation of the compilation graph. Requires
+that you have I<dot> and I<gv> programs installed. Hidden option,
+useful for debugging.
+
+=item B<--write-graph>
+
+Write a I<compilation-graph.dot> file in the current directory with
+the compilation graph description in the Graphviz format. Hidden
+option, useful for debugging.
+
+=item B<--save-temps>
+
+Write temporary files to the current directory and do not delete them
+on exit. Hidden option, useful for debugging.
+
=item B<--help>
-Print a summary of command line options.
+Print a summary of command-line options and exit.
-=item B<-o> I<filename>
+=item B<--help-hidden>
+
+Print a summary of command-line options and exit. Print help even for
+options intended for developers.
+
+=item B<--version>
-Specify the output file to be I<filename>.
+Print version information and exit.
+
+=back
+
+=head2 Control Options
+
+By default, LLVMC is built with some standard configuration libraries
+that define the following options:
+
+=over
=item B<-I> I<directory>
@@ -52,11 +106,11 @@ or B<-S> it has no effect.
=head1 EXIT STATUS
-If B<llvmc> succeeds, it will exit with 0. Otherwise, if an error
-occurs, it will exit with a non-zero value. If one of the compilation
-tools returns a non-zero status, pending actions will be discarded and
-B<llvmc> will return the same result code as the failing compilation
-tool.
+If B<llvmc> succeeds, it will exit with code 0. Otherwise, if an
+error occurs, it will exit with a non-zero value. If one of the
+compilation tools returns a non-zero status, pending actions will be
+discarded and B<llvmc> will return the same result code as the failing
+compilation tool.
=head1 SEE ALSO