From 9547411390b36a7f2b66bef2acf6e5b8faf3742f Mon Sep 17 00:00:00 2001 From: Peter Conrad Date: Sat, 7 Jan 2023 14:04:33 -0800 Subject: [PATCH] Update docs to include time and title in arguments with `--edit` (#1657) --- docs/external-editors.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/docs/external-editors.md b/docs/external-editors.md index f679d19e..977a9de2 100644 --- a/docs/external-editors.md +++ b/docs/external-editors.md @@ -6,10 +6,31 @@ License: https://www.gnu.org/licenses/gpl-3.0.html # External editors Configure your preferred external editor by updating the `editor` option -in your [configuration file](./reference-config-file.md#editor) +in your [configuration file](./reference-config-file.md#editor). If your editor is not +in your operating system's `PATH` environment variable, then you will have to +enter the full path of your editor. -If your editor is not in your operating system's `PATH` environment variable, -then you will have to enter in the full path of your editor. +Once it's configured, you can create an entry as a new document in your editor using the `jrnl` +command by itself: + +``` text +jrnl +``` + +You can specify the time and title of the entry as usual on the first line of the document. + +If you want, you can skip the editor by including a quick entry with the `jrnl` command: + +``` text +jrnl yesterday: All my troubles seemed so far away. +``` + +If you want to start the entry on the command line and continue writing in your chosen editor, +use the `--edit` flag. For example: + +``` text +jrnl yesterday: All my troubles seemed so far away. --edit +``` !!! note To save and log any entry edits, save and close the file. @@ -99,4 +120,4 @@ When you're done editing the message, save and `C-x #` to close the buffer and s ## Other editors -If you're using another editor and would like to share, feel free to [contribute documentation](./contributing.md#editing-documentation) on it. \ No newline at end of file +If you're using another editor and would like to share, feel free to [contribute documentation](./contributing.md#editing-documentation) on it.