<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>UI / frepple (frepple.exe on Windows)</title> <link rel='stylesheet' href='../styles.css' type='text/css' /> <!--PageHeaderFmt--> </head> <body> <div id="container"> <div id="menubar"> <div id="logo" align="center"> <br/><img src='../frepple.bmp' alt="frepple" /><br/> <a href='http://www.frepple.com/'> <strong>a Free<br/>Production Planning<br/>Library</strong> </a></div> <div id="menu"> <br/> <h3><a href='../Main/HomePage.html'>Main</a></h3> <h3><a href='Main.html'>User Manual</a></h3> <h3><a href='../Tutorial/Main.html'>Tutorial</a></h3> <h3><a href='../Frepple/Main.html'>Reference Manual</a></h3> <h3><a href='../Main/FAQ.html'>FAQ</a></h3> <h3><a href='../reference/index.html'>C++ API</a></h3> <br/><div> </div> </div> </div> <div id="content"> <br/> <!--PageText--> <div id='wikitext'> <p><a class='wikilink' href='../Main/HomePage.html'>Main</a> > <span class='wikitrail'><a class='wikilink' href='Main.html'>User Guide</a> > <a class='wikilink' href='CommandLine.html'>Batch commands</a> > <a class='selflink' href='Frepple.html'>frepple (frepple.exe on Windows)</a></span> </p> <p class='vspace'>This executable runs the planning engine and solver.<br />The program reads XML input data, and executes the modeling and planning commands included in them. </p> <p class='vspace'>This executable is more relevant when you use only the frePPLe solver capability in the back end, and you have developed your own front end and data store.<br />If you are using the user interface of frePPLe, <strong>it is recommended to use the command 'manage.py frepple_run' instead of this executable</strong>. </p> <p class='vspace'>Usage: </p><ul><li><strong>frepple [options] [files | directories]</strong><br /> Passing one or more XML files and/or directories.<br /> The arguments are processed sequentially.<br /> When a directory is specified, the application will process all files in it with the extension '.xml' in alphabetical order. </li><li><strong>frepple [options]</strong><br /> When passing no file or directory arguments, input will be read from the standard input. Output from other programs can be piped to the command. </li></ul><p class='vspace'>Options: </p><ul><li><strong>-validate -v</strong>:<br /> Validate the XML input for correctness, as defined in the frepple.xsd schema.<br /> This validation is disabled by default. </li><li><strong>-check -c</strong>:<br /> Only validate the input, without executing the content. </li><li><strong>-? -h -help</strong>:<br /> Show help. </li></ul><p class='vspace'>The program will automatically execute the commands in the init.xml and init.py files. </p> <p class='vspace'>The variable FREPPLE_HOME optionally points to a directory where the initialization files init.xml, init.py, frepple.xsd and module libraries will be searched. </p> <p class='vspace'>The return code is 0 when the program completes succesfully, and non-zero in case of errors </p> </div> <!--PageFooterFmt--> <!--HTMLFooter--> </div></div> </body> </html>
