imag/bin/domain/imag-log
Matthias Beyer f1a639ea8c Change id reporting API to return ExitCode
Because this API only errors when write!() errors occur, we can return
the exit code as an error here.

This way the user of the API can immediately exit if there was an IO
error, but the API automatically takes care of the right return value,
returning (exiting) with zero (0) if there was an "Broken pipe" error
and with one (1) otherwise, which is the expected behaviour here.

All calls to that API were changed accordingly.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-02-11 03:22:56 +01:00
..
src Change id reporting API to return ExitCode 2019-02-11 03:22:56 +01:00
Cargo.toml Update version strings 2018-11-10 11:56:37 +01:00
README.md Initial import: imag-log 2018-01-03 16:54:08 +01:00

README.md

Log

The "imag-log" module is a lightweight interface to the "imag-diary" command.

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 show work

which prints one log per line (including time it was logged).