Configuration Files

worklog comes with a default configuration file that looks like this:

[worklog]
# Determines where the worklog backend file is located.
path = ~/.worklog

# Defines how many entries of the logfile should be printable to STDOUT before
# using a pager.
no_pager_max_entries = 10

[workday]
# Defines how many hours per day should be worked.
hours_target = 8
# Defines how many working hours per day are the upper limit.
# This value should be larger or equal than `workday.hours_target`.
hours_max = 10

# Define the lower limits of minutes to work until the corresponding break is
# automatically applied.
# e.g. auto_break_limit_minutes = [0,360,540]
auto_break_limit_minutes = []
# Defines the break durations in minutes for the interval boundaries above.
# e.g. auto_break_duration_minutes = [0,30,45]
auto_break_duration_minutes = []

It is possible to overwrite single or multiple configuration values by creating a file ~/.config/worklog/config which will overwrite the default configuration values.

For the sake of an example let us assume that a personalized config file has been created with the following content.

[worklog]
path = ~/.my-worklog-file

[workday]
hours_max = 12

Those configuration changes how change where the worklog file is located. worklog now uses the file ~/.my-worklog-file as its back-end. Also the soft-limit has been increased from 10 hours to 12 hours.

Any value in the default configuration can be overwritten in this way. For example in the section Automatic Break Handling the configuration file will be modified in order to configure automatic breaks.