Daniel Dunbar | dbec033 | 2009-04-29 01:00:32 +0000 | [diff] [blame^] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | clang - the clang C and Objective-C compiler |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<clang> [I<options>] I<filenames...> |
| 10 | |
| 11 | FIXME: Fill in synposis and options. |
| 12 | |
| 13 | =head1 DESCRIPTION |
| 14 | |
| 15 | FIXME: Fill in description. |
| 16 | |
| 17 | =head1 OPTIONS |
| 18 | |
| 19 | =over |
| 20 | |
| 21 | =item B<-###> |
| 22 | |
| 23 | Print the commands to run for this compilation. |
| 24 | |
| 25 | =item B<--analyze> |
| 26 | |
| 27 | Run the static analyzer. |
| 28 | |
| 29 | =item B<--help> |
| 30 | |
| 31 | Display available options. |
| 32 | |
| 33 | =item B<-E> |
| 34 | |
| 35 | Only run the preprocessor. |
| 36 | |
| 37 | =item B<-ObjC++> |
| 38 | |
| 39 | Treat source input files as Objective-C++ inputs. |
| 40 | |
| 41 | =item B<-ObjC> |
| 42 | |
| 43 | Treat source input files as Objective-C inputs. |
| 44 | |
| 45 | =item B<-Qunused-arguments> |
| 46 | |
| 47 | Don't emit warning for unused driver arguments. |
| 48 | |
| 49 | =item B<-S> |
| 50 | |
| 51 | Only run preprocess and compilation steps. |
| 52 | |
| 53 | =item B<-Wa,>I<args> |
| 54 | |
| 55 | Pass the comma separated arguments in I<args> to the assembler. |
| 56 | |
| 57 | =item B<-Wl,>I<args> |
| 58 | |
| 59 | Pass the comma separated arguments in I<args> to the linker. |
| 60 | |
| 61 | =item B<-Wp,>I<args> |
| 62 | |
| 63 | Pass the comma separated arguments in I<args> to the preprocessor. |
| 64 | |
| 65 | =item B<-Xanalyzer> I<arg> |
| 66 | |
| 67 | Pass I<arg> to the static analyzer. |
| 68 | |
| 69 | =item B<-Xassembler> I<arg> |
| 70 | |
| 71 | Pass I<arg> to the assembler. |
| 72 | |
| 73 | =item B<-Xclang> I<arg> |
| 74 | |
| 75 | Pass I<arg> to the clang compiler. |
| 76 | |
| 77 | =item B<-Xlinker> I<arg> |
| 78 | |
| 79 | Pass I<arg> to the linker. |
| 80 | |
| 81 | =item B<-Xpreprocessor> I<arg> |
| 82 | |
| 83 | Pass I<arg> to the preprocessor. |
| 84 | |
| 85 | =item B<-c> |
| 86 | |
| 87 | Only run preprocess, compile, and assemble steps. |
| 88 | |
| 89 | =item B<-emit-llvm> |
| 90 | |
| 91 | Use the LLVM representation for assembler and object files. |
| 92 | |
| 93 | =item B<-o> I<file> |
| 94 | |
| 95 | Write output to I<file>. |
| 96 | |
| 97 | =item B<-pipe> |
| 98 | |
| 99 | Use pipes between commands, when possible. |
| 100 | |
| 101 | =item B<-print-file-name>=I<file> |
| 102 | |
| 103 | Print the full library path of I<file>. |
| 104 | |
| 105 | =item B<-print-libgcc-file-name> |
| 106 | |
| 107 | Print the library path for "libgcc.a". |
| 108 | |
| 109 | =item B<-print-prog-name>=I<name> |
| 110 | |
| 111 | Print the full program path of I<name>. |
| 112 | |
| 113 | =item B<-print-search-dirs> |
| 114 | |
| 115 | Print the paths used for finding libraries and programs. |
| 116 | |
| 117 | =item B<-save-temps> |
| 118 | |
| 119 | Save intermediate compilation results. |
| 120 | |
| 121 | =item B<-time> |
| 122 | |
| 123 | Time individual commands. |
| 124 | |
| 125 | =item B<-v> |
| 126 | |
| 127 | Show commands to run and use verbose output. |
| 128 | |
| 129 | =item B<-x> I<language> |
| 130 | |
| 131 | Treat subsequent input files as having type I<language>. |
| 132 | |
| 133 | =back |
| 134 | |
| 135 | =head1 ENVIRONMENT |
| 136 | |
| 137 | FIXME: Fill in environment. |
| 138 | |
| 139 | =head1 BUGS |
| 140 | |
| 141 | FIXME: Bugs? |
| 142 | |
| 143 | =head1 SEE ALSO |
| 144 | |
| 145 | FIXME: See also? |
| 146 | |
| 147 | =head1 AUTHOR |
| 148 | |
| 149 | Maintained by the Clang / LLVM Team (L<http://clang.llvm.org>). |
| 150 | |
| 151 | =cut |