home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / info / calc.info-29 (.txt) < prev    next >
GNU Info File  |  1994-12-22  |  22KB  |  362 lines
  1. This is Info file calc.info, produced by Makeinfo-1.55 from the input
  2. file calc.texinfo.
  3.    This file documents Calc, the GNU Emacs calculator.
  4.    Copyright (C) 1990, 1991 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the section entitled "GNU General Public License" is included
  11. exactly as in the original, and provided that the entire resulting
  12. derived work is distributed under the terms of a permission notice
  13. identical to this one.
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that the section entitled "GNU General Public License"
  17. may be included in a translation approved by the author instead of in
  18. the original English.
  19. File: calc.info,  Node: Installation,  Next: Reporting Bugs,  Prev: Programming,  Up: Top
  20. Installation
  21. ************
  22. Calc 2.02 comes as a set of GNU Emacs Lisp files, with names like
  23. `calc.el' and `calc-ext.el', and also as a `calc.texinfo' file which
  24. can be used to generate both on-line and printed documentation.
  25.    To install Calc, just follow these simple steps.  If you want more
  26. information, each step is discussed at length in the sections below.
  27.   1. Change (`cd') to the Calc "home" directory.  This directory was
  28.      created when you unbundled the Calc `.tar' or `.shar' file.
  29.   2. Type `make' to install Calc privately for your own use, or type
  30.      `make install' to install Calc system-wide.  This will compile all
  31.      the Calc component files, modify your `.emacs' or the system-wide
  32.      `lisp/default' file to install Calc as appropriate, and format the
  33.      on-line Calc manual.
  34.      Both variants are shorthand for the following three steps:
  35.         * `make compile' to run the byte-compiler.
  36.         * `make private' or `make public', corresponding to `make' and
  37.           `make install', respectively.  (If `make public' fails
  38.           because your system doesn't already have a `default' or
  39.           `default.el' file, use Emacs or the Unix `touch' command to
  40.           create a zero-sized one first.)
  41.         * `make info' to format the on-line Calc manual.  This first
  42.           tries to use the `makeinfo' program; if that program is not
  43.           present, it uses the Emacs `texinfo-format-buffer' command
  44.           instead.
  45.      The Unix `make' utility looks in the file `Makefile' in the
  46.      current directory to see what Unix commands correspond to the
  47.      various "targets" like `install' or `public'.  If your system
  48.      doesn't have `make', you will have to examine the `Makefile' and
  49.      type in the corresponding commands by hand.
  50.   3. If you ever move Calc to a new home directory, just give the `make
  51.      private' or `make public' command again in the new directory.
  52.   4. Test your installation as described at the end of these
  53.      instructions.
  54.   5. (Optional.)  To print a hardcopy of the Calc manual (over 500
  55.      pages) or just the Calc Summary (about 20 pages), follow the
  56.      instructions under "Printed Documentation" below.
  57. Calc is now installed and ready to go!
  58. Upgrading from Calc 1.07
  59. ========================
  60. If you have Calc version 1.07 or earlier, you will find that Calc 2.00
  61. is organized quite differently.  For one, Calc 2.00 is now distributed
  62. already split into many parts; formerly this was done as part of the
  63. installation procedure.  Also, some new functions must be autoloaded
  64. and the `M-#' key must be bound to `calc-dispatch' instead of to `calc'.
  65.    The easiest way to upgrade is to delete your old Calc files and then
  66. install Calc 2.00 from scratch using the above instructions.  You should
  67. then go into your `.emacs' or `default' file and remove the old
  68. `autoload' and `global-set-key' commands for Calc, since `make
  69. public'/`make private' has added new, better ones.
  70.    See the `README' and `README.prev' files in the Calc distribution
  71. for more information about what has changed since version 1.07.
  72. (`README.prev' describes changes before 2.00, and is present only in
  73. the FTP and tape versions of the distribution.)
  74. The `make public' Command
  75. =========================
  76. If you are not the regular Emacs administrator on your system, your
  77. account may not be allowed to execute the `make public' command, since
  78. the system-wide `default' file may be write-protected.  If this is the
  79. case, you will have to ask your Emacs installer to execute this
  80. command.  (Just `cd' to the Calc home directory and type `make public'.)
  81.    The `make private' command adds exactly the same set of commands to
  82. your `.emacs' file as `make public' adds to `default'.  If your Emacs
  83. installer is concerned about typing this command out of the blue, you
  84. can ask her/him instead to copy the necessary text from your `.emacs'
  85. file.  (It will be marked by a comment that says "Commands added by
  86. `calc-private-autoloads' on (date and time).")
  87. Compilation
  88. ===========
  89. Calc is written in a way that maximizes performance when its code has
  90. been byte-compiled; a side effect is that performance is seriously
  91. degraded if it *isn't* compiled.  Thus, it is essential to compile the
  92. Calculator before trying to use it.  The function `calc-compile' in the
  93. file `calc-maint.el' runs the Emacs byte-compiler on all the Calc source
  94. files.  (Specifically, it runs `M-x byte-compile-file' on all files in
  95. the current directory with names of the form `calc*.el', and also on
  96. the file `macedit.el'.)
  97.    If `calc-compile' finds that certain files have already been
  98. compiled and have not been changed since, then it will not bother to
  99. recompile those files.
  100.    The `calc-compile' command also pre-builds certain tables, such as
  101. the units table (*note The Units Table::.) and the built-in rewrite
  102. rules (*note Rearranging with Selections::.) which Calc would otherwise
  103. need to rebuild every time those features were used.
  104.    The `make compile' shell command is simply a convenient way to start
  105. an Emacs and give it a `calc-compile' command.
  106. Auto-loading
  107. ============
  108. To teach Emacs how to load in Calc when you type `M-#' for the first
  109. time, add these lines to your `.emacs' file (if you are installing Calc
  110. just for your own use), or the system's `lisp/default' file (if you are
  111. installing Calc publicly).  The `make private' and `make public'
  112. commands, respectively, take care of this.  (Note that `make' runs
  113. `make private', and `make install' runs `make public'.)
  114.      (autoload 'calc-dispatch          "calc" "Calculator Options" t)
  115.      (autoload 'full-calc              "calc" "Full-screen Calculator" t)
  116.      (autoload 'full-calc-keypad       "calc" "Full-screen X Calculator" t)
  117.      (autoload 'calc-eval              "calc" "Use Calculator from Lisp")
  118.      (autoload 'defmath                "calc" nil t t)
  119.      (autoload 'calc                   "calc" "Calculator Mode" t)
  120.      (autoload 'quick-calc             "calc" "Quick Calculator" t)
  121.      (autoload 'calc-keypad            "calc" "X windows Calculator" t)
  122.      (autoload 'calc-embedded          "calc" "Use Calc from any buffer" t)
  123.      (autoload 'calc-embedded-activate "calc" "Activate =>'s in buffer" t)
  124.      (autoload 'calc-grab-region       "calc" "Grab region of Calc data" t)
  125.      (autoload 'calc-grab-rectangle    "calc" "Grab rectangle of data" t)
  126.    Unless you have installed the Calc files in Emacs' main `lisp/'
  127. directory, you will also have to add a command that looks like the
  128. following to tell Emacs where to find them.  In this example, we have
  129. put the files in directory `/usr/gnu/src/calc-2.00'.
  130.      (setq load-path (append load-path (list "/usr/gnu/src/calc-2.00")))
  131. The `make public' and `make private' commands also do this (they use
  132. the then-current directory as the name to add to the path).  If you
  133. move Calc to a new location, just repeat the `make public' or `make
  134. private' command to have this new location added to the `load-path'.
  135.    The `autoload' command for `calc-dispatch' is what loads `calc.elc'
  136. when you type `M-#'.  It is the