]> code.delx.au - gnu-emacs/blobdiff - man/speedbar.texi
Add a provide statement.
[gnu-emacs] / man / speedbar.texi
index 8a7ad10701cb54fb2f474217d0738a8b7e18d40d..62cce0024ae9a2b79f9ecf53c2447467618cb8f0 100644 (file)
@@ -1,34 +1,13 @@
 \input texinfo   @c -*-texinfo-*-
-@c
-@c $Id: speedbar.texi,v 1.6 2000/12/05 23:06:42 fx Exp $
-@c
-
-@c This file is part of GNU Emacs
-
-@c GNU Emacs is free software; you can redistribute it and/or modify it
-@c under the terms of the GNU General Public License as published by the
-@c Free Software Foundation; either version 2 of the License, or (at
-@c your option) any later version.
-
-@c GNU Emacs is distributed in the hope that it will be useful, but
-@c WITHOUT ANY WARRANTY; without even the implied warranty of
-@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-@c General Public License for more details.
-
-@c You should have received a copy of the GNU General Public License
-@c along with Emacs; see the file COPYING.  If not, write to the Free
-@c Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
 @setfilename ../info/speedbar
 @settitle Speedbar: File/Tag summarizing utility
+@syncodeindex fn cp
 
-@dircategory Emacs
-@direntry
-* Speedbar: (speedbar).        File/Tag summarizing utility.
-@end direntry
-@ifnottex
-Copyright @copyright{} 1999, 2000 Free Software Foundation, Inc.
+@copying
+Copyright @copyright{} 1999, 2000, 2002, 2004 Free Software Foundation, Inc.
 
+@quotation
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with the
@@ -46,7 +25,13 @@ This document is part of a collection distributed under the GNU Free
 Documentation License.  If you want to distribute this document
 separately from the collection, you can do so by adding a copy of the
 license to the document, as described in section 6 of the license.
-@end ifnottex
+@end quotation
+@end copying
+
+@dircategory Emacs
+@direntry
+* Speedbar: (speedbar). File/Tag summarizing utility.
+@end direntry
 
 @titlepage
 @sp 10
@@ -56,29 +41,9 @@ license to the document, as described in section 6 of the license.
 @vskip 0pt plus 1 fill
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1999, 2000 Free Software Foundation, Inc.
-@sp 1
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-any later version published by the Free Software Foundation; with the
-Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
-``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License'' in the Emacs manual.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
-
-This document is part of a collection distributed under the GNU Free
-Documentation License.  If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-license to the document, as described in section 6 of the license.
+@insertcopying
 @end titlepage
 
-@syncodeindex fn cp
-
 @node Top, , , (dir)Top
 @comment  node-name,  next,  previous,  up
 
@@ -161,18 +126,18 @@ system, and look.  If one mode is learned, then the other modes are easy
 to use.
 
 @menu
-* Basic Keybindings::
+* Basic Key Bindings::
 * Basic Visuals::
 * Mouse Bindings::
 * Displays Submenu::
 @end menu
 
-@node Basic Keybindings, Basic Visuals, Basic Navigation, Basic Navigation
+@node Basic Key Bindings, Basic Visuals, Basic Navigation, Basic Navigation
 @comment  node-name,  next,  previous,  up
-@section Basic Keybindings
-@cindex keybindings
+@section Basic Key Bindings
+@cindex key bindings
 
-These keybindings are common across all modes:
+These key bindings are common across all modes:
 
 @table @kbd
 @item delete, SPC
@@ -244,7 +209,7 @@ flushed.  This is similar to a power click.  @xref{Mouse Bindings}.
 Contract the current group, hiding sub items.
 @end table
 
-@node Basic Visuals, Mouse Bindings, Basic Keybindings, Basic Navigation
+@node Basic Visuals, Mouse Bindings, Basic Key Bindings, Basic Navigation
 @comment  node-name,  next,  previous,  up
 @section Basic Visuals
 @cindex visuals
