1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<html>
<head>
<title> </title>
<style>
px {font-family: "Lucida Console", Monaco, monospace }
p { font-size:100%; line-height:1.1em; }
body {xfont-style: sans-serif}
body {
color:#333; font-family:Verdana, Arial, Helvetica, sans-serif; font-size:1em; line-height:1.3em; }
a:visited { color:#666; }
h1,h2,h3,h4,h5,h6 { color:#333; font-family:georgia, verdana, sans-serif; }
h1 { font-size:150%; page-break-before:auto;background-color: #aaaaff}
h2 { font-size:143%;color:teal; }
h3 { font-size:134%;color:blue; }
h4 { font-size:120%;color:gray; }
img { max-width: 55em}
p{ padding: 0;margin:0; }
p{ padding-right:1.4em; }
p{ padding-bottom:0.1em; }
p{ padding-top:1em; }
p{ whitespace: pre-wrap; }
h5,h6 { font-size:100% }
a.nav,a:link.nav, a:visited.nav { background-color:#FFF; color:#000; }
XXtable { border:double #000; border-collapse:collapse; }
XXtable { border-collapse:collapse; }
XXtd { border:thin solid #888; }
XXtd { border:none; }
li { margin-bottom:0.5em; }
blockquote { display:block; font-size:100%; line-height:1.1em; margin:0 0 0.5em; padding:0 2.5em; }
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: #BBB}
#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; }
h1#pageName { line-height:1em; margin:0.2em 0 0.2em 0; padding:0; }
.property { color:#666; font-size:100%; }
a.existingWikiWord[title]{ //border: 1px dashed #BBB; }
.byline { color:#666; font-size:1.0em; font-style:italic; margin-bottom:1em; padding-top:1px; }
</style>
</head>
<BODY bgcolor=#F0F0F0 text=#000000 link=#0000ff vlink=#C000C0 alink=#ff0000><A NAME=top></A>
<!--
<h5><a href="https://github.com/urbanjost/M_CLI2">[UP]</a></h5>
<button type="button" onclick="javascript:history.back()">Back</button>
-->
<div id="Container">
<div id="Content">
<CENTER>
<H1><HR><I>Manual Reference Pages - </I><NOBR>get_args (3m_cli2)</NOBR><HR></H1>
</CENTER>
<A name=0>
<H3>NAME</H3>
</A>
<BLOCKQUOTE>
get_args(3f) - [ARGUMENTS:M_CLI2] return keyword values when parsing
command line arguments
(LICENSE:PD)
<P>
</BLOCKQUOTE>
<A name=contents></A><H3>CONTENTS</H3></A>
<BLOCKQUOTE>
<A HREF=#1>Synopsis</A><BR>
<A HREF=#2>Description</A><BR>
<A HREF=#3>Options</A><BR>
<A HREF=#4>Convenience Functions</A><BR>
<A HREF=#5>Example</A><BR>
<A HREF=#6>Author</A><BR>
<A HREF=#7>License</A><BR>
</BLOCKQUOTE>
<A name=8>
<H3>SYNOPSIS</H3>
</A>
<BLOCKQUOTE>
get_args(3f) and its convenience functions:
<P>
<PRE>
use M_CLI2, only : get_args
! convenience functions
use M_CLI2, only : dget, iget, lget, rget, sget, cget
use M_CLI2, only : dgets, igets, lgets, rgets, sgets, cgets
<P>
subroutine get_args(name,value,delimiters)
<P>
character(len=*),intent(in) :: name
<P>
type(${TYPE}),allocatable,intent(out) :: value(:)
! or
type(${TYPE}),allocatable,intent(out) :: value
<P>
character(len=*),intent(in),optional :: delimiters
<P>
where ${TYPE} may be from the set
{real,doubleprecision,integer,logical,complex,character(len=:)}
</PRE>
</BLOCKQUOTE>
<A name=2>
<H3>DESCRIPTION</H3>
</A>
<BLOCKQUOTE>
<P>
GET_ARGS(3f) returns the value of keywords after SET_ARGS(3f) has
been called to parse the command line. For fixed-length CHARACTER
variables see GET_ARGS_FIXED_LENGTH(3f). For fixed-size arrays see
GET_ARGS_FIXED_SIZE(3f).
<P>
As a convenience multiple pairs of keywords and variables may be
specified if and only if all the values are scalars and the CHARACTER
variables are fixed-length or pre-allocated.
</BLOCKQUOTE>
<A name=3>
<H3>OPTIONS</H3>
</A>
<BLOCKQUOTE>
<P>
<TABLE cellpadding=3>
<TR valign=top><TD width=6% nowrap>
<B>NAME</B> </TD><TD valign=bottom>
name of commandline argument to obtain the value of
</TD></TR>
<TR valign=top><TD width=6% nowrap>
<B>VALUE</B> </TD><TD valign=bottom>
variable to hold returned value. The kind of the value
is used to determine the type of returned value. May
be a scalar or allocatable array. If type is CHARACTER
the scalar must have an allocatable length.
</TD></TR>
<TR valign=top><TD colspan=2>
<B>DELIMITERS</B> </TD></TR><TR valign=top><TD width=6%> </TD><TD>
By default the delimiter for array values are comma,
colon, and whitespace. A string containing an alternate
list of delimiter characters may be supplied.
</TD></TR>
<TR></TR></TABLE></BLOCKQUOTE>
<A name=4>
<H3>CONVENIENCE FUNCTIONS</H3>
</A>
<BLOCKQUOTE>
There are convenience functions that are replacements for calls to
get_args(3f) for each supported default intrinsic type
<BLOCKQUOTE>
<TABLE cellpadding=3><!-- tsb: There are convenience functions that are replacements for calls to
-->
<TR></TR><TR></TR>
<TR valign=top><TD width=3%>
o
</TD><TD>
scalars -- dget(3f), iget(3f), lget(3f), rget(3f), sget(3f),
cget(3f)
</TD></TR>
<TR valign=top><TD width=3%>
o
</TD><TD>
vectors -- dgets(3f), igets(3f), lgets(3f), rgets(3f),
sgets(3f), cgets(3f)
</TD></TR>
<TR></TR></TABLE></BLOCKQUOTE>
<P>
D is for DOUBLEPRECISION, I for INTEGER, L for LOGICAL, R for REAL,
S for string (CHARACTER), and C for COMPLEX.
<P>
If the functions are called with no argument they will return the
UNNAMED array converted to the specified type.
</BLOCKQUOTE>
<A name=5>
<H3>EXAMPLE</H3>
</A>
<BLOCKQUOTE>
<P>
Sample program:
<P>
<PRE>
program demo_get_args
use M_CLI2, only : filenames=>unnamed, set_args, get_args
implicit none
integer :: i
! Define ARGS
real :: x, y, z
real,allocatable :: p(:)
character(len=:),allocatable :: title
logical :: l, lbig
! Define and parse (to set initial values) command line
! o only quote strings and use double-quotes
! o set all logical values to F or T.
call set_args(’ &
& -x 1 -y 2 -z 3 &
& -p -1,-2,-3 &
& --title "my title" &
& -l F -L F &
& --label " " &
& ’)
! Assign values to elements
! Scalars
call get_args(’x’,x,’y’,y,’z’,z,’l’,l,’L’,lbig)
! Allocatable string
call get_args(’title’,title)
! Allocatable arrays
call get_args(’p’,p)
! Use values
write(*,’(1x,g0,"=",g0)’)’x’,x, ’y’,y, ’z’,z
write(*,*)’p=’,p
write(*,*)’title=’,title
write(*,*)’l=’,l
write(*,*)’L=’,lbig
if(size(filenames) > 0)then
write(*,’(i6.6,3a)’)(i,’[’,filenames(i),’]’,i=1,size(filenames))
endif
end program demo_get_args
</PRE>
</BLOCKQUOTE>
<A name=6>
<H3>AUTHOR</H3>
</A>
<BLOCKQUOTE>
John S. Urban, 2019
</BLOCKQUOTE>
<A name=7>
<H3>LICENSE</H3>
</A>
<BLOCKQUOTE>
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 50409d9e-8a3e-4e16-add3-1b21c3c34202 using man macros.</FONT>
<br><br><center><img src="images/get_args.gif"></center>
</div>
</div>
</body>
</HTML>
|
