*NERDTree.txt* A tree explorer plugin to rule the Vim world. Bwahahaha!!

CONTENTS *NERDTree-contents*

1.Intro...................................|NERDTree|

2.Functionality provided..................|NERDTreeFunctionality|

2.1.Global commands...................|NERDTreeGlobalCommands|

2.2.Bookmarks.........................|NERDTreeBookmarks|

2.2.1.The bookmark table..........|NERDTreeBookmarkTable|

2.2.2.Bookmark commands...........|NERDTreeBookmarkCommands|

2.2.3.Invalid bookmarks...........|NERDTreeInvalidBookmarks|

2.3.NERDTree mappings.................|NERDTreeMappings|

2.4.The NERDTree menu.................|NERDTreeMenu|

3.Settings................................|NERDTreeSettings|

3.1.Settings summary..................|NERDTreeSettingsSummary|

3.2.Settings details..................|NERDTreeSettingsDetails|

4.The NERDTree API........................|NERDTreeAPI|

4.1.Key map API.......................|NERDTreeKeymapAPI|

4.2.Menu API..........................|NERDTreeMenuAPI|

4.3.Menu API..........................|NERDTreeAddPathFilter()|

4.4.Path Listener API.................|NERDTreePathListenerAPI|

5.About...................................|NERDTreeAbout|

6.License.................................|NERDTreeLicense|

1. Intro *NERDTree*

What is this "NERDTree"??

The NERDTree allows you to explore your filesystem and to open files and

directories. It presents the filesystem to you in the form of a tree which you

manipulate with the keyboard and/or mouse. It also allows you to perform

simple filesystem operations.

The following features and functionality are provided by the NERDTree:

* Files and directories are displayed in a hierarchical tree structure

* Different highlighting is provided for the following types of nodes:

* files

* directories

* sym-links

* windows .lnk files

* read-only files

* executable files

* Many (customisable) mappings are provided to manipulate the tree:

* Mappings to open/close/explore directory nodes

* Mappings to open files in new/existing windows/tabs

* Mappings to change the current root of the tree

* Mappings to navigate around the tree

* ...

* Directories and files can be bookmarked.

* Most NERDTree navigation can also be done with the mouse

* Filtering of tree content (can be toggled at runtime)

* custom file filters to prevent e.g. vim backup files being displayed

* optional displaying of hidden files (. files)

* files can be "turned off" so that only directories are displayed

* The position and size of the NERDTree window can be customised

* The order in which the nodes in the tree are listed can be customised.

* A model of your filesystem is created/maintained as you explore it. This

has several advantages:

* All filesystem information is cached and is only re-read on demand

* If you revisit a part of the tree that you left earlier in your

session, the directory nodes will be opened/closed as you left them

* The script remembers the cursor position and window position in the NERD

tree so you can toggle it off (or just close the tree window) and then

reopen it (with NERDTreeToggle) the NERDTree window will appear exactly

as you left it

* You can have a separate NERDTree for each tab, share trees across tabs,

or a mix of both.

* By default the script overrides the default file browser (netrw), so if

you :edit a directory a (slightly modified) NERDTree will appear in the

current window

* A programmable menu system is provided (simulates right clicking on a

node)

* one default menu plugin is provided to perform basic filesystem

operations (create/delete/move/copy files/directories)

* There's an API for adding your own keymappings

2. Functionality provided *NERDTreeFunctionality*

2.1. Global Commands *NERDTreeGlobalCommands*

:NERDTree [<start-directory> | <bookmark>] *:NERDTree*

Opens a fresh NERDTree. The root of the tree depends on the argument

given. There are 3 cases: If no argument is given, the current directory

will be used. If a directory is given, that will be used. If a bookmark

name is given, the corresponding directory will be used. For example: >

:NERDTreeVCS [<start-directory> | <bookmark>] *:NERDTreeVCS*

Like |:NERDTree|, but searches up the directory tree to find the top of

the version control system repository, and roots the NERDTree there. It

works with Git, Subversion, Mercurial, Bazaar, and Darcs repositories. A

couple of examples: >

:NERDTreeFromBookmark <bookmark> *:NERDTreeFromBookmark*

Opens a fresh NERDTree with the root initialized to the directory for

<bookmark>. The only reason to use this command over :NERDTree is for

the completion (which is for bookmarks rather than directories).

