Preface

This document is an introduction to the QEF construction system and its associated tools and procedures.

As an introductory guide, the intention is not to provide definitive descriptions of the QEF system, but rather to introduce and illustrate basic concepts and tools of the QEF Software Process Automation System and the approach that it supports. This guide is divided into three major parts:

Part I - Introduction to QEF

This part is intended for all QEF users. It introduces the fundamental concepts and most important tools. This part should be sufficient for most users to get started to using QEF.

1:	Welcome to *QEF: introduction, the QEF* components, rational, architecture, and software process.
2:	*QEF* Documentation: accessing the *QEF* documentation.
3:	Getting Started: user set up required to use the *QEF* system.
4:	The *QEF* Tutorials: three tutorials illustrating the major tools and concepts of the *QEF* system, and some miscellaneous notes that might be helpful.
5:	The *QEF* Graphical User Interface: brief introduction to the *QEF* GUI.
6:	Qdsrv: The Directory Server: major tool for navigation through the forest of project trees.
7:	Getting Started, Really: converting simple or straight forward projects to be managed by *QEF*.

Part II - Advanced Topics

The chapters of this part are intended for the user who will be creating qef scripts and configuration files and will be converting projects to use QEF.

8:	Qvrs: The *QEF* Variables System: description of qvrs, the major *QEF* configuration system.
9:	Qsg: The Principal *QEF* Script Generator: describes qsg, the primary *QEF* Script Generator.
10:	The File System Integrity Check (FSIC) System: protecting the health of a software product by ensuring the integrity of the file systems.
11:	Advanced Tools: some of the more useful tools that are not directly associated with software construction.
12:	*QEF* and Large Projects: issues with respect to large projects and *QEF*.

The Appendices

The appendices provide documentation on various aspects of the QEF product, particularly those aspects that need to be readily available or conspicuous. The last four appendices are x_db database entries or lists of such entries, presented here for quick reference and for use within the web site.

A: QEF Installation Instructions: installing and configuring the QEF product.

B: Q-Tree Maintenance Procedures: QEF system maintenance procedures.

C: Using QEF on Microsoft Platforms: special considerations on QEF use on Microsoft systems.

D: Q-Tree Command Summaries: brief description of all the QEF product tools.

E: The QEF Quick Reference Card: user setup, frequently used commands, special facilities.

F: The QEF Specialist's Reference Card: lists of qvrs keywords, variables, and functions, qsg keywords, functions, list operators, and scripts, and qef macros and controls.

G: Index of the X-q* Databases: alphabetic cross referenced listing of the seventeen hundred items in the QEF x_db databases.

Typographical Conventions Used in this Guide

Information Type	Example	Notes
Commands to be entered	% qef Install # cm comments	The "%" sign indicates that this command is to the shell.
Command output	`set ConfigName tut3`	Often following the command.
Meta-variables	`<machine>@<date>`	Some information is abstracted for brevity. Cases where literal '<' or '>' are meant should be self-evident (e.g., C header files) or will be indicated.
Installation directory for the Q-Tree	<qtree>, $QTREE, or <Q>	Typically /usr/qtree or /usr/local/qtree.
File and pathnames in text	/usr/qtree, /etc/passwd
*QEF* utilities	qef, sls	Within a web browser, such as Netscape, these terms are links to the x-qef description of the tool.
Other utilities	make, ls, cd
The User's home directory		Any instance, other than those used in a shell command, will be replaced by the literal directory path.
Line split to fit	output line exceeds possible width.	Sometimes example output lines exceed the width of the page, so lines are split to allow text to fit.
Section Links		Some or all of these images will appear at the right top and bottom corners of the web pages. They are links to the *QEF* home page, the guide's Table of Contents, the previous section, the top and bottom of the current page, and the next section respectively.

c002.qh - 9.5 - 03/10/22