OKABE(1)
2024-05-07
NAME ¶
okabe - OSC-controlled timer for the terminal
SYNOPSIS ¶
okabe [-f <okabe.ini>] [-p <port>] [-v]
DESCRIPTION ¶
okabe is an OSC-controlled timer application for the terminal.
The options are as follows:
-f <okabe.ini>
Specify the path of the initialization file. This option defaults to "okabe.ini".
-p <port>
Set the port on which to listen for OSC messages. This option defaults to 7602.
-v
Print the version information and exit.
The timers along with their initial remaining time are specified through an initialization file. The format of this file is documented in the okabe(5) manual page. A timer's name can not exceed 8 characters. Otherwise, it will be cut. Every timer can be controlled using three OSC addresses:
| Address | Description |
| /<name>/toggle | Toggles the timer on/off. This command does not take an argument. |
| /<name>/add | Adds time to the timer. The first argument is an int32 representing the number of seconds to add. |
| /<name>/sub | Subtracts time from the timer. The first argument is an int32 representing the number of seconds to subtract. |
EXIT STATUS ¶
okabe exits with a value >0 in case of an error. Otherwise, the exit status is 0.
SEE ALSO ¶
okabe(5)
AUTHORS ¶
Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/okabe. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.