michael/lf
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doc

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc.go
View File

@ -1475,11 +1475,10 @@ 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.
You may instead put this definition in a separate file and source it in your shell configuration file as follows:
[ -f "/path/to/colors" ] && source "/path/to/colors"
See the wiki page for ansi escape codes
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 .
Icons
@ -1506,7 +1505,7 @@ Default values are as follows given with their matching order in lf:
ex x
fi -
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 .
*/
package main

14
docstring.go
View File

@ -1658,12 +1658,10 @@ newlines with backslashes as follows:
"
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:
[ -f "/path/to/colors" ] && source "/path/to/colors"
See the wiki page for ansi escape codes
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 .
@ -1692,6 +1690,6 @@ in lf:
ex x
fi -
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 .
`

10
lf.1
View File

@ -1641,13 +1641,7 @@ Having all entries on a single line can make it hard to read. You may instead di
"
.EE
.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:
.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.
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 .
.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:
.PP
@ -1668,4 +1662,4 @@ Icons are configured using 'LF_ICONS' environment variable or an icons file. The
fi -
.EE
.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 .