:NERDTreeToggle [<start-directory> | <bookmark>] *:NERDTreeToggle*

If a NERDTree already exists for this tab, it is reopened and rendered

again. If <start-directory> or <bookmark> is given, the root of NERDTree

is set to that path. If no NERDTree exists for this tab then this command

acts the same as the |:NERDTree| command.

:NERDTreeToggleVCS [<start-directory> | <bookmark>] *:NERDTreeToggleVCS*

Like |:NERDTreeToggle|, but searches up the directory tree to find the top of

the version control system repository, and roots the NERDTree there. It

works with Git, Subversion, Mercurial, Bazaar, and Darcs repositories. A

couple of examples: >

:NERDTreeFocus *:NERDTreeFocus*

Opens (or reopens) the NERDTree if it is not currently visible;

otherwise, the cursor is moved to the already-open NERDTree.

:NERDTreeMirror *:NERDTreeMirror*

Shares an existing NERDTree, from another tab, in the current tab.

Changes made to one tree are reflected in both as they are actually the

same buffer.

If only one other NERDTree exists, that tree is automatically mirrored.

If more than one exists, the script will ask which tree to mirror.

:NERDTreeClose *:NERDTreeClose*

Close the NERDTree in this tab.

:NERDTreeFind [<path>] *:NERDTreeFind*

Without the optional argument, find and reveal the file for the active

buffer in the NERDTree window. With the <path> argument, find and

reveal the specified path.

Focus will be shifted to the NERDTree window, and the cursor will be

placed on the tree node for the determined path. If a NERDTree for the

current tab does not exist, a new one will be initialized.

:NERDTreeCWD *:NERDTreeCWD*

Change the NERDTree root to the current working directory. If no

NERDTree exists for this tab, a new one is opened.

:NERDTreeRefreshRoot *:NERDTreeRefreshRoot*

Refreshes the NERDTree root node.

2.2. Bookmarks *NERDTreeBookmarks*

Bookmarks in the NERDTree are a way to tag files or directories of interest.

For example, you could use bookmarks to tag all of your project directories.

2.2.1. The Bookmark Table *NERDTreeBookmarkTable*

If the bookmark table is active (see |NERDTree-B| and

|NERDTreeShowBookmarks|), it will be rendered above the tree. You can double

click bookmarks or use the |NERDTree-o| mapping to activate them. See also,

|NERDTree-t| and |NERDTree-T|

2.2.2. Bookmark commands *NERDTreeBookmarkCommands*

Note: The following commands are only available within the NERDTree buffer.

:Bookmark [<name>]

Bookmark the current node as <name>. If there is already a <name>

bookmark, it is overwritten. <name> must not contain spaces.

If <name> is not provided, it defaults to the file or directory name.

For directories, a trailing slash is present.

:BookmarkToRoot <bookmark>

Make the directory corresponding to <bookmark> the new root. If a treenode

corresponding to <bookmark> is already cached somewhere in the tree then

the current tree will be used, otherwise a fresh tree will be opened.

Note that if <bookmark> points to a file then its parent will be used

instead.

:RevealBookmark <bookmark>

If the node is cached under the current root then it will be revealed

(i.e. directory nodes above it will be opened) and the cursor will be

placed on it.

:OpenBookmark <name>

The Bookmark named <name> is opened as if |NERDTree-o| was applied to

its entry in the Bookmark table. If the Bookmark points to a directory,

it is made the new root of the current NERDTree. If the Bookmark points

to a file, that file is opened for editing in another window.

:ClearBookmarks [<bookmarks>]

Remove all the given bookmarks. If no bookmarks are given then remove all

bookmarks on the current node.

:ClearAllBookmarks

Remove all bookmarks.

:EditBookmarks

Opens the bookmarks file for manual editing, e.g. for removing invalid

bookmarks.

:ReadBookmarks

Re-read the bookmarks in the |NERDTreeBookmarksFile|.

See also |:NERDTree| and |:NERDTreeFromBookmark|.

2.2.3. Invalid Bookmarks *NERDTreeInvalidBookmarks*

If invalid bookmarks are detected, the script will issue an error message and

the invalid bookmarks will become unavailable for use.

These bookmarks will still be stored in the bookmarks file (see

|NERDTreeBookmarksFile|), down at the bottom. There will always be a blank line

