The Shore Alpha Release
Version 0.1

The Shore Project Group
Computer Sciences Department
UW-Madison
Madison, WI

Thu Nov 3 14:11:17 CST 1994

Contents

1 What is the Alpha Release?

The Alpha release of the Shore software is an early release of work-in-progress to a small group of sites. The release is targeted for sites that will use Shore as a system for writing applications using the Shore Data-definition Language. This document describes the release and provides pointers to other documents explaining how to install and use the software.

Note, the Alpha release is not intended for those who want to write servers by extending the Shore Storage Manager, and the release contains no documentation for such purposes. We are working on such documentation.

If you have questions, comments or bug reports, please mail them to


    shore_support@cs.wisc.edu

1.1 Requirements

The Alpha release is supported for Sparcstations running SunOS 4.1.3. You will also need the GNU C/C++ compiler, gcc, version 2.6.0 or 2.5.8 (we have not done extensive testing with 2.5.8). Complete details on required software and hardware are available in the Requirements section of the Installation manual.

1.2 Copyright and Disclaimer

The Shore software is distributed with the following copyright notice and disclaimer, and is subject to its terms:

Copyright (c) 1994 Computer Sciences Department, University of Wisconsin - Madison. All Rights Reserved.

Permission to use, copy, modify and distribute this software and its documentation is hereby granted, provided that both the copyright notice and this permission notice appear in all copies of the software, derivative works or modified versions, and any portions thereof, and that both notices appear in supporting documentation.

THE COMPUTER SCIENCES DEPARTMENT OF THE UNIVERSITY OF WISCONSIN - MADISON ALLOWS FREE USE OF THIS SOFTWARE IN ITS ``AS IS'' CONDITION. THE DEPARTMENT DISCLAIMS ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.

The Shore Project Group requests users of this software to return any improvements or extensions that they make to the Shore Project Group, Computer Sciences Department, University of Wisconsin, 1210 West Dayton Street, Madison, WI 53706-1685.

In addition, the Shore Project Group requests that users grant the Computer Sciences Department rights to redistribute these changes.

2 Release Contents

The Shore Software distribution consists of documentation, binary, and source releases. These are briefly described below. Additional information is available in the installation manual.

2.1 Documentation Release

The documentation release consists of HTML and Postscript versions (in html/ and ps/, respectively) of the following documents:

In addition, source code for example programs, including an implementation of the OO7 Benchmark, is included in the examples directory.

2.2 Binary Release

The binary release consists of the SDL compiler, run-time library to be linked with applications, the Shore Server executable, and utilities for mounting the Shore File System as an NFS file system. The binary release is available with and without debugging support. With debugging support, the binary release contains debugging symbols and auditing code, and therefore is 2-4 times slowing and over twice as large as the non-debugging version.

2.3 Source Release

The source release contains the source tree and tools for building everything in the binary release.

3 Getting Started

The following sections explain how to get started using Shore to write applications.

3.1 Installing the Shore Software

The first step in using Shore is to install the documentation and software. The Shore Software Installation Manual explains how to install the documentation and binary releases and how to use the source release to compile new binaries.

The installation manual contains a section on testing the installation. This is a step-by-step guide to starting a Shore Server, compiling and running an application and mounting the Shore file system.

3.2 Learning More about the Shore Server

After you have installed the Shore software and tested your installation, you can find more information about using the Shore Server and file system in the document titled: Configuring and Running a Shore Server.

3.3 Writing, Compiling, and Running Applications

A number of example applications are included in documentation release. The document, Getting Started with Shore uses these examples to explain how to write, compile and run applications.

To write your own Shore application, you will need to be familiar with the Shore Data-definition language, SDL. See the document, An SDL Reference Manual, and the man pages, sdl(SDL) and sdlcxx(SDL) for more information.


zwilling@caseus.cs.wisc.edu
Thu Nov 3 14:11:14 CST 1994