From d01db4862b7ab2d6b94cf3f437f503e4b8c862e9 Mon Sep 17 00:00:00 2001 From: Junegunn Choi Date: Wed, 22 Jul 2015 01:12:50 +0900 Subject: [PATCH] Update documentation --- man/man1/fzf.1 | 4 ++++ src/options.go | 38 +++++++++++++++++++------------------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/man/man1/fzf.1 b/man/man1/fzf.1 index 5d369e7b..8d10d389 100644 --- a/man/man1/fzf.1 +++ b/man/man1/fzf.1 @@ -257,6 +257,10 @@ When enabled, \fBCTRL-N\fR and \fBCTRL-P\fR are automatically remapped to .BI "--history-size=" "N" Maximum number of entries in the history file (default: 1000). The file is automatically truncated when the number of the lines exceeds the value. +.TP +.BI "--header-file=" "FILE" +The content of the file will be printed as the "sticky" header. The file can +span multiple lines and can contain ANSI color codes. .SS Scripting .TP .BI "-q, --query=" "STR" diff --git a/src/options.go b/src/options.go index 4c6e9a03..e789d4e4 100644 --- a/src/options.go +++ b/src/options.go @@ -24,37 +24,37 @@ const usage = `usage: fzf [options] -n, --nth=N[,..] Comma-separated list of field index expressions for limiting search scope. Each can be a non-zero integer or a range expression ([BEGIN]..[END]) - --with-nth=N[,..] Transform item using index expressions within finder + --with-nth=N[,..] Transform item using index expressions within finder -d, --delimiter=STR Field delimiter regex for --nth (default: AWK-style) +s, --no-sort Do not sort the result - --tac Reverse the order of the input - --tiebreak=CRI Sort criterion when the scores are tied; + --tac Reverse the order of the input + --tiebreak=CRITERION Sort criterion when the scores are tied; [length|begin|end|index] (default: length) Interface -m, --multi Enable multi-select with tab/shift-tab - --ansi Enable processing of ANSI color codes - --no-mouse Disable mouse - --color=COLSPEC Base scheme (dark|light|16|bw) and/or custom colors - --black Use black background - --reverse Reverse orientation - --cycle Enable cyclic scroll - --no-hscroll Disable horizontal scroll - --inline-info Display finder info inline with the query - --prompt=STR Input prompt (default: '> ') - --bind=KEYBINDS Custom key bindings. Refer to the man page. - --history=FILE History file - --history-size=N Maximum number of history entries (default: 1000) - --header-file=N Header file + --ansi Enable processing of ANSI color codes + --no-mouse Disable mouse + --color=COLSPEC Base scheme (dark|light|16|bw) and/or custom colors + --black Use black background + --reverse Reverse orientation + --cycle Enable cyclic scroll + --no-hscroll Disable horizontal scroll + --inline-info Display finder info inline with the query + --prompt=STR Input prompt (default: '> ') + --bind=KEYBINDS Custom key bindings. Refer to the man page. + --history=FILE History file + --history-size=N Maximum number of history entries (default: 1000) + --header-file=FILE The file whose content to be printed as header Scripting -q, --query=STR Start the finder with the given query -1, --select-1 Automatically select the only match -0, --exit-0 Exit immediately when there's no match -f, --filter=STR Filter mode. Do not start interactive finder. - --print-query Print query as the first line - --expect=KEYS Comma-separated list of keys to complete fzf - --sync Synchronous search for multi-staged filtering + --print-query Print query as the first line + --expect=KEYS Comma-separated list of keys to complete fzf + --sync Synchronous search for multi-staged filtering Environment variables FZF_DEFAULT_COMMAND Default command to use when input is tty