haskal
/
utop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed some minor typos in the README and man pages (#461)

This commit is contained in:
G-J 2023-09-08 11:05:52 +02:00 committed by GitHub
parent 464cdcbaf7
commit 3e45a6e98f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -52,10 +52,10 @@ To use utop, simply run:
utop utop
utop display a bar after the prompt which is used to show possible utop displays a bar after the prompt which is used to show possible
completions in real-time. You can navigate in it using `M-left` and completions in real time. You can navigate in it using `M-left` and
`M-right`, and select one completion using `M-down`. The `M` denotes `M-right`, and select one completion using `M-down`. The `M` denotes
the meta key, which is `Alt` most of the time. the meta key, which is `Alt` on most systems.
Customization Customization
------------- -------------
@ -104,7 +104,7 @@ You can turn on the vi edit mode by `#edit_mode_vi`. It currently supports
three vi modes: normal, insert, visual mode, and you can get/set content three vi modes: normal, insert, visual mode, and you can get/set content
with vim-like registers. with vim-like registers.
This special edit mode is evolving rapidly, see the CHANGES of lambda-term for the rapidly changing information. This special edit mode is evolving rapidly; see the CHANGES of lambda-term for the rapidly changing information.
### UTop API ### UTop API
@ -133,7 +133,9 @@ started from within Emacs.
The recommended way to install `utop.el` is via Emacs's built-in package manager `package.el`. The recommended way to install `utop.el` is via Emacs's built-in package manager `package.el`.
`utop.el` is available on the community-maintained `utop.el` is available on the community-maintained
[MELPA Stable](https://stable.melpa.org) and [MELPA](https://melpa.org) `package.el` repositories. If you're not using them already, please follow the setup instructions [here](https://melpa.org/#/getting-started). [MELPA Stable](https://stable.melpa.org) and [MELPA](https://melpa.org) `package.el` repositories.
If you're not using them already, please follow the setup instructions
[here](https://melpa.org/#/getting-started).
**Note:** Using MELPA Stable is recommended as it has the latest stable version. **Note:** Using MELPA Stable is recommended as it has the latest stable version.
MELPA has a development snapshot for users who don't mind breakage but MELPA has a development snapshot for users who don't mind breakage but
@ -260,13 +262,13 @@ correctly:
Fatal error: cannot load shared library dlllwt-unix_stubs Fatal error: cannot load shared library dlllwt-unix_stubs
Reason: dlopen(dlllwt-unix_stubs.so, 138): image not found Reason: dlopen(dlllwt-unix_stubs.so, 138): image not found
It shall point to the directory `stublibs` inside your ocaml installation. It should point to the directory `stublibs` inside your ocaml installation.
Automatically installing toplevel printers Automatically installing toplevel printers
------------------------------------------ ------------------------------------------
Utop will automatically install toplevel printers for custom Utop will automatically install toplevel printers for custom
types if their interface file is marked with an types if their interface files are marked with an
`[@@ocaml.toplevel_printer]` attribute. Adding this annotation to `[@@ocaml.toplevel_printer]` attribute. Adding this annotation to
your libraries will remove the need to have a separate `top` package your libraries will remove the need to have a separate `top` package
to install the printers. to install the printers.
@ -297,7 +299,7 @@ Creating a custom utop-enabled toplevel
The recommended way to build a custom utop toplevel is via The recommended way to build a custom utop toplevel is via
[Dune][dune]. The entry point of the custom utop must call [Dune][dune]. The entry point of the custom utop must call
`UTop_main.main`. For instance write the following `myutop.ml` file: `UTop_main.main`. For instance, write the following `myutop.ml` file:
```ocaml ```ocaml
let () = UTop_main.main () let () = UTop_main.main ()
@ -312,14 +314,14 @@ and the following dune file:
(libraries utop)) (libraries utop))
``` ```
then to build the toplevel, run: then, to build the toplevel, run:
``` ```
$ dune myutop.bc $ dune myutop.bc
``` ```
Note the `-linkall` in the link flags. By default OCaml doesn't link Note the `-linkall` in the link flags. By default OCaml doesn't link
unused modules, however for a toplevel you don't know in advance what unused modules. However for a toplevel you don't know in advance what
the user is going to use so you must link everything. the user is going to use so you must link everything.
If you want to include more libraries in your custom utop, simply add If you want to include more libraries in your custom utop, simply add
@ -341,7 +343,7 @@ supported.
### Manually, with ocamlfind ### Manually, with ocamlfind
This section describe methods using ocamlfind. These are no longer This section describe methods using `ocamlfind`. These are no longer
tested, so there is no guarantee they still work. tested, so there is no guarantee they still work.
If you want to create a custom toplevel with utop instead of the If you want to create a custom toplevel with utop instead of the
@ -349,7 +351,7 @@ classic one you need to link it with utop and its dependencies and
call `UTop_main.main` in the last linked unit. You also need to pass call `UTop_main.main` in the last linked unit. You also need to pass
the `-thread` switch when linking the toplevel. the `-thread` switch when linking the toplevel.
The easiest way to do that is by using ocamlfind: The easiest way to do that is by using `ocamlfind`:
$ ocamlfind ocamlmktop -o myutop -thread -linkpkg -package utop myutop_main.cmo $ ocamlfind ocamlmktop -o myutop -thread -linkpkg -package utop myutop_main.cmo
@ -359,14 +361,14 @@ Where `myutop_main.ml` contains:
let () = UTop_main.main () let () = UTop_main.main ()
``` ```
You can also use the `ocamlc` sub-command instead of `ocamlmktop`, in You can also use the `ocamlc` sub-command instead of `ocamlmktop`. In
this case you need to pass these thee extra arguments: this case you need to pass these three extra arguments:
* `-linkall` to be sure all units are linked into the produced toplevel * `-linkall` to be sure all units are linked into the produced toplevel
* `-package compiler-libs.toplevel` * `-package compiler-libs.toplevel`
* `-predicates create_toploop` * `-predicates create_toploop`
With the last option ocamlfind will generate a small ocaml unit, With the last option `ocamlfind` will generate a small ocaml unit,
linked just before `myutop_main.cmo`, which will register at startup linked just before `myutop_main.cmo`, which will register at startup
packages already linked in the toplevel so they are not loaded again packages already linked in the toplevel so they are not loaded again
by the `#require` directive. It does the same with the `ocamlmktop` by the `#require` directive. It does the same with the `ocamlmktop`
@ -377,9 +379,9 @@ For example:
$ ocamlfind ocamlc -o myutop -thread -linkpkg -linkall -predicates create_toploop \ $ ocamlfind ocamlc -o myutop -thread -linkpkg -linkall -predicates create_toploop \
-package compiler-libs.toplevel,utop myutop.cmo -package compiler-libs.toplevel,utop myutop.cmo
Note that if you are not using ocamlfind, you will need to do that Note that if you are not using `ocamlfind`, you will need to do that
yourself. You have to call `Topfind.don't_load` with the list of all yourself. You have to call `Topfind.don't_load` with the list of all
packages linked with the toplevel. packages linked with the toplevel.
A full example using ocamlbuild is provided in the A full example using `ocamlbuild` is provided in the
[examples/custom-utop](examples/custom-utop) directory. [examples/custom-utop](examples/custom-utop) directory.

16
man/utop.1
View File

@ -25,13 +25,13 @@ utop \- Universal toplevel for OCaml
.SH DESCRIPTION .SH DESCRIPTION
.B utop .B utop
is a enhanced toplevel for OCaml with many features, including context is an enhanced toplevel for OCaml with many features, including context
sensitive completion. sensitive completion.
When you start When you start
.B utop .B utop
what you see is the prompt followed by a bar containing words. This is what you see is the prompt followed by a bar containing words. This is
the completion bar, it contains the possible completion and is updated the completion bar: it contains the possible completion and is updated
as you type. The highlighted word in the completion bar is the as you type. The highlighted word in the completion bar is the
selected word. You can navigate using the keys Alt+Left and Alt+Right selected word. You can navigate using the keys Alt+Left and Alt+Right
and you can complete using the currently selected word by pressing and you can complete using the currently selected word by pressing
@ -51,9 +51,9 @@ utop supports completion on:
* object methods * object methods
Colors are by default configured for terminals with dark colors, such Colors are by default configured for terminals with dark colors, such
as white on black, so the prompt may looks too bright on light colors as white on black, so the prompt may look too bright on light-colored
terminals. You can change that by setting the color profile of terminals. You can change that by setting the color profile of
utop. For that type: utop. To do that, type:
UTop.set_profile UTop.Light;; UTop.set_profile UTop.Light;;
@ -80,7 +80,7 @@ file:
(autoload 'utop "utop" "Toplevel for OCaml" t) (autoload 'utop "utop" "Toplevel for OCaml" t)
then you can run utop by pressing M-x and typing "utop". utop support then you can run utop by pressing M-x and typing "utop". utop supports
completion in emacs mode. Just press Tab to complete a word. You can completion in emacs mode. Just press Tab to complete a word. You can
also integrate it with the tuareg, caml or typerex mode. For that add also integrate it with the tuareg, caml or typerex mode. For that add
the following lines to your the following lines to your
@ -112,7 +112,7 @@ Show absolute filenames in error message.
Add \fIdir\fR to the list of include directories. Add \fIdir\fR to the list of include directories.
.TP .TP
.BI -init " file" .BI -init " file"
Load \fIfile\fR instead of default init file. Load \fIfile\fR instead of the default init file.
.TP .TP
.BI -labels .BI -labels
Use commuting label mode. Use commuting label mode.
@ -127,10 +127,10 @@ Do not compile assertion checks.
Ignore non-optional labels in types. Ignore non-optional labels in types.
.TP .TP
.BI -nostdlib .BI -nostdlib
Do not add default directory to the list of include directories. Do not add the default directory to the list of include directories.
.TP .TP
.BI -ppx " command" .BI -ppx " command"
Pipe abstract syntax trees through preprocessor \fIcommand\fR. Pipe abstract syntax trees through the preprocessor \fIcommand\fR.
.TP .TP
.BI -principal .BI -principal
Check principality of type inference. Check principality of type inference.

4
man/utoprc.5
View File

@ -24,7 +24,7 @@ ignored. Configuration lines are of the form:
<wildcard>: <value> <wildcard>: <value>
.I <wildcard> .I <wildcard>
may contains the '*' star character. In that case any key which match may contain the '*' asterisk character. In that case any key which matches
the pattern is given the value after the colon. the pattern is given the value after the colon.
The boolean key The boolean key
@ -111,7 +111,7 @@ example:
identifier.foreground: #5fbf7f identifier.foreground: #5fbf7f
utop will choose the nearest color of the terminal when specifying a utop will choose the nearest color of the terminal when specifying an
X11 color or a color given by its RGB components. If you are using X11 color or a color given by its RGB components. If you are using
gnome-terminal or konsole, you can enable 256 colors by setting the gnome-terminal or konsole, you can enable 256 colors by setting the
environment variable TERM to "xterm-256color". environment variable TERM to "xterm-256color".