Update documentation (#1755)

doc.txt

@@ -148,7 +148,7 @@ The following options can be used to customize the behavior of lf:
     globfilter          bool      (default false)
     globsearch          bool      (default false)
     hidden              bool      (default false)
-    hiddenfiles         []string  (default '.*')
+    hiddenfiles         []string  (default '.*' for Unix and '' for Windows)
     hidecursorinactive  bool      (default false)
     history             bool      (default true)
     icons               bool      (default false)
@@ -192,6 +192,7 @@ The following options can be used to customize the behavior of lf:
     truncatechar        string    (default '~')
     truncatepct         int       (default 100)
     waitmsg             string    (default 'Press any key to continue')
+    watch               bool      (default false)
     wrapscan            bool      (default true)
     wrapscroll          bool      (default false)
     user_{option}       string    (default none)
@@ -814,10 +815,10 @@ sets or ranges. Otherwise, these characters are interpreted as they are.
 hidden (bool) (default false)
 
 Show hidden files. On Unix systems, hidden files are determined by the
-value of hiddenfiles. On Windows, only files with hidden attributes are
+value of hiddenfiles. On Windows, files with hidden attributes are also
 considered hidden files.
 
-hiddenfiles ([]string) (default .*)
+hiddenfiles ([]string) (default .* for Unix and `` for Windows)
 
 List of hidden file glob patterns. Patterns can be given as relative or
 absolute paths. Globbing supports the usual special characters, * to
@@ -1113,6 +1114,12 @@ waitmsg (string) (default Press any key to continue)
 
 String shown after commands of shell-wait type.
 
+watch (bool) (default false)
+
+Watch the filesystem for changes using fsnotify to automatically refresh
+file information. FUSE is currently not supported due to limitations in
+fsnotify.
+
 wrapscan (bool) (default true)
 
 Searching can wrap around the file list.
@@ -2056,9 +2063,9 @@ single characters as values of entries. The ln entry supports the
 special value target, which will use the link target to select a icon.
 File name rules will still apply based on the link's name -- this
 mirrors GNU's ls and dircolors behavior. The icons file (refer to the
-CONFIGURATION section) should consist of whitespace-separated pairs with
-a # character to start comments until the end of the line. Each line
-should contain 1-3 columns, first column is filetype or filename
+CONFIGURATION section) should consist of whitespace-separated arrays
+with a # character to start comments until the end of the line. Each
+line should contain 1-3 columns, first column is filetype or filename
 pattern, second column is the icon, third column is an optional icon
 color. If there is only one column, means to disable rule for this
 filetype or pattern. Do not forget to add set icons true to your lfrc to

lf.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.11.4
 .\"
-.TH "LF" "1" "2024-03-31" "r32" "DOCUMENTATION"
+.TH "LF" "1" "2024-06-22" "" "DOCUMENTATION"
 .hy
 .SH NAME
 .PP
@@ -166,7 +166,7 @@ findlen             int       (default 1)
 globfilter          bool      (default false)
 globsearch          bool      (default false)
 hidden              bool      (default false)
-hiddenfiles         []string  (default \[aq].*\[aq])
+hiddenfiles         []string  (default \[aq].*\[aq] for Unix and \[aq]\[aq] for Windows)
 hidecursorinactive  bool      (default false)
 history             bool      (default true)
 icons               bool      (default false)
@@ -210,6 +210,7 @@ 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])
+watch               bool      (default false)
 wrapscan            bool      (default true)
 wrapscroll          bool      (default false)
 user_{option}       string    (default none)
@@ -834,9 +835,9 @@ Otherwise, these characters are interpreted as they are.
 Show hidden files.
 On Unix systems, hidden files are determined by the value of
 \f[C]hiddenfiles\f[R].
-On Windows, only files with hidden attributes are considered hidden
+On Windows, files with hidden attributes are also considered hidden
 files.
-.SS hiddenfiles ([]string) (default \f[C].*\f[R])
+.SS hiddenfiles ([]string) (default \f[C].*\f[R] for Unix and \[ga]\[ga] for Windows)
 .PP
 List of hidden file glob patterns.
 Patterns can be given as relative or absolute paths.
@@ -1136,6 +1137,12 @@ value of 0 will only show the end of the filename, e.g.:
 .SS waitmsg (string) (default \f[C]Press any key to continue\f[R])
 .PP
 String shown after commands of shell-wait type.
+.SS watch (bool) (default false)
+.PP
+Watch the filesystem for changes using \f[C]fsnotify\f[R] to
+automatically refresh file information.
+FUSE is currently not supported due to limitations in
+\f[C]fsnotify\f[R].
 .SS wrapscan (bool) (default true)
 .PP
 Searching can wrap around the file list.
@@ -2399,8 +2406,13 @@ File name rules will still apply based on the link\[aq]s name -- this
 mirrors GNU\[aq]s \f[C]ls\f[R] and \f[C]dircolors\f[R] behavior.
 The icons file (refer to the CONFIGURATION
 section (https://github.com/gokcehan/lf/blob/master/doc.md#configuration))
-should consist of whitespace-separated pairs with a \f[C]#\f[R]
+should consist of whitespace-separated arrays with a \f[C]#\f[R]
 character to start comments until the end of the line.
+Each line should contain 1-3 columns, first column is filetype or
+filename pattern, second column is the icon, third column is an optional
+icon color.
+If there is only one column, means to disable rule for this filetype or
+pattern.
 Do not forget to add \f[C]set icons true\f[R] to your \f[C]lfrc\f[R] to
 see the icons.
 Default values are as follows given with their matching order in lf:
@@ -2426,3 +2438,6 @@ fi  -
 .PP
 A sample icons file can be found at
 <https://github.com/gokcehan/lf/blob/master/etc/icons.example>
+.PP
+A sample colored icons file can be found at
+<https://github.com/gokcehan/lf/blob/master/etc/icons_colored.example>