From 00fc4ffda2a99904151dd46187dc7d9889218d7d Mon Sep 17 00:00:00 2001 From: b4b4r07 Date: Tue, 4 Apr 2023 01:54:31 +0900 Subject: [PATCH] Readme --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8afd93d..d4d1a29 100644 --- a/README.md +++ b/README.md @@ -202,11 +202,14 @@ short:-G long:--ghq desc:Show ghq path func:ghq list --full-path condition:which Label | Description ---|--- -short | a short option (e.g. `-G`) -long | a long option (e.g. `--ghq`) +short (`*`) | a short option (e.g. `-G`) +long (`*`) | a long option (e.g. `--ghq`) desc | a description for the option -func | a command which returns directory list (e.g. `ghq list --full-path`) +func (`*`) | a command which returns directory list (e.g. `ghq list --full-path`) condition | a command which determine that the option should be implemented or not (e.g. `which ghq`) +format | a string which indicates how to format a line selected by the filter before passing cd command. `%` is replaced as a selected line and then passed to cd command (e.g. `$HOME/src/%`). This is useful for the case that input sources for the interactive filter are not a full-path. + +> **Note**: `*`: A required key. But either `short` or `long` is good enough.