cgit.sxemacs.org Git - packages/blob - xemacs-packages/clearcase/clearcase.texi

   1 \input texinfo   @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename clearcase.info
   4 @settitle XEmacs Clearcase Reference Manual
   5 @dircategory XEmacs
   6 @direntry
   7 * Clearcase: (clearcase).      New Clearcase Version Control for XEmacs (UNIX, Windows).
   8 @end direntry
   9 @c footnotestyle separate
  10 @c paragraphindent 2
  11 @c %**end of header
  12 @setchapternewpage odd
  13 @ifinfo
  14 This document describes the XEmacs package called clearcase.
  15 Copyright @copyright{} 2001 Adrian Aichner.
  16 @end ifinfo
  17
  18 @c @c Combine indices.
  19 @c @synindex cp fn
  20 @c @syncodeindex vr fn
  21 @c @syncodeindex ky fn
  22 @c @syncodeindex pg fn
  23 @c @syncodeindex tp fn
  24
  25 @titlepage
  26 @c @sp 10
  27 @c @comment The title is printed in a large font.
  28 @c @center @titlefont{Clearcase}
  29 @c @c The following two commands start the copyright page.
  30 @c @page
  31 @c @vskip 0pt plus 1filll
  32 @c Copyright @copyright{} 2000 Adrian Aichner.
  33 @title XEmacs Clearcase Reference Manual
  34 @subtitle Version 1.00 (for XEmacs 21.1, 21.2), dated 2001-12-09
  35
  36 @author by Adrian Aichner
  37 @page
  38 @vskip 0pt plus 1filll
  39 @sp 2
  40 @c Version 3.3 @*
  41 @c Revised for XEmacs Versions 21.0,@*
  42 @c April 1998.@*
  43
  44 Permission is granted to make and distribute verbatim copies of this
  45 manual provided the copyright notice and this permission notice are
  46 preserved on all copies.
  47
  48 Permission is granted to copy and distribute modified versions of this
  49 manual under the conditions for verbatim copying, provided also that the
  50 section entitled ``GNU General Public License'' is included
  51 exactly as in the original, and provided that the entire resulting
  52 derived work is distributed under the terms of a permission notice
  53 identical to this one.
  54
  55 Permission is granted to copy and distribute translations of this manual
  56 into another language, under the above conditions for modified versions,
  57 except that the section entitled ``GNU General Public License'' may be
  58 included in a translation approved by the Free Software Foundation
  59 instead of in the original English.
  60 @end titlepage
  61 @node Top, Clearcase Overview, , (dir)
  62 @comment node-name, next,          previous, up
  63 @chapter Clearcase Package
  64
  65 This is the XEmacs Clearcase Reference Manual, Version 1.00 (for XEmacs
  66 21.1, 21.2), released 2001-12-09, by @email{adrian@@xemacs.org, Adrian
  67 Aichner}.
  68
  69 @menu
  70 * Clearcase Overview::                Overview of clearcase package
  71 * Clearcase Installation::            Installation of the clearcase package
  72 * Known Problems of Clearcase::       Problems, Workarounds, and Fixes
  73 * Concept Index::                     An item for each concept
  74 @end menu
  75
  76 @node Clearcase Overview, Clearcase Installation, Top, (dir)
  77 @comment node-name,     next,          previous, up
  78 @chapter Clearcase Overview
  79 @cindex What is clearcase?
  80
  81 @code{clearcase} is a Configuration Management System of Rational
  82 Software Corporation written by @email{esler@@rational.com, Kevin
  83 Esler}.
  84
  85 The @code{clearcase} package described here supports ClearCase version
  86 control from within the @code{XEmacs} editor.
  87
  88 @enumerate
  89
  90 @item
  91
  92 Make sure you're using Gnu Emacs-20.4 or XEmacs-21.1 or later.
  93
  94 Make sure that you DON'T load old versions of vc-hooks.el which contain
  95 incompatible versions of the tq package (functions tq-enqueue and
  96 friends). In particular, Bill Sommerfeld's VC/CC integration has this
  97 problem.
  98
  99 @item
 100
 101 Insert this in your emacs startup file:
 102 (unless (noninteractive)
 103   (require 'clearcase))
 104
 105 @end enumerate
 106
 107 When you begin editing in any view-context, a ClearCase menu will appear
 108 and ClearCase Minor Mode will be activated for you.
 109
 110 @node Clearcase Installation, Known Problems of Clearcase, Clearcase Overview, (dir)
 111 @comment node-name,     next,          previous, up
 112 @chapter Clearcase Installation
 113 @cindex How to install clearcase
 114
 115 You have following three choices to install clearcase (@pxref{Using
 116 Packages, Using Packages, , xemacs}):
 117
 118 @enumerate
 119
 120 @item
 121 Use the package GUI:
 122
 123 @itemize @bullet
 124
 125 @item
 126 In XEmacs Release 21.1:
 127
 128 Select a download site under
 129
 130 @example
 131 Options->Manage Packages->Add Download Site
 132 @end example
 133
 134 and after listing available packages with
 135
 136 @example
 137 Options->Manage Packages->List & Install
 138 @end example
 139
 140 install @code{clearcase} with
 141
 142 @example
 143 Packages->Toggle install `clearcase'
 144 Packages->Install/Remove Selected
 145 @end example
 146
 147 followed by starting a fresh XEmacs.
 148
 149 @item
 150 In XEmacs Beta Release 21.2-bXX:
 151
 152 Menus have been re-arranged in XEmacs 21.2.
 153
 154 Select a download site under
 155
 156 @example
 157 Tools->Packages->Add Download Site
 158 @end example
 159
 160 and after listing available packages with
 161
 162 @example
 163 Tools->Packages->List and Install
 164 @end example
 165
 166 install @code{clearcase} with
 167
 168 @example
 169 Packages->Toggle install `clearcase'
 170 Packages->Install/Remove Selected
 171 @end example
 172
 173 followed by starting a fresh XEmacs.
 174
 175 @end itemize
 176
 177 @item
 178 Run XEmacs command
 179
 180 @example
 181 @kbd{M-x package-admin-add-binary-package RET @var{clearcase-package-tarball-path}}
 182 @end example
 183
 184 after tarball download with EFS or ftp.
 185
 186 @item
 187
 188 Extract the clearcase tarball(s) into the xemacs-packages hierarchy from
 189 your favorite shell.
 190
 191 @code{bash}, @code{csh}, @code{ksh}, @code{zsh} come to mind on
 192 @code{UNIX} systems; @code{Cygwin's} @code{bash}, @code{cmd.exe}, and
 193 @code{command.exe} for @code{Windows 95/98/NT}.
 194
 195 @example
 196 @kbd{cd @var{installation-directory}/xemacs-packages;
 197 gzip -dc @var{clearcase-package-tarball-path} | tar -xvf -}
 198 @end example
 199
 200 @end enumerate
 201
 202 @node Known Problems of Clearcase, Concept Index, Clearcase Installation, Top
 203 @comment node-name,    next,  previous,      up
 204 @chapter Known Problems of Clearcase
 205 @cindex Limitations
 206 @cindex Bugs
 207
 208 @enumerate
 209
 210 @item
 211 None known.  Please report any using M-x report-emacs-bug.
 212
 213 @end enumerate
 214
 215 @node Concept Index, , Known Problems of Clearcase, Top
 216 @comment node-name,    next,  previous,      up
 217 @unnumbered Concept Index
 218 @printindex cp
 219 @contents
 220 @bye