cgit.sxemacs.org Git - packages/blob - xemacs-packages/semantic/doc/semantic.texi

   1 \input texinfo  @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename semantic.info
   4 @set TITLE  Semantic Manual
   5 @set AUTHOR Eric M. Ludlam, David Ponce, and Richard Y. Kim
   6 @settitle @value{TITLE}
   7
   8 @c *************************************************************************
   9 @c @ Header
  10 @c *************************************************************************
  11
  12 @c Merge all indexes into a single index for now.
  13 @c We can always separate them later into two or more as needed.
  14 @syncodeindex vr cp
  15 @syncodeindex fn cp
  16 @syncodeindex ky cp
  17 @syncodeindex pg cp
  18 @syncodeindex tp cp
  19
  20 @c @footnotestyle separate
  21 @c @paragraphindent 2
  22 @c @@smallbook
  23 @c %**end of header
  24
  25 @copying
  26 This manual documents Semantic, a new intrastructure for parser
  27 based text analysis for Emacs.
  28
  29 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007 Eric M. Ludlam
  30 Copyright @copyright{} 2001, 2002, 2003, 2005 David Ponce
  31 Copyright @copyright{} 2002, 2003 Richard Y. Kim
  32
  33 @quotation
  34 Permission is granted to copy, distribute and/or modify this document
  35 under the terms of the GNU Free Documentation License, Version 1.1 or
  36 any later version published by the Free Software Foundation; with the
  37 Invariant Sections being list their titles, with the Front-Cover Texts
  38 being list, and with the Back-Cover Texts being list.  A copy of the
  39 license is included in the section entitled ``GNU Free Documentation
  40 License''.
  41 @end quotation
  42 @end copying
  43
  44 @ifinfo
  45 @dircategory Emacs
  46 @direntry
  47 * Semantic: (semantic). Infrastructure for parser based text analysis.
  48 @end direntry
  49 @end ifinfo
  50
  51 @iftex
  52 @finalout
  53 @end iftex
  54
  55 @c @setchapternewpage odd
  56 @c @setchapternewpage off
  57
  58 @ifinfo
  59 This file documents Semantic.
  60 @emph{Infrastructure for parser based text analysis in Emacs}
  61
  62 Copyright @copyright{} 2002 @value{AUTHOR}
  63 @end ifinfo
  64
  65 @titlepage
  66 @sp 10
  67 @title @value{TITLE}
  68 @author by @value{AUTHOR}
  69 @vskip 0pt plus 1 fill
  70 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003 @value{AUTHOR}
  71 @page
  72 @vskip 0pt plus 1 fill
  73 @insertcopying
  74 @end titlepage
  75 @page
  76
  77 @c MACRO inclusion
  78 @include semanticheader.texi
  79
  80
  81 @c *************************************************************************
  82 @c @ Document
  83 @c *************************************************************************
  84 @contents
  85
  86 @node top
  87 @top @value{TITLE}
  88
  89 @semantic{} is a program for Emacs which includes, at its core, a
  90 lexer, and two compiler compilers (bovinator and wisent).  Additional
  91 tools include, support for imenu, speedbar, whichfunc, eldoc,
  92 hippie-expand, and several other build in tools.
  93
  94 The core utility is the parser infrastructure which allows different
  95 types of parsers to be linked into the system.  Two build in parsers
  96 include the ``bovine'' parser, and the ``wisent'' parser.
  97
  98 To send bug reports, or participate in discussions about semantic,
  99 use the mailing list cedet-semantic@@sourceforge.net via the URL:
 100 @url{http://lists.sourceforge.net/lists/listinfo/cedet-semantic}
 101
 102 @menu
 103 * Overview::
 104 * Installation/Basic Configuration::
 105 * Semantic manuals::
 106 * Semantic Internals::
 107 * Glossary::
 108 * GNU Free Documentation License::
 109 * Index::
 110 @end menu
 111
 112 @node Overview
 113 @chapter Overview
 114
 115 @include overview.texi
 116
 117 @node Installation/Basic Configuration
 118 @chapter Installation and Basic Configuration
 119
 120 @include installation.texi
 121
 122 @node Semantic manuals
 123 @chapter Semantic manuals
 124
 125 To know how to use applications enabled by @semantic{},
 126 @inforef{top, the User's Guide, semantic-user}.
 127
 128 If you are an application developer and need to know the functions and
 129 concepts,
 130 @inforef{top, the Application Development Manual, semantic-appdev}.
 131
 132 To support a new language,
 133 @inforef{top, the Language Support Developer's Guide, semantic-langdev}.
 134
 135 To use the grammar writing environment, and write in the rule based
 136 language,
 137 @inforef{top, the Grammar Framework Manual, grammar-fw}.
 138
 139 For details on the original @semantic{} @acronym{LL} parser,
 140 @inforef{top, the Bovine Parser Manual, bovine}.
 141
 142 For details on the Bison-like @acronym{LALR} parser,
 143 @inforef{top, the Wisent Parser Manual, wisent}.
 144
 145 @node Semantic Internals
 146 @chapter Semantic Internals
 147
 148 @include internals.texi
 149
 150 @node Glossary
 151 @appendix Glossary
 152
 153 @include glossary.texi
 154
 155 @node GNU Free Documentation License
 156 @appendix GNU Free Documentation License
 157
 158 @include fdl.texi
 159
 160 @node Index
 161 @unnumbered Index
 162 @printindex cp
 163
 164 @iftex
 165 @contents
 166 @summarycontents
 167 @end iftex
 168
 169 @bye
 170
 171 @c Following comments are for the benefit of ispell.
 172
 173 @c LocalWords: alist API APIs arg argc args argv asis assoc autoload Wisent
 174 @c LocalWords: backquote bnf bovinate bovinates LALR
 175 @c LocalWords: bovinating bovination bovinator bucketize
 176 @c LocalWords: cb cdr charquote checkcache cindex CLOS
 177 @c LocalWords: concat concocting const constantness ctxt Decl defcustom
 178 @c LocalWords: deffn deffnx defun defvar destructor's dfn diff dir
 179 @c LocalWords: doc docstring EDE EIEIO elisp emacsman emph enum
 180 @c LocalWords: eq Exp EXPANDFULL expresssion fn foo func funcall
 181 @c LocalWords: ia ids iff ifinfo imenu imenus init int isearch itemx java kbd
 182 @c LocalWords: keymap keywordtable lang languagemode lexer lexing Ludlam
 183 @c LocalWords: menubar metaparent metaparents min minibuffer Misc mode's
 184 @c LocalWords: multitable NAvigaTOR noindent nomedian nonterm noselect
 185 @c LocalWords: nosnarf obarray OLE OO outputfile paren parsetable POINT's
 186 @c LocalWords: popup positionalonly positiononly positionormarker pre
 187 @c LocalWords: printf printindex Programmatically pt punctuations quotemode
 188 @c LocalWords: ref regex regexp Regexps reparse resetfile samp sb
 189 @c LocalWords: scopestart SEmantic semanticdb setfilename setq
 190 @c LocalWords: settitle setupfunction sexp sp SPC speedbar speedbar's
 191 @c LocalWords: streamorbuffer struct subalist submenu submenus
 192 @c LocalWords: subsubsection sw sym texi texinfo titlefont titlepage
 193 @c LocalWords: tok TOKEN's toplevel typemodifiers uml unset untar
 194 @c LocalWords: uref usedb var vskip xref yak