Converted 55 files from nroff to markdown

ompi/mpi/man/man3/MPI_Comm_f2c.md

@@ -0,0 +1,63 @@
+# Name
+
+`MPI_Comm_f2c`, `MPI_Comm_c2f`, `MPI_File_f2c`, `MPI_File_c2f`, `MPI_Info_f2c,`
+`MPI_Info_c2f`, `MPI_Message_f2c`, `MPI_Message_c2f`, `MPI_Op_f2c`, `MPI_Op_c2f,`
+`MPI_Request_f2c`, `MPI_Request_c2f`, `MPI_Type_f2c`, `MPI_Type_c2f`,
+`MPI_Win_f2c`, `MPI_Win_c2f`  - Translates a C handle into a Fortran
+handle, or vice versa.
+
+# Syntax
+
+## C Syntax
+
+```c
+#include <mpi.h>
+
+MPI_Comm MPI_Comm_f2c(MPI_Fint comm)
+MPI_Fint MPI_Comm_c2f(MPI_Comm comm)
+
+MPI_File MPI_File_f2c(MPI_Fint file)
+MPI_Fint MPI_File_c2f(MPI_File file)
+
+MPI_Group MPI_Group_f2c(MPI Fint group)
+MPI_Fint MPI_Group_c2f(MPI Group group)
+
+MPI_Info MPI_Info_f2c(MPI_Fint info)
+MPI_Fint MPI_Info_c2f(MPI_Info info)
+
+MPI_Message MPI_Message_f2c(MPI_Fint message)
+MPI_Fint MPI_Message_c2f(MPI_Message message)
+
+MPI_Op MPI_Op_f2c(MPI_Fint op)
+MPI_Fint MPI_Op_c2f(MPI_Op op)
+
+MPI_Request MPI_Request_f2c(MPI_Fint request)
+MPI_Fint MPI_Request_c2f(MPI_Request request)
+
+MPI_Datatype MPI_Type_f2c(MPI_Fint datatype)
+MPI_Fint MPI_Type_c2f(MPI_Datatype datatype)
+
+MPI_Win MPI_Win_f2c(MPI_Fint win)
+MPI_Fint MPI_Win_c2f(MPI_Win win)
+```
+
+# Description
+
+Handles are passed between Fortran and C by using an explicit C wrapper
+to convert Fortran handles to C handles. There is no direct access to C
+handles in Fortran. The type definition `MPI_Fint` is provided in C for
+an integer of the size that matches a Fortran `INTEGER`; usually,
+`MPI_Fint` will be equivalent to `int`. The handle translation functions
+are provided in C to convert from a Fortran handle (which is an integer)
+to a C handle, and vice versa.
+
+For example, if `comm` is a valid Fortran handle to a communicator, then
+`MPI_Comm_f2c` returns a valid C handle to that same communicator; if
+`comm` = `MPI_COMM_NULL` (Fortran value), then `MPI_Comm_f2c` returns a null
+C handle; if `comm` is an invalid Fortran handle, then `MPI_Comm_f2c`
+returns an invalid C handle.
+
+# Note
+
+This function does not return an error value. Consequently, the result
+of calling it before `MPI_Init` or after `MPI_Finalize` is undefined.

ompi/mpi/man/man3/MPI_Comm_free.md

