File: cmdline.cli.in

package info (click to toggle)
autoproject 0.20-16
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 980 kB
  • sloc: sh: 2,948; ansic: 1,677; cpp: 199; makefile: 59
file content (135 lines) | stat: -rw-r--r-- 4,450 bytes parent folder | download | duplicates (11)
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
##      @configure_input@
##
## Interface Description File for CLIG - command line interface generator
## author: Harald Kirsch (kirschh@lionbioscience.com)
## Adapted for autoproject by Jim Van Zandt <jrv@vanzandt.mv.com>

## The Name specified is only used in/for the manual page
Name #NAME#

## Usage specifies a one-liner which is printed as part of
## usage-message. It is also used in the NAME-section of the manual
## page as a short description.
Usage {#DESCRIPTION#}

## The Version specified is printed as part of the usage-message.
## (The value comes from `configure.in', and is inserted by `configure')
Version {@VERSION@}

## Commandline specifies the name of a slot in the generated struct
## which will be set to a newly allocated string holding the
## concatenated command line. This is particularly useful for programs
## which want to record their calling sequence somewhere, e.g. in a in
## output file to document how it was generated.
Commandline tool

## These options were selected when autoproject was run.
## More options can be added at any time (see clig(1) and examples below).
@output@
String -output oname {send output to this file instead of standard output}
@@
@interactive@
Flag -i interactive {prompt for confirmation}
@@
@dry-run@
Flag -dry-run dry_run {take no real actions}
@@
@no-warn@
Flag  -no-warn 	no_warn {disable warnings}
@@
@quiet@
Flag  -q 	quiet 	{inhibit usual output}
Flag  -quiet 	quiet2 	{inhibit usual output}
Flag  -silent 	quiet3 	{inhibit usual output}
@@
@brief@
Flag  -brief	brief   {shorten output}
@@
@verbose@
Flag  -verbose	verbose {print more information}
@@
@directory@
String  -directory directory_name {use specified directory}
@@
@cd@
String -cd cd_directory_name {change to specified directory before proceeding}
@@
Flag -help show_help {show usage information}
Flag -version show_version {show program version}

########################################################################
## EXAMPLE OF FLAG OPTION

## Flag options are rather trivial. They do not have any parameters.
#Flag -v verbose {switch on verbose program operation}

########################################################################
## EXAMPLES OF STRING OPTIONS

## String options can have one or more parameters. By default they
## have exactly one parameter.
#String -title title {title of x/y-plot}

## To let them have exactly two parameters, use the following
#String -xytitles xytitles {title of x- and y-axis} \
#    {count = 2,2}

## To impose no upper limit on the number of parameters, use oo,
## i.e. double-`o'
#String -plotnames plotnames {names of curves to plot} \
#    {count = 1,oo}

## An option you really need should be made mandatory. (I'm not sure
## whether it can be called an `option' then?)
#String -colors colors {colors to use in plots} \
#    mandatory \
#    {count = 1,5}

## Non-mandatory options can have default values
#String -bg background {background color} \
#    {default = red}

########################################################################
## EXAMPLES OF FLOAT OPTIONS

## The simplest Float-option has a default-count of 1, is not
## mandatory, imposes no limit on the parameter and has no default
#Float -o offset {offset to add to all curves to plot}

## Float-option parameters can be forced to lie in a given range
#Float -p p {probability}  {range = 0,1}
    
## `count', `mandatory' and `default' work as for String-options
#Float -f f {frequencies} \
#    {count = 2, 10} \
#    {range = 0, 47.11 } \
#    {default = 2 4 8 16.11}

## special values for range-specs are -oo and oo denoting minus
## infinity and infinity
#Float -negscale negscale {negative scale value}     {range = -oo, 0.0}

#Float -scale scale {scale value}     {range = 0.0, oo}

########################################################################
## EXAMPLES OF INT OPTIONS

## Int-options work like Float options.
#Int -a a {flog quarx flirim poli gam i nabgala} \
#    mandatory
#
#Int -b b {ram dibum gabalabarum deri pum pam} \
#    {count = 3,4} \
#    {range = -10, 10} \
#    {default = -1 0 1}

########################################################################
## EXAMPLES OF REST COMMAND

## The Rest-command specifies what may be found on the command line
## after all options have extracted their parameters. The Rest-command
## has a default `count' of 1,oo, but here we set it to 1,10.
#Rest infiles {list of input files} \
#    {count = 1,10}