Llewellyn/fzf
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/fzf.git synced 2024-11-29 00:06:29 +00:00
Code Issues Projects Releases Wiki Activity
559fb7ee45
fzf/man/man1/fzf-tmux.1

69 lines
2.0 KiB
Groff
Raw Normal View History

[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
.ig
The MIT License (MIT)
0.45.0
2024-01-01 00:01:43 +00:00
Copyright (c) 2013-2024 Junegunn Choi
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
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.
..
0.54.1
2024-07-19 08:10:35 +00:00
.TH fzf\-tmux 1 "Jul 2024" "fzf 0.54.1" "fzf\-tmux - open fzf in tmux split pane"
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
.SH NAME
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
fzf\-tmux - open fzf in tmux split pane
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
.SH SYNOPSIS
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B fzf\-tmux [LAYOUT OPTIONS] [\-\-] [FZF OPTIONS]
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
.SH DESCRIPTION
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
fzf\-tmux is a wrapper script for fzf that opens fzf in a tmux split pane or in
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
a tmux popup window. It is designed to work just like fzf except that it does
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
not take up the whole screen. You can safely use fzf\-tmux instead of fzf in
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
your scripts as the extra options will be silently ignored if you're not on
tmux.
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.SH LAYOUT OPTIONS
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
(default layout: \fB\-d 50%\fR)
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.SS Popup window
(requires tmux 3.2 or above)
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-p [WIDTH[%][,HEIGHT[%]]]"
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-w WIDTH[%]"
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-h WIDTH[%]"
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-x COL"
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-y ROW"
[fzf-tmux] Add option to start fzf in tmux popup window Requires latest tmux built from source (e.g. brew install tmux --HEAD) Examples: # 50%/50% width and height on the center of the screen fzf-tmux -p # 80%/80% fzf-tmux -p80% # 80%/40% fzf-tmux -p80%,40% # Separate -w and -h fzf-tmux -w80% -h40% # 80%/40% at position (0, 0) fzf-tmux -w80% -h40% -x0 -y0 You can configure key bindings and fuzzy completion to open in tmux popup window like so: FZF_TMUX_OPTS='-p 80%'
2020-03-31 13:18:09 +00:00
.SS Split pane
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-u [height[%]]"
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
Split above (up)
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-d [height[%]]"
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
Split below (down)
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-l [width[%]]"
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
Split left
.TP
[man] Escape hyphens to prevent conversion to Unicode hyphens (#3885) ASCII hyphens (U+002D HYPHEN-MINUS) in the option names (e.g. -x and --extended) and the code examples in the man pages should be escaped as \- (e.g. \-x and \-\-extended) to prevent them being converted to Unicode hyphens in some environments. For example, in openSUSE Tumbleweed, the raw ASCII hyphens in the man-page sources are configured to be the Unicode hyphen (U+2010 HYPHEN). This makes it impossible to search the option name in the man page by e.g. /--extended[RET]. A problem also arises in copying and pasting option names and code examples from the man page. It appears to be the normal ASCII hyphens by appearance (in typical terminal fonts) but are not recognized as the ASCII hyphens by the `fzf` command.
2024-06-24 00:32:35 +00:00
.B "\-r [width[%]]"
[fzf-tmux] Add man page
2016-07-10 05:44:00 +00:00
Split right
Reference in New Issue Copy Permalink