As well as allowing you to access documents directly by name (which is normally the fastest method if you know where to find the information you want), HTX also allows you to search for information by keyword.
Keyword searching is performed using the
findme command, which is simply illustrated:
This command will search your documentation set for the string “HTX” and will then display a list of the documents found using your WWW browser, with each entry in the list being a hyper-link to the document in question. It is then a simple matter to follow the link to the document you want to read (in this example there will probably only be one document to choose from – this one).
The way in which the
findme command performs its search is explained in the next section, but in
essence it attempts to find information about major topics quickly by searching only the main titles of
documents. It then goes on to consider more detailed (and time consuming) searches only for more
obscure topics that can’t be found readily. The progress of the search is displayed on your
terminal, so you can interrupt it if you fail to find what you want quickly and don’t want to
The more level of detail
findme needs to consider, the more detailed will be the list of results it
generates, with individual HTML pages being listed if appropriate. This strategy of performing
progressively deeper searches can be observed if you ask for information on something a little more
findme search for information on itself, or even something very obscure,
which will (probably) only be found in the body of the text of this document.
findme command allows you to find information at the level of detail you want by searching any
of four categories of information associated with hypertext documents:
/TITLEtags in the HTML header section for that page. The title of a document is obviously a good place to search for important topics and this can be done quite quickly.
If none of the switches shown above is used when
findme is invoked, its default action is
However, if one or more of the
-l switches is used, then only the specified categories of
information will be searched, and this will be done in a single pass through all the documents. For
will cause only the document names to be searched (for the string “sun”), while:
would search only the document titles, and:
would search both the titles and page headings in a single pass.
By default, the
findme command will search your entire documentation set,
consisting of all the documents found on the
HTX_PATH search path (see §2.3)
However, you can restrict the search to specific documents by listing them after the keyword you are searching for, thus:
would find information about “targets” in this document. This is often a useful way of finding reference information once you are reasonably familiar with a document’s contents. Restricting the search to a specific document will also make it far more rapid.
You may specify as many documents to search as you want. If you do not give explicit directory
HTX_PATH search path will be used to locate them.
findme command has a number of options that allow you to fine-tune the search that it performs.
findme command description in §A for full details.