Minor tweaks to help text, README, Changelog

This commit is contained in:
Stephen Seo 2024-06-10 18:44:04 +09:00
parent 3de3f9f2c9
commit c29047b2f4
3 changed files with 9 additions and 1 deletions

View file

@ -1,5 +1,9 @@
# Changelog for break\_interval # Changelog for break\_interval
## Upcoming Changes
Minor tweaks to help text, README.
## Version 1.1 ## Version 1.1
Change usage of internal audio to use a Unix pipe instead of reading from Change usage of internal audio to use a Unix pipe instead of reading from

View file

@ -5,7 +5,10 @@ meant to be used as a way to notify the user to take a break when the interval
jingle plays. jingle plays.
# For usage: # For usage:
./break_interval --help > ./break_interval --help
./program [minutes] [file_to_play_on_interval] [player_program] [player_args...]
minutes defaults to 5, file defaults to internal file, program defaults to "/usr/bin/mpv".
Note that this program uses execl/execv, so if a program is specified, it must be the full path to the program.
Running the program with no args will default to playing a jingle every 5 Running the program with no args will default to playing a jingle every 5
minutes. minutes.

View file

@ -141,6 +141,7 @@ int play_jingle_from_memory(const char *jingle_data,
void print_help(void) { void print_help(void) {
puts("./program [minutes] [file_to_play_on_interval] [player_program] [player_args...]"); puts("./program [minutes] [file_to_play_on_interval] [player_program] [player_args...]");
puts(" minutes defaults to 5, file defaults to internal file, program defaults to \"/usr/bin/mpv\"."); puts(" minutes defaults to 5, file defaults to internal file, program defaults to \"/usr/bin/mpv\".");
puts("Note that this program uses execl/execv, so if a program is specified, it must be the full path to the program.");
} }
int main(int argc, char **argv) { int main(int argc, char **argv) {