cmdline.cli

   1 ## Interface Description File for CLIG - command line interface generator
   2 ## author: Harald Kirsch (kirschh@lionbioscience.com)
   3 ## Adapted for autoproject by Jim Van Zandt <jrv@vanzandt.mv.com>
   4
   5 ## The Name specified is only used in/for the manual page
   6 Name mx3r
   7
   8 ## Usage specifies a one-liner which is printed as part of
   9 ## usage-message. It is also used in the NAME-section of the manual
  10 ## page as a short description.
  11 Usage {merges files looking for similar patterns, and allows several plugins
  12 for understanding the syntax of several files }
  13
  14 ## The Version specified is printed as part of the usage-message.
  15 Version {0.1.1}
  16
  17 ## Commandline specifies the name of a slot in the generated struct
  18 ## which will be set to a newly allocated string holding the
  19 ## concatenated command line. This is particularly useful for programs
  20 ## which want to record their calling sequence somewhere, e.g. in a in
  21 ## output file to document how it was generated.
  22 Commandline tool
  23
  24 ## These options were selected when autoproject was run.
  25 ## More options can be added at any time (see clig(1) and examples below).
  26 String --blr do_blrmerge {<base-filename> <local-filename> <remote-filename>
  27 Try a full (base->local to remote) merge} {count = 3,3}
  28 String -o output_file {<output_file>
  29 Store the mx3d result onto the specified file} {count = 1,1}
  30 String --hashcmp do_hashcmp {<line1> <line2> ... <lineN>
  31 Do a hash compare between 4 or more lines.} {count = 4,oo}
  32 Flag --test-plugin test_plugin {try to load the split-lines plugin}
  33 Flag --help show_help {show usage information}
  34
  35 ########################################################################
  36 ## EXAMPLE OF FLAG OPTION
  37
  38 ## Flag options are rather trivial. They do not have any parameters.
  39 #Flag -v verbose {switch on verbose program operation}
  40
  41 ########################################################################
  42 ## EXAMPLES OF STRING OPTIONS
  43
  44 ## String options can have one or more parameters. By default they
  45 ## have exactly one parameter.
  46 #String -title title {title of x/y-plot}
  47
  48 ## To let them have exactly two parameters, use the following
  49 #String -xytitles xytitles {title of x- and y-axis} \
  50 #    {count = 2,2}
  51
  52 ## To impose no upper limit on the number of parameters, use oo,
  53 ## i.e. double-`o'
  54 #String -plotnames plotnames {names of curves to plot} \
  55 #    {count = 1,oo}
  56
  57 ## An option you really need should be made mandatory. (I'm not sure
  58 ## whether it can be called an `option' then?)
  59 #String -colors colors {colors to use in plots} \
  60 #    mandatory \
  61 #    {count = 1,5}
  62
  63 ## Non-mandatory options can have default values
  64 #String -bg background {background color} \
  65 #    {default = red}
  66
  67 ########################################################################
  68 ## EXAMPLES OF FLOAT OPTIONS
  69
  70 ## The simplest Float-option has a default-count of 1, is not
  71 ## mandatory, imposes no limit on the parameter and has no default
  72 #Float -o offset {offset to add to all curves to plot}
  73
  74 ## Float-option parameters can be forced to lie in a given range
  75 #Float -p p {probability}  {range = 0,1}
  76
  77 ## `count', `mandatory' and `default' work as for String-options
  78 #Float -f f {frequencies} \
  79 #    {count = 2, 10} \
  80 #    {range = 0, 47.11 } \
  81 #    {default = 2 4 8 16.11}
  82
  83 ## special values for range-specs are -oo and oo denoting minus
  84 ## infinity and infinity
  85 #Float -negscale negscale {negative scale value}     {range = -oo, 0.0}
  86
  87 #Float -scale scale {scale value}     {range = 0.0, oo}
  88
  89 ########################################################################
  90 ## EXAMPLES OF INT OPTIONS
  91
  92 ## Int-options work like Float options.
  93 #Int -a a {flog quarx flirim poli gam i nabgala} \
  94 #    mandatory
  95 #
  96 #Int -b b {ram dibum gabalabarum deri pum pam} \
  97 #    {count = 3,4} \
  98 #    {range = -10, 10} \
  99 #    {default = -1 0 1}
 100
 101 ########################################################################
 102 ## EXAMPLES OF REST COMMAND
 103
 104 ## The Rest-command specifies what may be found on the command line
 105 ## after all options have extracted their parameters. The Rest-command
 106 ## has a default `count' of 1,oo, but here we set it to 1,10.
 107 #Rest infiles {list of input files} \
 108 #    {count = 1,10}
 109
 110