Commit 62b11465 authored by Andreas Marek's avatar Andreas Marek

Man page for elpa_allocate

parent b1297e23
......@@ -361,7 +361,8 @@ nobase_nodist_elpa_include_HEADERS = \
dist_man_MANS = \
man/elpa2_print_kernels.1 \
man/elpa_init.3
man/elpa_init.3 \
man/elpa_allocate.3
if ENABLE_LEGACY
dist_man_MANS += \
......
.TH "elpa_allocate" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_allocate \- allocate an instance of the ELPA library
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "elpa => \fBelpa_allocate\fP ()"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.br
.RI "class(elpa_t) \fBelpa\fP: returns an instance of the ELPA object"
.br
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "\fBelpa_t\fP handle = \fBelpa_allocate\fP ();"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.br
.br
.RI "elpa_t \fBhandle\fP: returns an handle to the allocated ELPA object"
.SH DESCRIPTION
Allocate an ELPA object. The function \fBelpa_init\fP(3) must be called once BEFORE \fBelpa_allocate\fP can be called.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fPelpa_init\fP(3)
......@@ -50,4 +50,4 @@ with the \fBelpa_strerr\fP(3) function.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1)
\fBelpa2_print_kernels\fP(1) \fBelpa_allocate\fP(3)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment