nikhilgupta10 / GridLAB-D

Other
1 stars 0 forks source link

#753 --modhelp not listed in --help output, #2491

Closed nikhilgupta10 closed 7 years ago

nikhilgupta10 commented 7 years ago

The extremely useful --modhelp command line option is not listed in the output of --help.

I think the entry should be something like:
--modhelp <module>:<object> print help on all properties of an object

Observed using GridLAB-D v2.3 (Build 5035) on Mac OSX

,

nikhilgupta10 commented 7 years ago

nikhilgupta10 imported these comments from Sourceforge: "jcfuller": * status changed from new to closed

There were a number of command line options (~50) that were not listed in v2.3. This has been remedied in v3.0 and newer. The total outputs are posted below. Because of the necessary overhaul to get all of these into v2.3, we elected to roll it out with v3.0.

C:\/Users\d3x289\Documents\GridLABD\branch\3.0\VS2005\x64\Release>gridlabd --help
Syntax: gridlabd [<options>] file1 [file2 [...]]

Command-line options


--check|-c Performs module checks before starting simulation
--debug Toggles display of debug messages
--debugger Enables the debugger
--dumpall Dumps the global variable list
--mt_profile <n-threads> Analyses multithreaded performance profile
--profile Toggles performance profiling of core and modules while simulation runs
--quiet|-q Toggles suppression of all but error and fatal messages
--verbose|-v Toggles output of verbose messages
--warn|-w Toggles display of warning messages
--workdir|-W Sets the working directory

Global and module control


--define|-D <name>=[<module>:]<value> Defines or sets a global (or module) variable
--globals Displays a sorted list of all global variables
--libinfo|-L <module> Displays information about a module

Information


--copyright Displays copyright
--license Displays the license agreement
--version|-V Displays the version information
--setup Open simulation setup screen

Test processes


--dsttest Perform daylight savings rule test
--endusetest Perform enduse pseudo-object test
--globaldump Perform a dump of the global variables
--loadshapetest Perform loadshape pseudo-object test
--locktest Perform memory locking test
--modtest <module> Perform test function provided by module
--randtest Perform random number generator test
--scheduletest Perform schedule pseudo-object test
--test <module> Perform unit test of module (deprecated)
--testall=<filename> Perform tests of modules listed in file
--unitstest Perform unit conversion system test
--validate ... Perform model validation check

File and I/O Formatting


--kml[=<filename>] Output to KML (Google Earth) file of model (only supported by some modules)
--stream Toggles streaming I/O
--sanitize <options> <indexfile> <outputfile> Output a sanitized version of the GLM model
--xmlencoding 8|16|32 Set the XML encoding system
--xmlstrict Toggle strict XML formatting (default is enabled)
--xsd [module[:class]] Prints the XSD of a module or class
--xsl module[,module[,...]]] Create the XSL file for the module(s) listed

Help


--help|-h Displays command line help
--info <subject> Obtain online help regarding <subject>
--modhelp module[:class] Display structure of a class or all classes in a module
--example module:class Display an example of an instance of the class before init

Process control


--pidfile[=<filename>] Set the process ID file (default is gridlabd.pid)
--threadcount|-T <n> Set the maximum number of threads allowed
--job ... Start a job

System options


--avlbalance Toggles automatic balancing of object index
--bothstdout Merges all output on stdout
--check_version Perform online version check to see if any updates are available
--compile|-C Toggles compile-only flags
--environment|-e <appname> Set the application to use for run environment
--output|-o <file> Enables save of output to a file (default is gridlabd.glm)
--pause Toggles pause-at-exit feature
--relax Allows implicit variable definition when assignments are made

Server mode


--server Enables the server
--clearmap Clears the process map of defunct jobs (deprecated form)
--pclear Clears the process map of defunct jobs
--pcontrol Enters process controller
--pkill <procnum> Kills a run on a processor
--pstatus Prints the process list
--redirect <stream>[:<file>] Redirects an output to stream to a file (or null)
--server_portnum|-P Sets the server port number (default is 6267)
--slave <master> Enables slave mode under master
--slavenode Sets a listener for a remote GridLAB-D call to run in slave mode
--id <idnum> Sets the ID number for the slave to inform its using to the master

,

"dchassin":- Milestone: Unscheduled --> Knothole Interim ,