after the valid bookmarks but before the invalid ones.

Each line in the bookmarks file represents one bookmark. The proper format is:

<bookmark name><space><full path to the bookmark location>

You can use the :EditBookmarks command to open the bookmarks file for editing.

After you have corrected any invalid bookmarks, either restart vim, or run

:ReadBookmarks from the NERDTree window.

2.3. NERDTree Mappings *NERDTreeMappings*

o........Open files, directories and bookmarks......................|NERDTree-o|

go.......Open selected file, but leave cursor in the NERDTree......|NERDTree-go|

Find selected bookmark directory in current NERDTree

t........Open selected node/bookmark in a new tab...................|NERDTree-t|

T........Same as 't' but keep the focus on the current tab..........|NERDTree-T|

i........Open selected file in a split window.......................|NERDTree-i|

gi.......Same as i, but leave the cursor on the NERDTree...........|NERDTree-gi|

s........Open selected file in a new vsplit.........................|NERDTree-s|

gs.......Same as s, but leave the cursor on the NERDTree...........|NERDTree-gs|

<CR>.....User-definable custom open action.......................|NERDTree-<CR>|

O........Recursively open the selected directory....................|NERDTree-O|

x........Close the current nodes parent.............................|NERDTree-x|

X........Recursively close all children of the current node.........|NERDTree-X|

e........Edit the current directory.................................|NERDTree-e|

double-click....same as |NERDTree-o|.

middle-click....same as |NERDTree-i| for files, and |NERDTree-e| for directories.

D........Delete the current bookmark ...............................|NERDTree-D|

P........Jump to the root node......................................|NERDTree-P|

p........Jump to current nodes parent...............................|NERDTree-p|

K........Jump up inside directories at the current tree depth.......|NERDTree-K|

J........Jump down inside directories at the current tree depth.....|NERDTree-J|

<C-J>....Jump down to next sibling of the current directory.......|NERDTree-C-J|

<C-K>....Jump up to previous sibling of the current directory.....|NERDTree-C-K|

C........Change the tree root to the selected directory.............|NERDTree-C|

u........Move the tree root up one directory........................|NERDTree-u|

U........Same as 'u' except the old root node is left open..........|NERDTree-U|

r........Recursively refresh the current directory..................|NERDTree-r|

R........Recursively refresh the current root.......................|NERDTree-R|

m........Display the NERDTree menu..................................|NERDTree-m|

cd.......Change the CWD to the directory of the selected node......|NERDTree-cd|

CD.......Change tree root to the CWD...............................|NERDTree-CD|

I........Toggle whether hidden files displayed......................|NERDTree-I|

f........Toggle whether the file filters are used...................|NERDTree-f|

F........Toggle whether files are displayed.........................|NERDTree-F|

B........Toggle whether the bookmark table is displayed.............|NERDTree-B|

L........Toggle whether the number of lines in files is displayed..|NERDTree-FL|

q........Close the NERDTree window..................................|NERDTree-q|

A........Zoom (maximize/minimize) the NERDTree window...............|NERDTree-A|

?........Toggle the display of the quick help.......................|NERDTree-?|

*NERDTree-o*

Default key: o

Map setting: NERDTreeMapActivateNode

Applies to: files and directories.

If a file node is selected, it is opened in the previous window.

If a directory is selected it is opened or closed depending on its current

state.

If a bookmark that links to a directory is selected then that directory

becomes the new root.

If a bookmark that links to a file is selected then that file is opened in the

previous window.

*NERDTree-go*

Default key: go

Map setting: NERDTreeMapPreview

Applies to: files.

If a file node or a bookmark that links to a file is selected, it is opened in

the previous window, but the cursor does not move.

If a bookmark that links to a directory is selected then that directory

becomes the new root.

The default key combo for this mapping is "g" + NERDTreeMapActivateNode (see

|NERDTree-o|).

*NERDTree-t*

Default key: t

Map setting: *NERDTreeMapOpenInTab*

Applies to: files and directories.

Opens the selected file in a new tab. If a directory is selected, a fresh

NERDTree for that directory is opened in a new tab.

If a bookmark which points to a directory is selected, open a NERDTree for

that directory in a new tab. If the bookmark points to a file, open that file

in a new tab.

*NERDTree-T*

Default key: T

