bk-helptool - (unknown subject)
NAME
bk helptool − graphical front-end to the BitKeeper
help system
SYNOPSIS
bk helptool [topic]
DESCRIPTION
The bk helptool command is a graphical interface to
the online help system.
There are two text windows displayed, a window of topics on the left and the help text on the right. There are multiple sections, which group related topics together. A topic is slightly indented, the section heading is not.
You can move around using the mouse, clicking on topics. You can also page through the entire help using PageDown or PageUp. To move from section to section, use the Left arrow to move up and the Right arrow to move forward. This is fairly useful since the first entry in each section tries to give a brief overview of that section.
HYPERLINK
STACK
Helptool has a stack of places that you have visited,
very similar to the hyperlink stack in a web browser. If you
click on a topic you will notice that the Back button
becomes enabled. Clicking it will move back to the previous
topic. Similarly for forward. The same hot keys which work
in Netscape are used here for forward and back.
SEARCHING
Helptool includes a simple search facility. To search
for information, you type a word or phrase and hit return
(or click on Search). The search facility is fairly
basic, single word searches tend to work better than
phrases. If a phrase is wanted, it must be put in quotes,
i.e., “lock file.” By default, the search will
return approximate matches, i.e., searching on
“a” will return anything with the letter
“a.” There is a config option to turn this
off.
The lines which match, if any, are shown slightly indented. Above the indent lines is the name of the command or help page which contains the lines. You can click on that to jump to that page. Each command or page which contains the search phrase will be be highlighted in orange so that you click through each of the pages which contain the information.
If you go to a page and it was not what you wanted, and you wish to look at the summary lines again, jump back by clicking Search or hitting return. Note that the search results are not part of the hyperlink stack of visited pages, but you can get back to the search results at any time by hitting Return.
BINDINGS
The up/down bindings will move through topics, so when they
hit the end and the key is pressed again, the topic changes
to the next or previous.
DownArrow Scroll the help text down one line.
UpArrow Scroll the help text up one line.
LeftArrow Scroll the help text left one column.
RightArrow Scroll the help text right one column.
PageDown Scroll the help text down one screen.
PageUp Scroll the help text up one screen.
Home Scroll to the top of help text.
End Scroll to the bottom of the help text.
Control-Up Move to the beginning of the previous topic.
Control-Down Move to the beginning of the next topic.
Control-Left Move to the beginning of the next section
(not topic).
Control-Right Move to the beginning of the previous
section (not topic).
Alt-Left Move backwards to the previously visited topic.
Alt-Right Move forwards to the to the next topic in the
stack.
Escape Exit bk helptool.
Control-b Scroll the help text up one screen.
Control-f Scroll the help text down one screen.
Control-e Scroll the help text down one line.
Control-y Scroll the help text up one line.
Control-q Exit from bk helptool.
SEE ALSO
bk-config-gui, bk-help
CATEGORY
GUI-tools