Node:ecb-directories, Next:ecb-sources, Previous:ecb-tree-buffer, Up:Customizable options
This group contains settings for the directories-buffer in the ECB:
| add-path-for-not-matching-files | User Option |
Add path of a file to ecb-source-path if not already contained.
This is done during the auto. windows synchronization which happens if
a file is opened not via the file/directory-browser of ECB. In such a
situation ECB adds the path of the new file auto. to
ecb-source-path at least temporally for the current Emacs
session. This option defines two things:
The value of this option is a cons-cell where the car is a boolean for 1. and the cdr is a boolean for 2. A value of not nil for the car (1.) is reasonably if a user often
opens files not via the ECB-browser which are not located in any of
the paths of |
| auto-expand-directory-tree | User Option |
Automatically expand the directory tree to the current source file.
There are three options:
|
| after-directory-change-hook | User Option |
Hook which run directly after the selected directory has changed. This
means not onyl after a click onto a directory in the directory-window
of ECB but it means this hook runs always when the current directory
changes regardless of the trigger of this change. So for example it
runs also when you just switches from one buffer to another via
switch-to-buffer or switch-to-buffer-other-window and
the directory of these filebuffers is different but only when
auto-synchronizing of the ECB-windows is on (see
ecb-window-sync). It runs not when switching between buffers
and the associated files reside in the same directory.
Each function added to this hook will be called with two arguments: The directory which was current _before_ the directory-change-trigger and the directory which was now the current (i.e. after the trigger). Example: If you switch from a filebuffer "~/.emacs" to a filebuffer "/tmp/test.txt" then the functions of this hook will be called with the two arguments "~" and "/tmp". |
| cache-directory-contents | User Option |
|
Cache contents of directories.
This can be useful if The value of this option is a list where each element is a cons-cell
and looks like:
(<dir-regexp> . <filenumber threshold>) with
A directory will only be cached if and only if the directory-name
matches at least one rexexp of this option and its content-number
exceeds the related threshold AND the directory-name matches NOT any
regexp of The cache entry for a certain directory will be refreshed and
actualized only by using the POWER-click (see
Default-value: ECB caches the contents of all remote directories regardless of the size and all other directories if more than 50 entries are contained. Examples: An entry An entry An entry Please note: If you want your home-dir being cached then you MUST NOT use "~" because ECB tries always to match full path-names! |
| cache-directory-contents-not | User Option |
|
Do not cache the contents of certain directories. The value of this
option is a list where the each element is a regular expression a
directory must match if it should not being cached.
If a directory-name matches at least one of the regexps of this option
the directory-contents will never being cached. See
This option can be useful when normally all directories with a certain amount of content (files and subdirs) should be cached but some special directories not. This can be achieved by:
Please note: If you want your home-dir exclude from being cached then you MUST NOT use "~" because ECB tries always to match full path-names! |
| directories-buffer-after-create-hook | User Option |
Local hook running after the creation of the directories-buffer. Every
function of this hook is called once without arguments direct after
creating the directories-buffer of ECB and it's local key-map. So for
example a function could be added which performs calls of
local-set-key to define new keybindings only for the
directories-buffer of ECB.
The following keys must not be rebind in the directories-buffer: F2, F3 and F4 |
| directories-buffer-name | User Option |
|
Name of the ECB directory buffer. Because it is not a normal buffer
for editing you should enclose the name with stars, e.g. " *ECB
Directories*".
If it is necessary for you you can get emacs-lisp access to the buffer-object of
the ECB-directory-buffer by this name, e.g. by a call of Changes for this option at runtime will take affect only after deactivating and then activating ECB again! |
| directories-menu-sorter | User Option |
|
Function which re-sorts the menu-entries of the directories buffer.
If a function then this function is called to re-arrange the
menu-entries of the combined menu-entries of the user-menu-extensions
of The function get one argument, a list of menu-entries. For the format
of this argument see |
| directories-menu-user-extension | User Option |
Static user extensions for the popup-menu of the directories buffer.
Value is a list of elements of the following type: Each element
defines a new menu-entry and is either:
The function of a menu-command must follow the following guidelines:
Such a function must be defined with the macro
Example for the definition of such a menu-function:
(tree-buffer-defpopup-command ecb-my-special-dir-popup-function
"Prints the name of the directory of the node under point."
(let ((node-data=dir (tree-node-get-data node)))
(message ``Dir under node: %s'' node-data=dir)))
Per default the static user-extensions are added at the beginning of
the built-in menu-entries of These menu-extensions are static. A dynamic menu-extension can be
achieved via |
| directories-menu-user-extension-function | User Option |
Dynamic user extensions for the popup-menu of the directories buffer.
A function which has to return a list in the same format like the
option ecb-directories-menu-user-extension. This function is
called when the user opens the popup-menu for the directories buffer.
If no dynamically evaluated menu-extensions should be added to the
directories-buffer the function has to return nil. Therefore the
default-value of this option is Per default the dynamic user-extensions are added in front of the
static extensions of |
| directories-show-node-info | User Option |
|
When to display which node-info in the directories-buffer. Define
which node info should displayed after moving the mouse over a node
(or after a shift click onto the node) in the directories-buffer.
You can define "when" a node-info should be displayed:
You can define what info should be displayed:
Do NOT set this option directly via setq but use always customize! |
| display-default-dir-after-start | User Option |
|
Automatically display current default-directory after activating ECB.
If a file-buffer is displayed in the current active edit-window then
ECB synchronizes its tree-buffers to this file-buffer - at least if
the option If true then ECB selects autom. the current default-directory after activation even if no file-buffer is displayed in the current active edit-window. This is useful if ECB is autom. activated after startup of Emacs and Emacs is started without a file-argument. So the directory from which the startup has performed is auto. selected in the ECB-directories buffer and the ECB-sources buffer displays the contents of this directory. |
| excluded-directories-regexps | User Option |
| Directories that should not be included in the directories list. The value of this variable should be a list of regular expression. |
| prescan-directories-for-emptyness | User Option |
Prescan directories for emptyness. ECB does this so directories are
displayed as empty in the directories-buffer even without
user-interaction (i.e. in previous ECB-versions the emptyness of a
directory has been first checked when the user has clicked onto a
directory). ECB optimizes this check as best as possible but if a
directory contains a lot of subdirectories which contain in turn a lot
of entries, then expanding such a directory or selecting it would take
of course more time as without this check - at least at the first time
(all following selects of a directory uses the cached information if
its subdirectories are empty or not). Therefore ECB performs this
check stealthy (see ecb-stealthy-tasks-delay) so normally there
should no performance-decrease or additional waiting-time for the
user. There is one exception: For remote directories (in the sense of
tramp, ange-ftp, or efs) this check can descrease performance even if
performed stealthy and interruptable. Therefore this option offers
three possible settings:
The option |
| host-accessible-check-valid-time | User Option |
|
Time in seconds a cached accessible-state of a remote host is valid.
This option is a list where each element specifies how long for a
certain remote host the cached ping-state (i.e. if the host is
accessible or not) should be valid. During this time-intervall ECB
pings such a remote host only once, all other checks use the cached
value of that real check. But it the cached value is older than the
value of this option ECB will ping again.
Per default ECB discards after 1 minute the cached ping-state of each remote host. But if you are sure that a certain remote host is always accessible (i.e. means in consequence that you are always online when working with ECB and remote-paths) then add an entry to this option with a high valid-interval. Examples: An entry (".*sourceforge.*" . 3600) ensures that all remote hosts machting the string "sourceforge" will only once pinged during one hour. Or (".*" . 300) would ensure that every remote host would be pinged only once during 5 minutes. |
| ping-options | User Option |
List of options for the ping program. These options can be used to
limit how many ICMP packets are emitted. Ping is used to test if a
remote host of a remote path (e.g. a tramp-, ange-ftp- or efs-path) is
accessible See also ecb-ping-program.
|
| ping-program | User Option |
Program to send network test packets to a host. See also
ecb-ping-options.
|
| prescan-directories-exclude-regexps | User Option |
Which directories should be excluded from the empty-prescan. If a
directory matches any of the regexps of this option it will not be
prescanned for emptyness - This option takes only effect if
ecb-prescan-directories-for-emptyness is not nil.
|
| show-sources-in-directories-buffer | User Option |
| Show source files in directories buffer. |
| source-path | User Option |
| Paths where to find code sources. Each path can have an optional alias that is used as it's display name. If no alias is set, the path is used as display name. |
| source-path | User Option |
|
Paths where to find code sources. Each path can have an optional alias
that is used as it's display name. If no alias is set, the path is
used as display name.
Lisp-type of tis option: The value must be a list L whereas each element of L is either
|
| use-speedbar-instead-native-tree-buffer | User Option |
|
If true then uses speedbar for directories, sources or methods. This
means that speedbar is integrated in the ECB-frame and is displayed in
that window normally displaying the standard ECB-directories-buffer,
ECB-sources-buffer or ECB-methods-buffer.
This option takes effect in all layouts which contain either a directory window, a sources window or a method window. This option can have four valid values:
Note: For directories and sources a similar effect and usability is
available by setting this option to
|