update doc

This commit is contained in:
Gokcehan 2022-03-20 01:15:32 +03:00
parent 8c71e5ba9f
commit 2f9d840eda
3 changed files with 19 additions and 28 deletions

17
doc.go
View File

@ -242,7 +242,7 @@ locations:
%LOCALAPPDATA% C:\Users\<user>\AppData\Local %LOCALAPPDATA% C:\Users\<user>\AppData\Local
A sample configuration file can be found at A sample configuration file can be found at
https://github.com/gokcehan/lf/blob/master/etc/lfrc.example. https://github.com/gokcehan/lf/blob/master/etc/lfrc.example .
Commands Commands
@ -1475,12 +1475,11 @@ You may instead divide it to multiple lines in between double quotes by escaping
" "
Having such a long variable definition in a shell configuration file might be undesirable. Having such a long variable definition in a shell configuration file might be undesirable.
You may instead put this definition in a separate file and source it in your shell configuration file as follows: You may instead use the colors file for configuration.
A sample colors file can be found at
[ -f "/path/to/colors" ] && source "/path/to/colors" https://github.com/gokcehan/lf/blob/master/etc/colors.example .
You may also see the wiki page for ansi escape codes
See the wiki page for ansi escape codes https://en.wikipedia.org/wiki/ANSI_escape_code .
https://en.wikipedia.org/wiki/ANSI_escape_code.
Icons Icons
@ -1506,7 +1505,7 @@ Default values are as follows given with their matching order in lf:
ex x ex x
fi - fi -
See the wiki page for an example icons configuration A sample icons file can be found at
https://github.com/gokcehan/lf/wiki/Icons. https://github.com/gokcehan/lf/blob/master/etc/icons.example .
*/ */
package main package main

View File

@ -249,7 +249,7 @@ locations:
%LOCALAPPDATA% C:\Users\<user>\AppData\Local %LOCALAPPDATA% C:\Users\<user>\AppData\Local
A sample configuration file can be found at A sample configuration file can be found at
https://github.com/gokcehan/lf/blob/master/etc/lfrc.example. https://github.com/gokcehan/lf/blob/master/etc/lfrc.example .
Commands Commands
@ -1658,13 +1658,11 @@ newlines with backslashes as follows:
" "
Having such a long variable definition in a shell configuration file might Having such a long variable definition in a shell configuration file might
be undesirable. You may instead put this definition in a separate file and be undesirable. You may instead use the colors file for configuration. A
source it in your shell configuration file as follows: sample colors file can be found at
https://github.com/gokcehan/lf/blob/master/etc/colors.example . You may also
[ -f "/path/to/colors" ] && source "/path/to/colors" see the wiki page for ansi escape codes
https://en.wikipedia.org/wiki/ANSI_escape_code .
See the wiki page for ansi escape codes
https://en.wikipedia.org/wiki/ANSI_escape_code.
Icons Icons
@ -1692,6 +1690,6 @@ in lf:
ex x ex x
fi - fi -
See the wiki page for an example icons configuration A sample icons file can be found at
https://github.com/gokcehan/lf/wiki/Icons. https://github.com/gokcehan/lf/blob/master/etc/icons.example .
` `

12
lf.1
View File

@ -280,7 +280,7 @@ You can configure the default values of following variables to change these loca
%LOCALAPPDATA% C:\eUsers\e<user>\eAppData\eLocal %LOCALAPPDATA% C:\eUsers\e<user>\eAppData\eLocal
.EE .EE
.PP .PP
A sample configuration file can be found at https://github.com/gokcehan/lf/blob/master/etc/lfrc.example. A sample configuration file can be found at https://github.com/gokcehan/lf/blob/master/etc/lfrc.example .
.SH COMMANDS .SH COMMANDS
This section shows information about builtin commands. Modal commands do not take any arguments, but instead change the operation mode to read their input conveniently, and so they are meant to be assigned to keybindings. This section shows information about builtin commands. Modal commands do not take any arguments, but instead change the operation mode to read their input conveniently, and so they are meant to be assigned to keybindings.
.PP .PP
@ -1641,13 +1641,7 @@ Having all entries on a single line can make it hard to read. You may instead di
" "
.EE .EE
.PP .PP
Having such a long variable definition in a shell configuration file might be undesirable. You may instead put this definition in a separate file and source it in your shell configuration file as follows: Having such a long variable definition in a shell configuration file might be undesirable. You may instead use the colors file for configuration. A sample colors file can be found at https://github.com/gokcehan/lf/blob/master/etc/colors.example . You may also see the wiki page for ansi escape codes https://en.wikipedia.org/wiki/ANSI_escape_code .
.PP
.EX
[ -f "/path/to/colors" ] && source "/path/to/colors"
.EE
.PP
See the wiki page for ansi escape codes https://en.wikipedia.org/wiki/ANSI_escape_code.
.SH ICONS .SH ICONS
Icons are configured using 'LF_ICONS' environment variable or an icons file. The variable uses the same syntax as 'LS_COLORS/LF_COLORS'. Instead of colors, you should put a single characters as values of entries. Icons file should consist of whitespace separated pairs with '#' character to start comments until the end of line. Do not forget to enable 'icons' option to see the icons. Default values are as follows given with their matching order in lf: Icons are configured using 'LF_ICONS' environment variable or an icons file. The variable uses the same syntax as 'LS_COLORS/LF_COLORS'. Instead of colors, you should put a single characters as values of entries. Icons file should consist of whitespace separated pairs with '#' character to start comments until the end of line. Do not forget to enable 'icons' option to see the icons. Default values are as follows given with their matching order in lf:
.PP .PP
@ -1668,4 +1662,4 @@ Icons are configured using 'LF_ICONS' environment variable or an icons file. The
fi - fi -
.EE .EE
.PP .PP
See the wiki page for an example icons configuration https://github.com/gokcehan/lf/wiki/Icons. A sample icons file can be found at https://github.com/gokcehan/lf/blob/master/etc/icons.example .