From 2f9d840eda9d69b30ae110d6e678667e3dc89297 Mon Sep 17 00:00:00 2001 From: Gokcehan Date: Sun, 20 Mar 2022 01:15:32 +0300 Subject: [PATCH] update doc --- doc.go | 17 ++++++++--------- docstring.go | 18 ++++++++---------- lf.1 | 12 +++--------- 3 files changed, 19 insertions(+), 28 deletions(-) diff --git a/doc.go b/doc.go index 8b95cd6..04fa19c 100644 --- a/doc.go +++ b/doc.go @@ -242,7 +242,7 @@ locations: %LOCALAPPDATA% C:\Users\\AppData\Local 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 @@ -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. -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 -https://en.wikipedia.org/wiki/ANSI_escape_code. +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 diff --git a/docstring.go b/docstring.go index 7c75dd6..ae43d39 100644 --- a/docstring.go +++ b/docstring.go @@ -249,7 +249,7 @@ locations: %LOCALAPPDATA% C:\Users\\AppData\Local 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 @@ -1658,13 +1658,11 @@ 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 -https://en.wikipedia.org/wiki/ANSI_escape_code. +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 . Icons @@ -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 . ` diff --git a/lf.1 b/lf.1 index 0f53e41..0a03cea 100644 --- a/lf.1 +++ b/lf.1 @@ -280,7 +280,7 @@ You can configure the default values of following variables to change these loca %LOCALAPPDATA% C:\eUsers\e\eAppData\eLocal .EE .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 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 @@ -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 .