                        ---------------
                        Lotus NotesPeek
                        ---------------
                        
This is the README for Lotus NotesPeek, a browser for Notes data.  The 
software agreement for NotesPeek is at the end of this file.


WHAT IS NOTESPEEK?
------------------

NotesPeek is a browser for Notes data.  It was written for the use of 
technical Notes users who want to see a more raw view of their Notes 
databases than the Notes client provides.  The goal in NotesPeek is to 
present the information in Notes databases as it is available through the 
Notes API.

NotesPeek is based on a containment hierarchy: Notes servers have 
databases, databases have documents, documents have items, etc.  For the 
most part, this containment hierarchy is that presented by the API.  One 
exception is that NotesPeek presents object data as being contained within 
object items, when they are not.

Selecting a line in the tree view on the left will display information 
about that line in the text view on the right.

NotesPeek displays almost all of the data available through the Notes 
API.  There is some data available at the database level that is not yet 
shown (full-text index information, for example).  Where data cannot be 
interpreted because its format is not documented, it is displayed as a hex 
dump.


INSTALLING
----------

NotesPeek consists of a single executable, notespk.exe, which can be 
placed anywhere you like.  The Notes executable directory must be on the 
path, and your notes.ini must be on the path.  


NAVIGATING
----------

The tree view can be navigated with either the mouse or the keyboard.  The 
expand and collapse buttons are sensitive to single-clicks.  
Double-clicking a line will either expand or contract it, depending on 
whether it is already expanded or contracted. 

Using the keyboard, the arrow keys move around the tree.  Up and down 
arrow simply move up and down the list.  Left and right move along the 
parent-child relationships, and expand and collapse as needed as they go.  
Backspace moves from a child to its parent without collapsing.  Enter will 
expand or collapse a line.

Keys on the numeric keypad can also be used to expand and contract lines.  
Plus will expand the current line, minus will contract it.  Star will 
expand the current line, but more than just one level.  How deep it 
expands depends on what type of line it is.

You can interrupt NotesPeek by typing Ctrl+Break, just as in Notes.  This 
is most often needed when expanding a documents node with many documents.

There is a third pane in the window: it is above the tree view, and can be 
exposed by dragging the splitter down.  It displays the current node and 
all of its parents.  It can be used to see the context of the current 
node.  This pane accepts no input.

The font for either the tree or text view can be changed.  Simply click in 
the desired view, and then use View - Set Font to select the font.

Keep in mind that NotesPeek is an MDI application, so you can open more 
than one Peek window at once.  You can also open a window for a specific 
server or file (with File - Open File or File - Open Server).  This is 
useful if the file is outside of your Notes data directory, or if the 
server is not in the same domain as your home server.


KNOWN PROBLEMS
--------------

On Windows 3.1, the page down key does not move the selection in the tree 
view.  This is due to a bug in Windows.

Very rarely, the display in the text view will be long enough to get 
truncated. 

The text view is slow to display large amounts of text.


LICENSE
-------

Lotus NotesPeek Software Agreement

YOU MUST READ THESE TERMS AND CONDITIONS BEFORE YOU USE LOTUS NOTESPEEK. 
PLEASE PAY PARTICULAR ATTENTION TO THE "LIMITED WARRANTY" AND "LIMITATION 
OF LIABILITY" SECTIONS.  AFTER YOU HAVE READ THIS AGREEMENT, FOLLOW THE 
INSTRUCTIONS BELOW FOR ACCEPTING THIS AGREEMENT AND USING LOTUS NOTESPEEK.

1.  USE OF SOFTWARE; PROPRIETARY RIGHTS.   Provided you are an authorized 
Lotus Business Partner in good standing, Lotus Development Corporation 
grants you the right to use and reproduce Lotus NotesPeek (the "Software") 
for the sole purpose of viewing Notes databases within your organization.  
Under no circumstances may you (a) loan, rent, sublicense or otherwise 
transfer or provide access to the Software or any copy, either on a 
temporary or permanent basis, to any third party or any person or (b) 
alter, merge, modify or adapt the Software in any way including reverse 
engineering, disassembling or decompiling.  Lotus retains all intellectual 
property rights in the Software and all copies thereof, including, without 
limitation, copyright.  You must reproduce the copyright notice on each 
disk of all backup copies.  

2.  TERMINATION.   Lotus may terminate this Agreement and the right to use 
the Software, or may modify the terms of this Agreement, at any time 
without notice.  Upon termination you must deinstall and destroy all 
copies of the Software and certify to that effect in writing to Lotus.

3.  RESPONSIBILITIES; NO SUPPORT.   You acknowledge that the Software is 
not commercially available and has not undergone the quality assurance 
testing Lotus performs on products which Lotus makes available to the 
general public.  You should allow access to the Software only by 
knowledgeable and trained individuals.  IN LIGHT OF THE FOREGOING, YOU ARE 
REQUIRED TO BACKUP ALL DATA AND PROGRAMS PRIOR TO USING THE SOFTWARE.   
Lotus will not provide any support or technical assistance with respect to 
your use of the Software.

4.  NO WARRANTY.   Given the nature of this right to use, LOTUS IS 
PROVIDING THE SOFTWARE TO YOU "AS IS" AND MAKES NO WARRANTY OR 
REPRESENTATION, EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THE SOFTWARE OR 
ANY RELATED USER DOCUMENTATION, INCLUDING, WITHOUT LIMITATION, THEIR 
QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
    
5.  LIMITATION OF LIABILITY.   Because software is inherently complex and 
may not be completely free of errors, you are required to verify your work 
and to make backup copies.  IN NO EVENT WILL LOTUS BE LIABLE FOR DIRECT, 
INDIRECT, SPECIAL, INCIDENTAL, ECONOMIC, TORT, COVER OR CONSEQUENTIAL 
DAMAGES OF ANY KIND OR NATURE WHATSOEVER IN CONNECTION WITH YOUR USE OF 
THE SOFTWARE, INCLUDING WITHOUT LIMITATION, DAMAGES OR COSTS RELATING TO 
LOSS OF PROFITS, BUSINESS, GOODWILL, DATA OR COMPUTER PROGRAMS, EVEN IF ADV
ISED OF THE POSSIBILITY OF SUCH DAMAGES.

6.  MISCELLANEOUS.   This Agreement may not be amended or modified without 
the written consent of an authorized representative of each party. The 
export, distribution and disclosure of the Software are subject to U.S. 
Export Administration Regulations.  The terms of Sections 1, 4 and 5 shall 
survive any termination of this Agreement.  This Agreement shall be 
governed by the laws of the Commonwealth of Massachusetts.

USING THE SOFTWARE WILL CONSTITUTE YOUR ACCEPTANCE OF THE TERMS AND 
CONDITIONS OF THIS AGREEMENT.
