nextuppreviouscontents
Visit our: CCMS Home Page
Send us your comments on this user guide: CCMS Comment Form
Next: Chapter 1 IntroductionUp: Table of ContentsPrevious: Copyright


Preface


This manual assumes that the reader has a basic (graduate) level of understanding of crystallographic methodology and terminology, but is not necessarily familiar with the XView system or the XtalView software package.

Overview


Chapter 1, "Introduction," provides an introduction to XtalView and informationon how to obtain the software and whom to contact for assistance.

Chapter 2, "Getting Started," tells you how to set up your workstation environment.

 Chapter 3, "Using XtalView," gives an overview of the XtalView software,including the crystal database, history files, file formats, and plotting information. It also tells you how to use the XView system, on which XtalView is based.

Chapter 4, "Programming XtalView," gives programmers information for adding other applications to XtalView and using the XtalView database in other programs.

Chapters 5 and 6 contain reference pages for XtalView's window-based and non window-based applications. The information is organized into manual pages and listed in alphabetical order.


Online XtalView Documentation

                    All XtalView documentation is now in the form of HTML pages online at CCMS.  There are also copies in the $XTALVIEWHOME/doc directory that you can install locally for faster access or if you don't have internet access.


Conventions


This manual uses the following conventions.
 
 
Fonts
 
 
computer font
This font is used for commands, file names, windows,variables, etc., that are displayed or typed.
 
 
example
This font is used to show example interactive sessions.
<computer font>
This font, in angle brackets, indicates either akeystroke or mouse button. For example, <Ctrl> indicates the Control key on the keyboard and <Select> indicates the Select (left) mouse button(see "Mouse Buttons," below).
 
 
Mouse Buttons
 
 
The mouse buttons are indicated with angle brackets and computer font. Their functions are discussed below.

 <Adjust>

Middle mouse button.
<Menu>
Right mouse button
 
 
<Select>
Left mouse button
 
 
Terminology and Notation
Pop-up
Anything that "pops up" onto the screen when you click on an option with the mouse button. This can be a window, dialog box, menu, or list of options.
windowname.option
Options within windows or menus are sometimes referencedwith this notation. For example, insert.pentamer.best_fit_pentamer means thebest_fit_pentamer opt ion within the pentamer option within the the insert menu. The plot command in the Files window is written as Files.plot.
$XTALVIEWHOME
This is an environment variable that refers to the directoryin which XtalView was installed. It is set in the XtalView.env file. (Seechapter 2, "Setting up your Environment.")
 
 



nextuppreviouscontents
Visit our: CCMS Home Page
Send us your comments on this user guide: CCMS Comment Form
Next: Chapter 1 IntroductionUp: Table of ContentsPrevious: Copyright