peaclock

The binary clock view uses columns to represent digits for Hours (H), Minutes (M), and Seconds (S). Each digit is composed of four bits (values 8, 4, 2, and 1).

To get the value of a digit, add up the bits that are 'on'.

  |   |   | < 8
  | | | | | < 4
| | | | | | < 2
| | | | | | < 1
H H M M S S < Time Digit

Peaclock's output is determined by the combination of a mode and a view:

• Modes: Determine the clock value (e.g., clock, timer, or stopwatch).
• Views: Determine how that value is presented (e.g., ascii, digital, or binary).

Users can customize the clock's appearance, including width, height, color, padding, and margin. In auto size mode, the clock is responsive and fills the terminal, or can be set to a specific aspect ratio to prevent stretching.

You can specify a custom configuration file or directory to initialize peaclock with specific settings.

• Use --config=<file> to use a specific file for initialization. All other initializations are skipped. Use the special name NONE to skip all initializations.
• Use --config-dir=<dir> to use a specific directory as the config directory. Use NONE to skip all initializations.

Note: The config directory and file must be created by the user. If using a directory, the config file must be named config.

Default config directory: ${HOME}/.peaclock

peaclock --config "./path/to/config/file"
peaclock --config-dir "~/.config/peaclock"

The default Apple Clang compiler does not support C++17 features like std::filesystem. You must install a newer version of gcc or clang (e.g., via Homebrew).

1. Install and link GCC:

brew install gcc
brew link gcc

2. Build using the RUNME.sh script, passing the path to the new compiler via CMake arguments:

./RUNME.sh build -- -DCMAKE_CXX_COMPILER='<path-to-g++>'

Note: Replace <path-to-g++> with the actual path to your new compiler binary.

# Install GCC via Brew
brew install gcc
brew link gcc

# Build with specific compiler
./RUNME.sh build -- -DCMAKE_CXX_COMPILER='/usr/local/bin/g++'

Peaclock provides a shell script RUNME.sh to handle building and installation in release mode.

To build the project:

./RUNME.sh build

To install the project:

./RUNME.sh install

# Build
./RUNME.sh build

# Install
./RUNME.sh install

Once peaclock is running, you can switch between different functional modes and visual styles using keyboard shortcuts:

Modes

• w: Mode clock (displays current time)
• e: Mode timer (displays the timer)
• r: Mode stopwatch (displays the stopwatch)

Views

• W: View date
• E: View ascii clock
• R: View digital clock
• T: View binary clock
• Y: View icon clock

Controls

• : Start/stop timer or stopwatch
• <backspace>: Clear timer or stopwatch
• a: Toggle 24-hour time
• s: Toggle seconds
• d: Toggle date
• q, Q, or <ctrl-c>: Quit the program

peaclock allows you to save your current runtime settings into a configuration file using the command prompt (accessed via :).

• mkconfig <file>: Creates <file> and writes the current configuration settings to it.
• mkconfig! <file>: Overwrites or creates <file> and writes the current configuration settings to it.

Configuration files are plain text files where each command is on its own line. Lines starting with # are treated as comments.

# Example of a config file content
mode clock
view digital
set seconds on
style background blue

When a configuration directory is provided or detected, Peaclock expects and manages a specific directory structure to persist settings and command history:

• Configuration Directory: The root folder for Peaclock settings (defaults to ~/.peaclock).
• history/ subdirectory: A directory within the configuration directory used to store history files.
• history/command: A specific file within the history directory used to load command history.
• config file: The main configuration file located at the root of the configuration directory.

You can configure peaclock to run a specific shell command automatically when a timer finishes using the timer-exec command.

• timer-exec <str>: Sets the string to be executed by a shell upon timer completion. Passing an empty string clears this setting.

# Example command to enter in the prompt
timer-exec "notify-send 'Timer Finished!'"

The peaclock binary accepts several command-line flags for control and output formatting:

• --colour=<on|off|auto>: Controls color output for program info. auto detects if stdout is a TTY.
• -u, --config=<file>: Use the commands in the specified file for initialization. All other initializations are skipped.
• --config-dir=<dir>: Use the specified directory as the config directory.
• -h, --help: Print the help output.
• --license: Print the program license.
• -v, --version: Print the program version.

peaclock --help --colour=off
peaclock --version