CELLOMAT manpage

CELLOMAT(1) General Commands Manual

NAME

cellomat — Cellular automaton using several simulations and JavaFx for creating a live of its own.

SYNOPSIS

cellomat --boards { -b | -w } [ -v ] [ -d ]
cellomat { -b | -w [ -n <neighbourhood> ] } [ --board <board> ] [ --field-width <fieldWidth> ] [ --field-height <fieldHeight> ] [ --field-gap <fieldGap> ] [ --console ] [ --config <config> ] [ -v ] [ -d ]
cellomat --init [ --config <config> ] [ -v ] [ -d ]
cellomat ∅ | [ -v ] [ -d ]
cellomat -h | --sysinfo -v

DESCRIPTION

This manual page documents the cellomat command: The cellomat command launches a cellular automation for a “Boulder-Dash” --boulder-dash or a “Watchdog” --watchdog simulation using a given (optional) --board and (if applicable) an according neighbourhood --neighbourhood and may print out the automaton’s state to the console --console or may list the available boards --boards of a simulation --boulder-dash or --watchdog to the console. Invoking without any arguments launches a random simulation using a random board. All being configurable --config in a cellomat.ini configuration file.

Depending on the executable’s flavor the command might also be named cellomat-x.y.z.jar, cellomat-bundle-x86_64-x.y.z.elf, cellomat-bundle-x86_64-x.y.z.exe, cellomat-installer-x86_64-x.y.z.msi, cellomat-launcher-x.y.z.sh, cellomat-launcher-x86_64-x.y.z.elf, cellomat-launcher-x86_64-x.y.z.exe, cellomat-native-x86_64-x.y.z.elf where x.y.z stands for the version of the cellomat command. The according executable’s name will be referenced to in this manual as cellomat.

OPTIONS

-b --boulder-dash: Run the Boulder-Dash cellular automaton.
--board <board>: The board to be used for chosen cellular automaton.
--boards: Lists all boards available for the chosen cellular automaton.
--config <config>: Specifies the resource (file) to use when loading the configuration.
--console: Print the checkerboard also to the console.
-d --debug: Enables the debug mode with additional (developer readable) informational output.
--field-gap <fieldGap>: The desired gap between the checkerboard’s fields.
--field-height <fieldHeight>: The desired height of the checkerboard field’s heights.
--field-width <fieldWidth>: The desired width of the checkerboard field’s widths.
-h --help: Shows this help
--init: Initialize the configuration (from a template).
-n --neighbourhood <neighbourhood>: Use an according neighborhood, acceptable values are: { VON_NEUMANN, MOORE }
--sysinfo: Shows some system information for debugging purposes.
-v --verbose: Enables the verbose mode with additional (human readable) informational output.
-w --watchdog: Run the Watchdog cellular automaton.
: Launches a random board.

EXAMPLES

List all boards for Boulder-Dash simulation:

  • cellomat -b --boards -v

List all boards for Watchdog simulation:

  • cellomat -w --boards -v

Start random Boulder-Dash simulation:

  • cellomat -b -v

Start random Watchdog simulation:

  • cellomat -w -v

Start random Boulder-Dash printing state to the console:

  • cellomat -b --console

Start random Watchdog printing state to the console:

  • cellomat -w --console

Start Boulder-Dash simulation for board:

  • cellomat -b --board <board> -v

Start Watchdog simulation for board:

  • cellomat -w --board <board> -v

Start Boulder-Dash simulation for board:

  • cellomat -b --board <board> -v

Start Watchdog simulation for board:

  • cellomat -w --board <board> -v

Initialize a config file:

  • cellomat --init --config <config> -v

Start Boulder-Dash simulation from config file:

  • cellomat -b --config <config> -v

Start Watchdog simulation from config file:

  • cellomat -w --config <config> -v

Launch a random board:

  • cellomat

To show the help text:

  • cellomat -h

To print the system info:

  • cellomat --sysinfo

FILES

The cellomat.ini configuration file helps tweaking the cellular automaton:

[watchdog]
[[boards]]
[[[foobar]]]
0=iai#
1=iiii
2=###i
3=iiii
  • i denotes an inactive watchdog
  • a denotes an active watchdog
  • # denotes an inaccessible cell

The cellomat.ini configuration file must be located either in the current user’s working directory, the tty2mqtt executable’s folder or subfolder settings, etc or config or the user home’s ~/.config folder or in the /etc folder (in this precedence).

BUGS

See BitBucket issues: https://bitbucket.org/funcodez/funcodes-cellomat

AUTHOR

Siegfried Steiner steiner@refcodes.org

SEE ALSO