summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRalf Wildenhues <Ralf.Wildenhues@gmx.de>2008-09-20 08:50:50 +0200
committerRalf Wildenhues <Ralf.Wildenhues@gmx.de>2008-09-20 09:07:24 +0200
commit1f7fe1cc9c05244453c81264577f9d424fd1f4c8 (patch)
treea9363e1dffa2b36dba10cbf1fe568c792fc62eb2 /doc
parent27c7020eb0209da84d0a8477a3b34fbe91b7f2c4 (diff)
downloadlibtool-1f7fe1cc9c05244453c81264577f9d424fd1f4c8.tar.gz
Man pages for libtoolize and libtool, --help-all.
* Makefile.am (dist_man1_MANS, update_mans): New macros. ($(srcdir)/doc/libtool.1, $(srcdir)/doc/libtoolize.1): New rules. Use --help-all for libtool. (MAINTAINERCLEANFILES): New macro. Add dist_man1_MANS. (BUILT_SOURCES): Add libtoolize. * configure.ac: Check for help2man, set HELP2MAN. * doc/libtool.texi: Add @direntry for libtool-invocation. (Invoking libtool): Document -h, --help-all. Reorder mode description for consistency. (Compile mode): Do not document -Wl,FLAG and -XCClinker here. (Link mode): Document -Wc,FLAG here, reformat a bit. * libtoolize.m4sh: Reformat --help output a bit, to help help2man. * libltdl/config/ltmain.m4sh: Likewise. Also, set PROGRAM to `libtool', not `ltmain.sh', so the former is used in the man page. New argument `--help-all'. If given, call func_help and func_mode_help several times, beating output in shape with sed. (func_mode_help): Do not exit here. * libltdl/config/getopt.m4sh (func_usage): Work with different indentations, but require comment hash in first column, when grepping for '-h' in usage to end short help. (func_help): Accept optional argument to not exit. * NEWS, THANKS: Update. Suggestion by Karl Berry. Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore1
-rw-r--r--doc/libtool.texi37
2 files changed, 22 insertions, 16 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
index bc219011..5d0e8528 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -6,3 +6,4 @@ notes.txt
*.html
*.ps
*.pdf
+*.1
diff --git a/doc/libtool.texi b/doc/libtool.texi
index 7b6b3f57..59f38727 100644
--- a/doc/libtool.texi
+++ b/doc/libtool.texi
@@ -18,6 +18,8 @@
@dircategory Individual utilities
@direntry
+* libtool-invocation: (libtool)Invoking libtool.
+ Running the @code{libtool} script.
* libtoolize: (libtool)Invoking libtoolize. Adding libtool support.
@end direntry
@@ -1144,10 +1146,16 @@ to determine whether shared or static libraries will be built.
@item --finish
Same as @option{--mode=finish}.
+@item -h
+Display short help message.
+
@item --help
Display a help message and exit. If @option{--mode=@var{mode}} is
-specified, then detailed help for @var{mode} is
-displayed.
+specified, then detailed help for @var{mode} is displayed.
+
+@item --help-all
+Display help for the general options as well as detailed help for each
+operation mode, and exit.
@item --mode=@var{mode}
Use @var{mode} as the operation mode. When using libtool from the
@@ -1165,14 +1173,14 @@ Compile a source file into a libtool object.
Automatically set the library path so that another program can use
uninstalled libtool-generated programs or libraries.
-@item finish
-Complete the installation of libtool libraries on the system.
+@item link
+Create a library or an executable.
@item install
Install libraries or executables.
-@item link
-Create a library or an executable.
+@item finish
+Complete the installation of libtool libraries on the system.
@item uninstall
Delete installed libraries or executables.
@@ -1293,14 +1301,7 @@ linking.
@item -Wc,@var{flag}
@itemx -Xcompiler @var{flag}
-Pass a linker specific flag directly to the compiler.
-
-@item -Wl,@var{flag}
-@itemx -Xlinker @var{flag}
-Pass a linker specific flag directly to the linker.
-
-@item -XCClinker @var{flag}
-Pass a link specific flag to the compiler driver (@var{CC}) during linking.
+Pass a flag directly to the compiler.
@end table
@node Link mode
@@ -1469,12 +1470,16 @@ no need to append @var{libname} to the list of dependency libraries of
@var{output-file}, because linking against @var{output-file} already
supplies the same interface (@pxref{Linking with dlopened modules}).
+@item -Wc,@var{flag}
+@itemx -Xcompiler @var{flag}
+Pass a linker-specific flag directly to the compiler.
+
@item -Wl,@var{flag}
@itemx -Xlinker @var{flag}
-Pass a linker specific flag directly to the linker.
+Pass a linker-specific flag directly to the linker.
@item -XCClinker @var{flag}
-Pass a link specific flag to the compiler driver (@var{CC}) during linking.
+Pass a link-specific flag to the compiler driver (@var{CC}) during linking.
@end table
If the @var{output-file} ends in @samp{.la}, then a libtool library is