INSIGHT(1) INSIGHT(1)
NAME
insight, iiv - The IRIS InSight Online Documentation (Book) Viewer
SYNOPSIS
insight [ -v bookname [ -print ] [ -r ] [ -attrib attr ] [ -h style ] ]
[ -l libpath ] [ -b bookshelfname [ -only ] ]
[ -auth authorizationstring ]
[ -f | -nofork ]
DESCRIPTION
The IRIS InSight Viewer is an online information retrieval system. This
viewer provides an easy-to-use interface which allows the user to search
and browse through online information that is distributed from Silicon
Graphics.
OPTIONS
Command line options are described below.
-v The -v bookname option tells insight to invoke only the Viewer
window, and to load the specified book. The bookname is the
abbreviated short title for the book. This title can be found on
the stow icon for the book, or from the candidate list of the
library window during a search. Note that this option is case-
sensitive. For example,
insight -v IRISEssentials
-b The -b bookshelfname option tells insight to invoke the Library
(main) window and to produce a list of available books from the
specified bookshelf. By default, the entire Library is loaded
(unless -only is specified along with this option), and insight
simply changes it's default Library view to open that specific
bookshelf.
A bookshelf is defined as a directory containing a set of books. By
default, bookshelves are located in
/usr/share/Insight/library/SGI_bookshelves.
To examine a sample bookshelf, look under the default path of
/usr/share/Insight/library/SGI_bookshelves. All the directories
contained under this area are defined as "bookshelves". They are
displayed in the viewer as a vertically-stacked shelf, containing a
set of books. By convention, below each of those directories exists
another directory, called "books".
The path to the bookshelf should be specified (this can be a
relative pathname), along with the bookshelf name. For example,
insight -b
/usr/share/Insight/library/SGIbookshelves/SGIAdmin
Page 1
INSIGHT(1) INSIGHT(1)
will display the contents for the SGI_Admin bookshelf in the library
viewer.
-only
Used in conjunction with -b bookshelfname, this forces insight to
only load the specified bookshelf and not the entire Library.
-l The -l libpath option tells insight to invoke the Library (main)
window, and to load the specified library. A library is defined as
a collection of bookshelves. By default, the library is rooted at
/usr/share/Insight/library. The path (relative or full) to the new
library should be specified. Only one library may be specified. For
example,
insight -l /usr/share/Insight/libXXX
-r The -r option is used in conjunction with the -v bookname option.
It instructs the insight software to load the specified book in a
"restricted" viewer. A restricted viewer is defined as one that
does not have a Table-of-Contents navigation area.
-attrib
The -attrib attr option is used in conjunction with the -v bookname
option. It instructs the insight software to load the specified
book, and scroll to a particular entry point. That entry point is
designated by the result which is generated from the attribute
string. Note that the attr string must be enclosed in double-quotes
in order to be properly interpreted.
For any invalid expressions, or those that cannot be resolved,
insight will simply invoke the book in the Viewer, and will not
scroll to any particular entry point.
Although rarely used by an end-user, the following attribute
commands are available :
query(expression)
takes any expression valid in the insight query language, and
returns the entry point of the first element in the specified book
that matches the expression. For more information on the query
language, please consult the IRIS InSight on-line help.
For example, a user could specify the following:
insight -v PerSysAdmin -attrib "query(managing printers)".
The result would bring up the Personal System Administration Guide
and take them to the first area in the book that contained the
phrase "managing printers".
Page 2
INSIGHT(1) INSIGHT(1)
idmatch(name, value)
is a special case of query(), which searches in the current book for
the first element which has an attribute with the specified 'name'
and 'value' and returns the entry point for that element. If the
'name' argument is omitted (i.e., if there is only one argument, or
the first of two arguments is empty), then only attributes named ID
will be considered. This function is used to implement the most
common kind of hypertext link in SGML (Standard Generalized Markup
Language).
For example:
insight -v PerSysAdmin -attrib "idmatch(180)".
ancestor(expression)
returns returns the immediate parent element (entry point) for the
enclosed expression.
lsibling(expression)
returns the preceding sibling element (entry point) for the enclosed
expression.
rsibling(expression)
similar to lsibling(expression), but returns the next sibling
element (entry point) for the enclosed expression.
-h The -h style option is used in conjunction with the -v bookname
option. It instructs the insight software to load the specified
book, using the specified stylesheet. Although rarely used by an
end-user, it is available.
-print
The -print option is used to open the print window automatically for
the book specified by the -v bookname option.
-auth
The -auth authorizationstring option instructs insight to use the
designated string as an authorization key for reading books that
have been licensed. At this time, this option will not be needed for
accessing the online books from Silicon Graphics.
-f The -f (or -nofork) option tells insight to run in the foreground,
and to disable "run-once" behavior. "Run-once" is when one copy of
IRIS InSight can be invoked, per X-display. By default, "run-once"
behavior is turned on.
Page 3
INSIGHT(1) INSIGHT(1)
For additional information, please consult the IRIS InSight on-line help.
FILES
/usr/sbin/insight, /usr/sbin/iiv
SEE ALSO
sgihelp(1)
Page 4