xref: /llvm-project/llvm/docs/CommandGuide/llvm-dis.rst (revision 09a066b3aabfc4ea21d59d464f032f5f8a25c059)
18f4a8a63SDaniel Dunbarllvm-dis - LLVM disassembler
28f4a8a63SDaniel Dunbar============================
38f4a8a63SDaniel Dunbar
4a056684cSJames Henderson.. program:: llvm-dis
58f4a8a63SDaniel Dunbar
68f4a8a63SDaniel DunbarSYNOPSIS
78f4a8a63SDaniel Dunbar--------
88f4a8a63SDaniel Dunbar
98f4a8a63SDaniel Dunbar**llvm-dis** [*options*] [*filename*]
108f4a8a63SDaniel Dunbar
118f4a8a63SDaniel DunbarDESCRIPTION
128f4a8a63SDaniel Dunbar-----------
138f4a8a63SDaniel Dunbar
148f4a8a63SDaniel DunbarThe **llvm-dis** command is the LLVM disassembler.  It takes an LLVM
158f4a8a63SDaniel Dunbarbitcode file and converts it into human-readable LLVM assembly language.
168f4a8a63SDaniel Dunbar
178f4a8a63SDaniel DunbarIf filename is omitted or specified as ``-``, **llvm-dis** reads its
188f4a8a63SDaniel Dunbarinput from standard input.
198f4a8a63SDaniel Dunbar
208f4a8a63SDaniel DunbarIf the input is being read from standard input, then **llvm-dis**
218f4a8a63SDaniel Dunbarwill send its output to standard output by default.  Otherwise, the
228f4a8a63SDaniel Dunbaroutput will be written to a file named after the input file, with
238f4a8a63SDaniel Dunbara ``.ll`` suffix added (any existing ``.bc`` suffix will first be
248f4a8a63SDaniel Dunbarremoved).  You can override the choice of output file using the
258f4a8a63SDaniel Dunbar**-o** option.
268f4a8a63SDaniel Dunbar
278f4a8a63SDaniel DunbarOPTIONS
288f4a8a63SDaniel Dunbar-------
298f4a8a63SDaniel Dunbar
308f4a8a63SDaniel Dunbar**-f**
318f4a8a63SDaniel Dunbar
328f4a8a63SDaniel Dunbar Enable binary output on terminals.  Normally, **llvm-dis** will refuse to
338f4a8a63SDaniel Dunbar write raw bitcode output if the output stream is a terminal. With this option,
348f4a8a63SDaniel Dunbar **llvm-dis** will write raw bitcode regardless of the output device.
358f4a8a63SDaniel Dunbar
368f4a8a63SDaniel Dunbar**-help**
378f4a8a63SDaniel Dunbar
388f4a8a63SDaniel Dunbar Print a summary of command line options.
398f4a8a63SDaniel Dunbar
408f4a8a63SDaniel Dunbar**-o** *filename*
418f4a8a63SDaniel Dunbar
428f4a8a63SDaniel Dunbar Specify the output file name.  If *filename* is -, then the output is sent
438f4a8a63SDaniel Dunbar to standard output.
448f4a8a63SDaniel Dunbar
458f4a8a63SDaniel DunbarEXIT STATUS
468f4a8a63SDaniel Dunbar-----------
478f4a8a63SDaniel Dunbar
488f4a8a63SDaniel DunbarIf **llvm-dis** succeeds, it will exit with 0.  Otherwise, if an error
498f4a8a63SDaniel Dunbaroccurs, it will exit with a non-zero value.
508f4a8a63SDaniel Dunbar
518f4a8a63SDaniel DunbarSEE ALSO
528f4a8a63SDaniel Dunbar--------
538f4a8a63SDaniel Dunbar
54*09a066b3SAlex Brachet:manpage:`llvm-as(1)`
55