diff --git a/doc/src/04020-module-log.md b/doc/src/04020-module-log.md index b886391e..0f213a07 100644 --- a/doc/src/04020-module-log.md +++ b/doc/src/04020-module-log.md @@ -6,10 +6,35 @@ It is intended as a tumbeblog-like diary, where one does not care to fire up an editor and type in a long text, but rather type a few words and forget about it: +### Usage + +Logs can be created via an entry in the configuration file in the section `log`: + ``` -imag log --to work "Copying large amounts of data takes time" +[log] +logs = ["work", "hobby", "music"] +default = "hobby" ``` -Everything which can be done with `imag-log` can also be done with -`imag-diary`. +The `default` key is required and the name which is used here _must_ appear in +the `logs` array. + +In the above configuration snippet, the logs `work`, `hobby` and `music` are +created. The user may now log to one of these logs with: + +``` +imag log --to "Some message" +# or +imag log -t "Some message" +# or, to the default log: +imag log "Some message" +``` + +Logs can be read by naming the log: + +``` +imag log show work +``` + +which prints one log per line (including time it was logged).