Map setting: *NERDTreeMapOpenInTabSilent*

Applies to: files and directories.

The same as |NERDTree-t| except that the focus is kept in the current tab.

*NERDTree-i*

Default key: i

Map setting: *NERDTreeMapOpenSplit*

Applies to: files, and bookmarks pointing to files.

Opens the selected file in a new split window and puts the cursor in the new

window.

*NERDTree-gi*

Default key: gi

Map setting: *NERDTreeMapPreviewSplit*

Applies to: files, and bookmarks pointing to files.

The same as |NERDTree-i| except that the cursor is not moved.

The default key combo for this mapping is "g" + NERDTreeMapOpenSplit (see

|NERDTree-i|).

*NERDTree-s*

Default key: s

Map setting: *NERDTreeMapOpenVSplit*

Applies to: files, and bookmarks pointing to files.

Opens the selected file in a new vertically split window and puts the cursor

in the new window.

*NERDTree-gs*

Default key: gs

Map setting: *NERDTreeMapPreviewVSplit*

Applies to: files, and bookmarks pointing to files.

The same as |NERDTree-s| except that the cursor is not moved.

The default key combo for this mapping is "g" + NERDTreeMapOpenVSplit (see

|NERDTree-s|).

*NERDTree-<CR>*

Default key: <CR>

Map setting: *NERDTreeMapCustomOpen*

Applies to: files, directories, and bookmarks

Performs a customized open action on the selected node. This allows the user

to define an action that behaves differently from any of the standard

keys. See |NERDTreeCustomOpenArgs| for more details.

*NERDTree-O*

Default key: O

Map setting: *NERDTreeMapOpenRecursively*

Applies to: directories.

Recursively opens the selected directory.

All files and directories are cached, but if a directory would not be

displayed due to file filters (see |NERDTreeIgnore| |NERDTree-f|) or the

hidden file filter (see |NERDTreeShowHidden|) then its contents are not

cached. This is handy, especially if you have .svn directories.

*NERDTree-x*

Default key: x

Map setting: *NERDTreeMapCloseDir*

Applies to: files and directories.

Closes the parent of the selected node.

*NERDTree-X*

Default key: X

Map setting: *NERDTreeMapCloseChildren*

Applies to: directories.

Recursively closes all children of the selected directory.

Tip: To quickly "reset" the tree, use |NERDTree-P| with this mapping.

*NERDTree-e*

Default key: e

Map setting: *NERDTreeMapOpenExpl*

Applies to: files and directories.

|:edit|s the selected directory, or the selected file's directory. This could

result in a NERDTree or a netrw being opened, depending on

|NERDTreeHijackNetrw|.

*NERDTree-D*

Default key: D

Map setting: *NERDTreeMapDeleteBookmark*

Applies to: lines in the bookmarks table

Deletes the currently selected bookmark.

*NERDTree-P*

Default key: P

Map setting: *NERDTreeMapJumpRoot*

Applies to: no restrictions.

Jump to the tree root.

*NERDTree-p*

Default key: p

Map setting: *NERDTreeMapJumpParent*

Applies to: files and directories.

Jump to the parent node of the selected node.

*NERDTree-K*

Default key: K

Map setting: *NERDTreeMapJumpFirstChild*

Applies to: files and directories.

Jump to the first child of the current nodes parent.

If the cursor is already on the first node then do the following:

* loop back thru the siblings of the current nodes parent until we find an

open directory with children

* go to the first child of that node

*NERDTree-J*

Default key: J

Map setting: *NERDTreeMapJumpLastChild*

Applies to: files and directories.

Jump to the last child of the current nodes parent.

If the cursor is already on the last node then do the following:

* loop forward thru the siblings of the current nodes parent until we find

an open directory with children

* go to the last child of that node

*NERDTree-C-J*

Default key: <C-J>

Map setting: *NERDTreeMapJumpNextSibling*

Applies to: files and directories.

Jump to the next sibling of the selected node.

*NERDTree-C-K*

Default key: <C-K>

Map setting: *NERDTreeMapJumpPrevSibling*

Applies to: files and directories.

Jump to the previous sibling of the selected node.

*NERDTree-C*

Default key: C

Map setting: *NERDTreeMapChangeRoot*

Applies to: files and directories.

Make the selected directory node the new tree root. If a file is selected, its

