diff options
| -rw-r--r-- | man/ocaml.m | 2 | ||||
| -rw-r--r-- | man/ocamlc.m | 12 | ||||
| -rw-r--r-- | man/ocamldoc.m | 23 | ||||
| -rw-r--r-- | man/ocamllex.m | 4 | ||||
| -rw-r--r-- | man/ocamlopt.m | 12 | ||||
| -rw-r--r-- | man/ocamlyacc.m | 2 |
6 files changed, 33 insertions, 22 deletions
diff --git a/man/ocaml.m b/man/ocaml.m index 4b3b04498..80d641c12 100644 --- a/man/ocaml.m +++ b/man/ocaml.m @@ -22,7 +22,7 @@ The .BR ocaml (1) command is the toplevel system for OCaml, that permits interactive use of the OCaml system through a -read-eval-print loop. In this mode, the system repeatedly reads Caml +read-eval-print loop. In this mode, the system repeatedly reads OCaml phrases from the input, then typechecks, compiles and evaluates them, then prints the inferred type and result value, if any. The system prints a # (sharp) prompt before reading each phrase. diff --git a/man/ocamlc.m b/man/ocamlc.m index 92d41f62a..597d0ca0e 100644 --- a/man/ocamlc.m +++ b/man/ocamlc.m @@ -22,7 +22,7 @@ ocamlc \- The OCaml bytecode compiler The OCaml bytecode compiler .BR ocamlc (1) -compiles Caml source files to bytecode object files and links +compiles OCaml source files to bytecode object files and links these object files to produce standalone bytecode executable files. These executable files are then run by the bytecode interpreter .BR ocamlrun (1). @@ -78,7 +78,7 @@ the implementation Arguments ending in .cmo are taken to be compiled object bytecode. These files are linked together, along with the object files obtained -by compiling .ml arguments (if any), and the Caml Light standard +by compiling .ml arguments (if any), and the OCaml standard library, to produce a standalone executable program. The order in which .cmo and.ml arguments are presented on the command line is relevant: compilation units are initialized in that order at @@ -117,7 +117,7 @@ below). Arguments ending in .so are assumed to be C shared libraries (DLLs). During linking, they are -searched for external C functions referenced from the Caml code, +searched for external C functions referenced from the OCaml code, and their names are written in the generated bytecode executable. The run-time system .BR ocamlrun (1) @@ -158,7 +158,7 @@ Thus, it behaves exactly like .BR ocamlc , but compiles faster. .B ocamlc.opt -may not be available in all installations of O\Caml. +may not be available in all installations of OCaml. .SH OPTIONS @@ -242,7 +242,7 @@ and the bytecode for the program. The resulting file is larger, but it can be executed directly, even if the .BR ocamlrun (1) command is not -installed. Moreover, the "custom runtime" mode enables linking Caml +installed. Moreover, the "custom runtime" mode enables linking OCaml code with user-defined C functions. Never use the @@ -389,7 +389,7 @@ specify the name of the output file produced. .TP .B \-output\-obj Cause the linker to produce a C object file instead of a bytecode -executable file. This is useful to wrap Caml code as a C library, +executable file. This is useful to wrap OCaml code as a C library, callable from any C program. The name of the output object file is .B camlprog.o by default; it can be set with the diff --git a/man/ocamldoc.m b/man/ocamldoc.m index 1a35506a9..17be62d86 100644 --- a/man/ocamldoc.m +++ b/man/ocamldoc.m @@ -27,12 +27,15 @@ ocamldoc \- The OCaml documentation generator The OCaml documentation generator .BR ocamldoc (1) generates documentation from special comments embedded in source files. The -comments used by OCamldoc are of the form +comments used by +.B ocamldoc +are of the form .I (** ... *) and follow the format described in the .IR "The OCaml user's manual" . -OCamldoc can produce documentation in various formats: HTML, LaTeX, TeXinfo, +.B ocamldoc +can produce documentation in various formats: HTML, LaTeX, TeXinfo, Unix man pages, and .BR dot (1) dependency graphs. Moreover, users can add their own @@ -112,7 +115,9 @@ to display it. Dynamically load the given file (which extension usually is .cmo or .cma), which defines a custom documentation generator. If the given file is a simple one and does not exist in -the current directory, then ocamldoc looks for it in the custom +the current directory, then +.B ocamldoc +looks for it in the custom generators default directory, and in the directories specified with the .B \-i option. @@ -236,7 +241,9 @@ as the title for the generated documentation. .BI \-intro \ file Use content of .I file -as ocamldoc text to use as introduction (HTML, LaTeX and TeXinfo only). +as +.B ocamldoc +text to use as introduction (HTML, LaTeX and TeXinfo only). For HTML, the file is used to create the whole "index.html" file. .TP .B \-v @@ -249,10 +256,14 @@ Print version string and exit. Print short version number and exit. .TP .B \-warn\-error -Treat Ocamldoc warnings as errors. +Treat +.B ocamldoc +warnings as errors. .TP .B \-hide\-warnings -Do not print OCamldoc warnings. +Do not print +.B ocamldoc +warnings. .TP .BR \-help \ or \ \-\-help Display a short usage summary and exit. diff --git a/man/ocamllex.m b/man/ocamllex.m index f45bdc18b..f07cc6cd6 100644 --- a/man/ocamllex.m +++ b/man/ocamllex.m @@ -26,7 +26,7 @@ Running .BR ocamllex (1) on the input file .IR lexer \&.mll -produces Caml code for a lexical analyzer in file +produces OCaml code for a lexical analyzer in file .IR lexer \&.ml. This file defines one lexing function per entry point in the lexer @@ -53,7 +53,7 @@ command recognizes the following options: .TP .B \-ml Output code that does not use OCaml's built-in automata -interpreter. Instead, the automaton is encoded by Caml functions. +interpreter. Instead, the automaton is encoded by OCaml functions. This option is mainly useful for debugging .BR ocamllex (1), using it for production lexers is not recommended. diff --git a/man/ocamlopt.m b/man/ocamlopt.m index 35dcb6dcd..539fe8fe1 100644 --- a/man/ocamlopt.m +++ b/man/ocamlopt.m @@ -22,7 +22,7 @@ ocamlopt \- The OCaml native-code compiler The OCaml high-performance native-code compiler .BR ocamlopt (1) -compiles Caml source files to native code object files and link these +compiles OCaml source files to native code object files and link these object files to produce standalone executables. The @@ -65,7 +65,7 @@ should always be referred to under the name .IR x .cmx (when given a .o file, .BR ocamlopt (1) -assumes that it contains code compiled from C, not from Caml). +assumes that it contains code compiled from C, not from OCaml). The implementation is checked against the interface file .IR x .mli @@ -74,7 +74,7 @@ The implementation is checked against the interface file Arguments ending in .cmx are taken to be compiled object code. These files are linked together, along with the object files obtained -by compiling .ml arguments (if any), and the Caml Light standard +by compiling .ml arguments (if any), and the OCaml standard library, to produce a native-code executable program. The order in which .cmx and .ml arguments are presented on the command line is relevant: compilation units are initialized in that order at @@ -318,7 +318,7 @@ option is given, specify the name of plugin file produced. .TP .B \-output\-obj Cause the linker to produce a C object file instead of an executable -file. This is useful to wrap Caml code as a C library, +file. This is useful to wrap OCaml code as a C library, callable from any C program. The name of the output object file is camlprog.o by default; it can be set with the .B \-o @@ -427,11 +427,11 @@ the module. The name of the plugin must be set with the .B \-o -option. A plugin can include a number of Caml +option. A plugin can include a number of OCaml modules and libraries, and extra native objects (.o, .a files). Building native plugins is only supported for some operating system. Under some systems (currently, -only Linux AMD 64), all the Caml code linked in a plugin must have +only Linux AMD 64), all the OCaml code linked in a plugin must have been compiled without the .B \-nodynlink flag. Some constraints might also diff --git a/man/ocamlyacc.m b/man/ocamlyacc.m index 7601224d1..43436f2f6 100644 --- a/man/ocamlyacc.m +++ b/man/ocamlyacc.m @@ -30,7 +30,7 @@ Assuming the input file is .IR grammar \&.mly, running .B ocamlyacc -produces Caml code for a parser in the file +produces OCaml code for a parser in the file .IR grammar \&.ml, and its interface in file .IR grammar \&.mli. |