runProgram -- run an external program

Synopsis

• Usage:

  runProgram(program, args)

  runProgram(program, exe, args)

• Inputs:
  • program, an instance of the type Program, the program to run, generated by findProgram.
  • exe, a string, the specific executable file to run. This is only necessary if the program consists of multiple such files. If not given, then program#"name" is used.
  • args, a string, the command line arguments passed to the program.
• Optional inputs:
  • KeepFiles => a Boolean value, default value false, whether to keep the temporary files containing the program's output.
  • RaiseError => a Boolean value, default value true, whether to raise an error if the program returns a nonzero value.
  • RunDirectory => a string, default value null, the directory from which to run the program. If it does not exist, then it will be created. If null, then the program will be run from the current working directory (see currentDirectory).
  • Verbose => a Boolean value, default value false, whether to print the command line input and the program's output.

Description

This method runs an external program which has already been loaded using findProgram. The results of this run are available in a ProgramRun object.

i1 : gfan = findProgram("gfan", "gfan --help")

o1 = gfan

o1 : Program

i2 : runProgram(gfan, "_version")

o2 = 0

o2 : ProgramRun

i3 : oo#"output"

o3 = Gfan version:
     gfan0.6.2

     Forked from source tree on:
     1506606121 Thu Sep 28 15:42:01 2017

     Linked libraries:
     GMP 6.2.0
     Cddlib       YES
     SoPlex        NO
     Singular      NO

i4 : runProgram(gfan, "_foo", RaiseError => false)

o4 = 256

o4 : ProgramRun

i5 : oo#"error"

o5 = UNKNOWN OPTION: _foo.
     USE --help AS A SINGLE OPTION TO VIEW THE HELP TEXT.

See also

• ProgramRun -- result of running an external program
• findProgram -- load external program