diff options
author | Joe Lim <50560759+joelim-work@users.noreply.github.com> | 2024-01-18 14:51:04 +1100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-18 14:51:04 +1100 |
commit | 8a14749154c2c11fce4fec0188dc204c012bd3e9 (patch) | |
tree | 1d4a584f76531323d29277229051011bd8b51c59 | |
parent | b401318046c4d4260ab982e9a4ce1dabf5b5623f (diff) |
Update generated documentation (#1580)
-rw-r--r-- | doc.txt | 146 | ||||
-rw-r--r-- | lf.1 | 144 |
2 files changed, 163 insertions, 127 deletions
@@ -126,69 +126,73 @@ The following command line commands are provided by lf: The following options can be used to customize the behavior of lf: - anchorfind bool (default true) - autoquit bool (default false) - borderfmt string (default "\033[0m") - cleaner string (default '') - cursoractivefmt string (default "\033[7m") - cursorparentfmt string (default "\033[7m") - cursorpreviewfmt string (default "\033[4m") - dircache bool (default true) - dircounts bool (default false) - dirfirst bool (default true) - dironly bool (default false) - dirpreviews bool (default false) - drawbox bool (default false) - dupfilefmt string (default '%f.~%n~') - errorfmt string (default "\033[7;31;47m") - filesep string (default "\n") - findlen int (default 1) - globsearch bool (default false) - hidden bool (default false) - hiddenfiles []string (default '.*') - history bool (default true) - icons bool (default false) - ifs string (default '') - ignorecase bool (default true) - ignoredia bool (default true) - incfilter bool (default false) - incsearch bool (default false) - info []string (default '') - infotimefmtnew string (default 'Jan _2 15:04') - infotimefmtold string (default 'Jan _2 2006') - mouse bool (default false) - number bool (default false) - numberfmt string (default "\033[33m") - period int (default 0) - preserve []string (default "mode") - preview bool (default true) - previewer string (default '') - promptfmt string (default "\033[32;1m%u@%h\033[0m:\033[34;1m%d\033[0m\033[1m%f\033[0m") - ratios []int (default '1:2:3') - relativenumber bool (default false) - reverse bool (default false) - ruler []string (default 'acc:progress:selection:filter:ind') - rulerfmt string (default " %a| %p| \033[7;31m %m \033[0m| \033[7;33m %c \033[0m| \033[7;35m %s \033[0m| \033[7;34m %f \033[0m| %i/%t") - scrolloff int (default 0) - selmode string (default 'all') - shell string (default 'sh' for Unix and 'cmd' for Windows) - shellflag string (default '-c' for Unix and '/c' for Windows) - shellopts []string (default '') - sixel bool (default false) - smartcase bool (default true) - smartdia bool (default false) - sortby string (default 'natural') - statfmt string (default "\033[36m%p\033[0m| %c| %u| %g| %S| %t| -> %l") - tabstop int (default 8) - tagfmt string (default "\033[31m") - tempmarks string (default '') - timefmt string (default 'Mon Jan _2 15:04:05 2006') - truncatechar string (default '~') - truncatepct int (default 100) - waitmsg string (default 'Press any key to continue') - wrapscan bool (default true) - wrapscroll bool (default false) - user_{option} string (default none) + anchorfind bool (default true) + autoquit bool (default false) + borderfmt string (default "\033[0m") + cleaner string (default '') + copyfmt string (default "\033[7;33m") + cursoractivefmt string (default "\033[7m") + cursorparentfmt string (default "\033[7m") + cursorpreviewfmt string (default "\033[4m") + cutfmt string (default "\033[7;31m") + dircache bool (default true) + dircounts bool (default false) + dirfirst bool (default true) + dironly bool (default false) + dirpreviews bool (default false) + drawbox bool (default false) + dupfilefmt string (default '%f.~%n~') + errorfmt string (default "\033[7;31;47m") + filesep string (default "\n") + findlen int (default 1) + globsearch bool (default false) + hidden bool (default false) + hiddenfiles []string (default '.*') + hidecursorinactive bool (default false) + history bool (default true) + icons bool (default false) + ifs string (default '') + ignorecase bool (default true) + ignoredia bool (default true) + incfilter bool (default false) + incsearch bool (default false) + info []string (default '') + infotimefmtnew string (default 'Jan _2 15:04') + infotimefmtold string (default 'Jan _2 2006') + mouse bool (default false) + number bool (default false) + numberfmt string (default "\033[33m") + period int (default 0) + preserve []string (default "mode") + preview bool (default true) + previewer string (default '') + promptfmt string (default "\033[32;1m%u@%h\033[0m:\033[34;1m%d\033[0m\033[1m%f\033[0m") + ratios []int (default '1:2:3') + relativenumber bool (default false) + reverse bool (default false) + ruler []string (default 'acc:progress:selection:filter:ind') + rulerfmt string (default " %a| %p| \033[7;31m %m \033[0m| \033[7;33m %c \033[0m| \033[7;35m %s \033[0m| \033[7;34m %f \033[0m| %i/%t") + scrolloff int (default 0) + selectfmt string (default "\033[7;35m") + selmode string (default 'all') + shell string (default 'sh' for Unix and 'cmd' for Windows) + shellflag string (default '-c' for Unix and '/c' for Windows) + shellopts []string (default '') + sixel bool (default false) + smartcase bool (default true) + smartdia bool (default false) + sortby string (default 'natural') + statfmt string (default "\033[36m%p\033[0m| %c| %u| %g| %S| %t| -> %l") + tabstop int (default 8) + tagfmt string (default "\033[31m") + tempmarks string (default '') + timefmt string (default 'Mon Jan _2 15:04:05 2006') + truncatechar string (default '~') + truncatepct int (default 100) + waitmsg string (default 'Press any key to continue') + wrapscan bool (default true) + wrapscroll bool (default false) + user_{option} string (default none) The following environment variables are exported for shell commands: @@ -705,6 +709,10 @@ height, (4) horizontal position, (5) vertical position of preview pane and (6) next file name to be previewed respectively. Preview cleaning is disabled when the value of this option is left empty. +copyfmt (string) (default \033[7;33m) + +Format string of the indicator for files to be copied. + cursoractivefmt (string) (default \033[7m), cursorparentfmt string (default \033[7m), cursorpreviewfmt string (default \033[4m) Format strings for highlighting the cursor. cursoractivefmt applies in @@ -725,6 +733,10 @@ format string for fmt.Sprintf. Such a string should end with the terminal reset sequence. For example, \033[4m%s\033[0m has the same effect as \033[4m. +cutfmt (string) (default \033[7;31m) + +Format string of the indicator for files to be cut. + dircache (bool) (default true) Cache directory contents. @@ -806,6 +818,10 @@ match character sets or ranges. In addition, if a pattern starts with !, then its matches are excluded from hidden files. To add multiple patterns, use : as a separator. Example: .*:lost+found:*.bak +hidecursorinactive (bool) (default false) + +Hide the cursor when the terminal or tmux pane loses focus. + history (bool) (default true) Save command history. @@ -972,6 +988,10 @@ user-defined options, in the form %{lf_user_<name>} (e.g. Any section containing a failed expansion (result is a blank string) is discarded and not shown. +selectfmt (string) (default \033[7;35m) + +Format string of the indicator for files that are selected. + selmode (string) (default all) Selection mode for commands. When set to all it will use the selected @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.11.4 .\" -.TH "LF" "1" "2023-12-19" "r27-218-g39ad76d" "DOCUMENTATION" +.TH "LF" "1" "2024-01-18" "" "DOCUMENTATION" .hy .SH NAME .PP @@ -144,69 +144,73 @@ The following options can be used to customize the behavior of lf: .IP .nf \f[C] -anchorfind bool (default true) -autoquit bool (default false) -borderfmt string (default \[dq]\[rs]033[0m\[dq]) -cleaner string (default \[aq]\[aq]) -cursoractivefmt string (default \[dq]\[rs]033[7m\[dq]) -cursorparentfmt string (default \[dq]\[rs]033[7m\[dq]) -cursorpreviewfmt string (default \[dq]\[rs]033[4m\[dq]) -dircache bool (default true) -dircounts bool (default false) -dirfirst bool (default true) -dironly bool (default false) -dirpreviews bool (default false) -drawbox bool (default false) -dupfilefmt string (default \[aq]%f.\[ti]%n\[ti]\[aq]) -errorfmt string (default \[dq]\[rs]033[7;31;47m\[dq]) -filesep string (default \[dq]\[rs]n\[dq]) -findlen int (default 1) -globsearch bool (default false) -hidden bool (default false) -hiddenfiles []string (default \[aq].*\[aq]) -history bool (default true) -icons bool (default false) -ifs string (default \[aq]\[aq]) -ignorecase bool (default true) -ignoredia bool (default true) -incfilter bool (default false) -incsearch bool (default false) -info []string (default \[aq]\[aq]) -infotimefmtnew string (default \[aq]Jan _2 15:04\[aq]) -infotimefmtold string (default \[aq]Jan _2 2006\[aq]) -mouse bool (default false) -number bool (default false) -numberfmt string (default \[dq]\[rs]033[33m\[dq]) -period int (default 0) -preserve []string (default \[dq]mode\[dq]) -preview bool (default true) -previewer string (default \[aq]\[aq]) -promptfmt string (default \[dq]\[rs]033[32;1m%u\[at]%h\[rs]033[0m:\[rs]033[34;1m%d\[rs]033[0m\[rs]033[1m%f\[rs]033[0m\[dq]) -ratios []int (default \[aq]1:2:3\[aq]) -relativenumber bool (default false) -reverse bool (default false) -ruler []string (default \[aq]acc:progress:selection:filter:ind\[aq]) -rulerfmt string (default \[dq] %a| %p| \[rs]033[7;31m %m \[rs]033[0m| \[rs]033[7;33m %c \[rs]033[0m| \[rs]033[7;35m %s \[rs]033[0m| \[rs]033[7;34m %f \[rs]033[0m| %i/%t\[dq]) -scrolloff int (default 0) -selmode string (default \[aq]all\[aq]) -shell string (default \[aq]sh\[aq] for Unix and \[aq]cmd\[aq] for Windows) -shellflag string (default \[aq]-c\[aq] for Unix and \[aq]/c\[aq] for Windows) -shellopts []string (default \[aq]\[aq]) -sixel bool (default false) -smartcase bool (default true) -smartdia bool (default false) -sortby string (default \[aq]natural\[aq]) -statfmt string (default \[dq]\[rs]033[36m%p\[rs]033[0m| %c| %u| %g| %S| %t| -> %l\[dq]) -tabstop int (default 8) -tagfmt string (default \[dq]\[rs]033[31m\[dq]) -tempmarks string (default \[aq]\[aq]) -timefmt string (default \[aq]Mon Jan _2 15:04:05 2006\[aq]) -truncatechar string (default \[aq]\[ti]\[aq]) -truncatepct int (default 100) -waitmsg string (default \[aq]Press any key to continue\[aq]) -wrapscan bool (default true) -wrapscroll bool (default false) -user_{option} string (default none) +anchorfind bool (default true) +autoquit bool (default false) +borderfmt string (default \[dq]\[rs]033[0m\[dq]) +cleaner string (default \[aq]\[aq]) +copyfmt string (default \[dq]\[rs]033[7;33m\[dq]) +cursoractivefmt string (default \[dq]\[rs]033[7m\[dq]) +cursorparentfmt string (default \[dq]\[rs]033[7m\[dq]) +cursorpreviewfmt string (default \[dq]\[rs]033[4m\[dq]) +cutfmt string (default \[dq]\[rs]033[7;31m\[dq]) +dircache bool (default true) +dircounts bool (default false) +dirfirst bool (default true) +dironly bool (default false) +dirpreviews bool (default false) +drawbox bool (default false) +dupfilefmt string (default \[aq]%f.\[ti]%n\[ti]\[aq]) +errorfmt string (default \[dq]\[rs]033[7;31;47m\[dq]) +filesep string (default \[dq]\[rs]n\[dq]) +findlen int (default 1) +globsearch bool (default false) +hidden bool (default false) +hiddenfiles []string (default \[aq].*\[aq]) +hidecursorinactive bool (default false) +history bool (default true) +icons bool (default false) +ifs string (default \[aq]\[aq]) +ignorecase bool (default true) +ignoredia bool (default true) +incfilter bool (default false) +incsearch bool (default false) +info []string (default \[aq]\[aq]) +infotimefmtnew string (default \[aq]Jan _2 15:04\[aq]) +infotimefmtold string (default \[aq]Jan _2 2006\[aq]) +mouse bool (default false) +number bool (default false) +numberfmt string (default \[dq]\[rs]033[33m\[dq]) +period int (default 0) +preserve []string (default \[dq]mode\[dq]) +preview bool (default true) +previewer string (default \[aq]\[aq]) +promptfmt string (default \[dq]\[rs]033[32;1m%u\[at]%h\[rs]033[0m:\[rs]033[34;1m%d\[rs]033[0m\[rs]033[1m%f\[rs]033[0m\[dq]) +ratios []int (default \[aq]1:2:3\[aq]) +relativenumber bool (default false) +reverse bool (default false) +ruler []string (default \[aq]acc:progress:selection:filter:ind\[aq]) +rulerfmt string (default \[dq] %a| %p| \[rs]033[7;31m %m \[rs]033[0m| \[rs]033[7;33m %c \[rs]033[0m| \[rs]033[7;35m %s \[rs]033[0m| \[rs]033[7;34m %f \[rs]033[0m| %i/%t\[dq]) +scrolloff int (default 0) +selectfmt string (default \[dq]\[rs]033[7;35m\[dq]) +selmode string (default \[aq]all\[aq]) +shell string (default \[aq]sh\[aq] for Unix and \[aq]cmd\[aq] for Windows) +shellflag string (default \[aq]-c\[aq] for Unix and \[aq]/c\[aq] for Windows) +shellopts []string (default \[aq]\[aq]) +sixel bool (default false) +smartcase bool (default true) +smartdia bool (default false) +sortby string (default \[aq]natural\[aq]) +statfmt string (default \[dq]\[rs]033[36m%p\[rs]033[0m| %c| %u| %g| %S| %t| -> %l\[dq]) +tabstop int (default 8) +tagfmt string (default \[dq]\[rs]033[31m\[dq]) +tempmarks string (default \[aq]\[aq]) +timefmt string (default \[aq]Mon Jan _2 15:04:05 2006\[aq]) +truncatechar string (default \[aq]\[ti]\[aq]) +truncatepct int (default 100) +waitmsg string (default \[aq]Press any key to continue\[aq]) +wrapscan bool (default true) +wrapscroll bool (default false) +user_{option} string (default none) \f[R] .fi .PP @@ -726,6 +730,9 @@ The following arguments are passed to the file, (1) current file name, preview pane and (6) next file name to be previewed respectively. Preview cleaning is disabled when the value of this option is left empty. +.SS copyfmt (string) (default \f[C]\[rs]033[7;33m\f[R]) +.PP +Format string of the indicator for files to be copied. .SS cursoractivefmt (string) (default \f[C]\[rs]033[7m\f[R]), cursorparentfmt string (default \f[C]\[rs]033[7m\f[R]), cursorpreviewfmt string (default \f[C]\[rs]033[4m\f[R]) .PP Format strings for highlighting the cursor. @@ -748,6 +755,9 @@ interpreted as a format string for \f[C]fmt.Sprintf\f[R]. Such a string should end with the terminal reset sequence. For example, \f[C]\[rs]033[4m%s\[rs]033[0m\f[R] has the same effect as \f[C]\[rs]033[4m\f[R]. +.SS cutfmt (string) (default \f[C]\[rs]033[7;31m\f[R]) +.PP +Format string of the indicator for files to be cut. .SS dircache (bool) (default true) .PP Cache directory contents. @@ -830,6 +840,9 @@ In addition, if a pattern starts with \f[C]!\f[R], then its matches are excluded from hidden files. To add multiple patterns, use \f[C]:\f[R] as a separator. Example: \f[C].*:lost+found:*.bak\f[R] +.SS hidecursorinactive (bool) (default false) +.PP +Hide the cursor when the terminal or tmux pane loses focus. .SS history (bool) (default true) .PP Save command history. @@ -1003,6 +1016,9 @@ Expansions are also provided for user-defined options, in the form The \f[C]|\f[R] character splits the format string into sections. Any section containing a failed expansion (result is a blank string) is discarded and not shown. +.SS selectfmt (string) (default \f[C]\[rs]033[7;35m\f[R]) +.PP +Format string of the indicator for files that are selected. .SS selmode (string) (default \f[C]all\f[R]) .PP Selection mode for commands. |