diary

commit 8676402908970f082416d55194ffe6d6833c73fc
parent ef1014100c69cdc5dd93edc5104d3f9c67d7dae9
Author: Andreas Gruhler <agruhl@gmx.ch>
Date:   Sat, 11 Dec 2021 21:24:44 +0100

document formatters

Diffstat:
M
README.md
 | 
10
++++++++++

1 file changed, 10 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -169,6 +169,16 @@ $ rm ${XDG_CONFIG_HOME:-~/.config}/diary/diary.cfg
 $ diary
 ```
 
+## Custom Formatting
+
+The preview of the journal entries can be processed with a custom `--fmt-cmd`, `-F` or `fmt_cmd` in the [configuration file](#Configuration_File).
+
+The result of this formatting command is printed to a pseudo-terminal (pty) by default (behavior can be changed with the `--no-pty` flag).
+
+The output processed on the pty (not with Ncurses, without `--no-pty` flag) includes all ANSI escape characters supported by the terminal (colors, font types, etc.).
+
+Thus, formatters like `fmt` or any "cat like program" such as [`mdcat`](https://github.com/lunaryorn/mdcat) to process Markdown can be plugged in for `--fmt-cmd`.
+
 ## Import/Export (alpha)
 
 The import functionality can be triggered by pressing `i`.