site-lisp/cedet-1.0pre4/speedbar/speedbar/Directory-Display.html

   1 <html lang="en">
   2 <head>
   3 <title>Directory Display - Speedbar: File/Tag summarizing utility</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="Speedbar: File/Tag summarizing utility">
   6 <meta name="generator" content="makeinfo 4.8">
   7 <link title="Top" rel="start" href="index.html#Top">
   8 <link rel="up" href="File-Mode.html#File-Mode" title="File Mode">
   9 <link rel="prev" href="File-Mode.html#File-Mode" title="File Mode">
  10 <link rel="next" href="Hidden-Files.html#Hidden-Files" title="Hidden Files">
  11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  12 <meta http-equiv="Content-Style-Type" content="text/css">
  13 <style type="text/css"><!--
  14   pre.display { font-family:inherit }
  15   pre.format  { font-family:inherit }
  16   pre.smalldisplay { font-family:inherit; font-size:smaller }
  17   pre.smallformat  { font-family:inherit; font-size:smaller }
  18   pre.smallexample { font-size:smaller }
  19   pre.smalllisp    { font-size:smaller }
  20   span.sc    { font-variant:small-caps }
  21   span.roman { font-family:serif; font-weight:normal; }
  22   span.sansserif { font-family:sans-serif; font-weight:normal; }
  23 --></style>
  24 </head>
  25 <body>
  26 <div class="node">
  27 <p>
  28 <a name="Directory-Display"></a>
  29 Next:&nbsp;<a rel="next" accesskey="n" href="Hidden-Files.html#Hidden-Files">Hidden Files</a>,
  30 Previous:&nbsp;<a rel="previous" accesskey="p" href="File-Mode.html#File-Mode">File Mode</a>,
  31 Up:&nbsp;<a rel="up" accesskey="u" href="File-Mode.html#File-Mode">File Mode</a>
  32 <hr>
  33 </div>
  34
  35 <!-- node-name,  next,  previous,  up -->
  36 <h3 class="section">3.1 Directory Display</h3>
  37
  38 <p><a name="index-directory-display-17"></a>
  39 There are three major sections in the display.  The first line or two is
  40 the root directory speedbar is currently viewing.  You can jump to one
  41 of the parent directories by clicking on the name of the directory you
  42 wish to jump to.
  43
  44    <p>Next, directories are listed.  A directory starts with the group
  45 indicator button `<samp><span class="samp">&lt;+&gt;</span></samp>'.  Clicking the directory name makes speedbar
  46 load that directory as the root directory for its display.  Clicking the
  47 `<samp><span class="samp">&lt;+&gt;</span></samp>' button will list all directories and files beneath.
  48
  49    <p>Next, files are listed.  Files start with the group indicator `<samp><span class="samp">[+]</span></samp>'
  50 or `<samp><span class="samp">[?]</span></samp>'.  You can jump to a file in the attached frame by clicking
  51 on the file name.  You can expand a file and look at its tags by
  52 clicking on the `<samp><span class="samp">[+]</span></samp>' symbol near the file name.
  53
  54    <p>A typical session might look like this:
  55
  56 <pre class="example">     ~/lisp/
  57      &lt;+&gt; checkdoc
  58      &lt;+&gt; eieio
  59      &lt;-&gt; speedbar
  60       [+] Makefile
  61       [+] rpm.el #
  62       [+] sb-gud.el #
  63       [+] sb-info.el #
  64       [+] sb-rmail.el #
  65       [+] sb-w3.el
  66       [-] speedbar.el *!
  67        {+} Types
  68        {+} Variables
  69        {+} def (group)
  70        {+} speedbar-
  71       [+] speedbar.texi *
  72      &lt;+&gt; testme
  73      [+] align.el
  74      [+] autoconf.el
  75 </pre>
  76    <p>In this example, you can see several directories.  The directory
  77 <samp><span class="file">speedbar</span></samp> has been opened inline.  Inside the directory
  78 <samp><span class="file">speedbar</span></samp>, the file <samp><span class="file">speedbar.el</span></samp> has its tags exposed.
  79 These tags are extensive, and they are summarized into tag groups.
  80
  81    <p>Files get additional boolean flags associated with them.  Valid flags are:
  82
  83    <p><a name="index-file-flags-18"></a>
  84      <dl>
  85 <dt><code>*</code><dd>This file has been checked out of a version control
  86 system.  See <a href="Version-Control.html#Version-Control">Version Control</a>.
  87 <a name="index-g_t_0040code_007bspeedbar_002dobj_002dalist_007d-19"></a><br><dt><code>#</code><dd>This file has an up to date object file associated with it.  The
  88 variable <code>speedbar-obj-alist</code> defines how speedbar determines this
  89 value.
  90 <br><dt><code>!</code><dd>This file has an out of date object file associated with it.
  91 </dl>
  92
  93    <p>A Tag group is prefixed with the symbol `<samp><span class="samp">{+}</span></samp>'.  Clicking this
  94 symbol will show all symbols that have been organized into that group.
  95 Different types of files have unique tagging methods as defined by their
  96 major mode.  Tags are generated with either the <code>imenu</code> package, or
  97 through the <code>etags</code> interface.
  98
  99    <p>Tag groups are defined in multiple ways which make it easier to find the
 100 tag you are looking for.  Imenu keywords explicitly create groups, and
 101 speedbar will automatically create groups if tag lists are too long.
 102
 103    <p>In our example, Imenu created the groups `<samp><span class="samp">Types</span></samp>' and
 104 `<samp><span class="samp">Variables</span></samp>'.  All remaining top-level symbols are then regrouped
 105 based on the variable <code>speedbar-tag-hierarchy-method</code>.  The
 106 subgroups `<samp><span class="samp">def</span></samp>' and `<samp><span class="samp">speedbar-</span></samp>' are groupings where the first
 107 few characters of the given symbols are specified in the group name.
 108 Some group names may say something like `<samp><span class="samp">speedbar-t to speedbar-v</span></samp>',
 109 indicating that all symbols which alphabetically fall between those
 110 categories are included in that sub-group.  See <a href="Tag-Hierarchy-Methods.html#Tag-Hierarchy-Methods">Tag Hierarchy Methods</a>.
 111
 112    </body></html>
 113