From 700c82ddc4fa3619c239bf2bb118b1b84b8d6d10 Mon Sep 17 00:00:00 2001 From: John Criswell Date: Fri, 3 Oct 2003 13:45:55 +0000 Subject: [PATCH] Adding basic documentation for the LLVM C and C++ frontends. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8835 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/llvmgcc.html | 110 ++++++++++++++++++++++++++++++++ docs/CommandGuide/llvmgxx.html | 111 +++++++++++++++++++++++++++++++++ 2 files changed, 221 insertions(+) create mode 100644 docs/CommandGuide/llvmgcc.html create mode 100644 docs/CommandGuide/llvmgxx.html diff --git a/docs/CommandGuide/llvmgcc.html b/docs/CommandGuide/llvmgcc.html new file mode 100644 index 00000000000..f74d7ccd097 --- /dev/null +++ b/docs/CommandGuide/llvmgcc.html @@ -0,0 +1,110 @@ + + +LLVM: llvmgcc tool + + + + + +

LLVM: llvmgcc tool

+ +

+NAME +

+ +llvmgcc + +

+SYNOPSIS +

+ +llvmgcc [options] filename +

+DESCRIPTION +

+ +The llvmgcc command is the LLVM C front end. It is a modified version of GCC +that takes C programs and compiles them into LLVM bytecode or assembly +language, depending upon the options. +

+ +The llvmgcc program uses the LLVM assembler gccas and the LLVM linker gccld to +do the work of creating complete programs. +

+ +Being derived from the GNU Compiler Collection, llvmgcc has many of gcc's +features and accepts most of gcc's options. It handles a number of gcc's +extensions to the C programming language. +

+ +Below you will find several commonly used options: + +

+OPTIONS +

+ +

-S +
+ Do not generate an LLVM bytecode file. Rather, compile the source file + into an LLVM assembly language file. +
+ +
-c +
+ Do not generate a linked bytecode executable. Rather, compile the source + file into an LLVM bytecode file. This bytecode file can then be linked + with other bytecode files later to generate a full LLVM executable. +
+ +
-o filename +
+ Specify the output file to be filename. If filename is -, + then llvmgcc sends its output to standard output. +
+ +
-I directory +
+ Add a directory to the header file search path. This option can be + repeated. +
+ +
-L directory +
+ Add directory to the library search path. This option can be + repeated. +
+ +
-lname +
+ Link in the library libname.[bc | a | so]. This library should be + a bytecode library. +
+ +
-Wl,option +
+ Pass option to the linker (usually gccld). +
+

+ +

+EXIT STATUS +

+ +If llvmgcc succeeds, it will exit with 0. Otherwise, if an error occurs, it +will exit with a non-zero value. + +

+SEE ALSO +

+llvmg++, +gccas, +gccld + +

+LLVM Team + + + diff --git a/docs/CommandGuide/llvmgxx.html b/docs/CommandGuide/llvmgxx.html new file mode 100644 index 00000000000..bc71411a1ce --- /dev/null +++ b/docs/CommandGuide/llvmgxx.html @@ -0,0 +1,111 @@ + + +LLVM: llvmg++ tool + + + + + +

LLVM: llvmg++ tool

+ +

+NAME +

+ +llvmg++ + +

+SYNOPSIS +

+ +llvmg++ [options] filename +

+DESCRIPTION +

+ +The llvmg++ command is the LLVM C++ front end. It is a modified version of g++ +that takes C++ programs and compiles them into LLVM bytecode or assembly +language, depending upon the options. +

+ +The llvmg++ program uses the LLVM assembler gccas and the LLVM linker gccld to +do the work of creating complete programs. +

+ +Being derived from the GNU Compiler Collection, llvmg++ has many of g++'s +features and accepts most of g++'s options. It handles a number of g++'s +extensions to the C++ programming language. +

+ +Below you will find several commonly used options: + +

+OPTIONS +

+ +

-S +
+ Do not generate an LLVM bytecode file. Rather, compile the source file + into an LLVM assembly language file. +
+ +
-c +
+ Do not generate a linked executable. Rather, compile the source file into + an LLVM bytecode file. This bytecode file can then be linked with other + bytecode files later on to generate a full LLVM executable. +
+ +
-o filename +
+ Specify the output file to be filename. If filename is -, + then llvmgcc sends its output to standard output. +
+ +
-I directory +
+ Add a directory to the header file search path. This option can be + repeated. +
+ +
-L directory +
+ Add directory to the library search path. This option can be + repeated. +
+ +
-lname +
+ Link in the library libname.[bc | a | so]. This library should be + a bytecode library. +
+ +
-Wl,option +
+ Pass option to the linker (usually gccld). +
+ +

+ +

+EXIT STATUS +

+ +If llvmg++ succeeds, it will exit with 0. Otherwise, if an error occurs, it +will exit with a non-zero value. + +

+SEE ALSO +

+llvmg++, +gccas, +gccld + +

+LLVM Team + + + -- 2.34.1