From c08937aee7587fecafead121662d36a5ff0af864 Mon Sep 17 00:00:00 2001
From: Misha Brukman <brukman+llvm@gmail.com>
Date: Fri, 2 Jul 2004 16:06:19 +0000
Subject: [PATCH] * Standardize manpage output: program name bold, options
 italic/emphasized * Make links in SEE ALSO section of manpages short without
 "the ... manpage"

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14579 91177308-0d34-0410-b5e6-96231b3b80d8
---
 docs/CommandGuide/analyze.pod         |  7 ++-----
 docs/CommandGuide/bugpoint.pod        |  5 ++---
 docs/CommandGuide/extract.pod         |  6 ++----
 docs/CommandGuide/gccas.pod           |  6 ++----
 docs/CommandGuide/gccld.pod           |  6 ++----
 docs/CommandGuide/llc.pod             |  6 ++----
 docs/CommandGuide/lli.pod             | 14 +++++++-------
 docs/CommandGuide/llvm-as.pod         |  5 ++---
 docs/CommandGuide/llvm-bcanalyzer.pod |  4 ++--
 docs/CommandGuide/llvm-db.pod         |  2 --
 docs/CommandGuide/llvm-dis.pod        |  5 ++---
 docs/CommandGuide/llvm-extract.pod    |  6 ++----
 docs/CommandGuide/llvm-link.pod       |  2 +-
 docs/CommandGuide/llvm-nm.pod         |  5 ++---
 docs/CommandGuide/llvm-prof.pod       |  7 +++----
 docs/CommandGuide/llvmgcc.pod         |  5 ++---
 docs/CommandGuide/llvmgxx.pod         |  3 +--
 docs/CommandGuide/opt.pod             |  6 ++----
 18 files changed, 38 insertions(+), 62 deletions(-)

diff --git a/docs/CommandGuide/analyze.pod b/docs/CommandGuide/analyze.pod
index 3df0898760c..e1bbe780645 100644
--- a/docs/CommandGuide/analyze.pod
+++ b/docs/CommandGuide/analyze.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ analyze - LLVM program analyzer
 
 =head1 SYNOPSIS
 
