From 5953729c2a5e4b9233dc5a96211a33ca6c509fc3 Mon Sep 17 00:00:00 2001 From: Martin Dvorak Date: Mon, 16 Dec 2019 22:34:15 +0100 Subject: [PATCH] Making keys documentation convention consistent. --- INSTALLATION.md | 4 ++-- README.md | 2 +- doc/USER-DOCUMENTATION.md | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/INSTALLATION.md b/INSTALLATION.md index 9378adf..db6c5ab 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -338,7 +338,7 @@ hstr --show-configuration >> ~/.bashrc . ~/.bashrc ``` -Make sure to **run** HSTR using Ctrlr (or `hstrwsl`) - otherwise commands will not appear in prompt. +Make sure to **run** HSTR using Ctrl-r (or `hstrwsl`) - otherwise commands will not appear in prompt. [Configure](CONFIGURATION.md) HSTR and check its [man page](README.md#documentation). @@ -369,7 +369,7 @@ hstr --show-configuration >> ~/.bashrc . ~/.bashrc ``` -Make sure to **run** HSTR using Ctrlr (or `hstrcygwin`) - otherwise commands will not appear in prompt. +Make sure to **run** HSTR using Ctrl-r (or `hstrcygwin`) - otherwise commands will not appear in prompt. [Configure](CONFIGURATION.md) HSTR and check its [man page](README.md#documentation). ## Build on macOS diff --git a/README.md b/README.md index 6146818..c870688 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ again? Are you looking for a tool that is able to manage your HSTR (**H**i**ST**o**R**y) is a command line utility that brings improved Bash/zsh command completion from the history. It aims to make completion **easier** and more **efficient** -than Ctrlr. +than Ctrl-r. HSTR can also **manage** your command history (for instance you can remove commands that are obsolete or contain a piece of sensitive information) diff --git a/doc/USER-DOCUMENTATION.md b/doc/USER-DOCUMENTATION.md index 982c71b..2722fa9 100644 --- a/doc/USER-DOCUMENTATION.md +++ b/doc/USER-DOCUMENTATION.md @@ -18,7 +18,7 @@ Table of contents: * Examples # Features -HSTR is typically started by pressing Ctrlr after +HSTR is typically started by pressing Ctrl-r after you configure it for this shorcut in your shell. However, you can run it as a normal program just by typing: @@ -71,10 +71,10 @@ HSTR allows you to store and manage your favorite commands. A new favorite command can be added from -ranking or raw history view by pressing Ctrlf. +ranking or raw history view by pressing Ctrl-f. You can check your favorite commands by choosing -favorite view - rotate views using Ctrl/ or start +favorite view - rotate views using Ctrl-/ or start HSTR by adding `favorites-view` to `HSTR_CONFIG` environment property. A favorite command can be choosen just by pressing `ENTER` when on command in favorite view. @@ -138,7 +138,7 @@ hstr --kill-last-command ``` See configuration section for how to bind this functionality to -a key - bound to Ctrlx k by default. +a key - bound to Ctrl-k by default. # Examples