The MPICH implementation comes with several kinds of documentation. Installers are encouraged to provide site-specific information, such as the location of the installation (particularly if it is not in /usr/local/mpich-1.2.1).
A complete set of Unix man pages for the MPICH implementation are in mpich/man. man/man1 contains the commands for compiling and linking MPI programs; man/man3 contains the MPI routines; man/man4 contains the MPE routines and mpirun, and man/man5 contains the MPID routines (these are for the low-level part of the MPICH implementation, are are not of interest to users). The command mpich/bin/mpiman is a script that runs xman on these man pages.
Web (HTML) versions are available from ftp://ftp/.mcs.anl.gov/pub/mpi/manwww.tar.Z. They are available at http://www.mcs.anl.gov/mpi/www. A sample Web page is shown below.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN"> <HTML> <HEAD> <TITLE>Using MPICH</TITLE> </HEAD> <BODY BGCOLOR="FFFFFF"> <H1>Site-specific information on the MPICH implementation of MPI</H1> <H2>Location of libraries and programs</H2> The MPICH implementation is located in <TT>/home/MPI/releases/current</TT>; the architecture-specific files are in the directories show below. Each of these directories has a lib directory for libraries and a bin directory for programs. <CENTER> <TABLE> <TR><TH><B>System</B><TH><B>Location</B><TH><B>Notes</B></TR> <TR><TD VALIGN=TOP>Sun4 SunOS<TD>sun4/ch_p4<BR> sun4/ch_shmem</TR> <TR><TD VALIGN=TOP>Solaris<TD>solaris/ch_p4<BR> solaris/ch_p4smp<BR> solaris/ch_shmem<TD>ch_p4smp is for p4 -comm=shared</TR> <TR><TD VALIGN=TOP>IBM SP<TD>rs6000/ch_mpl</TR> <TR><TD VALIGN=TOP>IBM RS6000<TD>rs6000/ch_p4<BR> rs6000/ch_shmem</TR> <TR><TD VALIGN=TOP>SGI IRIX<TD>IRIXN32/ch_p4<BR> IRIXN32/ch_shmem</TR> <TR><TD VALIGN=TOP>SGI IRIX (64bit)<TD>IRIX64/ch_p4<BR> IRIX64/ch_shmem</TR> <TR><TD VALIGN=TOP>LINUX<TD>LINUX/ch_p4<BR> LINUX/ch_shmem</TR> </TABLE> </CENTER> <H2>Documentation</H2> The command <TT>bin/mpiman</TT> in the respective directories (e.g., <TT>/home/MPI/releases/current/solaris/ch_p4/bin</TT>) provides man pages with xman. The <A HREF="http://www.mcs.anl.gov/mpi/www/index.html">man pages</A> are also available. <H2>Examples</H2> A simple example in C and Fortran is in <TT>/home/MPI/releases/current/examples</TT>. More examples may be found in the MPICH source tree, located at <TT>/home/MPI/mpich/examples</TT>. </BODY> </HTML>
Users often prefer working from example Makefiles and programs. The directory that is installed in the examples directory contains a C and Fortran version of the `pi' program, along with a Makefile.in. Other examples there include a simple parallel I/O program and an MPI program written using the C++ bindings for the MPI functions. Users may be interested in some of the examples that are in the source tree, also in the examples directory.