Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
urbanjost committed Jul 21, 2023
1 parent 320f0d9 commit 30a9173
Show file tree
Hide file tree
Showing 121 changed files with 10,139 additions and 75 deletions.
57 changes: 35 additions & 22 deletions docs/BOOK_M_readline.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta name="generator" content="vi(1)/vim(1)" />
<meta name="description" content="@(#)M_readline::BOOK_M_readline: BOOK composed of pages for man(1) topic M_readline"/>
<meta name="author" content="urbanjs" />
<meta name="date" content="2022-01-09" />
<meta name="date" content="2023-07-20" />
<meta name="keywords" content="Fortran, Fortran code, source code repository, Fortran library, Fortran archive, source code" />
<!--
Pick your favorite style sheet from among the eight offerings:
Expand Down Expand Up @@ -59,8 +59,12 @@
border-color: blue;
}
/* ======================================================== */
summary{
background-color: white;
}
/* ======================================================== */
body{
background-color: black;
background-color: gray40;
margin-top: 1.58em;
margin-left: 8%;
margin-right: 4%;
Expand Down Expand Up @@ -108,7 +112,7 @@
pre { background-color:#DDD; font-size:100%; overflow:auto; padding:1em; }
a,li span { color:#000; }
a:hover, a.nav:hover, a:hover math { background-color:#000; color:#FFF; }
#Container { margin:0 10px; text-align:center; background-color: black}
#Container { margin:0 10px; text-align:center; background-color: gray50}
#Content { border-top:none; margin:auto; padding:0.3em; text-align:left; width:100%; max-width:55em; background:#FFF}
span.webName { font-size:.5em; }
textarea#content { font-size: 1em; line-height: 1.125; }
Expand Down Expand Up @@ -178,7 +182,14 @@
return '' ;
}
</script>

<style>
/* ======================================================== */
/* Start new page on printing */
BR.newpage{
page-break-before:always
}
/* ======================================================== */
</style>
<!--
-->

Expand Down Expand Up @@ -267,6 +278,25 @@
<body onload="set_style_from_cookie()">
<a name="TOP">&nbsp;</a>

<details>
<summary>shortcuts:</summary>
<script language="JavaScript1.1" type="text/javascript">
document.write('<center><table border="4" >\n');
document.write('<tbody>\n');
loadthem();
if (COLUMNS != 5 ){
document.write('</tr>\n');
}
document.write('</tbody>\n');
document.write('</table></center>\n');
document.write('<hr\n>');
document.write('</details>');
FIRSTPASS=1;
FRAMECOUNT=0;
loadthem();
</script>
</div>
</body>
<div>
<form>
Themes:
Expand All @@ -285,21 +315,4 @@
<input type="submit" onclick="switch_style('Ultramarine');return false;" name="theme" value="Ultramarine" id="Ultramarine">
</form>
</div>
<hr>
<h3>SHORTCUTS:</h3>
<script language="JavaScript1.1" type="text/javascript">
document.write('<center><table border="4" >\n');
document.write('<tbody>\n');
loadthem();
if (COLUMNS != 5 ){
document.write('</tr>\n');
}
document.write('</tbody>\n');
document.write('</table></center>\n');
document.write('<hr\n>');
FIRSTPASS=1;
FRAMECOUNT=0;
loadthem();
</script>
</div>
</body>
</html>
29 changes: 15 additions & 14 deletions docs/M_readline.3m_readline.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<head>
<title> </title>
<style>
px {font-family: "Lucida Console", Monaco }
px {font-family: "Lucida Console", Monaco, monospace }
p { font-size:100%; line-height:1.1em; }
body {xfont-style: sans-serif}
body {
Expand Down Expand Up @@ -41,7 +41,10 @@
</style>
</head>
<BODY bgcolor=#F0F0F0 text=#000000 link=#0000ff vlink=#C000C0 alink=#ff0000><A NAME=top></A>
<!--
<h5><a href="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/urbanjost/M_readline">[UP]</a></h5>
<button type="button" onclick="javascript:history.back()">Back</button>
-->
<div id="Container">
<div id="Content">
<CENTER>
Expand All @@ -53,9 +56,9 @@ <H3>NAME</H3>

</A>
<BLOCKQUOTE>
<B>M_readline(3fm) </B>- [M_readline::INTRO] Calling <B>readline</B>(3c) from Fortran
<B>(LICENSE:PD)
</B></BLOCKQUOTE>
M_readline(3fm) - [M_readline::INTRO] Calling readline(3c) from Fortran
(LICENSE:PD)
</BLOCKQUOTE>
<A name=contents></A><H3>CONTENTS</H3></A>
<BLOCKQUOTE>
<A HREF=#1>Synopsis</A><BR>
Expand All @@ -70,9 +73,7 @@ <H3>SYNOPSIS</H3>

</A>
<BLOCKQUOTE>
<PRE>
<B>Use</B> M_readline, <I>only</I> : <I>system_readline</I>
</PRE>
Use M_readline, only : system_readline
</BLOCKQUOTE>
<A name=2>

Expand All @@ -81,8 +82,8 @@ <H3>DESCRIPTION</H3>
</A>
<BLOCKQUOTE>
<P>
The <B>M_readline</B>(3fm) module uses the ISO_C_BINDING module to create a
binding to the GNU <B>readline</B>(3c) procedure from Fortran programs.
The M_readline(3fm) module uses the ISO_C_BINDING module to create a
binding to the GNU readline(3c) procedure from Fortran programs.
</BLOCKQUOTE>
<A name=3>

Expand All @@ -92,13 +93,13 @@ <H3>EXAMPLE</H3>
<BLOCKQUOTE>
<P>
The test program is basically just a read loop that prompts for
lines of input read with <B>readline</B>(3c). You can edit the line being
read with <B>readline</B>(3c) per its documentation. At a minimum, you can
lines of input read with readline(3c). You can edit the line being
read with readline(3c) per its documentation. At a minimum, you can
probably move around the line with the left and right arrow keys, and
insert characters by typing them wherever you moved the cursor to,
and use the DEL/ RUBOUT key to delete characters and such. If you use
a GNU/Linux shell with command line editing, you are probably familiar
with <B>readline</B>(3c)&#146;s function.
with readline(3c)&#146;s function.
<P>
It quits if you enter &#146;q&#146; on an input line, and it dumps the history if
you enter &#146;h&#146;.
Expand Down Expand Up @@ -148,12 +149,12 @@ <H3>LICENSE</H3>
<BLOCKQUOTE>
Public Domain
<P>
Although this interface to <B>readline</B>(3c) is released as Public Domain,
Although this interface to readline(3c) is released as Public Domain,
note that the Readline library itself is free software, distributed
under the terms of the [GNU] General Public License, version 2.
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>M_readline (3m_readline)</TD> <TD align=right width=33%><I>January 09, 2022</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="https://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 0bbf9072-32b7-44a2-9e78-2437d635bffe using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>M_readline (3m_readline)</TD> <TD align=right width=33%><I>July 20, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="https://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 171681d9-5409-4b74-86d3-494c8688070f using man macros.</FONT>
<br><br><center><img src="images/M_readline.gif"></center>
</div>
</div>
Expand Down
187 changes: 187 additions & 0 deletions docs/doxygen_out/html/C-M__readline_8c.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>M_readline: /home/urbanjs/venus/V600/github/CWRAP/M_readline/src/C-M_readline.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">M_readline
</div>
<div id="projectbrief">M_readline module (Fortran)</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f9db88818e6eb5092c58be7c97f33b4a.html">venus</a></li><li class="navelem"><a class="el" href="dir_4ed9484895f5e4135f49e30622ffa97d.html">V600</a></li><li class="navelem"><a class="el" href="dir_54b2efe27ac8fcacd29ecec6b05fbce3.html">github</a></li><li class="navelem"><a class="el" href="dir_b3671edec5395f099e06299993d758c2.html">CWRAP</a></li><li class="navelem"><a class="el" href="dir_bfa95b88300b0b2e1e1fb32841ac0d4a.html">M_readline</a></li><li class="navelem"><a class="el" href="dir_5a55476daf93c2c27f68238d10ca4275.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">C-M_readline.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;unistd.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;readline/readline.h&gt;</code><br />
<code>#include &lt;readline/history.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for C-M_readline.c:</div>
<div class="dyncontent">
<div class="center"><img src="C-M__readline_8c__incl.png" border="0" usemap="#_2home_2urbanjs_2venus_2V600_2github_2CWRAP_2M__readline_2src_2C-M__readline_8c" alt=""/></div>
<map name="_2home_2urbanjs_2venus_2V600_2github_2CWRAP_2M__readline_2src_2C-M__readline_8c" id="_2home_2urbanjs_2venus_2V600_2github_2CWRAP_2M__readline_2src_2C-M__readline_8c">
<area shape="rect" title=" " alt="" coords="176,5,383,61"/>
<area shape="rect" title=" " alt="" coords="5,109,76,136"/>
<area shape="rect" title=" " alt="" coords="101,109,175,136"/>
<area shape="rect" title=" " alt="" coords="199,109,266,136"/>
<area shape="rect" title=" " alt="" coords="291,109,361,136"/>
<area shape="rect" title=" " alt="" coords="386,109,530,136"/>
<area shape="rect" title=" " alt="" coords="555,109,689,136"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a80269900528c2ee04bf7cacb3a07ff40"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="C-M__readline_8c.html#a80269900528c2ee04bf7cacb3a07ff40">show_history_list</a> ()</td></tr>
<tr class="separator:a80269900528c2ee04bf7cacb3a07ff40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a146edc06a54e833494378446131c6bcd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="C-M__readline_8c.html#a146edc06a54e833494378446131c6bcd">FCreadline</a> (int len, char *myline, char prompt[])</td></tr>
<tr class="separator:a146edc06a54e833494378446131c6bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a146edc06a54e833494378446131c6bcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a146edc06a54e833494378446131c6bcd">&#9670;&nbsp;</a></span>FCreadline()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FCreadline </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>myline</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>prompt</em>[]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p class="reference">References <a class="el" href="C-M__readline_8c.html#a80269900528c2ee04bf7cacb3a07ff40">show_history_list()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="C-M__readline_8c_a146edc06a54e833494378446131c6bcd_cgraph.png" border="0" usemap="#C-M__readline_8c_a146edc06a54e833494378446131c6bcd_cgraph" alt=""/></div>
<map name="C-M__readline_8c_a146edc06a54e833494378446131c6bcd_cgraph" id="C-M__readline_8c_a146edc06a54e833494378446131c6bcd_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,97,32"/>
<area shape="rect" href="C-M__readline_8c.html#a80269900528c2ee04bf7cacb3a07ff40" title=" " alt="" coords="145,5,280,32"/>
</map>
</div>

</div>
</div>
<a id="a80269900528c2ee04bf7cacb3a07ff40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80269900528c2ee04bf7cacb3a07ff40">&#9670;&nbsp;</a></span>show_history_list()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void show_history_list </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="C-M__readline_8c_a80269900528c2ee04bf7cacb3a07ff40_icgraph.png" border="0" usemap="#C-M__readline_8c_a80269900528c2ee04bf7cacb3a07ff40_icgraph" alt=""/></div>
<map name="C-M__readline_8c_a80269900528c2ee04bf7cacb3a07ff40_icgraph" id="C-M__readline_8c_a80269900528c2ee04bf7cacb3a07ff40_icgraph">
<area shape="rect" title=" " alt="" coords="145,5,280,32"/>
<area shape="rect" href="C-M__readline_8c.html#a146edc06a54e833494378446131c6bcd" title=" " alt="" coords="5,5,97,32"/>
</map>
</div>

</div>
</div>
</div><!-- contents -->
<div class="ttc" id="aC-M__readline_8c_html_a80269900528c2ee04bf7cacb3a07ff40"><div class="ttname"><a href="C-M__readline_8c.html#a80269900528c2ee04bf7cacb3a07ff40">show_history_list</a></div><div class="ttdeci">void show_history_list()</div><div class="ttdef"><b>Definition:</b> C-M_readline.c:14</div></div>
<div class="ttc" id="aC-M__readline_8c_html_a146edc06a54e833494378446131c6bcd"><div class="ttname"><a href="C-M__readline_8c.html#a146edc06a54e833494378446131c6bcd">FCreadline</a></div><div class="ttdeci">void FCreadline(int len, char *myline, char prompt[])</div><div class="ttdef"><b>Definition:</b> C-M_readline.c:23</div></div>
<div class="ttc" id="anamespacem__readline_html"><div class="ttname"><a href="namespacem__readline.html">m_readline</a></div><div class="ttdef"><b>Definition:</b> M_readline.f90:62</div></div>
<div class="ttc" id="anamespacem__readline_html_a6eae368d34bd43ead64623b2d6d10ae0"><div class="ttname"><a href="namespacem__readline.html#a6eae368d34bd43ead64623b2d6d10ae0">m_readline::system_readline</a></div><div class="ttdeci">subroutine, public system_readline(line, prompt)</div><div class="ttdef"><b>Definition:</b> M_readline.f90:155</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="https://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
9 changes: 9 additions & 0 deletions docs/doxygen_out/html/C-M__readline_8c__incl.map
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<map id="/home/urbanjs/venus/V600/github/CWRAP/M_readline/src/C&#45;M_readline.c" name="/home/urbanjs/venus/V600/github/CWRAP/M_readline/src/C&#45;M_readline.c">
<area shape="rect" id="node1" title=" " alt="" coords="176,5,383,61"/>
<area shape="rect" id="node2" title=" " alt="" coords="5,109,76,136"/>
<area shape="rect" id="node3" title=" " alt="" coords="101,109,175,136"/>
<area shape="rect" id="node4" title=" " alt="" coords="199,109,266,136"/>
<area shape="rect" id="node5" title=" " alt="" coords="291,109,361,136"/>
<area shape="rect" id="node6" title=" " alt="" coords="386,109,530,136"/>
<area shape="rect" id="node7" title=" " alt="" coords="555,109,689,136"/>
</map>
1 change: 1 addition & 0 deletions docs/doxygen_out/html/C-M__readline_8c__incl.md5
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
4f5942834454865533ad20c90b3fe1da
Binary file added docs/doxygen_out/html/C-M__readline_8c__incl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<map id="FCreadline" name="FCreadline">
<area shape="rect" id="node1" title=" " alt="" coords="5,5,97,32"/>
<area shape="rect" id="node2" href="$C-M__readline_8c.html#a80269900528c2ee04bf7cacb3a07ff40" title=" " alt="" coords="145,5,280,32"/>
</map>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7d52c52be54a909e893d65d909843f2d
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<map id="show_history_list" name="show_history_list">
<area shape="rect" id="node1" title=" " alt="" coords="145,5,280,32"/>
<area shape="rect" id="node2" href="$C-M__readline_8c.html#a146edc06a54e833494378446131c6bcd" title=" " alt="" coords="5,5,97,32"/>
</map>
Loading

0 comments on commit 30a9173

Please sign in to comment.