GRELNOTES(1)GRELNOTES(1)NAMEgrelnotes - graphical on-line release notes viewer
SYNOPSISgrelnotes [ X toolkitoption... ] [-rpath path]
[product] [chapter]
DESCRIPTIONgrelnotes provides a graphical interface for viewing the on-line release
notes.
For each software product installed on the workstation there is a set of
on-line release notes. Each set of release notes contains a number of
chapters providing important information about the product. grelnotes
makes it possible to quickly locate and browse these release notes.
If grelnotes is executed with no arguments, it will come up displaying
the release notes for the "IRIX" software product. The "IRIX" product is
the basic software included on the workstation (eg. unix and utilities).
If these release notes are not installed, the release notes for the
product "eoe" will be displayed and if these are not present, the first
set of release notes found will be displayed.
If product is specified, the program will come up displaying the first
chapter of the release notes for that product. If chapter is specified in
addition to product the program will come up displaying this chapter of
the product's release notes.
VIEWING RELEASE NOTES
The grelnotes program window consists of a menu bar at the top, a product
and chapter title display below that, the document text viewer and a set
of chapter movement buttons at the bottom.
When grelnotes comes up it will be displaying a chapter of a product's
release notes. The product and chapter currently displayed is indicated
just below the program menu bar.
If you wish to read this chapter you may use the scrollbar and arrow
buttons to the right of the text viewer to scroll through the document.
The following keyboard keys may also be used for document browsing:
Up/Down arrows Move up/down one line of text
Page Up/Down Move up/down one page of text
Home/End Move to top of first/last page
Spacebar Move down one page of text
A new product may be selected from the Products item on the program menu
bar.
Page 1
GRELNOTES(1)GRELNOTES(1)
A new chapter may be selected from the Chapters item on the program menu
bar. A new chapter may also be selected using the Prev Chapter or Next
Chapter buttons at the bottom of the program window. These buttons move
sequentially through the list of chapters.
Text in the text viewer may be selected for pasting into other documents
or applications. Selection of text is performed using the left mouse
button. Note that the document or application into which text is to be
pasted must obey the ICCCM conventions for cut and paste operations.
PRINTING RELEASE NOTESgrelnotes provides printing of release notes by selecting the Print...
item from the File menu. Either the current chapter or all chapters of
the current product may be printed. All printing is done on the default
system printer. Use the System Manager program to establish a default
printer on your system if one has not already been selected.
UPDATING THE PRODUCT AND CHAPTER LISTS
If products have been added or removed from the system while grelnotes is
running, the list of products and chapters that grelnotes knows about can
be updated by selecting Update List from the File menu.
RELEASE NOTES DIRECTORY
Typically the release notes for all products installed on the workstation
are located in subdirectories of /usr/relnotes. By default, grelnotes
looks in this directory for release notes. A different release notes
directory path may be specified in a number of ways. If the program
resource relnotesPath is set to a directory path, grelnotes will look in
this directory for release notes. If the environment variable
RELNOTESPATH is set to a path, the program will look there for release
notes. Finally, if the command-line option -rpath is specified, the path
argument to this option will be used as the release notes directory. The
environment variable takes precedence over the program resource and the
command-line option takes precedence over the environment variable.
WIDGET HIERARCHY
The following is an abbreviated widget hierarchy for grelnotes.
grelnotes (Grelnotes)
topForm (Form)
menuBar (RowColumn)
placeFrame (Frame)
placeForm (Form)
productLabel (Label)
product (Label)
chapterLabel (Label)
chapter (Label)
textViewSW (ScrolledWindow)
textViewSB (ScrollBar)
textViewFM (Frame)
textView (TextView)
buttonRC (RowColumn)
Page 2
GRELNOTES(1)GRELNOTES(1)
prevChapter (PushButton)
nextChapter (PushButton)
PROGRAM RESOURCESgrelnotes is written using the standard X toolkit and the Motif widget
set. The program accepts all standard Xt/Motif resources and command line
options. In addition to these resources the following resources are
specific to the grelnotes program and may be specified by the user.
relnotesPath (class RelnotesPath)
Specifies the root release notes directory. Each
product's release notes are a subdirectory of
this root pathname. See above discussion.
tempPath (class TempPath)
Specifies the directory into which temporary
files created by the program should be placed.
The path should not end with '/'. Note that the
environment variable TMPDIR, if set, overrides
any setting of this resource.
TextView.normalFont (class Font)
Specifies the font to be used for regular text.
See note below.
TextView.underlineFont (class Font)
Specifies the font to be used for italicized or
underlined text. See note below.
TextView.boldFont (class Font)
Specifies the font to be used for bolded text.
See note below.
TextView.boldUnderFont (class Font)
Specifies the font to be used for text that is
both bold and italicized or underlined. See note
below.
TextView.normalForeground (class Foreground)
Specifies the foreground color for regular text.
TextView.underlineForeground (class Foreground)
Specifies the foreground color for italicized or
underlined text.
TextView.boldForeground (class Foreground)
Specifies the foreground color for bolded text.
TextView.boldUnderForeground (class Foreground)
Specifies the foreground color for bolded and
underlined text.
Page 3
GRELNOTES(1)GRELNOTES(1)
TextView.selectionForeground (class Background)
Specifies the foreground (text) color for
selected text.
TextView.selectionBackground (class Foreground)
Specifies the background color for selected
text.
TextView.textColumns (class TextColumns)
Specifies the number of columns to be displayed
by the text viewer when grelnotes comes up.
TextView.textRows (class TextRows)
Specifies the number of rows to be displayed by
the text viewer when grelnotes comes up.
TextView.blankCompress (class BlankCompress)
The on-line release notes have been formatted
for printing with a standard page length.
Therefore, pages have been padded with trailing
blank lines where necessary. This resource is
used to minimize the number of blank lines
displayed. This resource specifies a blank line
threshold. Consecutive blank lines up to this
threshold will be displayed. Any remaining
consecutive blank lines will be ignored. Set
this resource to zero (0) to disable blank line
compression.
TRANSLATIONS
The grelnotes program uses the following defaults for keyboard navigation
and text selection. The translations may be changed using the
TextView.translations resource.
Key/Button Action Routine
______________________________________
<Btn1Down>: StartSelect()
<Btn1Motion>: DragSelect()
<Btn1Up>: CompleteSelect()
<Key>Tab: NextTabGroup()
Ctrl<Key>Tab: NextTabGroup()
Shift<Key>Tab: PrevTabGroup()
Ctrl Shift<Key>Tab: PrevTabGroup()
<Key>osf3eginLine: FirstPage()
<Key>KP_Home: FirstPage()
<Key>KP_7: FirstPage()
<Key>osfEndLine: LastPage()
<Key>KP_End: LastPage()
<Key>KP_1: LastPage()
<Key>osfUp: LineUp()
<Key>KP_Up: LineUp()
Page 4
GRELNOTES(1)GRELNOTES(1)
<Key>KP_8: LineUp()
<Key>osfDown: LineDown()
<Key>KP_Down: LineDown()
<Key>KP_2: LineDown()
<Key>osfPageUp: PageUp()
<Key>KP_Prior: PageUp()
<Key>KP_9: PageUp()
<Key>osfPageDown: PageDown()
<Key>KP_Next: PageDown()
<Key>KP_3: PageDown()
<Key>space: PageDown()ACTION ROUTINES
The grelnotes program contains the following action routines.
StartSelect() Begin a text selection.
DragSelect() Drag the text selection.
CompleteSelect() Complete a text selection.
NextTabGroup() Move to next tab group.
PrevTabGroup() Move to previous tab group.
FirstPage() Scroll text to first page.
LastPage() Scroll text to last page.
LineUp() Scroll text one line down so that the next line up is
visible.
LineDown() Scroll text one line up so that the next line down is
visible.
PageUp() Scroll text one page down so that the next page up is
visible.
PageDown() Scroll text one page up so that the next page down is
visible.
NOTE
The grelnotes program displays pre-formatted release notes. The format
assumes the use of a fixed-width font for all text styles. In addition,
the format assumes that normal, underline, bold and bold-underline fonts
all have the same character width. The default fonts for the normalFont,
underlineFont, boldFont and boldUnderFont resources have been chosen to
adhere to these assumptions. If new fonts are to be specified for any of
these resources, the above assumptions should be observed or columnar
output may not be properly aligned.
Page 5
GRELNOTES(1)GRELNOTES(1)SEE ALSOman(1), relnotes(1)FILES
/usr/lib/X11/app-defaults/Grelnotes Program resource file
/usr/relnotes/<product>/TC Table of contents file for
<product>
/usr/relnotes/<product>/ch*.z Release notes for <product>
/usr/tmp/grel<id> Temporary file
Page 6
