summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorXavier Leroy <xavier.leroy@inria.fr>1999-02-25 14:25:54 +0000
committerXavier Leroy <xavier.leroy@inria.fr>1999-02-25 14:25:54 +0000
commit85802ed939245f49c331441c7d6e1af65f37230d (patch)
treec0d5adacb42d1c5a445668d0ade01d6993336de6 /man
parent88dcc69825a33c3ac6d0dab613ea009eb3dbab2a (diff)
downloadocaml-85802ed939245f49c331441c7d6e1af65f37230d.tar.gz
Ajout et corrections de pages de man
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@2311 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'man')
-rw-r--r--man/Makefile6
-rw-r--r--man/ocamlc.m14
-rw-r--r--man/ocamlmktop.m85
-rw-r--r--man/ocamlopt.m15
4 files changed, 120 insertions, 0 deletions
diff --git a/man/Makefile b/man/Makefile
new file mode 100644
index 0000000000..66040261cd
--- /dev/null
+++ b/man/Makefile
@@ -0,0 +1,6 @@
+include ../config/Makefile
+
+install:
+ for i in *.m; do cp $$i $(MANDIR)/`basename $$i .m`.$(MANEXT); done
+ echo '.so man$(MANEXT)/ocamlc.$(MANEXT)' > $(MANDIR)/ocamlc.opt.$(MANEXT)
+ echo '.so man$(MANEXT)/ocamlopt.$(MANEXT)' > $(MANDIR)/ocamlopt.opt.$(MANEXT)
diff --git a/man/ocamlc.m b/man/ocamlc.m
index 6183841c62..2f25d54e45 100644
--- a/man/ocamlc.m
+++ b/man/ocamlc.m
@@ -29,6 +29,9 @@ ocamlc \- The Objective Caml bytecode compiler
]
.I filename ...
+.B ocamlc.opt
+.I (same options)
+
.SH DESCRIPTION
The Objective Caml bytecode compiler
@@ -122,6 +125,17 @@ mode (see the description of
.B \-custom
below).
+.B ocamlc.opt
+is the same compiler as
+.BR ocamlc ,
+but compiled with the native-code compiler
+.BR ocamlopt (1).
+Thus, it behaves exactly like
+.BR ocamlc ,
+but compiles faster.
+.B ocamlc.opt
+is not available in all installations of Objective Caml.
+
.SH OPTIONS
The following command-line options are recognized by
diff --git a/man/ocamlmktop.m b/man/ocamlmktop.m
new file mode 100644
index 0000000000..1a956329c8
--- /dev/null
+++ b/man/ocamlmktop.m
@@ -0,0 +1,85 @@
+.TH OCAMLMKTOP 1
+
+.SH NAME
+ocamlmktop \- Building custom toplevel systems
+
+.SH SYNOPSIS
+.B ocamlmktop
+[
+.B \-v
+]
+[
+.BI \-cclib \ libname
+]
+[
+.BI \-ccopt \ option
+]
+[
+.B \-custom
+[
+.BI \-o \ exec-file
+]
+[
+.BI \-I \ lib-dir
+]
+.I filename ...
+
+.SH DESCRIPTION
+
+The
+.BR ocamlmktop (1)
+command builds Objective Caml toplevels that
+contain user code preloaded at start-up.
+The
+.BR ocamlmktop (1)
+command takes as argument a set of
+.IR x \&.cmo
+and
+.IR x \&.cma
+files, and links them with the object files that implement the Objective
+Caml toplevel. If the
+.B -custom
+flag is given, C object files and libraries (.o and .a files) can also
+be given on the command line and are linked in the resulting toplevel.
+
+.SH OPTIONS
+
+The following command-line options are recognized by
+.BR ocamlmktop (1).
+
+.TP
+.B \-v
+Print the version number of the compiler.
+
+.TP
+.BI \-cclib\ -l libname
+Pass the
+.BI \-l libname
+option to the C linker when linking in
+``custom runtime'' mode (see the corresponding option for
+.BR ocamlc (1).
+
+.TP
+.B \-ccopt
+Pass the given option to the C compiler and linker, when linking in
+``custom runtime'' mode. See the corresponding option for
+.BR ocamlc (1).
+
+.TP
+.B \-custom
+Link in ``custom runtime'' mode. See the corresponding option for
+.BR ocamlc (1).
+
+.TP
+.BI \-I directory
+Add the given directory to the list of directories searched for
+compiled interface files (.cmo and .cma).
+
+.TP
+.BI \-o \ exec-file
+Specify the name of the toplevel file produced by the linker.
+The default is is
+.BR a.out .
+
+.SH SEE ALSO
+.BR ocamlc (1).
diff --git a/man/ocamlopt.m b/man/ocamlopt.m
index bff268dc48..c15614102a 100644
--- a/man/ocamlopt.m
+++ b/man/ocamlopt.m
@@ -29,6 +29,9 @@ ocamlopt \- The Objective Caml native-code compiler
]
.I filename ...
+.B ocamlopt.opt
+.I (same options)
+
.SH DESCRIPTION
The Objective Caml high-performance
native-code compiler
@@ -121,6 +124,17 @@ does not need
.BR ocamlrun (1)
to run.
+.B ocamlopt.opt
+is the same compiler as
+.BR ocamlopt ,
+but compiled with itself instead of with the bytecode compiler
+.BR ocamlc (1).
+Thus, it behaves exactly like
+.BR ocamlopt ,
+but compiles faster.
+.B ocamlopt.opt
+is not available in all installations of Objective Caml.
+
.SH OPTIONS
The following command-line options are recognized by
@@ -157,6 +171,7 @@ causes the C linker to search for C libraries in
directory
.IR dir .
+.TP
.B \-compact
Optimize the produced code for space rather than for time. This
results in smaller but slightly slower programs. The default is to