NAME

navigator − OpenWindows browser and searcher for online documentation

SYNOPSIS

navigator -a answerbook-id [ -l language ]

AVAILABILITY

navigator is available as part of OpenWindows Version 3.1 and the Solaris 2.1 operating system. 

DESCRIPTION

navigator and docviewer(1) together comprise an OpenWindows application for navigating and viewing on-line AnswerBook collections. 

navigator provides three modes for accessing AnswerBook documents: Contents (table-of-contents browsing), Search (full-text search and retrieval), and Bookmarks (links the user creates to frequently referenced pages).  Documents found using navigator may then be viewed with docviewer(1). 

USAGE

Contents mode — navigator presents a contents hierarchy for browsing, from the top-level contents (sets of books in the collection) down to individual books, chapters, sections, and subsections.  Double-clicking SELECT on any document listed in the navigator window displays that document in the docviewer window. 

Search mode — In this mode navigator supports full-text searching of an entire AnswerBook, or portions thereof.  Search queries are free-form; there is no query language to learn. The navigator displays search results as a list of documents, ranked in order of relevance to the search query.  The algorithm used to determine document relevance is heuristical, and is based on word-occurrence statistics.  Documents in the search results list may be displayed in the docviewer window by double-clicking on their list entries.  The Previous Searches window provides a simple copy-and-paste facility for redoing or modifying search queries. 

Bookmarks mode — Users can set a bookmark on the page currently displayed in the docviewer window, and optionally include a comment with the bookmark.  In Bookmarks mode, the navigator displays the user’s list of bookmarks.  Double-clicking on a bookmark displays the corresponding page in the docviewer window. 

navigator also supports on-demand printing of documents.  The navigator Print window facilitates printing of any document found through any of the three navigation modes, as well as whatever document is currently displayed in the docviewer window. 

Some AnswerBooks contain translated documents in addition to the English versions.  The user can specify the preferred language at the beginning of an AnswerBook session via the $LANG environment variable or the "-l" command line flag.  navigator and docviewer will display, search, etc., documents in the preferred language when they are present in the AnswerBook. 

OPTIONS

−a answerbook-id
Specify the id of the AnswerBook to be viewed.

−l language
Specify the preferred language for displaying documents. Overrides value of $LANG if $LANG is set.

ENVIRONMENT

BOOKINFO

This environment variable must be set to the full pathname of the document collection’s bookinfo file.  navigator uses the bookinfo(5) file to locate a document collection’s table of contents databases and search index. 

LANG

Specify the preferred language for browsing, searching, etc.  Can be overridden by "-l" command line flag. 

$FULTEMP

Directory for writing temporary files used during search operation. 

navigator invokes other AnswerBook utilities, make sure the directory containing the AnswerBook binaries (docviewer, viewprint, and so on) is in your shell search path. 

FILES

~/.bookmarks

Contains bookmarks from the existing bookmarks list.  This file is not intended to be manually edited. 

/usr/tmp/ft∗
$FULTEMP/ft∗

Temporary files used during search operation. 

SEE ALSO

docviewer(1), viewopen(1), viewprint(1), setlocale(3C), bookinfo(5)

DIAGNOSTICS

navigator: Can’t find book configuration info
Indicates a problem with the bookinfo configuration file.
See bookinfo(1) and bookinfo(5). 

navigator: Can’t find book book-id
Indicates a problem with the bookinfo configuration file.
See bookinfo(1) and bookinfo(5). 

Can’t intialize searcher
The bookinfo entry for the current collection probably has an incorrect search-index-path .  Use bookinfo(1) to diagnose. 

NOTES

AnswerBook is a trademark of Sun Microsystems, Inc., licensed to SunSoft, Inc. 
 
 
 

SunOS 5.1  —  Last change: 18 March 1992