parent is used.

*NERDTree-u*

Default key: u

Map setting: *NERDTreeMapUpdir*

Applies to: no restrictions.

Move the tree root up a directory (like doing a "cd ..").

*NERDTree-U*

Default key: U

Map setting: *NERDTreeMapUpdirKeepOpen*

Applies to: no restrictions.

Like |NERDTree-u| except that the old tree root is kept open.

*NERDTree-r*

Default key: r

Map setting: *NERDTreeMapRefresh*

Applies to: files and directories.

If a directory is selected, recursively refresh that directory, i.e. scan the

filesystem for changes and represent them in the tree.

If a file node is selected then the above is done on it's parent.

*NERDTree-R*

Default key: R

Map setting: *NERDTreeMapRefreshRoot*

Applies to: no restrictions.

Recursively refresh the tree root.

*NERDTree-m*

Default key: m

Map setting: *NERDTreeMapMenu*

Applies to: files and directories.

Display the NERDTree menu. See |NERDTreeMenu| for details.

*NERDTree-cd*

Default key: cd

Map setting: *NERDTreeMapChdir*

Applies to: files and directories.

Change Vim's current working directory to that of the selected node.

*NERDTree-CD*

Default key: CD

Map setting: *NERDTreeMapCWD*

Applies to: no restrictions.

Change the NERDTree root to Vim's current working directory.

*NERDTree-I*

Default key: I

Map setting: *NERDTreeMapToggleHidden*

Applies to: no restrictions.

Toggles whether hidden files (i.e. "dot files") are displayed.

*NERDTree-f*

Default key: f

Map setting: *NERDTreeMapToggleFilters*

Applies to: no restrictions.

Toggles whether file filters are used. See |NERDTreeIgnore| for details.

*NERDTree-F*

Default key: F

Map setting: *NERDTreeMapToggleFiles*

Applies to: no restrictions.

Toggles whether file nodes are displayed.

*NERDTree-B*

Default key: B

Map setting: *NERDTreeMapToggleBookmarks*

Applies to: no restrictions.

Toggles whether the bookmarks table is displayed.

*NERDTree-FL*

Default key: FL

Map setting: *NERDTreeMapToggleFileLines*

Applies to: no restrictions.

Toggles whether the number of lines in files is displayed.

*NERDTree-q*

Default key: q

Map setting: *NERDTreeMapQuit*

Applies to: no restrictions.

Closes the NERDTree window.

*NERDTree-A*

Default key: A

Map setting: *NERDTreeMapToggleZoom*

Applies to: no restrictions.

Maximize (zoom) and minimize the NERDTree window.

*NERDTree-?*

Default key: ?

Map setting: *NERDTreeMapHelp*

Applies to: no restrictions.

Toggles whether the quickhelp is displayed.

2.3. The NERDTree menu *NERDTreeMenu*

The NERDTree has a menu that can be programmed via the an API (see

|NERDTreeMenuAPI|). The idea is to simulate the "right click" menus that most

file explorers have.

The script comes with two default menu plugins: exec_menuitem.vim and

fs_menu.vim. fs_menu.vim adds some basic filesystem operations to the menu for

creating/deleting/moving/copying files and directories. exec_menuitem.vim

provides a menu item to execute executable files.

Related tags: |NERDTree-m| |NERDTreeApi|

*NERDTreeMenu-j*

Default key: j

Map option: *NERDTreeMenuDown*

Applies to: The NERDTree menu.

Moves the cursor down.

*NERDTreeMenu-k*

Default key: k

Map option: *NERDTreeMenuUp*

Applies to: The NERDTree menu.

Moves the cursor up.

3. Customisation *NERDTreeSettings*

3.1. Customisation summary *NERDTreeSettingsSummary*

The plugin provides the following settings that can customise the behaviour

the NERDTree. These settings should be set in your vimrc, using `:let`.

|loaded_nerd_tree| Turns off the script.

|NERDTreeAutoCenter| Controls whether the NERDTree window centers

when the cursor moves within a specified

distance to the top/bottom of the window.

|NERDTreeAutoCenterThreshold| Controls the sensitivity of autocentering.

|NERDTreeCaseSensitiveFS| Tells the NERDTree whether or not it is

running in on a case sensitive file system.

|NERDTreeCaseSensitiveSort| Tells the NERDTree whether to be case

