[open-coarrays] 13/80: Add manpages

[Alastair McKinstry]

This is an automated email from the git hooks/post-receive script.

mckinstry pushed a commit to branch debian/master
in repository open-coarrays.

commit e29707f077936ec812dcb4a064bd0946ac20da08
Author: Alastair McKinstry <mckinstry at debian.org>
Date:   Fri Jun 3 14:16:32 2016 +0100

    Add manpages
---
 debian/manpages/caf.1             | 63 +++++++++++++++++++++++++++++++++++++++
 debian/manpages/cafrun.1          | 34 +++++++++++++++++++++
 debian/open-coarrays-bin.manpages |  1 +
 3 files changed, 98 insertions(+)

diff --git a/debian/manpages/caf.1 b/debian/manpages/caf.1
new file mode 100644
index 0000000..5f03900
--- /dev/null
+++ b/debian/manpages/caf.1
@@ -0,0 +1,63 @@
+.TH caf 1 OpenCoArrays
+
+.SH NAME
+caf - Fortran compiler wrapper for OpenCoarrays
+
+.SH SYNOPSIS
+caf <fortran-source-file> [options] ...
+
+.SH OPTIONS
+.TP
+\fB--help, -h\fR
+Show this help message
+\fB--version, -v, -V\fR
+Report version and copyright information
+\fB--wrapping, -w, --wraps\fR
+Report the name of the wrapped compiler
+
+
+.SH EXAMPLES
+   caf foo.f90 -o foo
+   caf -v
+   caf --help
+
+.SH DESCRIPTION
+
+As of OpenCoarrays 1.6.0, caf supports three categories of compilers
+with the following restrictions for each use case:
+
+ 1. With an OpenCoarrays-Aware (OCA) compiler (GNU 5.1.0 or later),
+   a. If any of the options listed above appear, any remaining arguments are ignored.
+   b. If present, <fortran-source-file> must
+      * be a Fortran source file,
+      * appear before all other arguments,
+      * be the only Fortran source file in the argument list,
+      * have a name of the form *.f90, *.F90, *.f, or *.F.
+   c. The environment variable 'CAFC' must be empty or point to a Fortran compiler/linker.
+   d. If 'CAFC' is empty, a default value of 'mpif90' is used.
+
+ 2. With non-OCA CAF compilers (Intel or Cray),
+   a. Observe restrictions 1a-d above.
+   b. Access OpenCoarrays collective subroutines via use association with an only clause,
+      e.g., 'use opencoarrays, only : co_sum,co_broadcast'
+
+ 3. With non-CAF compilers (all compilers not named above),
+   a. Observe restrictions 1a-d above.
+   b. Access OpenCoarrays capabilities via use association ('use opencoarrays').
+   c. The only CAF statements or expressions allowed are the following:
+      * 'num_images()'
+      * 'this_image()' with or without arguments
+      * 'sync all' with or without arguments.
+      * 'sync images' with or without arguments.
+      * 'error stop' without arguments.
+      * 'co_sum', 'co_broadcast', 'co_max', 'co_min', or 'co_reduce'
+
+ The caf wrapper will append -L, -l, and other required arguments as necessary
+ using values that get set during the OpenCoarrays build and installation.
+
+.SH SEE ALSO
+cafrun(1)
+
+.SH AUTHOR
+caf is part of the OpenCoarrays package from Sourcery, Inc.
+This manual page was written by Alastair McKinstry
diff --git a/debian/manpages/cafrun.1 b/debian/manpages/cafrun.1
new file mode 100644
index 0000000..f16a372
--- /dev/null
+++ b/debian/manpages/cafrun.1
@@ -0,0 +1,34 @@
+.TH cafrun 1 OpenCoArrays
+
+.SH NAME
+cafrun - Coarray Fortran executable launcher for OpenCoarrays
+
+.SH SYNOPSIS
+cafrun [options] ...
+
+
+.SH OPTIONS
+\fB--help, -h\fR
+Show this help message
+\fB--version, -v, -V\fR
+Report version and copyright information
+\fB--wrapping, -w, --wraps\fR
+Report the name of the wrapped compiler
+
+.SH EXAMPLES
+   cafrun -np 2 foo
+   cafrun -v
+   cafrun --help
+
+.SH NOTES
+
+[options] must a CAF executable file, one of the above arguments,
+   or an argument to the program name returned by caf --wraps
+
+.SH SEE ALSO
+caf(1)
+
+.SH AUTHOR
+caf is part of the OpenCoarrays package from Sourcery, Inc.
+This manual page was written by Alastair McKinstry
+
diff --git a/debian/open-coarrays-bin.manpages b/debian/open-coarrays-bin.manpages
new file mode 100644
index 0000000..2fb19fb
--- /dev/null
+++ b/debian/open-coarrays-bin.manpages
@@ -0,0 +1 @@
+debian/manpages/*

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/open-coarrays.git