Termonad

This module exposes Termonad's basic configuration options, as well as defaultMain, startWithCliArgs, and start.

If you want to configure Termonad, please take a look at Termonad.Config.

Documentation

defaultMain :: TMConfig -> IO ()

Run Termonad with the given TMConfig.

This function will check if there is a ~/.config/termonad/termonad.hs file and a ~/.cache/termonad/termonad-linux-x86_64 binary. Termonad will perform different actions based on whether or not these two files exist.

Here are the four different possible actions based on the existence of these two files.

• ~/.config/termonad/termonad.hs exists, ~/.cache/termonad/termonad-linux-x86_64 exists

  The timestamps of these two files are checked. If the ~/.config/termonad/termonad.hs file has been modified after the ~/.cache/termonad/termonad-linux-x86_64 binary, then Termonad will use GHC to recompile the ~/.config/termonad/termonad.hs file, producing a new binary at ~/.cache/termonad/termonad-linux-x86_64. This new binary will be re-executed. The TMConfig passed to this defaultMain will be effectively thrown away, however all command line options will be passed on to this new Termonad process.

  If GHC fails to recompile the ~/.config/termonad/termonad.hs file, then Termonad will just execute startWithCliArgs with the TMConfig passed in.

  If the ~/.cache/termonad/termonad-linux-x86_64 binary has been modified after the ~/.config/termonad/termonad.hs file, then Termonad will re-exec the ~/.cache/termonad/termonad-linux-x86_64 binary. The TMConfig passed to this defaultMain will be effectively thrown away, however all command line options will be passed on to this new Termonad process.

• ~/.config/termonad/termonad.hs exists, ~/.cache/termonad/termonad-linux-x86_64 does not exist

  Termonad will use GHC to recompile the ~/.config/termonad/termonad.hs file, producing a new binary at ~/.cache/termonad/termonad-linux-x86_64. This new binary will be re-executed. The TMConfig passed to this defaultMain will be effectively thrown away, however all command line options will be passed on to this new Termonad process.

  If GHC fails to recompile the ~/.config/termonad/termonad.hs file, then Termonad will just execute startWithCliArgs with the TMConfig passed in.

• ~/.config/termonad/termonad.hs does not exist, ~/.cache/termonad/termonad-linux-x86_64 exists

  Termonad will ignore the ~/.cache/termonad/termonad-linux-x86_64 binary and just run startWithCliArgs with the TMConfig passed to this function.

• ~/.config/termonad/termonad.hs does not exist, ~/.cache/termonad/termonad-linux-x86_64 does not exist

  Termonad will run startWithCliArgs with the TMConfig passed to this function.

Other notes:

1. That the locations of ~/.config/termonad/termonad.hs and ~/.cache/termonad/termonad-linux-x86_64 may differ depending on your system.
2. In your own ~/.config/termonad/termonad.hs file, you can use either defaultMain or startWithCliArgs. As long as you always execute the system-wide termonad binary (instead of the binary produced as ~/.cache/termonad/termonad-linux-x86_64), the effect should be similar.
3. If you directly run the cached termonad binary (e.g. ~/.cache/termonad/termonad-linux-x86_64) instead of the system-installed Termonad binary (e.g. /usr/bin/termonad), the Termonad will recompile the the configuration file ~/.config/termonad/termonad.hs according to the above logic (while possibly overwriting the executable file for the binary you're currently running), but it will not re-exec into the newly built termonad binary.
4. When running the system-wide termonad binary, the initial TMConfig that gets passed into this function comes from tmConfigFromPreferencesFile. As stated above, this initial TMConfig gets ignored if users have a ~/.config/termonad/termonad.hs file that gets recompiled and re-execed.

End users generally call defaultMain in their ~/.config/termonad/termonad.hs file.

defaultMain interally calls startWithCliArgs, which parses CLI arguments and combines them with the passed-in TMConfig. startWithCliArgs then internally calls start.

If you don't want the re-compiling and re-exec functionality, you can directly use startWithCliArgs. If you also don't want the CLI argument parsing functionality, you can directly use start.

startWithCliArgs :: TMConfig -> IO ()

Run Termonad with the given TMConfig.

Do not perform any of the recompilation operations that the defaultMain function does.

This function does parse command line arguments, and then calls start.

start :: TMConfig -> IO ()

Run Termonad with the given TMConfig.

Do not perform any of the recompilation operations that the defaultMain function does.

This function does not parse command line arguments.

module Termonad.Config