Newer Older
1
README for CC Mode 5.34
2
Current maintainer : Alan Mackenzie
andreasj's avatar
andreasj committed
3
Contact address    : bug-cc-mode@gnu.org
martinb's avatar
martinb committed
4 5 6

INTRODUCTION

andreasj's avatar
andreasj committed
7
    The canonical web location for all knowledge CC Mode is:
martinb's avatar
martinb committed
8

andreasj's avatar
andreasj committed
9
	<http://cc-mode.sourceforge.net/>
martinb's avatar
martinb committed
10 11 12 13

    Please read the cc-mode.texi manual for details on using CC Mode.
    This is available on-line from:

14
        <http://cc-mode.sourceforge.net/html-manual/index.html>
martinb's avatar
martinb committed
15

16 17 18
    As of this writing (June 2019), CC Mode currently works out of
    the box with XEmacs versions 21.5 (latest release) and later, and
    with Emacs versions 24.5 and later.  (It might well still work
19
    with some earlier versions and will very likely work with later
20 21 22
    versions too, when they become available.)  Note that due to the
    cessation of active develpment of XEmacs, CC Mode 5.34 might well
    be the last version to support XEmacs at all.
martinb's avatar
martinb committed
23 24 25

MORE INFORMATION

andreasj's avatar
andreasj committed
26
    Check out the CC Mode web site for the latest information,
martinb's avatar
martinb committed
27 28 29 30 31 32 33 34 35 36 37 38
    updates, tips, installation and compatibility notes, etc. on using
    CC Mode.  The installation instructions given below are an excerpt
    of the on-line instructions.  If you have problems installing CC
    Mode, please check out the URL above before submitting a bug
    report.  Thanks!

    The MANIFEST file contains a description of all the files you
    should have gotten with this distribution.

MANUALS

    Preformatted versions of the manual in DVI, PostScript, and Info,
39 40 41 42
    are all available at the CC Mode web page.  The Info manual has
    two variants, one for GNU Emacs, the other for XEmacs - the only
    differences between them are the targets of some cross references
    within the manual.
martinb's avatar
martinb committed
43

44
    To build the manual yourself, you will need Texinfo 4.7 or later
45 46
    or Texinfo 5.x or later.  For 5.x or 6.x (recommended), Simply
    type:
martinb's avatar
martinb committed
47

48 49 50
        % makeinfo cc-mode.texi                   # For GNU Emacs
    or
        % makeinfo -DXEMACS cc-mode.texi          # For XEmacs
martinb's avatar
martinb committed
51

52
    To make the DVI version, type:
martinb's avatar
martinb committed
53 54 55

        % texi2dvi cc-mode.texi

56
    If you're still using Texinfo 4.x, see its manual.
57

martinb's avatar
martinb committed
58 59 60
INSTALLATION

    Here is a quick guide for installing CC Mode.  For the latest
youngs's avatar
youngs committed
61
    information on installing CC Mode, please see the CC Mode web site
martinb's avatar
martinb committed
62 63
    given above.

64 65 66
    If you're using XEmacs, make sure you've got the "advice" package
    installed.

martinb's avatar
martinb committed
67 68
  Byte Compiling

mast's avatar
mast committed
69 70 71
    It is highly recommended that you byte-compile CC Mode for
    performance reasons.  Running CC Mode non-byte-compiled is not
    supported.
youngs's avatar
youngs committed
72 73 74

    You can compile CC Mode in the same way as any other package.  To
    compile it from a running (X)Emacs session:
martinb's avatar
martinb committed
75

youngs's avatar
youngs committed
76 77 78
        M-0 M-x byte-recompile-directory RET /path/to/cc-mode RET

    To compile CC Mode from the shell:
martinb's avatar
martinb committed
79

80 81
        $ cd /path/to/cc-mode
        $ $(EMACS) -batch -no-site-file -q -f batch-byte-compile cc-*.el
martinb's avatar
martinb committed
82 83

    where $(EMACS) is either emacs or xemacs depending on the flavor
84 85 86
    you use.  Note that the byte compiled files from one version of
    (X)Emacs are likely not to work on a different version - compile
    them fresh when you upgrade your (X)Emacs version.
martinb's avatar
martinb committed
87

youngs's avatar
youngs committed
88
  Installing
andreasj's avatar
andreasj committed
89

youngs's avatar
youngs committed
90 91 92
    Put the compiled files somewhere (X)Emacs will find them, i.e. in
    some path that's in the load-path variable.  You must make sure
    they are found before any CC Mode files which are distributed with
mast's avatar
mast committed
93 94 95
    (X)Emacs.  A directory has higher precendence than all directories
    after it in the load-path list.

martinb's avatar
martinb committed
96 97 98 99 100 101 102
    To test that you have things set up correctly, visit a C file and
    then type:

        M-x c-version RET
        => Using CC Mode version 5.XX

    where XX is the correct minor revision number.
youngs's avatar
youngs committed
103 104 105 106 107 108 109 110

  Compatibility Issues

    CC Mode should work fine with most versions of Emacs and XEmacs
    which aren't ancient (see the introduction above).

    For more details about interactions with different packages, see
    the CC Mode web page.