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
|
<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_subcommand (3m_cli2)</NOBR><HR></H1>
</CENTER>
<A name=0>
<H3>NAME</H3>
</A>
<BLOCKQUOTE>
get_subcommand(3f) - [ARGUMENTS:M_CLI2] special-case routine for
handling subcommands on a command line
(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>Returns</A><BR>
<A HREF=#4>Example</A><BR>
<A HREF=#5>Author</A><BR>
<A HREF=#6>License</A><BR>
</BLOCKQUOTE>
<A name=7>
<H3>SYNOPSIS</H3>
</A>
<BLOCKQUOTE>
function get_subcommand()
<P>
<PRE>
character(len=:),allocatable :: get_subcommand
<P>
</PRE>
</BLOCKQUOTE>
<A name=2>
<H3>DESCRIPTION</H3>
</A>
<BLOCKQUOTE>
In the special case when creating a program with subcommands it
is assumed the first word on the command line is the subcommand. A
routine is required to handle response file processing, therefore
this routine (optionally processing response files) returns that
first word as the subcommand name.
<P>
It should not be used by programs not building a more elaborate
command with subcommands.
</BLOCKQUOTE>
<A name=3>
<H3>RETURNS</H3>
</A>
<BLOCKQUOTE>
<TABLE cellpadding=3>
<TR valign=top><TD width=6% nowrap>
<B>NAME</B> </TD><TD valign=bottom>
name of subcommand
</TD></TR>
<TR></TR></TABLE></BLOCKQUOTE>
<A name=4>
<H3>EXAMPLE</H3>
</A>
<BLOCKQUOTE>
Sample program:
<P>
<PRE>
program demo_get_subcommand
!x! SUBCOMMANDS
!x! For a command with subcommands like git(1)
!x! you can make separate namelists for each subcommand.
!x! You can call this program which has two subcommands (run, test),
!x! like this:
!x! demo_get_subcommand --help
!x! demo_get_subcommand run -x -y -z --title -l -L
!x! demo_get_subcommand test --title -l -L --testname
!x! demo_get_subcommand run --help
implicit none
!x! DEFINE VALUES TO USE AS ARGUMENTS WITH INITIAL VALUES
real :: x=-999.0,y=-999.0,z=-999.0
character(len=80) :: title="not set"
logical :: l=.false.
logical :: l_=.false.
character(len=80) :: testname="not set"
character(len=20) :: name
call parse(name) !x! DEFINE AND PARSE COMMAND LINE
!x! ALL DONE CRACKING THE COMMAND LINE.
!x! USE THE VALUES IN YOUR PROGRAM.
write(*,*)’command was ’,name
write(*,*)’x,y,z .... ’,x,y,z
write(*,*)’title .... ’,title
write(*,*)’l,l_ ..... ’,l,l_
write(*,*)’testname . ’,testname
contains
subroutine parse(name)
!x! PUT EVERYTHING TO DO WITH COMMAND PARSING HERE FOR CLARITY
use M_CLI2, only : set_args, get_args, get_args_fixed_length
use M_CLI2, only : get_subcommand, set_mode
character(len=*) :: name ! the subcommand name
character(len=:),allocatable :: help_text(:), version_text(:)
call set_mode(’response_file’)
! define version text
version_text=[character(len=80) :: &
’@(#)PROGRAM: demo_get_subcommand >’, &
’@(#)DESCRIPTION: My demo program >’, &
’@(#)VERSION: 1.0 20200715 >’, &
’@(#)AUTHOR: me, myself, and I>’, &
’@(#)LICENSE: Public Domain >’, &
’’ ]
! general help for "demo_get_subcommand --help"
help_text=[character(len=80) :: &
’ allowed subcommands are ’, &
’ * run -l -L --title -x -y -z ’, &
’ * test -l -L --title ’, &
’’ ]
! find the subcommand name by looking for first word on command
! not starting with dash
name = get_subcommand()
select case(name)
case(’run’)
help_text=[character(len=80) :: &
’ ’, &
’ Help for subcommand "run" ’, &
’ ’, &
’’ ]
call set_args( &
& ’-x 1 -y 2 -z 3 --title "my title" -l F -L F’,&
& help_text,version_text)
call get_args(’x’,x)
call get_args(’y’,y)
call get_args(’z’,z)
call get_args_fixed_length(’title’,title)
call get_args(’l’,l)
call get_args(’L’,l_)
case(’test’)
help_text=[character(len=80) :: &
’ ’, &
’ Help for subcommand "test" ’, &
’ ’, &
’’ ]
call set_args(&
& ’--title "my title" -l F -L F --testname "Test"’,&
& help_text,version_text)
call get_args_fixed_length(’title’,title)
call get_args(’l’,l)
call get_args(’L’,l_)
call get_args_fixed_length(’testname’,testname)
case default
! process help and version
call set_args(’ ’,help_text,version_text)
write(*,’(*(a))’)’unknown or missing subcommand [’,trim(name),’]’
write(*,’(a)’)[character(len=80) :: &
’ allowed subcommands are ’, &
’ * run -l -L -title -x -y -z ’, &
’ * test -l -L -title ’, &
’’ ]
stop
end select
end subroutine parse
end program demo_get_subcommand
<P>
</PRE>
</BLOCKQUOTE>
<A name=5>
<H3>AUTHOR</H3>
</A>
<BLOCKQUOTE>
John S. Urban, 2019
</BLOCKQUOTE>
<A name=6>
<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_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>
</body>
</HTML>
|
