/.emacs.d/ecb-2.40/html-help/ecb_002dhistory.html

https://bitbucket.org/shuangxinyu/emacspack · HTML · 243 lines · 189 code · 45 blank · 9 comment · 0 complexity · 6dd0479cebe4fb2a1b66bc077fca8152 MD5 · raw file 

    

  1. <html lang="en">
    2. 

  2. <head>
    3. 

  3. <title>ecb-history - ECB - the Emacs Code Browser</title>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html">
    5. 

  5. <meta name="description" content="ECB - the Emacs Code Browser">
    6. 

  6. <meta name="generator" content="makeinfo 4.8">
    7. 

  7. <link title="Top" rel="start" href="ecb.html#Top">
    8. 

  8. <link rel="up" href="Customizable-options.html#Customizable-options" title="Customizable options">
    9. 

  9. <link rel="prev" href="ecb_002dmethods.html#ecb_002dmethods" title="ecb-methods">
    10. 

  10. <link rel="next" href="ecb_002danalyse.html#ecb_002danalyse" title="ecb-analyse">
    11. 

  11. <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
    12. 

  12. <meta http-equiv="Content-Style-Type" content="text/css">
    13. 

  13. <style type="text/css"><!--
    14. 

  14.   pre.display { font-family:inherit }
    15. 

  15.   pre.format  { font-family:inherit }
    16. 

  16.   pre.smalldisplay { font-family:inherit; font-size:smaller }
    17. 

  17.   pre.smallformat  { font-family:inherit; font-size:smaller }
    18. 

  18.   pre.smallexample { font-size:smaller }
    19. 

  19.   pre.smalllisp    { font-size:smaller }
    20. 

  20.   span.sc    { font-variant:small-caps }
    21. 

  21.   span.roman { font-family:serif; font-weight:normal; } 
    22. 

  22.   span.sansserif { font-family:sans-serif; font-weight:normal; } 
    23. 

  23. --></style>
    24. 

  24. </head>
    25. 

  25. <body>
    26. 

  26. <div class="node">
    27. 

  27. <p>
    28. 

  28. <a name="ecb-history"></a>
    29. 

  29. <a name="ecb_002dhistory"></a>
    30. 

  30. Next:&nbsp;<a rel="next" accesskey="n" href="ecb_002danalyse.html#ecb_002danalyse">ecb-analyse</a>,
    31. 

  31. Previous:&nbsp;<a rel="previous" accesskey="p" href="ecb_002dmethods.html#ecb_002dmethods">ecb-methods</a>,
    32. 

  32. Up:&nbsp;<a rel="up" accesskey="u" href="Customizable-options.html#Customizable-options">Customizable options</a>
    33. 

  33. <hr>
    34. 

  34. </div>
    35. 

  35. 

  36. <h4 class="subsection">7.3.6 Group ecb-history</h4>
    37. 

  37. 

  38. <p class="noindent">This group contains settings for the history-buffer in the ECB:
    39. 

  39. 

  40. <div class="defun">
    41. 

  41. &mdash; User Option: <b>history-buffer-after-create-hook</b><var><a name="index-history_002dbuffer_002dafter_002dcreate_002dhook-233"></a></var><br>
    42. 

  42. <blockquote><p>Local hook running after the creation of the history-buffer. Every
    43. 

  43. function of this hook is called once without arguments direct after
    44. 

  44. creating the history-buffer of ECB and it's local key-map. So for
    45. 

  45. example a function could be added which performs calls of
    46. 

  46. <code>local-set-key</code> to define new keybindings only for the
    47. 

  47. history-buffer of ECB. 
    48. 

  48. </p></blockquote></div>
    49. 

  49. 

  50. <div class="defun">
    51. 

  51. &mdash; User Option: <b>history-buffer-name</b><var><a name="index-history_002dbuffer_002dname-234"></a></var><br>
    52. 

  52. <blockquote><p>Name of the ECB history buffer. Because it is not a normal buffer for
    53. 

  53. editing you should enclose the name with stars, e.g. &ldquo;*ECB
    54. 

  54. History*&rdquo;.
    55. 

  55. 

  56.         <p>If it is necessary for you you can get emacs-lisp access to the
    57. 

  57. buffer-object of the ECB-history-buffer by this name, e.g. by a call
    58. 

  58. of <code>set-buffer</code>.
    59. 

  59. 

  60.         <p>Changes for this option at runtime will take affect only after
    61. 

  61. deactivating and then activating ECB again! 
    62. 

  62. </p></blockquote></div>
    63. 

  63. 

  64. <div class="defun">
    65. 

  65. &mdash; User Option: <b>history-exclude-file-regexps</b><var><a name="index-history_002dexclude_002dfile_002dregexps-235"></a></var><br>
    66. 

  66. <blockquote><p>List of regexps which exclude source-files from being historized. Be
    67. 

  67. aware that each always full filenames (ie. incl. full path) are
    68. 

  68. matched against these regexps! Therefore be carefore with regexps
    69. 

  69. beginning with ^! 
    70. 

  70. </p></blockquote></div>
    71. 

  71. 

  72. <div class="defun">
    73. 

  73. &mdash; User Option: <b>history-item-name</b><var><a name="index-history_002ditem_002dname-236"></a></var><br>
    74. 

  74. <blockquote><p>The name to use for items in the history buffer. 
    75. 

  75. </p></blockquote></div>
    76. 

  76. 

  77. <div class="defun">
    78. 

  78. &mdash; User Option: <b>history-make-buckets</b><var><a name="index-history_002dmake_002dbuckets-237"></a></var><br>
    79. 

  79. <blockquote><p>Bucketize the entries of the history-buffer.
    80. 

  80. 

  81.         <p>There are several options how the bucketizing should be done:
    82. 

  82.           <ul>
    83. 

  83. <li>'never:
    84. 

    85. 

  85.           <p>No bucketizing at all, ie. all entries of the history-buffer we be
    86. 

  86. displayed flat.
    87. 

  87. 

  88.           <li>'directory:
    89. 

    90. 

  90.           <p>All entries with related filesources residing in the same
    91. 

  91. directory will be contained in a bucket named with that directory.
    92. 

  92. 

  93.           <li>'mode:
    94. 

    95. 

  95.           <p>All entries with related buffers have the same
    96. 

  96. major-mode will be contained in a bucket named with that major-mode
    97. 

  97. 

  98.           <li>'extension:
    99. 

    100. 

  100.           <p>All entries with related filesources having the
    101. 

  101. same extension will be contained in a bucket named with that extension
    102. 

  102. </ul>
    103. 

  103. 

  104.         <p>If the value is a list of regular expressions then all entries where the
    105. 

  105. buffername matches the same regular expression will be contained in one
    106. 

  106. bucket. If the value is nil then this is interpreted as an empty list of
    107. 

  107. regular expressions!
    108. 

  108. 

  109.         <p>The default value is 'directory. 
    110. 

  110. </p></blockquote></div>
    111. 

  111. 

  112. <div class="defun">
    113. 

  113. &mdash; User Option: <b>history-menu-sorter</b><var><a name="index-history_002dmenu_002dsorter-238"></a></var><br>
    114. 

  114. <blockquote><p>Function which re-sorts the menu-entries of the directories buffer.
    115. 

  115. 

  116.         <p>If a function then this function is called to sort the menu-entries of
    117. 

  117. the combined menu-entries of the user-menu-extensions of
    118. 

  118. <code>ecb-history-menu-user-extension</code> and the built-in-menu
    119. 

  119. <code>ecb-history-menu</code>. If nil then no special sorting will be done
    120. 

  120. and the user-extensions are placed in front of the built-in-entries.
    121. 

  121. 

  122.         <p>For the guidelines for such a sorter-function see
    123. 

  123. <code>ecb-directories-menu-sorter</code>. 
    124. 

  124. </p></blockquote></div>
    125. 

  125. 

  126. <div class="defun">
    127. 

  127. &mdash; User Option: <b>history-menu-user-extension</b><var><a name="index-history_002dmenu_002duser_002dextension-239"></a></var><br>
    128. 

  128. <blockquote><p>Static user extensions for the popup-menu of the history buffer. 
    129. 

  129. For further explanations see <code>ecb-directories-menu-user-extension</code>.
    130. 

  130. 

  131.         <p>The node-argument of a menu-function contains as data a cons:
    132. 

  132. 

  133.         <p>car is the filename of the source for which the popup-menu has
    134. 

  134. been opened. cdr is the related buffer-name; but be careful,
    135. 

  135. because the node can point to a dead buffer (see
    136. 

  136. <code>ecb-kill-buffer-clears-history</code>). Use always <code>ecb-source-get-*</code>
    137. 

  137. to extract whatever you need from the node-data. E.g. use
    138. 

  138. <code>ecb-source-get-filename</code> to get the full filename of the source
    139. 

  139. of the node and use <code>ecb-source-get-buffername</code> or <code>ecb-source-get-buffer</code> to
    140. 

  140. get the buffername rsp. the buffer-object.
    141. 

  141. 

  142.         <p>Per default the static user-extensions are added at the beginning of the
    143. 

  143. built-in menu-entries of <code>ecb-history-menu</code> but the whole menu can be
    144. 

  144. re-arranged with <code>ecb-history-menu-sorter</code>. 
    145. 

  145. </p></blockquote></div>
    146. 

  146. 

  147. <div class="defun">
    148. 

  148. &mdash; User Option: <b>history-menu-user-extension-function</b><var><a name="index-history_002dmenu_002duser_002dextension_002dfunction-240"></a></var><br>
    149. 

  149. <blockquote><p>Dynamic user extensions for the popup-menu of the history buffer. A
    150. 

  150. function which has to return a list in the same format like the option
    151. 

  151. <code>ecb-history-menu-user-extension</code>. This function is called when
    152. 

  152. the user opens the popup-menu for the history buffer.
    153. 

  153. 

  154.         <p>If no dynamically evaluated menu-extensions should be added to the
    155. 

  155. history-buffer the function has to return nil. Therefore the
    156. 

  156. default-value of this option is <code>ignore</code>.
    157. 

  157. 

  158.         <p>Per default the dynamic user-extensions are added in front of the
    159. 

  159. static extensions of <code>ecb-history-menu-user-extension</code> but the
    160. 

  160. whole menu can be re-arranged with <code>ecb-history-menu-sorter</code>. 
    161. 

  161. </p></blockquote></div>
    162. 

  162. 

  163. <div class="defun">
    164. 

  164. &mdash; User Option: <b>history-show-node-info</b><var><a name="index-history_002dshow_002dnode_002dinfo-241"></a></var><br>
    165. 

  165. <blockquote><p>When to display which node-info in the history-buffer. 
    166. 

  166. Define which node info should be displayed after moving the mouse
    167. 

  167. over a node (or after a shift click onto the node) in the
    168. 

  168. history-buffer.
    169. 

  169. 

  170.         <p>You can define &ldquo;when&rdquo; a node-info should be displayed:
    171. 

  171. See <code>ecb-directories-show-node-info</code> for the possible choices.
    172. 

  172. 

  173.         <p>You can define &ldquo;which&rdquo; info should be displayed:
    174. 

  174.           <ul>
    175. 

  175. <li>name: Only the full node-name is displayed. 
    176. 

  176. <li>path: The full-path of the node is displayed. 
    177. 

  177. <li>name-path: The full node-name and the full-path is displayed. 
    178. 

  178. </ul>
    179. 

  179. 

  180.         <p>Do NOT set this option directly via setq but use always customize! 
    181. 

  181. </p></blockquote></div>
    182. 

  182. 

  183. <div class="defun">
    184. 

  184. &mdash; User Option: <b>history-sort-ignore-case</b><var><a name="index-history_002dsort_002dignore_002dcase-242"></a></var><br>
    185. 

  185. <blockquote><p>Ignore case for sorting the history-entries. See also
    186. 

  186. <code>ecb-history-sort-method</code>. 
    187. 

  187. </p></blockquote></div>
    188. 

  188. 

  189. <div class="defun">
    190. 

  190. &mdash; User Option: <b>history-sort-method</b><var><a name="index-history_002dsort_002dmethod-243"></a></var><br>
    191. 

  191. <blockquote><p>Defines how the entries in the history-buffer are sorted.
    192. 

  192.           <ul>
    193. 

  193. <li><code>name</code>:
    194. 

  194. Sorting by name (default). 
    195. 

  195. <li><code>extension</code>:
    196. 

  196. Sorting first by extension and then by name. 
    197. 

  197. <li><code>nil</code>:
    198. 

  198. No sorting, means the most recently used buffers are on the top of the
    199. 

  199. history and the seldom used buffers at the bottom. 
    200. 

  200. </ul>
    201. 

  201. 

  202.         <p>See also <code>ecb-history-sort-ignore-case</code>.
    203. 

  203. 

  204.         <p>If the history is bucketized (see <code>ecb-history-make-buckets</code>) then this
    205. 

  205. sorting applies to the sorting within each bucket. 
    206. 

  206. </p></blockquote></div>
    207. 

  207. 

  208. <div class="defun">
    209. 

  209. &mdash; User Option: <b>history-stick-indirect-buffers-to-basebuffer</b><var><a name="index-history_002dstick_002dindirect_002dbuffers_002dto_002dbasebuffer-244"></a></var><br>
    210. 

  210. <blockquote><p>Stick all indirect-buffers as subnodes to their base-buffer.
    211. 

  211. 

  212.         <p>If nil then indirect-buffers are treated as non-indirect-buffers
    213. 

  213. and sorted into the history-buffer-sequence according to the
    214. 

  214. setting of <code>ecb-history-sort-method</code>.
    215. 

  215. 

  216.         <p>If not nil then indirect-buffers are always sticked to their base-buffer, ie. 
    217. 

  217. the base-buffer is displayed as expandable node with all its indirect-buffers
    218. 

  218. as children-nodes, so the history looks like:
    219. 

  219. 

  220.      <pre class="example">        [-] &lt;base-buffer BB&gt;
    221. 

  221.          |  &lt;indirect-buffer 1 of BB&gt;
    222. 

  222.          `- &lt;indirect-buffer 2 of BB&gt;
    223. 

  223.    </pre>
    224. 

  224.         </blockquote></div>
    225. 

    226. 

  226. <div class="defun">
    227. 

  227. &mdash; User Option: <b>kill-buffer-clears-history</b><var><a name="index-kill_002dbuffer_002dclears_002dhistory-245"></a></var><br>
    228. 

  228. <blockquote><p>Define if <code>kill-buffer</code> should also clear the history. There are
    229. 

  229. three options:
    230. 

    231. 

  231.           <ul>
    232. 

  232. <li><code>auto</code>:
    233. 

  233. Removes automatically the corresponding history-entry after the buffer
    234. 

  234. has been killed. 
    235. 

  235. <li><code>ask</code>:
    236. 

  236. Asks, if the history-entry should be removed after the kill. 
    237. 

  237. <li><code>nil</code>:
    238. 

  238. <code>kill-buffer</code> does not affect the history (this is the default). 
    239. 

  239. </ul>
    240. 

  240.         </p></blockquote></div>
    241. 

    242. 

  242.    </body></html>
    243.