From a606d1f34e554a8d779d7d2c740c661a9bae01ef Mon Sep 17 00:00:00 2001 From: Mikhail Glushenkov Date: Tue, 25 Nov 2008 21:38:38 +0000 Subject: Add a man page for llvmc. Really basic for now, will be updated later. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60049 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/index.html | 21 +++++++------ docs/CommandGuide/llvmc.pod | 70 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 9 deletions(-) create mode 100644 docs/CommandGuide/llvmc.pod (limited to 'docs/CommandGuide') diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index b0d6e645ad..8ddfd25661 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -15,8 +15,8 @@

These documents are HTML versions of the man pages 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 +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 --help (general options) or --help-hidden (general+debugging options) arguments to the tool you are interested in.

@@ -32,7 +32,7 @@ options) arguments to the tool you are interested in.

diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod new file mode 100644 index 0000000000..fccd6f7d51 --- /dev/null +++ b/docs/CommandGuide/llvmc.pod @@ -0,0 +1,70 @@ +=pod + +=head1 NAME + +llvmc - The LLVM Compiler Driver (WIP) + +=head1 SYNOPSIS + +B [I] I + +=head1 DESCRIPTION + +B is a configurable driver for invoking other LLVM (and non-LLVM) tools +in order to compile, optimize and link software for multiple languages. For +those familiar with FSF's B tool, it is very similar. Please note that +B is considered an experimental tool. + +=head1 OPTIONS + +=over + +=item B<--help> + +Print a summary of command line options. + +=item B<-o> I + +Specify the output file to be I. + +=item B<-I> I + +Add a directory to the header file search path. This option can be +repeated. + +=item B<-L> I + +Add I to the library search path. This option can be +repeated. + +=item B<-l>I + +Link in the library libI.[bc | a | so]. This library should +be a bitcode library. + +=item B<-emit-llvm> + +Make the output be LLVM bitcode (with B<-c>) or assembly (with B<-s>) instead +of native object (or assembly). If B<-emit-llvm> is given without either B<-c> +or B<-S> it has no effect. + +=back + +=head1 EXIT STATUS + +If B 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 will return the same result code as the failing compilation +tool. + +=head1 SEE ALSO + +L, L, L, +L, L, L + +=head1 AUTHORS + +Maintained by the LLVM Team (L). + +=cut -- cgit v1.2.3