usr.bin/clang/tblgen/tblgen.1

   1 .\" $FreeBSD$
   2 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   3 .\"
   4 .\" Standard preamble:
   5 .\" ========================================================================
   6 .de Sp \" Vertical space (when we can't use .PP)
   7 .if t .sp .5v
   8 .if n .sp
   9 ..
  10 .de Vb \" Begin verbatim text
  11 .ft CW
  12 .nf
  13 .ne \\$1
  14 ..
  15 .de Ve \" End verbatim text
  16 .ft R
  17 .fi
  18 ..
  19 .\" Set up some character translations and predefined strings.  \*(-- will
  20 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  21 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  22 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  23 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  24 .\" nothing in troff, for use with C<>.
  25 .tr \(*W-
  26 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  27 .ie n \{\
  28 .    ds -- \(*W-
  29 .    ds PI pi
  30 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  31 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  32 .    ds L" ""
  33 .    ds R" ""
  34 .    ds C` ""
  35 .    ds C' ""
  36 'br\}
  37 .el\{\
  38 .    ds -- \|\(em\|
  39 .    ds PI \(*p
  40 .    ds L" ``
  41 .    ds R" ''
  42 'br\}
  43 .\"
  44 .\" Escape single quotes in literal strings from groff's Unicode transform.
  45 .ie \n(.g .ds Aq \(aq
  46 .el       .ds Aq '
  47 .\"
  48 .\" If the F register is turned on, we'll generate index entries on stderr for
  49 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  50 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  51 .\" output yourself in some meaningful fashion.
  52 .ie \nF \{\
  53 .    de IX
  54 .    tm Index:\\$1\t\\n%\t"\\$2"
  55 ..
  56 .    nr % 0
  57 .    rr F
  58 .\}
  59 .el \{\
  60 .    de IX
  61 ..
  62 .\}
  63 .\"
  64 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  65 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  66 .    \" fudge factors for nroff and troff
  67 .if n \{\
  68 .    ds #H 0
  69 .    ds #V .8m
  70 .    ds #F .3m
  71 .    ds #[ \f1
  72 .    ds #] \fP
  73 .\}
  74 .if t \{\
  75 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  76 .    ds #V .6m
  77 .    ds #F 0
  78 .    ds #[ \&
  79 .    ds #] \&
  80 .\}
  81 .    \" simple accents for nroff and troff
  82 .if n \{\
  83 .    ds ' \&
  84 .    ds ` \&
  85 .    ds ^ \&
  86 .    ds , \&
  87 .    ds ~ ~
  88 .    ds /
  89 .\}
  90 .if t \{\
  91 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  92 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  93 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  94 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  95 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  96 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  97 .\}
  98 .    \" troff and (daisy-wheel) nroff accents
  99 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 100 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 101 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 102 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 103 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 104 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 105 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 106 .ds ae a\h'-(\w'a'u*4/10)'e
 107 .ds Ae A\h'-(\w'A'u*4/10)'E
 108 .    \" corrections for vroff
 109 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 110 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 111 .    \" for low resolution devices (crt and lpr)
 112 .if \n(.H>23 .if \n(.V>19 \
 113 \{\
 114 .    ds : e
 115 .    ds 8 ss
 116 .    ds o a
 117 .    ds d- d\h'-1'\(ga
 118 .    ds D- D\h'-1'\(hy
 119 .    ds th \o'bp'
 120 .    ds Th \o'LP'
 121 .    ds ae ae
 122 .    ds Ae AE
 123 .\}
 124 .rm #[ #] #H #V #F C
 125 .\" ========================================================================
 126 .\"
 127 .IX Title "TBLGEN 1"
 128 .TH TBLGEN 1 "2011-04-23" "LLVM 3.0" "LLVM Command Guide"
 129 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 130 .\" way too many mistakes in technical documents.
 131 .if n .ad l
 132 .nh
 133 .SH "NAME"
 134 tblgen \- Target Description To C++ Code Generator
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBtblgen\fR [\fIoptions\fR] [\fIfilename\fR]
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 \&\fBtblgen\fR translates from target description (.td) files into \*(C+ code that can
 141 be included in the definition of an \s-1LLVM\s0 target library. Most users of \s-1LLVM\s0 will
 142 not need to use this program. It is only for assisting with writing an \s-1LLVM\s0
 143 target backend.
 144 .PP
 145 The input and output of \fBtblgen\fR is beyond the scope of this short
 146 introduction. Please see the \fICodeGeneration\fR page in the \s-1LLVM\s0 documentation.
 147 .PP
 148 The \fIfilename\fR argument specifies the name of a Target Description (.td) file
 149 to read as input.
 150 .SH "OPTIONS"
 151 .IX Header "OPTIONS"
 152 .IP "\fB\-help\fR" 4
 153 .IX Item "-help"
 154 Print a summary of command line options.
 155 .IP "\fB\-o\fR \fIfilename\fR" 4
 156 .IX Item "-o filename"
 157 Specify the output file name.  If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBtblgen\fR
 158 sends its output to standard output.
 159 .IP "\fB\-I\fR \fIdirectory\fR" 4
 160 .IX Item "-I directory"
 161 Specify where to find other target description files for inclusion. The
 162 \&\fIdirectory\fR value should be a full or partial path to a directory that contains
 163 target description files.
 164 .IP "\fB\-asmwriternum\fR \fIN\fR" 4
 165 .IX Item "-asmwriternum N"
 166 Make \-gen\-asm\-writer emit assembly writer number \fIN\fR.
 167 .IP "\fB\-class\fR \fIclass Name\fR" 4
 168 .IX Item "-class class Name"
 169 Print the enumeration list for this class.
 170 .IP "\fB\-print\-records\fR" 4
 171 .IX Item "-print-records"
 172 Print all records to standard output (default).
 173 .IP "\fB\-print\-enums\fR" 4
 174 .IX Item "-print-enums"
 175 Print enumeration values for a class
 176 .IP "\fB\-gen\-emitter\fR" 4
 177 .IX Item "-gen-emitter"
 178 Generate machine code emitter.
 179 .IP "\fB\-gen\-register\-enums\fR" 4
 180 .IX Item "-gen-register-enums"
 181 Generate the enumeration values for all registers.
 182 .IP "\fB\-gen\-register\-desc\fR" 4
 183 .IX Item "-gen-register-desc"
 184 Generate a register info description for each register.
 185 .IP "\fB\-gen\-register\-desc\-header\fR" 4
 186 .IX Item "-gen-register-desc-header"
 187 Generate a register info description header for each register.
 188 .IP "\fB\-gen\-instr\-enums\fR" 4
 189 .IX Item "-gen-instr-enums"
 190 Generate enumeration values for instructions.
 191 .IP "\fB\-gen\-instr\-desc\fR" 4
 192 .IX Item "-gen-instr-desc"
 193 Generate instruction descriptions.
 194 .IP "\fB\-gen\-asm\-writer\fR" 4
 195 .IX Item "-gen-asm-writer"
 196 Generate the assembly writer.
 197 .IP "\fB\-gen\-dag\-isel\fR" 4
 198 .IX Item "-gen-dag-isel"
 199 Generate a \s-1DAG\s0 (Directed Acycle Graph) instruction selector.
 200 .IP "\fB\-gen\-subtarget\fR" 4
 201 .IX Item "-gen-subtarget"
 202 Generate subtarget enumerations.
 203 .IP "\fB\-gen\-intrinsic\fR" 4
 204 .IX Item "-gen-intrinsic"
 205 Generate intrinsic information.
 206 .IP "\fB\-version\fR" 4
 207 .IX Item "-version"
 208 Show the version number of this program.
 209 .SH "EXIT STATUS"
 210 .IX Header "EXIT STATUS"
 211 If \fBtblgen\fR succeeds, it will exit with 0.  Otherwise, if an error
 212 occurs, it will exit with a non-zero value.
 213 .SH "AUTHORS"
 214 .IX Header "AUTHORS"
 215 Maintained by The \s-1LLVM\s0 Team (<http://llvm.org/>).