BK-HELPTOOL(1)

🌸 NAME 🌸

okay so you’re on the bk helptool(none) page from the BitKeeper User’s Manual, bestie — and this one is literally the graphical front-end to the BitKeeper help system. slay. 💅

✨ SYNOPSIS ✨

bk helptool [topic]

🦋 DESCRIPTION 🦋

The bk helptool command is a graphical interface to the online help system. no cap.

You get two text windows: a topics window on the left, and the help text on the right. There are multiple sections, and they group related topics together. A topic is slightly indented; the section heading is not. iconic layout behavior, honestly. 🎀

You can move around with the mouse by 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. lowkey genius. ✨

💖 HYPERLINK STACK 💖

Helptool has a stack of places you’ve visited, very similar to the hyperlink stack in a web browser. If you click on a topic, you’ll notice the Back button becomes enabled. Clicking it moves back to the previous topic. Similarly for forward. The same hot keys which work in Netscape are used here for forward and back. iykyk. 🫶

🔍 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. bestie, that’s the whole vibe. 🍓

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 highlighted in orange so that you click through each of the pages which contain the information. very “follow the sparkle trail” of it all. ✨

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. periodt. 💅

🎀 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. okay, keys, let’s go. 🔥

• 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

---

💖 source/version + date: BitKeeper Inc, 1E1 — manual name: bk helptool(none). byeeee, go click some topics bestie 🎀✨🦋