Skip to content

GitLab

Commit 7e400414 authored by Andreas Marek's avatar Andreas Marek
Browse files

More man pages

parent a092b731
Hide whitespace changes
Inline Side-by-side
Makefile.am
View file @ 7e400414
......@@ -464,6 +464,10 @@ dist_man_MANS = \
man/elpa_deallocate.3 \
man/elpa_load_settings.3 \
man/elpa_store_settings.3 \
man/elpa_print_settings.3 \
man/elpa_autotune_save_state.3 \
man/elpa_autotune_load_state.3 \
man/elpa_autotune_print_state.3 \
man/elpa_uninit.3
if ENABLE_LEGACY
......
man/elpa_autotune_load_state.3 0 → 100644
View file @ 7e400414
.TH "elpa_autotune_load_state" 3 "Tue Nov 13 2018" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_autotune_load_state \- loadsa state of an ELPA autotuning object
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
class(elpa_autotune_t), pointer :: autotune
.br
.RI "call elpa%\fBautotune_load_state\fP (autotune, filename, error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "class(elpa_t) \fBelpa\f: an instance of the ELPA object"
.br
.RI "class(elpa_autotune_t) \fBautotune\f: an instance of the ELPA autotune object"
.br
.RI "character(*) \fBfilename\fP: The filename to be used for loading the settings"
.br
.RI "integer, optional \fBerror\fP: A error return code"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
elpa_autotune_t autotune_handle;
.br
.RI "void \fBelpa_autotune_load_state\fP(\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle, \fBconst char\fP *filename, \fBint\fP *error):
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "elpa_t \fBhandle\fP: The handle to the ELPA object"
.br
.TP
.RI "elpa_autotune_t \fBhandle\fP: The handle to the ELPA autotune object"
.br
.TP
.RI "const char \fB*filename\fP: the filename to load the settings"
.br
.RI "int \fB*error\fP: the error return code"
.TP
.SH DESCRIPTION
Loads a previously stored state of an autotune object. With the loaded state the autotunig could be resumed
.SH "SEE ALSO"
.br
\fBelpa_autotune_save_state\fP(3)
man/elpa_autotune_print_state.3 0 → 100644
View file @ 7e400414
.TH "elpa_autotune_print_state" 3 "Tue Nov 13 2018" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_autotune_print_state \- prints the current state of an ELPA autotuning object
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
class(elpa_autotune_t), pointer :: autotune
.br
.RI "call elpa%\fBautotune_print_state\fP (autotune, error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "class(elpa_t) \fBelpa\f: an instance of the ELPA object"
.br
.RI "class(elpa_autotune_t) \fBautotune\f: an instance of the ELPA autotune object"
.br
.RI "integer, optional \fBerror\fP: A error return code"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
elpa_autotune_t autotune_handle;
.br
.RI "void \fBelpa_autotune_print_state\fP(\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle, \fBint\fP *error):
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "elpa_t \fBhandle\fP: The handle to the ELPA object"
.br
.TP
.RI "elpa_autotune_t \fBhandle\fP: The handle to the ELPA autotune object"
.br
.RI "int \fB*error\fP: the error return code"
.TP
.SH DESCRIPTION
Prints the current state of an autotune object.
.SH "SEE ALSO"
.br
\fBelpa_autotune_save_state\fP(3) \fBelpa_autotune_load_state\fP(3)
man/elpa_autotune_save_state.3 0 → 100644
View file @ 7e400414
.TH "elpa_autotune_save_state" 3 "Tue Nov 13 2018" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_autotune_save_state \- saves the current state of an ELPA autotuning object
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
class(elpa_autotune_t), pointer :: autotune
.br
.RI "call elpa%\fBautotune_save_state\fP (autotune, filename, error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "class(elpa_t) \fBelpa\f: an instance of the ELPA object"
.br
.RI "class(elpa_autotune_t) \fBautotune\f: an instance of the ELPA autotune object"
.br
.RI "character(*) \fBfilename\fP: The filename to be used for storing the settings"
.br
.RI "integer, optional \fBerror\fP: A error return code"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
elpa_autotune_t autotune_handle;
.br
.RI "void \fBelpa_autotune_save_state\fP(\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle, \fBconst char\fP *filename, \fBint\fP *error):
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "elpa_t \fBhandle\fP: The handle to the ELPA object"
.br
.TP
.RI "elpa_autotune_t \fBhandle\fP: The handle to the ELPA autotune object"
.br
.TP
.RI "const char \fB*filename\fP: the filename to store the settings"
.br
.RI "int \fB*error\fP: the error return code"
.TP
.SH DESCRIPTION
Saves the current state of an autotune object. The state can be restored with \fBelpa_autotune_load_state\fP.3 and the autoutuning could be resumed.
.SH "SEE ALSO"
.br
\fBelpa_autotune_load_state\fP(3)
man/elpa_print_settings.3 0 → 100644
View file @ 7e400414
.TH "elpa_print_settings" 3 "Tue Nov 13 2018" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_print_settings \- prints the setting of an elpa object
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "call elpa%\fBprint_settings\fP (error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "class(elpa_t) \fBelpa\f: returns an instance of the ELPA object"
.br
.RI "integer, optinal \fBerror\fP: A error return code"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "void \fBelpa_print_settings\fP(\fBelpa_t\fP handle, \fBint\fP *error):
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "elpa_t \fBhandle\fP: The handle to the ELPA object"
.br
.RI "int \fB*error\fP: the error return code"
.TP
.SH DESCRIPTION
Prints all the settings of an ELPA object. The settings can be stored, or loaded with \fBelpa_store_settings\fP.3 or \fBelpa_load_settings\fP.3
.SH "SEE ALSO"
.br
\fBelpa_store_setting\fP(3) \fBelpa_load_settings\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