tree_view/tree_view.7 at master · mickidymick/tree_view · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.TH YED-TREE_VIEW 7 "YED Plugin Manuals" "" "YED Plugin Manuals"
.SH NAME
tree_view \- A buffer that shows a tree view of all files.
.SH CONFIGURATION
.SS tree-view-update-period
Number of seconds between automatic filesystem refresh. Default is 5.
.SS tree-view-hidden-items
Space-separated list of substrings. Any file or directory whose name contains
one of these substrings will be hidden from the tree view.
.SS tree-view-image-extensions
Space-separated list of additional file extensions to treat as image files,
supplementing the built-in list. Example: ".raw .nef"
.SS tree-view-archive-extensions
Space-separated list of additional file extensions to treat as archive files,
supplementing the built-in list. Example: ".squashfs .zst"
.SS tree-view-child-char-l
Character used for the corner connector in the tree, default is "\[u2514]" (└).
.SS tree-view-child-char-i
Character used for the vertical line in the tree, default is "\[u2502]" (│).
.SS tree-view-child-char-t
Character used for the branch connector in the tree, default is "\[u251C]" (├).
.SS tree-view-directory-color
Attribute string for coloring directories. Default is "&blue".
.SS tree-view-exec-color
Attribute string for coloring executable files. Default is "&green".
.SS tree-view-symbolic-link-color
Attribute string for coloring symbolic links. Default is "&cyan".
.SS tree-view-device-color
Attribute string for coloring device files. Default is "&black swap &yellow.fg".
.SS tree-view-graphic-image-color
Attribute string for coloring image files. Default is "&magenta".
.SS tree-view-archive-color
Attribute string for coloring archive files. Default is "&red".
.SS tree-view-broken-link-color
Attribute string for coloring broken symbolic links. Default is "&black swap &red.fg".
.SH COMMANDS
.SS tree-view
Opens the
.I *tree-view-list
buffer. If the tree has not been built yet it will be initialized first.
Press
.B Enter
on a directory to expand or collapse it. Press
.B Enter
on a file to open it in the editor.
.SH PREVIEW
When the cursor is on a file in
.I *tree-view-list,
a preview of that file is shown in a split pane to the right. Only as many
lines as fit in the preview frame are read from the file; large files are
never fully loaded. The preview buffer is read-only and is not tracked as a
normal file.
.P
Moving the cursor to a directory or any non-regular entry closes the preview
pane automatically.
.SH BUFFERS
.SS *tree-view-list
The interactive file tree. Read-only; modified internally by the plugin.
.SS *tree-view-preview*
Ephemeral preview buffer. Populated on demand when hovering over a file and
cleared when the cursor leaves the file. Should not be written to directly.
.SH FILE TYPE DETECTION
Files are classified in the following priority order:
.IP 1.
Directory
.IP 2.
Symbolic link (valid or broken)
.IP 3.
Device file (block or character)
.IP 4.
Executable (owner execute bit set)
.IP 5.
Archive (by extension)
.IP 6.
Image (by extension)
.IP 7.
Regular file
.SH NOTES
Extension matching is case-insensitive and anchored to the end of the filename.
.SH VERSION
0.0.2
.SH KEYWORDS
tree_view, special, buffers, preview