summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJunegunn Choi <junegunn.c@gmail.com>2020-07-27 00:15:25 +0900
committerJunegunn Choi <junegunn.c@gmail.com>2020-07-27 00:27:03 +0900
commit0f9cb5590ec0a397143a7a4caf003a54885f4375 (patch)
tree68f3e5e8adf27919e3656d741ecadce6d5f6f2c8 /man
parentc0a83b27eb0e2a9a1f631d04830a7dc6d762a951 (diff)
Add preview window option for setting the initial scroll offset
Close #1057 Close #2120 # Initial scroll offset is set to the line number of each line of # git grep output *minus* 5 lines git grep --line-number '' | fzf --delimiter : --preview 'nl {1}' --preview-window +{2}-5
Diffstat (limited to 'man')
-rw-r--r--man/man1/fzf.121
1 files changed, 17 insertions, 4 deletions
diff --git a/man/man1/fzf.1 b/man/man1/fzf.1
index 878b30b5..ed8328c2 100644
--- a/man/man1/fzf.1
+++ b/man/man1/fzf.1
@@ -21,7 +21,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
..
-.TH fzf 1 "Jun 2020" "fzf 0.22.0" "fzf - a command-line fuzzy finder"
+.TH fzf 1 "Jul 2020" "fzf 0.22.0" "fzf - a command-line fuzzy finder"
.SH NAME
fzf - a command-line fuzzy finder
@@ -381,7 +381,7 @@ Preview window will be updated even when there is no match for the current
query if any of the placeholder expressions evaluates to a non-empty string.
.RE
.TP
-.BI "--preview-window=" "[POSITION][:SIZE[%]][:noborder][:wrap][:hidden]"
+.BI "--preview-window=" "[POSITION][:SIZE[%]][:noborder][:wrap][:hidden][:+SCROLL[-OFFSET]]"
Determines the layout of the preview window. If the argument contains
\fB:hidden\fR, the preview window will be hidden by default until
\fBtoggle-preview\fR action is triggered. Long lines are truncated by default.
@@ -390,6 +390,12 @@ Line wrap can be enabled with \fB:wrap\fR flag.
If size is given as 0, preview window will not be visible, but fzf will still
execute the command in the background.
+\fB+SCROLL[-OFFSET]\fR determines the initial scroll offset of the preview
+window. \fBSCROLL\fR can be either a numeric integer or a single-field index
+expression that refers to a numeric integer. The optional \fB-OFFSET\fR part is
+for adjusting the base offset so that you can see the text above it. It should
+be given as a numeric integer.
+
.RS
.B POSITION: (default: right)
\fBup
@@ -400,8 +406,15 @@ execute the command in the background.
.RS
e.g.
- \fBfzf --preview="head {}" --preview-window=up:30%
- fzf --preview="file {}" --preview-window=down:1\fR
+ \fB# Non-default scroll window positions and sizes
+ fzf --preview="head {}" --preview-window=up:30%
+ fzf --preview="file {}" --preview-window=down:1
+
+ # Initial scroll offset is set to the line number of each line of
+ # git grep output *minus* 5 lines
+ git grep --line-number '' |
+ fzf --delimiter : --preview 'nl {1}' --preview-window +{2}-5\fR
+
.RE
.SS Scripting
.TP