# file: Makefile	G. Moody	24 June 1989
#			Last revised:   31 May 2000
# `make' description file for WFDB software documentation
#
# -----------------------------------------------------------------------------
# WFDB applications: programs for working with annotated signals
# Copyright (C) 2000 George B. Moody
#
# These programs are free software; you can redistribute them and/or modify
# them under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
#
# These programs are distributed in the hope that they will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# these programs; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# You may contact the author by e-mail (george@mit.edu) or postal mail
# (MIT Room E25-505A, Cambridge, MA 02139 USA).  For updates to this software,
# please visit PhysioNet (http://www.physionet.org/).
# _____________________________________________________________________________
#
# This file is used with the UNIX `make' command to install on-line
# documentation for the WFDB Software Package, and also to format and print it.
# Before using this file for the first time, check that the site-specific
# variables below are appropriate for your system.

# The primary documentation for the WFDB Software Package consists of 3 guides:
#  * The WFDB Applications Guide.  This guide documents the application
#    programs provided in the app, convert, psd, wave (briefly), and wview
#    subdirectories of wfdb, as well as the file formats supported by the WFDB
#    Software Package. It also includes a tutorial on evaluation of arrhythmia
#    and ischemia detectors using this software and standard databases.
#  * The WFDB Programmer's Guide.  This guide documents the WFDB library.
#    It contains both tutorial and reference material, with many examples, that
#    will be useful if you wish to develop your own application programs for
#    reading, analyzing, or creating digitized, optionally annotated,
#    recordings of signals.
#  * The WAVE User's Guide.  This guide (found in wfdb/wave-doc, not in this
#    directory) includes a comprehensive tutorial, with reference material,
#    for WAVE, an interactive waveform browser with facilities for annotation
#    editing and control of external analysis programs. WAVE runs on PCs under
#    Linux, and on SPARC-based systems under SunOS or Solaris.
# The files in this directory can be used to prepare printed or on-line
# versions of the first two of these guides.

# On-line documentation
# =====================

# To install the man pages (the text of the WFDB Applications Guide) on-line,
# type `make install' (or just `make').  The individual pages will be
# accessible to the UNIX `man' command, and to similar commands such as `xman',
# provided that MANDIR (see below) is in your MANPATH (type `man man' for
# further information).

# If GNU emacs or GNU info has been installed on your system, a hypertext
# version of the WFDB Programmer's Guide may be installed by typing `make
# info'.  Once the info files have been installed, provided that INFODIR is in
# your INFOPATH (see below), you can browse the guide from within emacs by
# typing C-h i to enter the info system, and selecting `WFDB library' from
# the top-level menu.  Note that `make info' adds an entry for the Guide to the
# top-level `info' file ($INFODIR/dir).  If you install a GNU emacs update,
# this entry may disappear; to restore it, simply `make info' again.

# To install both the WFDB Applications Guide and the WFDB Programmer's Guide
# in HTML form, suitable for reading using a World Wide Web browser, type `make
# html'.  In order to do this successfully, you must have installed
# `latex2html' (to translate the appendices of the Applications Guide), and
# `rman' (to translate the man pages in the Applications Guide).  You also need
# `texi2html' (included here, to translate the WFDB Programmer's Guide),
# and Perl (in order to run `latex2html' and `texi2html').  Links to all of
# these are available from http://www.physionet.org, along with the latest
# versions of the files in this directory.

# Printed documentation
# =====================

# Individual man pages or info nodes can be printed using the facilities of
# man and emacs respectively, or (from the HTML versions) using your web
# browser's print facilities.  Complete printed copies of the WFDB
# Applications and Programmer's Guides can be obtained in several ways:
#  - Preformatted versions are provided in ../../html/*.ps.  If you don't have
#    a PostScript printer, you may still be able to use ghostscript to print
#    these versions on your printer (most popular laser, inkjet, and dot
#    matrix printers are supported by ghostscript).
#  - The sources for these manuals are provided in this directory;  you should
#    use these if you have made additions to the manuals or wish to customize
#    them in any other way.  To format the sources, you will need groff or
#    troff, gtbl or tbl, TeX, LaTeX, texi2dvi, and dvips. To format and print
#    the Applications Guide, type `make appguide' (but read `tmac.dif' first,
#    unless you are using groff). To print the Programmer's Guide, type
#    `make guide'.
#  - Finally, if you can't or don't wish to print your own copies, nicely
#    printed and bound copies are available from MIT (see `../../../ORDER.4M').
# Sources for ghostscript, groff, gtbl, TeX, LaTeX, texi2dvi, and dvips are
# all freely available (see `../SOURCES').
# _____________________________________________________________________________
