maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

* Standardize manpage output: program name bold, options italic/emphasized 

* Make links in SEE ALSO section of manpages short without "the ... manpage"

llvm-svn: 14579
This commit is contained in:
Misha Brukman 2004-07-02 16:06:19 +00:00
parent 763855342b
commit 6c4644b4a9
17 changed files with 36 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
llvm/docs/CommandGuide/analyze.pod
View File

@ -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

5
llvm/docs/CommandGuide/bugpoint.pod
View File

@ -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

6
llvm/docs/CommandGuide/extract.pod
View File

@ -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

6
llvm/docs/CommandGuide/gccas.pod
View File

@ -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

6
llvm/docs/CommandGuide/gccld.pod
View File

@ -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

6
llvm/docs/CommandGuide/llc.pod
View File

@ -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

14
llvm/docs/CommandGuide/lli.pod
View File

@ -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

5
llvm/docs/CommandGuide/llvm-as.pod
View File

@ -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

4
llvm/docs/CommandGuide/llvm-bcanalyzer.pod
View File

@ -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

2
llvm/docs/CommandGuide/llvm-db.pod
View File

@ -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

5
llvm/docs/CommandGuide/llvm-dis.pod
View File

@ -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

2
llvm/docs/CommandGuide/llvm-link.pod
View File

@ -6,7 +6,7 @@ llvm-link - LLVM linker
=head1 SYNOPSIS
llvm-link [options] filename [...]
B<llvm-link> [I<options>] I<filename ...>
=head1 DESCRIPTION

5
llvm/docs/CommandGuide/llvm-nm.pod
View File

@ -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

7
llvm/docs/CommandGuide/llvm-prof.pod
View File

@ -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

5
llvm/docs/CommandGuide/llvmgcc.pod
View File

@ -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

3
llvm/docs/CommandGuide/llvmgxx.pod
View File

@ -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

6
llvm/docs/CommandGuide/opt.pod
View File

@ -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