The short version is to take the standalone/fman.f90 file, compile it and you have a CLI (Command Line Interface) to descriptions of the Fortran intrinsics; with instructions available via "fman --help".

The descriptions can be previewed as HTML

If you want man-pages, HTML, or markdown descriptions; a Fortran module you can call with your own programs to display the descriptions, or to integrate the descriptions into fpm(1) as a plugin, read on.

Name

M_intrinsics(7f) - [FORTRAN] intrinsic man-pages

Description

Unlike many parts of the Fortran language, intrinsics can naturally be described in discrete units using man-page-like descriptions.

This is a project to

provide standard Fortran intrinsic markdown descriptions for the fortran-lang.org site
generate a set of man-page and HTML Fortran intrinsic documents
extract demo programs from each document into an fpm(1) package for easy verification
generate a platform-independent Fortran program for displaying the documents

Man-pages and Standalone Source

The man-pages can be used on *nix systems and Cygwin as well as other platforms; providing a convenient CLI (Command Line Interface).

The man-pages are available as archive files:

A single-file version of the CLI program fpm-man(1) is in fman.f90.

builds with gfortran fman.f90
builds with ifort -O1 fman.f90

Project Information

Use and Installation

The man-pages can often be integrated with editors or IDEs. This is a powerful reference when inspecting code that uses unfamiliar procedures and to verify correct usage when creating code in a CLI environment.

The process of installing man-pages can vary. Check your system documentation, but at a minimum if you create the directory $HOME/man/man3 and place the man-pages there and add $HOME/man to your $MANPATH you should be able to use the man-pages. For example:

        for NUM in 3 5 7
	do
	(
           mkdir -p $HOME/man/man${NUM}
           cd $HOME/man/man${NUM}
           tar xvfz $WHERE_YOU_PUT_TARFILE/manpages${NUM}.tgz
	)
	done
        cd ..
        mandb -c .
        export MANPATH=$HOME/man:$MANPATH
        export MANWIDTH=80   # optional, displays manpages in columns 1 to 80
        man -s 3fortran,5fortran,7fortran -k . # list topic line for all Fortran man-pages

Typical installation on a Linux platform as an administrator ( but it varies) :

     # as the administrator
     for NUM in 3 5 7
     do
     (
        cd /usr/share/man/man${NUM}
        tar xvfz /$WHERE_YOU_PUT_TARFILE/manpages${NUM}.tgz
     )
     done
     cd /usr/share/man
     mandb -c .

 then anyone on that platform can enter commands like

     man sinh.3fortran     # specifically show Fortran sinh(3) documentation
     man sinh.3f           # section abbreviations are often supported for this format
     man -k . -s 3fortran  # list all fortran pages
     man -s 3fortran --regex '.*' |col -b # show all Fortran intrinsics

See man(1) (ie. enter "man man") for more information.

Documentation Formats

The documents are maintained as Myst markdown files to be compatible with the fortran-lang.org site.

Using pandoc(1) they are then converted to flat-text files which are

run thru txt2man(1) to create the *roff file as a manpage
and then thru manserver(1) or groff (typically) to create an additional HTML file as collected in
- a simple index of intrinsics and index of statements
- These are collected into a single document using javascript: BOOK_FORTRAN.
- All pages in a single slidy HTML file
- documentation shortcuts
the example programs are extracted into the example/ directory.

Basic VIM Usage

The vim(1) editor will call up a man(1) page for a word if the letter "K" is pressed over the word and the manpage directory is in the searchpath (among other ways, append the man/ pathname to the environment variable MANPATH -see man(1) for more information).

Because there are name collisions with the Fortran procedures and other languages you may want to customize your .vimrc file to use a custom script or command when editing Fortran files. Just as an example, create a little Fortran file called "test.f90" and try:

   vim -c 'set keywordprg=env\ MANPATH=$HOME/man\ man\ -s\ 3fortran\ -a' test.f90

Contributing

Collaborators are welcome. This is a public github repository. Anyone can contribute, and is encouraged to do so. First, create a fork of this site from github. obtain a copy of the repository:

    git clone https://github.com/YOUR_SITE/M_intrinsics.git

Minimal Changes

At a minimum, you can cd(1) into the md/ directory and change the files there. Then push the git repository back to your fork and make a pull request.

If you are not familiar with this method, you can just post your changes on this site as an "Issue".

A moderator can periodically then accept your change and rebuild the distribution files and HTML documents.

The repository is set up as public, so I believe anyone with a github ID can change these files but it is unclear to me exactly how this should work, or whether a branch is required. Looking for more information ...

Using the Make File

You have to have a Fortran compiler, fpm(1) and pandoc(1) installed to use the method used here to convert the markdown files to man-pages, a Fortran utility program, and HTML. For reference

# use pandoc to convert the markdown files to text
scripts/scripts/totxt.sh
# run make(1) to generate all the other files
cd scripts
make
make ship

and check out the HTML page generated in docs/, the manpages in man/man3/ and the demo programs in example

References

The Fortran 2018 Standard as described at https://j3-fortran.org/doc/year/18/18-007r1.pdf
Intrinsic descriptions from Jason Blevins at the Fortran Wiki http://fortranwiki.org
GNU gfortran intrinsic descriptions at https://gcc.gnu.org/onlinedocs/gfortran/Intrinsic-Procedures.html
Myst-Markdown
Kramdown markup
pandoc
txt2man

Footnotes

https://fortran-lang.org/en/learn/intrinsics now includes an earlier version of these documents. They may be changed using the instructions found in the github webpage repository.

Keeping these original documents synced with those may be complicated by the fact that graphics, Unicode and math expressions may be included in the descriptions in the future, so further development there might create documentation difficult to maintain as man-pages that display well with man(1) (as the current translator does not handle the *roff syntax for tables, graphics, and formulas); and those features do not typically display well if at all with the man(1) command.

This page allows you to generate the CLI (Command Line Interface) command fpm-man (which is often renamed to fman(1)) that allows the fpm command to display the documents with "fpm man TOPIC" and provides an archive file with the intrinsic manpages on *nix machines (ie. on machines with the man(1) command) so it will continue to be maintained, but the differences between these and the on-line fortran-lang.org pages may become more extensive as time goes on.

Todo

Additional descriptions of procedures from the standard modules

Descriptions of most statements (READ, WRITE, EXIT, ...) in addition to the intrinsics.

Add

RANDOM_INIT
COSHAPE
FAILED_IMAGES
GET_TEAM
IMAGE_STATUS
LCOBOUND
STOPPED_IMAGES
TEAM_NUMBER
UCOBOUND

urbanjost/M_intrinsics