Skip to content

Commit

Permalink
manual: addressing several comments from tcld
Browse files Browse the repository at this point in the history
  • Loading branch information
@ftomassetti
ftomassetti committed Nov 18, 2015
1 parent 4dda5e8 commit 7145804
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ If you are using WorldEngine please let us know!
Contributors
============

The this project is maintained by [Bret Curtis](https://github.com/psi29a) and [Federico Tomassetti](https://github.com/ftomassetti).
This project is maintained by [Bret Curtis](https://github.com/psi29a) and [Federico Tomassetti](https://github.com/ftomassetti).

All contributions, questions, ideas are more than welcome!
Feel free to open an issue or write in our [google group](https://groups.google.com/forum/?hl=en#!forum/worldengine).
Expand Down
52 changes: 26 additions & 26 deletions manual/cli.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,36 +34,36 @@ General options
+------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+
| | --version | Display version information |
+------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+
| --bw | --black-and-white | Draw maps in black and white |
| --bw | --black-and-white | Draw maps in black and white (currently affects only the precipitation and temperature maps) |
+------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+


Options valid only for generate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| Short | Long | Description |
+===========+============================+======================================================================================================+
| -r FILE | --rivers=FILE | produce a map of rivers, after the option it expects the name of the file where to generate the map |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| --gs | --grayscale-heightmap | produce a grayscale heightmap |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| | --ocean_level=N | elevation cut off for sea level [default = 1.0] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| | --temps #/#/#/#/#/# | Provide alternate ranges for temperatures. [default = .126/.235/.406/.561/.634/.876] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| | --humidity #/#/#/#/#/#/# | Provide alternate ranges for humidities. [default = .059/.222/.493/.764/.927/.986/.998] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| -gv N | --gamma-value N | N = Gamma value for temperature/precipitation gamma correction curve. [default = 1.25] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| -go N | --gamma-offset N | N = Adjustment value for temperature/precipitation gamma correction curve. [default = .2] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| | ---not-fade-borders | avoid fading borders |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| | --scatter | generate scatter plot |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
| | --sat | generate satellite map |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------+
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| Short | Long | Description |
+===========+============================+================================================================================================================================================+
| -r FILE | --rivers=FILE | Produce a map of rivers, after the option it expects the name of the file where to generate the map |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| --gs | --grayscale-heightmap | Produce a grayscale heightmap |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| | --ocean_level=N | Elevation cut off for sea level [default = 1.0] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| | --temps #/#/#/#/#/# | Specify the quantiles used to identify the temperature levels. It should contains values in [0,1]. [default = .126/.235/.406/.561/.634/.876] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| | --humidity #/#/#/#/#/#/# | Specify the quantiles used to identify the humidity levels. It should contains values in [0,1]. [default = .059/.222/.493/.764/.927/.986/.998] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| -gv N | --gamma-value N | N = Gamma value for temperature/precipitation gamma correction curve. [default = 1.25] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| -go N | --gamma-offset N | N = Adjustment value for temperature/precipitation gamma correction curve. [default = .2] |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| | ---not-fade-borders | Avoid fading borders |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| | --scatter | Generate temperature vs. humidity scatter plot |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| | --sat | Generate satellite map |
+-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+

Options valid only for ancient map operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -94,7 +94,7 @@ Export options
+-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Short | Long | Description |
+===========+============================+================================================================================================================================+
| | --export-format | Export to a specific format such as BMP or PNG. See http://www.gdal.org/formats_list.html for possible formats [default = PNG] |
| | --export-format=FORMAT | Export to a specific format such as BMP or PNG. See http://www.gdal.org/formats_list.html for possible formats [default = PNG] |
+-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| | --export-datatype | Type of stored data, e.g. uint16, int32, float32 etc. [default = uint16] |
| | --export-datatype=TYPE | Type of stored data, e.g. uint16, int32, float32 etc. [default = uint16] |
+-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+

0 comments on commit 7145804

Please sign in to comment.