Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@urbanjost
urbanjost committed Feb 11, 2023
1 parent 2d3a1bb commit d75d4a0
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/M_CLI2.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ <H3>SEE ALSO</H3>
dget(3f), iget(3f), lget(3f), rget(3f), sget(3f), cget(3f) dgets(3f),
igets(3f), lgets(3f), rgets(3f), sgets(3f), cgets(3f)
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>M_CLI2 (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 5107b51e-b291-45d2-8e1f-efef0bf396dc using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>M_CLI2 (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 2fca3bf4-1d20-4acb-b6d2-e218413bd8bf using man macros.</FONT>
<br><br><center><img src="images/M_CLI2.gif"></center>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen_out/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
Introduction</h1>
<p>command line parsing using a command prototype</p>
<div class="image">
<img src="html/images/swirl.gif" alt=""/>
<img src="html/images/M_CLI2.gif" alt=""/>
</div>
</div></div><!-- PageDoc -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/get_args.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_args (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from d07111ae-831f-459b-83a7-5c104f50ca86 using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_args (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 50409d9e-8a3e-4e16-add3-1b21c3c34202 using man macros.</FONT>
<br><br><center><img src="images/get_args.gif"></center>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/get_args_fixed_length.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_args_fixed_length (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 111ba17c-b6b7-48e5-bb54-88a85d129320 using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_args_fixed_length (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from f14a0b90-d018-4dce-8b3a-a75c2fdca0c3 using man macros.</FONT>
<br><br><center><img src="images/get_args_fixed_length.gif"></center>
</div>
</div>
Expand Down
12 changes: 3 additions & 9 deletions docs/get_args_fixed_size.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,9 @@ <H3>DESCRIPTION</H3>
<BLOCKQUOTE>
<P>
get_args_fixed_size(3f) returns the value of keywords for fixed-size
<TABLE cellpadding=3><!-- tsb: get_args_fixed_size(3f) returns the value of keywords for fixed-size
-->
<TR></TR><TR></TR>
<TR valign=top><TD colspan=2>
<B>arrays after set_args(3f) has been called.</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
On input on the command
arrays after set_args(3f) has been called. On input on the command
line all values of the array must be specified.
</TD></TR>
<TR></TR></TABLE></BLOCKQUOTE>
</BLOCKQUOTE>
<A name=3>

<H3>OPTIONS</H3>
Expand Down Expand Up @@ -197,7 +191,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_args_fixed_size (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 44c85df4-b29d-4ed0-93b5-fad255d763f0 using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_args_fixed_size (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 0726aa4e-2fc1-4439-9593-851eb9b97be8 using man macros.</FONT>
<br><br><center><img src="images/get_args_fixed_size.gif"></center>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/get_subcommand.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_subcommand (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from b5e31321-d050-4453-b351-c04d6283652d using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>get_subcommand (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from e848d8e7-c008-4eef-904c-048f41ac7171 using man macros.</FONT>
<br><br><center><img src="images/get_subcommand.gif"></center>
</div>
</div>
Expand Down
16 changes: 8 additions & 8 deletions docs/man3.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,14 @@ <h1>M_CLI2 man(3) pages</h1>
</font>
<table border="1">
<tr> <th>grouping</th> <th>page</th> <th>description</th> </tr>
<tr><td style="background:#c8e4f5;">ARGUMENTS::M_CLI2::INTRO</td><td><a href="M_CLI2.3m_cli2.html">M_CLI2</a></td><td> command line argument parsing using a prototype command (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="get_args.3m_cli2.html">get_args</a></td><td> return keyword values when parsing command line arguments (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="get_args_fixed_length.3m_cli2.html">get_args_fixed_length</a></td><td> return keyword values for fixed-length string when parsing command line (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="get_args_fixed_size.3m_cli2.html">get_args_fixed_size</a></td><td> return keyword values for fixed-size array when parsing command line arguments (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="get_subcommand.3m_cli2.html">get_subcommand</a></td><td> special-case routine for handling subcommands on a command line (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="set_args.3m_cli2.html">set_args</a></td><td> command line argument parsing (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="set_mode.3m_cli2.html">set_mode</a></td><td> turn on optional modes (LICENSE:PD)</td></tr>
<tr><td style="background:#cff3ce;">ARGUMENTS:M_CLI2</td><td><a href="specified.3m_cli2.html">specified</a></td><td> return true if keyword was present on command line (LICENSE:PD)</td></tr>
<tr><td style="background:#f7f7f9;">ARGUMENTS::M_CLI2::INTRO</td><td><a href="M_CLI2.3m_cli2.html">M_CLI2</a></td><td> command line argument parsing using a prototype command (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="get_args.3m_cli2.html">get_args</a></td><td> return keyword values when parsing command line arguments (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="get_args_fixed_length.3m_cli2.html">get_args_fixed_length</a></td><td> return keyword values for fixed-length string when parsing command line (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="get_args_fixed_size.3m_cli2.html">get_args_fixed_size</a></td><td> return keyword values for fixed-size array when parsing command line arguments (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="get_subcommand.3m_cli2.html">get_subcommand</a></td><td> special-case routine for handling subcommands on a command line (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="set_args.3m_cli2.html">set_args</a></td><td> command line argument parsing (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="set_mode.3m_cli2.html">set_mode</a></td><td> turn on optional modes (LICENSE:PD)</td></tr>
<tr><td style="background:#d9ffd5;">ARGUMENTS:M_CLI2</td><td><a href="specified.3m_cli2.html">specified</a></td><td> return true if keyword was present on command line (LICENSE:PD)</td></tr>
</table>
</div>
</div>
Expand Down
Binary file modified docs/manpages.tgz
View file
Binary file not shown.
Binary file modified docs/manpages.zip
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/set_args.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>set_args (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from ba29441f-29e9-4c04-b955-64aa663c4687 using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>set_args (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from a623c18e-2bd5-4767-9566-b3d846a4aa55 using man macros.</FONT>
<br><br><center><img src="images/set_args.gif"></center>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/set_mode.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>set_mode (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 87a5f0d2-4631-4803-bae8-d4746fd7705d using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>set_mode (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 0bf00e61-4940-4fdb-be00-aa744c4cd778 using man macros.</FONT>
<br><br><center><img src="images/set_mode.gif"></center>
</div>
</div>
Expand Down
13 changes: 4 additions & 9 deletions docs/specified.3m_cli2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,17 +99,12 @@ <H3>DESCRIPTION</H3>
and of course a check whether the input conforms to the type when
requesting a value (with get_args(3f) or the convenience functions
like inum(3f)).
<TABLE cellpadding=3><!-- tsb: M_CLI2 intentionally does not have validators except for SPECIFIED(3f)
-->
<TR></TR><TR></TR>
<TR valign=top><TD colspan=2>
<B>Fortran already has powerful validation capabilities.</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
Logical
<P>
Fortran already has powerful validation capabilities. Logical
expressions ANY(3f) and ALL(3f) are standard Fortran features which
easily allow performing the common validations for command line
arguments without having to learn any additional syntax or methods.
</TD></TR>
<TR></TR></TABLE></BLOCKQUOTE>
</BLOCKQUOTE>
<A name=3>

<H3>OPTIONS</H3>
Expand Down Expand Up @@ -265,7 +260,7 @@ <H3>LICENSE</H3>
Public Domain
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>specified (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from 3c8354e7-128a-40a3-a274-2715e1e6c084 using man macros.</FONT>
<TABLE width=100%><TR> <TD width=33%><I>Nemo Release 3.1</I></TD> <TD width=33% align=center>specified (3m_cli2)</TD> <TD align=right width=33%><I>February 10, 2023</I></TD> </TR></TABLE><FONT SIZE=-1>Generated by <A HREF="http://www.squarebox.co.uk/download/manServer.shtml">manServer 1.08</A> from ecdc2e3c-a2c8-48f2-ad7e-3ec7b09bdfdb using man macros.</FONT>
<br><br><center><img src="images/specified.gif"></center>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions src/M_CLI2.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1438,7 +1438,7 @@ end subroutine prototype_to_dictionary
!! requesting a value (with get_args(3f) or the convenience functions
!! like inum(3f)).
!!
!! Fortran already has powerful validation capabilities. Logical
!! Fortran already has powerful validation capabilities. Logical
!! expressions ANY(3f) and ALL(3f) are standard Fortran features which
!! easily allow performing the common validations for command line
!! arguments without having to learn any additional syntax or methods.
Expand Down Expand Up @@ -2875,7 +2875,7 @@ end subroutine print_dictionary
!!##DESCRIPTION
!!
!! get_args_fixed_size(3f) returns the value of keywords for fixed-size
!! arrays after set_args(3f) has been called. On input on the command
!! arrays after set_args(3f) has been called. On input on the command
!! line all values of the array must be specified.
!!
!!##OPTIONS
Expand Down

0 comments on commit d75d4a0

Please sign in to comment.