WATCHDOG manpage

WATCHDOG(1) General Commands Manual

NAME

watchdog — Cellular automaton simulating a watchdog in a house using JavaFx.

SYNOPSIS

watchdog -l [ -v ] [ -d ]
watchdog [ -n <neighbourhood> ] [ --board <board> ] [ --field-width <fieldWidth> ] [ --field-height <fieldHeight> ] [ --field-gap <fieldGap> ] [ --console ] [ --config <config> ] [ -v ] [ -d ]
watchdog --init [ --config <config> ] [ -v ] [ -d ]
watchdog -h | --sysinfo -v

DESCRIPTION

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

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

OPTIONS

--board <board>: The board to be used for 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).
-l --list: Lists all boards available for the chosen cellular automaton.
-n --neighbourhood <neighbourhood>: Use an according neighborhood, acceptable values are: { VON_NEUMANN, MOORE }
-s --start: Starts the Watchdog cellular automaton.
--sysinfo: Shows some system information for debugging purposes.
-v --verbose: Enables the verbose mode with additional (human readable) informational output.
: Launches a random board.

EXAMPLES

Launch random board simulation:

  • watchdog

Launch random board simulation (verbose):

  • watchdog -v

List all boards for the simulation:

  • watchdog -l

List all boards for the simulation (verbose):

  • watchdog -l -v

Launch random board simulation printing state to the console:

  • watchdog --console

Start simulation for provided board:

  • watchdog --board <board> -v

Start simulation for provided board (verbose):

  • watchdog --board <board> -v

Initialize a config file:

  • watchdog --init --config <config> -v

Start simulation from config file:

  • watchdog --config <config> -v

To show the help text:

  • watchdog -h

To print the system info:

  • watchdog --sysinfo

FILES

The watchdog.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 watchdog.ini configuration file must be located either in the current user’s working directory, the watchdog 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-watchdog

AUTHOR

Siegfried Steiner steiner@refcodes.org

SEE ALSO