sensitive or not when sorting nodes.

|NERDTreeNaturalSort| Tells the NERDTree whether to use natural sort

order or not when sorting nodes.

|NERDTreeSortHiddenFirst| Tells the NERDTree whether to take the dot at

the beginning of the hidden file names into

account when sorting nodes.

|NERDTreeChDirMode| Tells the NERDTree if/when it should change

vim's current working directory.

|NERDTreeHighlightCursorline| Tell the NERDTree whether to highlight the

current cursor line.

|NERDTreeHijackNetrw| Tell the NERDTree whether to replace the netrw

autocommands for exploring local directories.

|NERDTreeIgnore| Tells the NERDTree which files to ignore.

|NERDTreeRespectWildIgnore| Tells the NERDTree to respect `'wildignore'`.

|NERDTreeBookmarksFile| Where the bookmarks are stored.

|NERDTreeBookmarksSort| Control how the Bookmark table is sorted.

|NERDTreeMarkBookmarks| Render bookmarked nodes with markers.

|NERDTreeMouseMode| Manage the interpretation of mouse clicks.

|NERDTreeQuitOnOpen| Closes the tree window or bookmark table after

opening a file.

|NERDTreeShowBookmarks| Tells the NERDTree whether to display the

bookmarks table on startup.

|NERDTreeShowFiles| Tells the NERDTree whether to display files in

the tree on startup.

|NERDTreeShowHidden| Tells the NERDTree whether to display hidden

files on startup.

|NERDTreeShowLineNumbers| Tells the NERDTree whether to display line

numbers in the tree window.

|NERDTreeSortOrder| Tell the NERDTree how to sort the nodes in the

tree.

|NERDTreeStatusline| Set a statusline for NERDTree windows.

|NERDTreeWinPos| Tells the script where to put the NERDTree

window.

|NERDTreeWinSize| Sets the window size when the NERDTree is

opened.

|NERDTreeWinSizeMax| Sets the maximum window size when the NERDTree

is zoomed.

|NERDTreeMinimalUI| Disables display of the 'Bookmarks' label and

'Press ? for help' text.

|NERDTreeMinimalMenu| Use a compact menu that fits on a single line

for adding, copying, deleting, etc

Collapses on the same line directories that have

only one child directory.

Cascade open while selected directory has only

one child that also is a directory.

|NERDTreeAutoDeleteBuffer| Tells the NERDTree to automatically remove a

buffer when a file is being deleted or renamed

via a context menu command.

|NERDTreeCreatePrefix| Specify a prefix to be used when creating the

NERDTree window.

|NERDTreeRemoveFileCmd| Specify a custom shell command to be used when

deleting files. Note that it should include one

space character at the end of the command and it

applies only to files.

|NERDTreeRemoveDirCmd| Specify a custom shell command to be used when

deleting directories. Note that it should

include one space character at the end of the

command and it applies only to directories.

|NERDTreeDirArrowCollapsible| These characters indicate when a directory is

|NERDTreeDirArrowExpandable| either collapsible or expandable.

|NERDTreeNodeDelimiter| A single character that is used to separate the

file or directory name from the rest of the

characters on the line of text.

|NERDTreeCustomOpenArgs| A dictionary with values that control how a node

is opened with the |NERDTree-<CR>| key.

3.2. Customisation details *NERDTreeSettingsDetails*

To enable any of the below settings you should put an appropriate >

<line in your ~/.vimrc.

*loaded_nerd_tree*

If this plugin is making you feel homicidal, it may be a good idea to turn it

off with this line in your vimrc: >

*NERDTreeAutoCenter*

Values: 0 or 1.

Default: 1

If set to 1, the NERDTree window will center around the cursor if it moves to

within |NERDTreeAutoCenterThreshold| lines of the top/bottom of the window.

This is ONLY done in response to tree navigation mappings,

i.e. |NERDTree-J| |NERDTree-K| |NERDTree-C-J| |NERDTree-C-K| |NERDTree-p|

The centering is done with a |zz| operation.

*NERDTreeAutoCenterThreshold*

Values: Any natural number.

Default: 3

This setting controls the "sensitivity" of the NERDTree auto centering. See

|NERDTreeAutoCenter| for details.

*NERDTreeCaseSensitiveFS*

Values: 0, 1, 2 or 3.

