Added hinting to man page.

diff --git a/doc/vimb.1 b/doc/vimb.1
index fa2f043..9f68b16 100644 (file)
--- a/doc/vimb.1
+++ b/doc/vimb.1
@@ -185,6 +185,104 @@ Scroll page \fIN\fP steps down.
 .TP
 .BI [ N ]k
 Scroll page \fIN\fP steps up.
+.SS Hinting
+Hinting in Vimb is how you accomplish the tasks that you would do with the
+mouse in common mouse-driven browsers: open a URI, yank a URI, save a page and
+so on. When hinting is started, the relevant elements on the page will
+be marked by labels generated from configured `hintkeys'.
+Hints can be selected by using <Tab>, <C-I> or <C-Tab>, <C-O>,
+by typing the chars of the label, or filtering the elements by some text
+that is part of the hinted element (like URI, link text, button label)
+or any combination of these methods.
+If <enter> is pressed, the current active hint will be fired.
+If only one possible hint remains, this will be fired automatically.
+.PP
+.BI Syntax: " ;{mode}{hint}"
+.PP
+Start Hints mode.
+Different elements depending on \fImode\fP are highlighted and `numbered'.
+Elements can be selected either by typing their label, or by typing part
+of their text (\fIhint\fP) to narrow down the result.
+When an element has been selected, it is automatically clicked
+or used (depending on \fImode\fP) and hint mode ends.
+.PP
+The filtering of hints by text splits the query at ' ' and use the single parts
+as separate queries to filter the hints.
+This is useful for hints that have a lot of filterable chars in common
+and many chars are required to make a distinct selection.
+For example ';over tw' will easily select the second hint out of
+{'very long link text one', 'very long link text two'}.
+.PP
+The following keys have special meanings in Hints modes:
+.PD 0
+.IP \fB<CR>\fP
+Selects the first highlighted element, or the current focused.
+.IP "\fB<Tab>\fP"
+Moves the focus to the next hint element.
+.IP "\fB<S-Tab>\fP"
+Moves the focus to the previous hint element.
+.IP "\fB<Esc>, CTRL\-C, CTRL\-[\fP"
+Exits Hints mode without selecting an element.
+.PD
+.TP
+.B Hint modes:
+.RS
+.PD 0
+.TP
+.B f
+Is an alias for the \fB;o\fP hint mode.
+.TP
+.B F
+Is an alias for the \fB;t\fP hint mode.
+.TP
+.B ;o
+Open hint's location in the current window.
+.TP
+.B ;t
+Open hint's location in a new window.
+.TP
+.B ;s
+Saves the hint's destination under the configured `download-path'.
+.TP
+.B ;O
+Generate an `:open' prompt with hint's URI.
+.TP
+.B ;T
+Generate an `:tabopen' prompt with hint's URI.
+.TP
+.B ;i
+Open hinted image in the current window.
+.TP
+.B ;I
+Open hinted image in a new window.
+.TP
+.B ;p
+Push the hint's URI to the end of the Read It Later queue like the `:qpush'
+command.
+This is only available if Vimb was compiled with the QUEUE feature.
+.TP
+.B ;P
+Push the hint's URI to the beginning of the Read It Later queue like the
+`:qunshift' command.
+This is only available if Vimb was compiled with the QUEUE feature.
+.TP
+.BI [ \(dqx ];y
+Yank hint's destination location into primary and secondary clipboard and into
+the register \fIx\fP.
+.TP
+.BI [ \(dqx ];Y
+Yank hint's text description or form text into primary and secondary clipboard
+and into the register \fIx\fP.
+.PD
+.RE
+.TP
+.BI Syntax: " g;{mode}{hint}"
+Start an extended hints mode and stay there until <Esc> is pressed.
+Like normal hinting, except that after a hint is selected, hints
+remain visible so that another one can be selected with the same action
+as the first.
+Note that the extended hint mode can only be combined with the following
+hint modes \fII p P s t y Y\fP.
 .SS Searching
 .TP
 .BI / QUERY ", ?" QUERY
@@ -545,6 +643,13 @@ Contains the pid of the running Vimb instance.
 .B VIMB_XID
 Holds the X-Window id of the Vimb window or of the embedding window if Vimb is
 started with the -e option.
+.TP
+.B VIMB_MIME_TYPE
+The mime-type of the download.
+This variable is only available when the server sent the mime-type header
+with the response and only if the download was not start by the `:save'
+command or the `;s' hinting.
+.TP
 .PD
 .PP
 Example:
@@ -599,6 +704,9 @@ Curent opened URI.
 .TP
 .B \(dq/
 Last search phrase.
+.TP
+.B \(dq;
+Contains the last hinted URL.
 .PD
 .RE
 .TP
@@ -705,6 +813,34 @@ If closed-max-items is set to 0, closed URLs will not be stored.
 .TP
 .B default-zoom (int)
 Default Full-Content zoom level in percent. Default is 100.
+.TP
+.B hint-follow-last (bool)
+If on, vimb automatically follows the last remaining hint on the page.
+If off hints are fired only if enter is pressed.
+.TP
+.B hint-number-same-length (bool)
+If on, all hint numbers will have the same length, so no hints will be
+ambiguous.
+.TP
+.B hint-timeout (int)
+Timeout before automatically following a non-unique numerical hint.
+To disable auto fire of hints, set this value to 0.
+.TP
+.B hintkeys (string)
+The keys used to label and select hints.
+With its default value, each hint has a unique number which can be typed
+to select it, while all other characters are used to filter hints based
+on their text.
+With a value such as asdfg;lkjh,
+each hint is `numbered' based on the characters of the home row.
+Note that the hint matching by label built of hintkeys is case sensitive.
+In this vimb differs from some other browsers that show hint labels in upper
+case, but match them lowercase.
+.RS
+To have upper case hint labels, it's possible to add following css to the
+`style.css' file in vimb's configuration directory.
+.IP "._hintLabel {text-transform: uppercase !important;}"
+.RE
 .SH FILES
 .TP
 .IR $XDG_CONFIG_HOME/vimb[/PROFILE]