Debian Codegraph @

README

raw
1 GNU cflow README
2 Copyright (C) 2005-2025 Sergey Poznyakoff
3 See the end of file for copying conditions.
4
5 * Introduction
6
7 This file contains brief information about configuring, and installing
8 GNU cflow. It is *not* intended as a replacement for the
9 documentation, instead it is provided as a brief reference only.
10 Please be sure to read the accompanuing documentation before using the
11 utility. See section `Documentation' below.
12
13 For the generic configuration options, see the file `INSTALL'.
14 Refer to file `ABOUT-NLS' for information regarding internationalization.
15
16 * History
17
18 The GNU cflow was initially written in 1997, when I needed a utility
19 that could display the control flow in a C program. The latest updates
20 in its old repo date back to 1999. Then, as I no longer needed the
21 package, it fell into oblivion.
22
23 Six years later a thread in gnu-devel mailing list had shown that
24 there is a kind of demand for that sort of utility, so I decided to
25 resurrect it and make a full-fledged package of it. On 2005-04-12 it
26 was dubbed a GNU package.
27
28 * Current Status
29
30 The package is fully operational. It compiles and runs on any
31 GNU/Linux and most decent UNIX-like systems. It supports all command
32 line switches required by POSIX, plus a number of extended ones. It is
33 able to produce output in two formats: in GNU cflow format (which is
34 the default) and in POSIX format.
35
36 Currently the utility is only able to process C sources. It is the
37 only deviation from POSIX specs, which requires ability to process
38 YACC and LEX sources as well as binary object files. This support will
39 appear in future versions.
40
41 Emacs module cflow-mode.el works with files in GNU cflow format (as
42 opposed to POSIX format). It has been tested with Emacs 24.2.1.
43
44 * Compilation
45
46 Please see the INSTALL file in this directory for the generic instructions
47 on how to use configure. There is currently only one package-specific
48 configuration option: --enable-debug, which compiles the package with
49 -g (or -ggdb if appropriate) option. Use it if you plan debugging
50 cflow.
51
52 * Installation
53
54 After running `./configure' and `make', run `make install'.
55
56 * Configuration File
57
58 The file src/cflow.rc provides a working configuration file for use
59 with gcc. See the documentation, sections 6.1 "Syntactic classes" and
60 6.3 "GCC Initialization", for more information.
61
62 * Documentation
63
64 Complete user manual in texinfo format is provided. After the
65 installation, it will be accessible by running `info cflow'. To read it
66 before installing the package, run `info -f doc/cflow' from the
67 package source root directory.
68
69 If you don't have GNU texinfo installed, see
70 http://www.gnu.org/software/texinfo for information on where to obtain it.
71
72 * Bug reporting.
73
74 Send bug reports and suggestions to <[email protected]>.
75
76 * Copyright Information:
77
78 Copyright (C) 2005, 2010, 2011, 2014 Sergey Poznyakoff
79
80 Permission is granted to anyone to make or distribute verbatim copies
81 of this document as received, in any medium, provided that the
82 copyright notice and this permission notice are preserved,
83 thus giving the recipient permission to redistribute in turn.
84
85 Permission is granted to distribute modified versions
86 of this document, or of portions of it,
87 under the above conditions, provided also that they
88 carry prominent notices stating who last changed them.
89
90
91 Local variables:
92 mode: outline
93 paragraph-separate: "[ ]*$"
94 end: