improve help

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@4979 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02

1 files changed, 40 insertions, 18 deletions

diff --git a/otherlibs/labltk/browser/help.txt b/otherlibs/labltk/browser/help.txt
index 941c81b04..62bfc5921 100644
--- a/otherlibs/labltk/browser/help.txt
+++ b/otherlibs/labltk/browser/help.txt
@@ -1,6 +1,7 @@
                           OCamlBrowser Help
 
 USE
+
    OCamlBrowser is composed of three tools, the Editor, which allows
    one to edit/typecheck/analyse .mli and .ml files, the Viewer, to
    walk around compiled modules, and the Shell, to run an OCaml
@@ -8,32 +9,35 @@ USE
    you may use several subshells.
 
    As with the compiler, you may specify a different path for the
-   standard library by setting OCAMLDIR. You may also extend the
+   standard library by setting OCAMLLIB. You may also extend the
    initial load path (only standard library by default) by using the
-   -I command line option.
+   -I command line option. The -nolabels, -rectypes and -w options are
+   also accepted, and inherited by subshells.
+   The -oldui options selects the old multi-window interface. The
+   default is now more like Smalltalk's class browser.
 
 1) Viewer
-   It displays the list of modules in the load path. Click on one to
-   start your trip.
-
-   The entry line at the bottom allows one to search for an identifier
-   in all modules, either by its name (? and * patterns allowed) or by
-   its type (if there is an arrow in the input). When search by type
-   is used, it is done in inclusion mode (cf. Modules - search symbol)
 
-   The Close all button is there to dismiss the windows created
-   during your trip (every click creates one...) By double-clicking on
-   it you will quit the browser.
+   This is the first window you get when you start OCamlBrowser.  It
+   displays a search window, and the list of modules in the load path.
+   At the top a row of menus.
 
    File - Open and File - Editor give access to the editor.
 
    File - Shell opens an OCaml shell.
 
+   View - Show all defs  displays the signature of the currently
+   selected module.
+
+   View - Search entry  shows/hides the search entry just
+   below the menu bar.
+
    Modules - Path editor changes the load path.
         Pressing [Add to path] or Insert key adds selected directories
         to the load path.
         Pressing [Remove from path] or Delete key removes selected
         paths from the load path.
+
    Modules - Reset cache rescans the load path and resets the module
    cache. Do it if you recompile some interface, or change the load
    path in a conflictual way.
@@ -52,12 +56,29 @@ USE
    arguments in the actual type are ignored if (1) there are to many
    of them, and (2) they do not appear explicitly in the pattern.
 
-2) Module walking
-   Each module is displayed in its own window.
+   The Search entry just below the menu bar allows one to search for
+   an identifier in all modules, either by its name (? and * patterns
+   allowed) or by its type (if there is an arrow in the input). When
+   search by type is used, it is done in inclusion mode (cf. Modules -
+   search symbol)
 
-   At the top, a scrollable list of the defined identifiers. If you
-   click on one, this will either create a new window (if this is a
-   sub-module) or display the signature for this identifier below.
+   The Close all button is there to dismiss the windows created
+   by the Detach button. By double-clicking on it you will quit the
+   browser.
+
+
+2) Module browsing
+
+   You select a module in the leftmost box by either cliking on it or
+   pressing return when it is selected. Fast access is available in
+   all boxes pressing the first few letter of the desired name.
+   Double-clicking / double-return displays the whole signature for
+   the module.
+
+   Defined identifiers inside the module are displayed in a box to the
+   right of the previous one. If you click on one, this will either
+   display its contents in another box (if this is a sub-module) or
+   display the signature for this identifier below.
 
    Signatures are clickable. Double clicking with the left mouse
    button on an identifier in a signature brings you to its signature,
@@ -67,7 +88,6 @@ USE
    selectable, also brings you to its signature.
 
    At the bottom, a series of buttons, depending on the context.
-   * Show all displays the signature of the whole module.
    * Detach copies the currently displayed signature in a new window,
      to keep it.
    * Impl and Intf bring you to the implementation or interface of
@@ -76,6 +96,7 @@ USE
    C-s opens a text search dialog for the displayed signature.
 
 3) File editor
+
    You can edit files with it, but there is no auto-save nor undo at
    the moment. Otherwise you can use it as a browser, making
    occasional corrections.
@@ -105,6 +126,7 @@ USE
    Signature shows the signature of the current file.
 
 4) Shell
+
    When you create a shell, a dialog is presented to you, letting you
    choose which command you want to run, and the title of the shell
    (to choose it in the Editor).