From 5cc2d92c38de99ed5980b3c438c2a2c4051d3fea Mon Sep 17 00:00:00 2001 From: Jonathan Harris Date: Sat, 7 Nov 2015 13:14:59 +0000 Subject: [PATCH] Updated Running from source (markdown) --- Running-from-source.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/Running-from-source.md b/Running-from-source.md index ccb4453..4bf905c 100644 --- a/Running-from-source.md +++ b/Running-from-source.md @@ -19,6 +19,35 @@ Linux: * Run with `./EDMarketConnector.py` . +Command-line +-------- + +The command-line program `EDMC.py` writes the current system and station (if docked) to stdout and optionally +writes ship loadout and/or station data to file. This program requires that the user has performed [setup](Installation & Setup) and verification through the app. + +Arguments: + +``` + -h, --help show this help message and exit + -v, --version print program version and exit + -c FILE write ship loadout to FILE in Coriolis json format + -e FILE write ship loadout to FILE in E:D Shipyard format + -m FILE write station commodity market data to FILE in CSV format + -o FILE write station outfitting data to FILE in CSV format + -s FILE write station shipyard data to FILE in CSV format +``` + +The program returns one of the following exit codes. Further information may be written to stderr. +
    +
  1. Success. Note that this doesn't necessarily mean that any requested output files have been produced - for example if the current station doesn't support the facilities for which data was requested.
    2. +
  2. Server is down.
    3. +
  3. Invalid Credentials.
    4. +
  4. Verification Required.
    5. +
  5. Not docked. You have requested station data but the user is not docked at a station.
    6. +
  6. I/O or other OS error.
    7. +
+ + Packaging for distribution --------