From 0ff8930c666fb1c698665265226fdd1c5dff43de Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Thu, 12 Mar 2009 16:05:51 +0000 Subject: [PATCH] Add some additional explanations of what the configure options are for, and add a note about the --with-esmtp option. This commit was SVN r20764. --- README | 48 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/README b/README index 0eb466772a..2fe38171df 100644 --- a/README +++ b/README @@ -524,16 +524,22 @@ for a full list); a summary of the more commonly used ones follows: Elan headers and libraries are not in default compiler/linker search paths. + Elan is the support library for Quadrics-based networks. + --with-elan-libdir= - Look in directory for the Elan libraries. By default, Open MPI will - look in /lib and /lib64, which covers - most cases. This option is only needed for special configurations. + Look in directory for the Quadrics Elan libraries. By default, Open + MPI will look in /lib and /lib64, + which covers most cases. This option is only needed for special + configurations. --with-gm= Specify the directory where the GM libraries and header files are located. This option is generally only necessary if the GM headers and libraries are not in default compiler/linker search paths. + GM is the support library for older Myrinet-based networks (GM has + been obsoleted by MX). + --with-gm-libdir= Look in directory for the GM libraries. By default, Open MPI will look in /lib and /lib64, which covers @@ -544,6 +550,8 @@ for a full list); a summary of the more commonly used ones follows: located. This option is generally only necessary if the MX headers and libraries are not in default compiler/linker search paths. + MX is the support library for Myrinet-based networks. + --with-mx-libdir= Look in directory for the MX libraries. By default, Open MPI will look in /lib and /lib64, which covers @@ -555,6 +563,8 @@ for a full list); a summary of the more commonly used ones follows: generally only necessary if the OpenFabrics headers and libraries are not in default compiler/linker search paths. + "OpenFabrics" refers to iWARP- and InifiniBand-based networks. + --with-openib-libdir= Look in directory for the OpenFabrics libraries. By default, Open MPI will look in /lib and Configuration to use for Portals support. The following values are possible: "utcp", "xt3", "xt3-modex" (default: utcp). @@ -580,6 +594,8 @@ for a full list); a summary of the more commonly used ones follows: if the InfiniPath headers and libraries are not in default compiler/linker search paths. + PSM is the support library for QLogic InfiniPath network adapters. + --with-psm-libdir= Look in directory for the PSM libraries. By default, Open MPI will look in /lib and /lib64, which covers @@ -590,6 +606,8 @@ for a full list); a summary of the more commonly used ones follows: located. This option is generally only necessary if the SCTP headers and libraries are not in default compiler/linker search paths. + SCTP is a special network stack over ethernet networks. + --with-sctp-libdir= Look in directory for the SCTP libraries. By default, Open MPI will look in /lib and /lib64, which covers @@ -603,6 +621,11 @@ for a full list); a summary of the more commonly used ones follows: UDAPL headers and libraries are not in default compiler/linker search paths. + UDAPL is the support library for high performance networks in Sun + HPC ClusterTools and on Linux OpenFabrics networks (although the + "openib" options are preferred for Linux OpenFabrics networks, not + UDAPL). + --with-udapl-libdir= Look in directory for the UDAPL libraries. By default, Open MPI will look in /lib and /lib64, @@ -614,6 +637,9 @@ for a full list); a summary of the more commonly used ones follows: located. This option is generally only necessary if the LSF headers and libraries are not in default compiler/linker search paths. + LSF is a resource manager system, frequently used as a batch + scheduler in HPC systems. + --with-lsf-libdir= Look in directory for the LSF libraries. By default, Open MPI will look in /lib and /lib64, which covers @@ -624,11 +650,27 @@ for a full list); a summary of the more commonly used ones follows: located. This option is generally only necessary if the TM headers and libraries are not in default compiler/linker search paths. + TM is the support library for the Torque and PBS Pro resource + manager systems, both of which are frequently used as a batch + scheduler in HPC systems. + --with-sge Specify to build support for the Sun Grid Engine (SGE) resource manager. SGE support is disabled by default; this option must be specified to build OMPI's SGE support. + The Sun Grid Engine (SGE) is a resource manager system, frequently + used as a batch scheduler in HPC systems. + +--with-esmtp= + + Specify the directory where the libESMTP libraries and header files are + located. This option is generally only necessary of the libESMTP + headers and libraries are not included in the default + compiler/linker search paths. + + libESMTP is a support library for sending e-mail. + --with-mpi-param_check(=value) "value" can be one of: always, never, runtime. If --with-mpi-param is not specified, "runtime" is the default. If --with-mpi-param