diff options
| author | Gabriel Scherer <gabriel.scherer@gmail.com> | 2016-04-14 13:17:15 -0400 |
|---|---|---|
| committer | Gabriel Scherer <gabriel.scherer@gmail.com> | 2016-04-18 11:25:01 -0400 |
| commit | 20cf23e625a144878ff0627b2f6eb68efd2db54e (patch) | |
| tree | 05a9de66d98ca04a9ce73d2946207e6718d64691 /man | |
| parent | db9b05989f9ec586791fc606a8f4e4d00f6a34a1 (diff) | |
| download | ocaml-20cf23e625a144878ff0627b2f6eb68efd2db54e.tar.gz | |
document .ocamldebug, the debugger initialization file
For consistency, I also added an "Initialization file" section in the
toplevel manpage.
Diffstat (limited to 'man')
| -rw-r--r-- | man/ocaml.m | 30 | ||||
| -rw-r--r-- | man/ocamldebug.m | 16 |
2 files changed, 41 insertions, 5 deletions
diff --git a/man/ocaml.m b/man/ocaml.m index 428a54999b..54d20a990b 100644 --- a/man/ocaml.m +++ b/man/ocaml.m @@ -96,11 +96,7 @@ directive. .TP .BI \-init \ file Load the given file instead of the default initialization file. -The default file is -.B .ocamlinit -in the current directory if it exists, otherwise -.B .ocamlinit -in the user's home directory. +See the "Initialization file" section below. .TP .B \-labels Labels are not ignored in types, labels may be used in applications, @@ -117,6 +113,10 @@ Do not compile assertion checks. Note that the special form .B assert\ false is always compiled because it is typed specially. .TP +.B \-noinit +Do not load any initialization file. +See the "Initialization file" section below. +.TP .B \-nolabels Ignore non-optional labels in types. Labels cannot be used in applications, and parameter order becomes strict. @@ -238,6 +238,26 @@ as a script file name, even when it starts with a hyphen (-). .BR \-help \ or \ \-\-help Display a short usage summary and exit. +.SH INITIALIZATION FILE + +When +.BR ocaml (1) +is invoked, it will read phrases from an initialization file before +giving control to the user. The default file is +.B .ocamlinit +in the current directory if it exists, otherwise +.B .ocamlinit +in the user's home directory. You can specify a different initialization file +by using the +.BI \-init \ file +option, and disable initialization files by using the +.B \-noinit +option. + +Note that you can also use the +.B #use +directive to read phrases from a file. + .SH ENVIRONMENT VARIABLES .TP .B LC_CTYPE diff --git a/man/ocamldebug.m b/man/ocamldebug.m index b0c9a897d2..f03ad60f39 100644 --- a/man/ocamldebug.m +++ b/man/ocamldebug.m @@ -98,6 +98,22 @@ Print short version number and exit. .TP .BR \-help \ or \ \-\-help Display a short usage summary and exit. + +.SH INITIALIZATION FILE + +When +.BR ocamldebug (1) +is invoked, it will read commands from an initialization file before +giving control to the user. The default file is +.B .ocamldebug +in the current directory if it exists, otherwise +.B .ocamldebug +in the user's home directory. + +Note that you can also use the +.B source file +command to read commands from a file. + .SH SEE ALSO .BR ocamlc (1) .br |