diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2017-12-19 19:24:56 +0100 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2018-01-03 16:54:08 +0100 |
commit | 0865984d6f80b1d8ceefd7492a71eacaa6b04d42 (patch) | |
tree | c7cd1cc56c354853a0af2dcc182bd04bd2c8959a /doc | |
parent | 7a364639ee992efa41c6a6183587c31d63bbe699 (diff) |
Add example usage for the log functionality
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/04020-module-log.md | 31 |
1 files changed, 28 insertions, 3 deletions
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`: + +``` +[log] +logs = ["work", "hobby", "music"] +default = "hobby" +``` + +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 <logname> "Some message" +# or +imag log -t <logname> "Some message" +# or, to the default log: +imag log "Some message" +``` + +Logs can be read by naming the log: + ``` -imag log --to work "Copying large amounts of data takes time" +imag log show work ``` -Everything which can be done with `imag-log` can also be done with -`imag-diary`. +which prints one log per line (including time it was logged). |