matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add example usage for the log functionality

Browse source
This commit is contained in:
Matthias Beyer 2017-12-19 19:24:56 +01:00
parent 7a364639ee
commit 0865984d6f
1 changed files with 28 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
doc/src/04020-module-log.md
View file

@ -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 <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 show work
```
which prints one log per line (including time it was logged).