From 05234590ebd18a99f306f247f73e7e0f2c969bda Mon Sep 17 00:00:00 2001 From: Greg Bodnar Date: Sun, 4 Aug 2019 15:23:33 +1200 Subject: [PATCH] Update docs Add doc about extracting timestamps with no spaces Timestamp formats may have no space between date and time components and cause the script to fail. In Encryption docs, explain how to prevent Fish history logging --- docs/encryption.md | 6 ++++++ docs/recipes.md | 5 ++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/encryption.md b/docs/encryption.md index 19bb178b..63859d91 100644 --- a/docs/encryption.md +++ b/docs/encryption.md @@ -56,6 +56,12 @@ setopt HIST_IGNORE_SPACE alias jrnl=" jrnl" ``` +The fish shell does not support automatically preventing logging like +this. To prevent `jrnl` commands being logged by fish, you must make +sure to type a space before every `jrnl` command you enter. To delete +existing `jrnl` commands from fish’s history, run +`history delete --prefix 'jrnl '`. + ## Manual decryption Should you ever want to decrypt your journal manually, you can do so diff --git a/docs/recipes.md b/docs/recipes.md index 45ef18b4..570b3a8c 100644 --- a/docs/recipes.md +++ b/docs/recipes.md @@ -97,7 +97,10 @@ log_question 'What did I make progress with?' ### Display random entry You can use this to select one title at random and then display the whole -entry. +entry. The invocation of `cut` needs to match the format of the timestamp. +For timestamps that have a space between data and time components, select +fields 1 and 2 as shown. For timestamps that have no whitespace, select +only field 1. ``` sh jrnl -on "$(jrnl --short | shuf -n 1 | cut -d' ' -f1,2)"