Once the Makefile has been created by running the configure script, several useful Makefile commands are available. A copy of the same Makefile is placed in the doc and src directories, however, the following Makefile commands are useful only in the proper directories. The commands are categorized by where they may be issued, src directory, doc directory, or either directory.
The following Makefile commands may be issed while the src directory is the current directory:
Completely compiles and links VMD . Copies of the proper files must be checked out from the RCS directory, and the source code dependencies must be up to date (see make co and make depend).
Compile a single source code file ( module, with proper filetype extension).
This will install the VMD executables, documentation files, and data files into a particular VMD library directory determined by setting configuration variables in the configure script (see section 3.2). As well, utility programs and scripts necessary to run VMD will be copied into a directory also specified in the configure script. This command should be run after the Makefile has been generated, and VMD has been successfully compiled with the requested options.
This creates a tarred and compressed version of the VMD working directory structure, which is suitable for distribution to other users via FTP. The resulting .tar.Z file is placed in the directory distrib in the VMD working directory. The distribution version contains all files needed to compile and run VMD , as well as the documentation files. This command is not needed by general users, it is used by VMD developers to generate the files which are made available via anonymous FTP.
The following Makefile commands may be issed while the doc directory is the current directory:
Will run Latex on the VMD documentation files, and produce all the guides for VMD . The following documents will be produced:
the VMD
Installation Guide.
the VMD
Programmers Guide.
the VMD
Users Guide.
Will run Latex and create the specified guide document, i.e., the VMD Users Guide if make doc.ug is entered.
This will format all the VMD documentation guides into a single document in book format, with each individual Guide in a separate Part. The resulting file will be called vmd.dvi.
The following Makefile commands may be issued from either the doc or src directory:
Checks out sets of files from the RCS (but does not lock them). The particular files checked out depend on which optional components were specified when the configure script was run and the Makefile created. The first form, make co, checks out copies of all files, and then does a make depend command (see below). The other options check out the following subsets of files:
All .C and .c files, which are
placed in the src directory.
All header ( .h) files, which are
placed in the src directory.
All documentation files, which are
placed in the doc directory. If just a single documentation guide is
to be created, the files required just for the installation, programmers, or
users guides may be checked out with the command co.doc.ig,
co.doc.pg, or co.doc.ug, respectively.
All utility programs and scripts, which are
placed in the bin directory.
All data files, which are
placed in the data directory.
All other special files necessary to
compile VMD
, which are placed in the src directory.
Removes all object files, backup files, and other unnecessary files still remaining after compilation has finished.
The source code file dependencies are generated, when possible, using special compiler flags (on SGI workstations, for example, this is done with the -M flag to the CC compiler). The resulting dependencies are placed in the file Makedata.depend in the src directory, and are included by the Makefile. Dependencies are determined based on the current optional component configuration; if the configuration changes, or new files are introduced, or the list of included files for a source code file changes, the dependencies should be recomputed. This is done automatically when a make co command is issued. Every time the dependencies are updated, a make version command is executed as well.
Installs the VMD executables and data files into the VMD library directory, and copies the startup scripts and utility programs used by VMD into a user-specified directory. These directories are specified by the configurable parameters INSTALLLIBDIR and INSTALLBINDIR in the file configure.parameters.
Copies the documentation guides into a directory doc within the VMD \ library directory, where program executables and data files were previously installed. This is not necessary for VMD to run, but may be useful to users.
Same as typing make install.exe install.doc.
Prints out a list of all RCS-locked files; the username of the person who locked each file is indicated by the ownership of the file.
Creates two files, which contain data used by the compiler and by Latex to determine the values of configurable parameters. These files are:
A C header file which contains
the program name, and current date, as a single string, and the values
for several configurable parameters as set in the file
configure.parameters.
A Latex file which
contains the program name, version, and current date as Latex macros.