summaryrefslogtreecommitdiff
path: root/docs/CommandGuide
diff options
context:
space:
mode:
authorJohn Criswell <criswell@uiuc.edu>2003-09-26 02:59:00 +0000
committerJohn Criswell <criswell@uiuc.edu>2003-09-26 02:59:00 +0000
commit6775392c3df70496e88acea20a4493c9893232ec (patch)
treefd686cfe8f6f7423b93decfad2743c2e14c82920 /docs/CommandGuide
parentee43b69762f0cdf7a0048c17e8239b82fff39b53 (diff)
downloadllvm-6775392c3df70496e88acea20a4493c9893232ec.tar.gz
llvm-6775392c3df70496e88acea20a4493c9893232ec.tar.bz2
llvm-6775392c3df70496e88acea20a4493c9893232ec.tar.xz
Added information about how llvm-as and llvm-dis select the input and output
filenames. Corrected some typos in the llvm-dis documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8716 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r--docs/CommandGuide/llvm-as.html35
-rw-r--r--docs/CommandGuide/llvm-dis.html40
2 files changed, 62 insertions, 13 deletions
diff --git a/docs/CommandGuide/llvm-as.html b/docs/CommandGuide/llvm-as.html
index e843f852e7..985c8af399 100644
--- a/docs/CommandGuide/llvm-as.html
+++ b/docs/CommandGuide/llvm-as.html
@@ -20,15 +20,39 @@ llvm-as
SYNOPSIS
</h3>
-llvm-as [options] &lt; filename&gt;
+llvm-as [options] [filename]
<h3>
DESCRIPTION
</h3>
-The llvm-as command is the LLVM assembler. It takes a human readable LLVM
-assembly language file and translates it into LLVM bytecode.
+The llvm-as command is the LLVM assembler. It reads a file containing human
+readable LLVM assembly language, translates it to LLVM bytecode, and writes the
+result into a file or to standard output.
+<p>
-By default, llvm-as places its output into filename.bc.
+If filename is omitted or is -, then llvm-as reads its input from standard
+input.
+<p>
+
+If an output file is not specified with the -o option, then llvm-as sends its
+output to a file or standard output by the following logic:
+
+<ul>
+ <li>
+ If the input is standard input, then the output is standard output.
+ <p>
+
+ <li>
+ If the input is a file that ends with .ll, then the output file is of
+ the same name, except that the suffix is changed to .bc.
+ <p>
+
+ <li>
+ If the input is a file that does not end with the .ll suffix, then the
+ output file has the same name as the input file, except that the .bc suffix
+ is appended.
+ <p>
+</ul>
<h3>
OPTIONS
@@ -49,7 +73,8 @@ OPTIONS
<li> -o &lt;filename&gt;
<br>
- Specify the output filename.
+ Specify the output filename. If filename is -, then llvm-as sends its
+ output to standard output.
<p>
<li> -stats
diff --git a/docs/CommandGuide/llvm-dis.html b/docs/CommandGuide/llvm-dis.html
index 9f7731ac43..c6288b0359 100644
--- a/docs/CommandGuide/llvm-dis.html
+++ b/docs/CommandGuide/llvm-dis.html
@@ -20,16 +20,39 @@ llvm-dis
SYNOPSIS
</h3>
-llvm-dis [options] &lt; filename&gt;
+llvm-dis [options] [filename]
<h3>
DESCRIPTION
</h3>
The llvm-dis command is the LLVM disassembler. It takes an LLVM bytecode file
-and converts it into one of several human readable formats.
+and converts it into LLVM assembly language or C source code with equivalent
+functionality.
+<p>
+
+If filename is omitted, llvm-dis reads its input from standard input.
+<p>
+
+The default output file for llvm-dis is determined by the following logic:
+<ul>
+ <li>
+ If the input is standard input or the file -, then the output is standard
+ output.
+ <p>
+
+ <li>
+ If the input filename ends in .bc, then the output filename will be
+ identical, except that the .bc suffix will be replaced by the .ll or .c
+ suffix (for LLVM assembly language and C code, respectively).
+ <p>
+
+ <li>
+ If the input filename does not end in .bc, then the output filename will be
+ identical to the input filename, except that the .ll or .c suffix will be
+ appended to the filename (for LLVM assembly language and C code,
+ respectively).
+</ul>
-By default, llvm-dis places its output in filename.ll, removing the .bc suffix
-if it exists.
<h3>
OPTIONS
</h3>
@@ -60,12 +83,13 @@ OPTIONS
<li> -o &lt;filename&gt;
<br>
- Specify the output filename.
+ Specify the output filename. If filename is -, then the output is sent to
+ standard output.
<p>
- <li> -time-pdisses
+ <li> -time-passes
<br>
- Record the amount of time needed for each pdiss and print it to standard
+ Record the amount of time needed for each pass and print it to standard
error.
<p>
</ul>
@@ -80,7 +104,7 @@ will exit with a non-zero value.
<h3>
SEE ALSO
</h3>
-llvm-dis
+llvm-as
<HR>
<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>