-analyze [options] [filename]
+B<analyze> [I<options>] [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -67,12 +66,10 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<opt>
+L<opt|opt>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
-
diff --git a/docs/CommandGuide/bugpoint.pod b/docs/CommandGuide/bugpoint.pod
index acd51811263..7317b399024 100644
--- a/docs/CommandGuide/bugpoint.pod
+++ b/docs/CommandGuide/bugpoint.pod
@@ -6,7 +6,7 @@ bugpoint - automatic test case reduction tool
 
 =head1 SYNOPSIS
 
-bugpoint [options] [input LLVM ll/bc files] [LLVM passes] B<--args>
+B<bugpoint> [I<options>] [I<input LLVM ll/bc files>] [I<LLVM passes>] B<--args>
 I<program arguments>
 
 =head1 DESCRIPTION
@@ -240,11 +240,10 @@ if an error occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<opt>, L<analyze>
+L<opt|opt>, L<analyze|analyze>
 
 =head1 AUTHOR
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/extract.pod b/docs/CommandGuide/extract.pod
index e2f860eda86..3232d8ef21d 100644
--- a/docs/CommandGuide/extract.pod
+++ b/docs/CommandGuide/extract.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ extract - extract a function from an LLVM module
 
 =head1 SYNOPSIS
 
-extract [options] --func function-name [filename]
+B<extract> [I<options>] B<--func> I<function-name> [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -64,11 +63,10 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<bugpoint>
+L<bugpoint|bugpoint>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/gccas.pod b/docs/CommandGuide/gccas.pod
index c5ee63b3c17..0c491a21dec 100644
--- a/docs/CommandGuide/gccas.pod
+++ b/docs/CommandGuide/gccas.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ gccas - optimizing LLVM assembler
 
 =head1 SYNOPSIS
 
-gccas [options] filename
+B<gccas> [I<options>] I<filename>
 
 =head1 DESCRIPTION
 
@@ -68,11 +67,10 @@ status.
 
 =head1 SEE ALSO
 
-L<llvm-as>, L<gccld>
+L<llvm-as|llvm-as>, L<gccld|gccld>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/gccld.pod b/docs/CommandGuide/gccld.pod
index 6b0257485fe..6accd1d7785 100644
--- a/docs/CommandGuide/gccld.pod
+++ b/docs/CommandGuide/gccld.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ gccld - optimizing LLVM linker
 
 =head1 SYNOPSIS
 
-gccld [options] file1 [file2 ...]
+B<gccld> [I<options>] I<filename ...>
 
 =head1 DESCRIPTION
 
@@ -167,11 +166,10 @@ status.
 
 =head1 SEE ALSO
 
-L<llvm-link>, L<gccas>
+L<llvm-link|llvm-link>, L<gccas|gccas>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod
index 2f812b991a5..71cbf1cb3a3 100644
--- a/docs/CommandGuide/llc.pod
+++ b/docs/CommandGuide/llc.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ llc - LLVM static compiler
 
 =head1 SYNOPSIS
 
-llc [options] [filename]
+B<llc> [I<options>] [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -194,11 +193,10 @@ it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<lli>
+L<lli|lli>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/lli.pod b/docs/CommandGuide/lli.pod
index 0f1fb96b2c3..25888c4e857 100644
--- a/docs/CommandGuide/lli.pod
+++ b/docs/CommandGuide/lli.pod
@@ -6,15 +6,15 @@ lli - directly execute programs from LLVM bytecode
 
 =head1 SYNOPSIS
 
-lli [options] [filename] [args ...]
+B<lli> [I<options>] [I<filename>] [I<program args>]
 
 =head1 DESCRIPTION
 
-B<lli> directly executes programs in LLVM bytecode format.  It takes a program in
-LLVM bytecode format and executes it using a just-in-time compiler, if one is
-available for the current architecture, or an interpreter.  B<lli> takes
-all of the same code generator options as L<llc|llc>, but they are only effective
-when B<lli> is using the just-in-time compiler.
+B<lli> directly executes programs in LLVM bytecode format.  It takes a program
+in LLVM bytecode format and executes it using a just-in-time compiler, if one is
+available for the current architecture, or an interpreter.  B<lli> takes all of
+the same code generator options as L<llc|llc>, but they are only effective when
+B<lli> is using the just-in-time compiler.
 
 If I<filename> is not specified, then B<lli> reads the LLVM bytecode for the
 program from standard input.
@@ -67,7 +67,7 @@ Otherwise, it will return the exit code of the program it executes.
 
 =head1 SEE ALSO
 
-L<llc>
+L<llc|llc>
 
 =head1 AUTHOR
 
diff --git a/docs/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod
index 55cfba5851d..9413c0c3ea8 100644
--- a/docs/CommandGuide/llvm-as.pod
+++ b/docs/CommandGuide/llvm-as.pod
@@ -6,7 +6,7 @@ llvm-as - LLVM assembler
 
 =head1 SYNOPSIS
 
-llvm-as [options] [filename]
+B<llvm-as> [I<options>] [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -77,11 +77,10 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<llvm-dis>, L<gccas>
+L<llvm-dis|llvm-dis>, L<gccas|gccas>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llvm-bcanalyzer.pod b/docs/CommandGuide/llvm-bcanalyzer.pod
index 28a27b0e30b..55ad323ca6d 100644
--- a/docs/CommandGuide/llvm-bcanalyzer.pod
+++ b/docs/CommandGuide/llvm-bcanalyzer.pod
@@ -6,7 +6,7 @@ llvm-bcanalyzer - LLVM bytecode analyzer
 
 =head1 SYNOPSIS
 
-llvm-bcanalyzer [options] [filename]
+B<llvm-bcanalyzer> [I<options>] [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -57,7 +57,7 @@ occurs, it will exit with a non-zero value, usually 1.
 
 =head1 SEE ALSO
 
-L<llvm-dis>, L<http://llvm.cs.uiuc.edu/docs/BytecodeFormat.html>
+L<llvm-dis|llvm-dis>, L<http://llvm.cs.uiuc.edu/docs/BytecodeFormat.html>
 
 =head1 AUTHORS
 
diff --git a/docs/CommandGuide/llvm-db.pod b/docs/CommandGuide/llvm-db.pod
index 23fb4f8b0e1..14073dd104a 100644
--- a/docs/CommandGuide/llvm-db.pod
+++ b/docs/CommandGuide/llvm-db.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -15,4 +14,3 @@ L<http://llvm.cs.uiuc.edu/docs/SourceLevelDebugging.html> in the meantime.
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod
index 1e03790e5ee..20556fbc766 100644
--- a/docs/CommandGuide/llvm-dis.pod
+++ b/docs/CommandGuide/llvm-dis.pod
@@ -6,7 +6,7 @@ llvm-dis - LLVM disassembler
 
 =head1 SYNOPSIS
 
-llvm-dis [options] [filename]
+B<llvm-dis> [I<options>] [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -56,11 +56,10 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<llvm-as>
+L<llvm-as|llvm-as>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod
index e2f860eda86..3232d8ef21d 100644
--- a/docs/CommandGuide/llvm-extract.pod
+++ b/docs/CommandGuide/llvm-extract.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ extract - extract a function from an LLVM module
 
 =head1 SYNOPSIS
 
-extract [options] --func function-name [filename]
+B<extract> [I<options>] B<--func> I<function-name> [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -64,11 +63,10 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<bugpoint>
+L<bugpoint|bugpoint>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod
index 16a9b560c0c..d7d34e27127 100644
--- a/docs/CommandGuide/llvm-link.pod
+++ b/docs/CommandGuide/llvm-link.pod
@@ -6,7 +6,7 @@ llvm-link - LLVM linker
 
 =head1 SYNOPSIS
 
-llvm-link [options] filename [...]
+B<llvm-link> [I<options>] I<filename ...>
 
 =head1 DESCRIPTION
 
diff --git a/docs/CommandGuide/llvm-nm.pod b/docs/CommandGuide/llvm-nm.pod
index 62080808a04..8a10405715f 100644
--- a/docs/CommandGuide/llvm-nm.pod
+++ b/docs/CommandGuide/llvm-nm.pod
@@ -6,7 +6,7 @@ llvm-nm - list LLVM bytecode file's symbol table
 
 =head1 SYNOPSIS
 
-llvm-nm [options] [filenames...]
+B<llvm-nm> [I<options>] [I<filenames...>]
 
 =head1 DESCRIPTION
 
@@ -113,11 +113,10 @@ B<llvm-nm> exits with an exit code of zero.
 
 =head1 SEE ALSO
 
-L<llvm-dis>, L<ar(1)>, L<nm(1)>
+L<llvm-dis|llvm-dis>, L<ar(1)>, L<nm(1)>
 
 =head1 AUTHOR
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llvm-prof.pod b/docs/CommandGuide/llvm-prof.pod
index 51f44769b5e..83566f0fdee 100644
--- a/docs/CommandGuide/llvm-prof.pod
+++ b/docs/CommandGuide/llvm-prof.pod
@@ -6,7 +6,7 @@ llvm-prof - print execution profile of LLVM program
 
 =head1 SYNOPSIS
 
-llvm-prof [options] [bytecode file] [llvmprof.out]
+B<llvm-prof> [I<options>] [I<bytecode file>] [I<llvmprof.out>]
 
 =head1 DESCRIPTION
 
@@ -47,12 +47,11 @@ error.
 
 =head1 EXIT STATUS
 
-B<llvm-prof> returns 1 if it cannot load the bytecode file or the profile
-information. Otherwise, it exits with zero.
+B<llvm-prof|llvm-prof> returns 1 if it cannot load the bytecode file or the
+profile information. Otherwise, it exits with zero.
 
 =head1 AUTHOR
 
 B<llvm-prof> is maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
diff --git a/docs/CommandGuide/llvmgcc.pod b/docs/CommandGuide/llvmgcc.pod
index c4b553a15a0..7e4923cb201 100644
--- a/docs/CommandGuide/llvmgcc.pod
+++ b/docs/CommandGuide/llvmgcc.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ llvmgcc - LLVM C front-end
 
 =head1 SYNOPSIS
 
-llvmgcc [options] filename
+B<llvmgcc> [I<options>] I<filename>
 
 =head1 DESCRIPTION
 
@@ -78,7 +77,7 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<llvmg++|llvmgxx>, L<gccas>, L<gccld>
+L<llvmg++|llvmgxx>, L<gccas|gccas>, L<gccld|gccld>
 
 =head1 AUTHORS
 
diff --git a/docs/CommandGuide/llvmgxx.pod b/docs/CommandGuide/llvmgxx.pod
index b5058af3780..b29174b107f 100644
--- a/docs/CommandGuide/llvmgxx.pod
+++ b/docs/CommandGuide/llvmgxx.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ llvmg++ - LLVM C++ front-end
 
 =head1 SYNOPSIS
 
-llvmg++ [options] filename
+B<llvmg++> [I<options>] I<filename>
 
 =head1 DESCRIPTION
 
diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod
index bd27ec17f95..64062ec49df 100644
--- a/docs/CommandGuide/opt.pod
+++ b/docs/CommandGuide/opt.pod
@@ -1,4 +1,3 @@
-
 =pod
 
 =head1 NAME
@@ -7,7 +6,7 @@ opt - LLVM optimizer
 
 =head1 SYNOPSIS
 
-opt [options] [filename]
+B<opt> [I<options>] [I<filename>]
 
 =head1 DESCRIPTION
 
@@ -89,11 +88,10 @@ occurs, it will exit with a non-zero value.
 
 =head1 SEE ALSO
 
-L<analyze>
+L<analyze|analyze>
 
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
 
 =cut
-
-- 
2.34.1