@@ -292,7 +257,7 @@ file uses square brackets.
 In all modes, a group can be `edited' by pressing @kbd{RET}, meaning a
 file will be opened, or a directory explicitly opened in speedbar.  A
 group can be expanded or contracted using @kbd{+} or
-@kbd{-}.  @xref{Basic Keybindings}.
+@kbd{-}.  @xref{Basic Key Bindings}.
 
 Sometimes groups may have a @samp{?} in its indicator box.  This means
 that it is a group type, but there are no contents, or no known way of
@@ -423,7 +388,7 @@ Advanced behavior, like copying and renaming files, is also provided.
 @menu
 * Directory Display::   What the display means.
 * Hidden Files::        How to display hidden files.
-* File Keybindings::    Performing file operations.
+* File Key Bindings::   Performing file operations.
 @end menu
 
 @node Directory Display, Hidden Files, File Mode, File Mode
@@ -510,14 +475,14 @@ Some group names may say something like @samp{speedbar-t to speedbar-v},
 indicating that all symbols which alphabetically fall between those
 categories are included in that sub-group.  @xref{Tag Hierarchy Methods}.
 
-@node Hidden Files, File Keybindings, Directory Display, File Mode
+@node Hidden Files, File Key Bindings, Directory Display, File Mode
 @comment  node-name,  next,  previous,  up
 @section Hidden Files
 @cindex hidden files
 
-On Unix, a hidden file is a file whose name starts with a period.  They
-are hidden from a regular directory listing because the user is not
-generally interested in them.
+On GNU and Unix systems, a hidden file is a file whose name starts
+with a period.  They are hidden from a regular directory listing
+because the user is not generally interested in them.
 
 In speedbar, a hidden file is a file which isn't very interesting and
 might prove distracting to the user.  Any uninteresting files are
@@ -537,12 +502,12 @@ Object files fall into the category of level 2 hidden files.  You can
 determine their presence by the @samp{#} and @samp{!} file indicators.
 @xref{Directory Display}.
 
-@node File Keybindings, , Hidden Files, File Mode
+@node File Key Bindings, , Hidden Files, File Mode
 @comment  node-name,  next,  previous,  up
-@section File Keybindings
-@cindex file keybindings
+@section File Key Bindings
+@cindex file key bindings
 
-File mode has keybindings permitting different file system operations
+File mode has key bindings permitting different file system operations
 such as copy or rename.  These commands all operate on the @dfn{current
 file}.  In this case, the current file is the file at point, or clicked
 on when pulling up the menu.
@@ -589,7 +554,7 @@ These buffers can have their tags expanded in the same way as files,
 and uses the same unknown file indicator (@pxref{File Mode}).
 
 Buffer mode does not have file operation bindings, but the following
-buffer specific keybindings are available:
+buffer specific key bindings are available:
 
 @table @kbd
 @item k
@@ -622,7 +587,7 @@ In these cases, a minor display mode is needed.  A minor display mode
 will override any major display mode currently being displayed for the
 duration of the specialized buffer's use.  Minor display modes
 will follow the general rules of their major counterparts in terms of
-keybindings and visuals, but will have specialized behaviors.
+key bindings and visuals, but will have specialized behaviors.
 
 @menu
 * RMAIL::  Managing folders in speedbar
@@ -682,10 +647,6 @@ You can click on any stack element and gdb will move to that stack
 level.  You can then check variables local to that level at the GDB
 prompt.
 
-This mode has the unfortunate side-effect of breaking GDB's repeat
-feature when you hit @kbd{RET} since your previous command is overridden
-with a stack fetching command.
-
 @node Customizing, Extending, Minor Modes, Top
 @comment  node-name,  next,  previous,  up
 @chapter Customizing
@@ -895,7 +856,7 @@ Hooks run when speedbar is loaded.
 @cindex @code{speedbar-reconfigure-keymaps-hook}
 @item speedbar-reconfigure-keymaps-hook
 Hooks run when the keymaps are regenerated.  Keymaps are reconfigured
-whenever modes change.  This will let you add custom keybindings.
+whenever modes change.  This will let you add custom key bindings.
 @cindex @code{speedbar-before-popup-hook}
 @item speedbar-before-popup-hook
 Hooks called before popping up the speedbar frame.
@@ -1105,7 +1066,7 @@ summary to display in the minibuffer.
 
 There are several helper functions you can use if you are going to use
 built in tagging.  These functions can be @code{or}ed since each one
-returns non-nil if it displays a message.  They are:
+returns non-@code{nil} if it displays a message.  They are:
 
 @table @code
 @cindex @code{speedbar-item-info-file-helper}
@@ -1204,7 +1165,7 @@ when the mouse passes over it.  @var{function} is called whenever the
 user clicks on the text.
 
 The optional argument @var{token} is extra data to associated with the
-text.  Lastly @var{prevline} should be non-nil if you want this line to
+text.  Lastly @var{prevline} should be non-@code{nil} if you want this line to
 appear directly after the last button which was created instead of on
 the next line.
 @end defun
@@ -1279,5 +1240,9 @@ Two good values are @code{nil} and @code{'statictag}.
 @printindex cp
 
 @bye
-@c  LocalWords:  speedbar's xref Keybindings slowbar kbd subsubsection
+@c  LocalWords:  speedbar's xref slowbar kbd subsubsection
 @c  LocalWords:  keybindings
+
+@ignore
+   arch-tag: e1fc85f0-1eeb-489f-a8d4-a2bfe711fa02
+@end ignore