Default: 2.

If set to 0, the NERDTree will interact with the file system without case

sensitivity.

If set to 1, the NERDTree will interact with the file system in a case-sensitive

manner.

If set to 2, the NERDTree assumes its case sensitivity from the OS it is

running on. It Will default to case-insensitive on Windows and macOS

machines and case-sensitive on everything else. Since it's not a foolproof

way of detection, NERDTree won't proceed with any write actions when

the destination is ambiguous.

Setting it to 3 will perform just like 2, but without suppressing write

actions.

*NERDTreeCaseSensitiveSort*

Values: 0 or 1.

Default: 0.

By default the NERDTree does not sort nodes case sensitively, i.e. nodes

could appear like this: >

But, if you set this setting to 1 then the case of the nodes will be taken

into account. The above nodes would then be sorted like this: >

*NERDTreeNaturalSort*

Values: 0 or 1.

Default: 0.

By default the NERDTree does not sort nodes in natural sort order, i.e. nodes

could appear like this: >

But if you set this setting to 1 then the natural sort order will be used. The

above nodes would then be sorted like this: >

*NERDTreeUseTCD*

Values: 0 or 1.

Default: 0.

By default, NERDTree will use the `:cd` command to change the current working

directory. If this setting is turned on, and the `:tcd` command is available, it

will be used instead.

*NERDTreeChDirMode*

Values: 0, 1, 2, or 3.

Default: 0.

Use this setting to tell the script when (if at all) to change the current

working directory (CWD) for vim.

If it is set to 0 then the CWD is never changed by the NERDTree.

If set to 1 then the CWD is changed when the NERDTree is first loaded to the

directory it is initialized in. For example, if you start the NERDTree with >

then the CWD will be changed to /home/marty/foobar and will not be changed

again unless you init another NERDTree with a similar command.

If the setting is set to 2 then it behaves the same as if set to 1 except that

the CWD is changed whenever the tree root is changed. For example, if the CWD

is /home/marty/foobar and you make the node for /home/marty/foobar/baz the new

root then the CWD will become /home/marty/foobar/baz.

If the set to 3, then it behaves the same as if set to 2, and the CWD is

changed whenever changing tabs to whatever the tree root is on that tab.

*NERDTreeHighlightCursorline*

Values: 0 or 1.

Default: 1.

If set to 1, the current cursor line in the NERDTree buffer will be

highlighted. This is done using the `'cursorline'` Vim option.

*NERDTreeHijackNetrw*

Values: 0 or 1.

Default: 1.

If set to 1, doing a >

will open up a window level NERDTree instead of a netrw in the target window.

Window level trees behaves slightly different from a regular trees in the

following respects:

1. 'o' will open the selected file in the same window as the tree,

replacing it.

2. you can have one tree per window - instead of per tab.

*NERDTreeIgnore*

Values: a list of regular expressions.

Default: ['\~$'].

This setting is used to specify which files the NERDTree should ignore. It

must be a list of regular expressions. When the NERDTree is rendered, any

files/directories that match any of the regex's in NERDTreeIgnore won't be

displayed.

For example if you put the following line in your vimrc: >

then all files ending in .vim or ~ will be ignored.

There are 3 magic flags that can be appended to the end of each regular

expression to specify that the regex should match only filenames, only lowest

level directories, or a full path. These flags are "[[dir]]", "[[file]]", and

"[[path]]". Example: >

This will cause all directories ending in ".d" to be ignored, all files ending

in ".o" to be ignored, and the "cache" subdirectory of any "tmp" directory to

be ignored. All other "cache" directories will be displayed.

When using the "[[path]]" tag on Windows, make sure you use escaped

backslashes for the separators in the regex, eg. 'Temp\\cache$[[path]]'

Note: to tell the NERDTree not to ignore any files you must use the following

line: >

The file filters can be turned on and off dynamically with the |NERDTree-f|

mapping.

*NERDTreeRespectWildIgnore*

Values: 0 or 1.

Default: 0.

If set to 1, the `'wildignore'` setting is respected.

*NERDTreeBookmarksFile*

Values: a path

Default: $HOME/.NERDTreeBookmarks

This is where bookmarks are saved. See |NERDTreeBookmarkCommands|.

*NERDTreeBookmarksSort*

Values: 0, 1, or 2