@@ -0,0 +1,75 @@
+# Name
+
+`MPI_Comm_free` - Mark a communicator object for deallocation.
+
+# Syntax
+
+## C Syntax
+
+```c
+#include <mpi.h>
+
+int MPI_Comm_free(MPI_Comm *comm)
+```
+
+## Fortran Syntax
+
+```fortran
+USE MPI
+! or the older form: INCLUDE 'mpif.h'
+
+MPI_COMM_FREE(COMM, IERROR)
+    INTEGER    COMM, IERROR
+```
+
+## Fortran 2008 Syntax
+
+```fortran
+USE mpi_f08
+
+MPI_Comm_free(comm, ierror)
+    TYPE(MPI_Comm), INTENT(INOUT) :: comm
+    INTEGER, OPTIONAL, INTENT(OUT) :: ierror
+```
+
+
+# Input Parameter
+
+* `comm` : Communicator to be destroyed (handle).
+
+# Output Parameter
+
+* `IERROR` : Fortran only: Error status (integer).
+
+# Description
+
+This operation marks the communicator object for deallocation. The
+handle is set to `MPI_COMM_NULL`. Any pending operations that use this
+communicator will complete normally; the object is actually deallocated
+only if there are no other active references to it. This call applies to
+intracommunicators and intercommunicators. Upon actual deallocation, the
+delete callback functions for all cached attributes (see Section 5.7 in
+the MPI-1 Standard, "Caching") are called in arbitrary order.
+
+# Notes
+
+Note that it is not defined by the MPI standard what happens if the
+`delete_fn` callback invokes other MPI functions. In Open MPI, it is not
+valid for `delete_fn` callbacks (or any of their children) to add or
+delete attributes on the same object on which the `delete_fn` callback is
+being invoked.
+
+# Errors
+
+Almost all MPI routines return an error value; C routines as the value
+of the function and Fortran routines in the last argument.
+Before the error value is returned, the current MPI error handler is
+called. By default, this error handler aborts the MPI job, except for
+I/O function errors. The error handler may be changed with
+`MPI_Comm_set_errhandler`; the predefined error handler `MPI_ERRORS_RETURN`
+may be used to cause error values to be returned. Note that MPI does not
+guarantee that an MPI program can continue past an error.
+
+# See Also
+
+[`MPI_Comm_delete_attr(3)`](./?file=MPI_Comm_delete_attr.md)

ompi/mpi/man/man3/MPI_Comm_free_keyval.md

@@ -0,0 +1,74 @@
+# Name
+
+`MPI_Comm_free_keyval` - Frees attribute key for communicator cache
+attribute.
+
+# Syntax
+
+## C Syntax
+
+```c
+#include <mpi.h>
+
+int MPI_Comm_free_keyval(int *comm_keyval)
+```
+
+## Fortran Syntax
+
+```fortran
+USE MPI
+! or the older form: INCLUDE 'mpif.h'
+
+MPI_COMM_FREE_KEYVAL(COMM_KEYVAL, IERROR)
+    INTEGER    COMM_KEYVAL, IERROR
+```
+
+## Fortran 2008 Syntax
+
+```fortran
+USE mpi_f08
+
+MPI_Comm_free_keyval(comm_keyval, ierror)
+    INTEGER, INTENT(INOUT) :: comm_keyval
+    INTEGER, OPTIONAL, INTENT(OUT) :: ierror
+```
+
+
+# Input/Output Parameter
+
+* `comm_keyval`
+
+# Output Parameter
+
+* `IERROR` : Fortran only: Error status (integer).
+
+# Description
+
+`MPI_Comm_free_keyval` frees an extant attribute key. This function sets
+the value of `keyval` to `MPI_KEYVAL_INVALID`. Note that it is not
+erroneous to free an attribute key that is in use, because the actual
+free does not transpire until after all references (in other
+communicators on the process) to the key have been freed. These
+references need to be explicitly freed by the program, either via calls
+to `MPI_Comm_delete_attr` that free one attribute instance, or by calls to
+`MPI_Comm_free` that free all attribute instances associated with the
+freed communicator.
+
+This call is identical to the call `MPI_Keyval_free` but is needed to
+match the communicator-specific creation function introduced in the
+MPI-2 standard. The use of `MPI_Keyval_free` is deprecated.
+
+# Notes
+
+Key values are global (they can be used with any and all communicators).
+
+# Errors
+
+Almost all MPI routines return an error value; C routines as the value
+of the function and Fortran routines in the last argument.
+Before the error value is returned, the current MPI error handler is
+called. By default, this error handler aborts the MPI job, except for
+I/O function errors. The error handler may be changed with
+`MPI_Comm_set_errhandler`; the predefined error handler `MPI_ERRORS_RETURN`
+may be used to cause error values to be returned. Note that MPI does not
+guarantee that an MPI program can continue past an error.