diff options
author | Sergey Poznyakoff <gray@gnu.org> | 2019-02-08 17:49:17 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org> | 2019-02-08 17:49:17 +0200 |
commit | a91da30acb68c56789caf2700108222c7f22d199 (patch) | |
tree | 3a233825a1a36806cd5977e038c516674d1c787b | |
parent | b64ca53d3f65ea7d51afa977e9d4bed808f494f7 (diff) | |
download | cflow-a91da30acb68c56789caf2700108222c7f22d199.tar.gz cflow-a91da30acb68c56789caf2700108222c7f22d199.tar.bz2 |
Fix the documentation
-rw-r--r-- | doc/cflow.1 | 28 | ||||
-rw-r--r-- | doc/cflow.texi | 4 |
2 files changed, 25 insertions, 7 deletions
diff --git a/doc/cflow.1 b/doc/cflow.1 index ae2f692..917eb42 100644 --- a/doc/cflow.1 +++ b/doc/cflow.1 @@ -10,28 +10,28 @@ .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with Cflow. If not, see <http://www.gnu.org/licenses/>. -.TH CFLOW 1 "February 27, 2014" "CFLOW" +.TH CFLOW 1 "February 8, 2019" "CFLOW" .SH NAME cflow \- generate a C-language flowgraph .SH SYNOPSIS .nh .na -\fBcflow\fB [\fB\-rxaSblnTv\fR] [\fB\-d\fR \fINUMBER\fR]\ +\fBcflow\fB [\fB\-ASTrxablnv\fR] [\fB\-d\fR \fINUMBER\fR]\ [\fB\-f\fR \fINAME\fR] [\fB\-i\fR \fICLASSES\fR] [\fB\-o\fR \fIFILE\fR]\ [\fB\-D\fR \fINAME\fR[\fB=\fIDEFN\fR]] [\fB\-I\fR \fIDIR\fR]\ [\fB\-m\fR \fINAME\fR] [\fB\-p\fR \fINUMBER\fR]\ [\fB\-s\fR \fISYMBOL\fB:\fR[\fB=\fR]\fITYPE\fR] [\fB\-U\fR \fINAME\fR]\ - [\fB\-\-depth=\fINUMBER\fR] [\fB\-\-format=\fINAME\fR]\ + [\fB\-\-all\fR] [\fB\-\-depth=\fINUMBER\fR] [\fB\-\-format=\fINAME\fR]\ [\fB\-\-include=\fICLASSES\fR] [\fB\-\-output=\fIFILE\fR]\ [\fB\-\-reverse\fR] [\fB\-\-xref\fR] [\fB\-\-ansi\fR]\ [\fB\-\-define=\fINAME\fR[\fB=DEFN\fR]]\ - [\fB\-\-include\-dir=\fIDIR\fR] [\fB\-\-main=\fINAME\fR]\ + [\fB\-\-include\-dir=\fIDIR\fR] [\fB\-\-main=\fINAME\fR] [\fB\-\-no\-main\fR]\ [\fB\-\-pushdown=\fINUMBER\fR] [\fB\-\-preprocess\fR[\fB=\fICOMMAND\fR]]\ [\fB\-\-cpp\fR[\fB=\fICOMMAND\fR]]\ [\fB\-\-symbol=\fISYMBOL\fB:\fR[\fB=\fR]\fITYPE\fR]\ [\fB\-\-use\-indentation\fR] [\fB\-\-undefine=\fINAME\fR]\ [\fB\-\-brief\fR] [\fB\-\-emacs\fR] [\fB\-\-print\-level\fR]\ [\fB\-\-level\-indent=\fIELEMENT\fR]\ @@ -133,12 +133,20 @@ Predefine \fINAME\fR as a macro. Add the directory \fIDIR\fR to the list of directories to be searched for header files. .TP \fB\-m\fR, \fB\-\-main=\fINAME\fR Assume main function is \fINAME\fR .TP +\fB\-\-no\-main\fR +Assume there's no main function in the program. This option has the +same effect as \fB\-\-all\fR, except that, if the program do define +the \fBmain\fR function, it will be treated as any other functions, +i.e. it will not be placed at the top of output, but in its +place as per the lexicographic ordering of function names. See also the +description of \fB\-\-all\fR. +.TP \fB\-p\fR, \fB\-\-pushdown=\fINUMBER\fR Set initial token stack size to \fINUMBER\fR. .TP \fB\-\-preprocess\fR[\fB=\fICOMMAND\fR], \fB\-\-cpp\fR[\fB=\fICOMMAND\fR] Run the specified preprocessor command. .TP @@ -164,12 +172,22 @@ Rely on indentation to solve suspicious constructs. Don't use indentation in parsing (default). .TP \fB\-U\fR, \fB\-\-undefine=\fINAME\fR Cancel any previous definition of \fINAME\fR. .SS Output control .TP +\fB\-A\fR, \fB\-\-all\fR +Produce graphs for all global functions in the program. Use this +option if your program contains functions which are not directly +reachable from \fBmain()\fR. +.sp +The output consist of separate flow graphs for each global function +defined in the program. These graphs will be placed after the graph +for \fBmain()\fR (if it exists), and will be ordered lexicographically by +the function name. +.TP \fB\-b\fR, \fB\-\-brief\fR Brief output. .TP \fB\-\-no\-brief\fR Disable brief output. .TP @@ -244,13 +262,13 @@ found at: .B http://www.gnu.org/software/cflow/manual .SH AUTHORS Sergey Poznyakoff .SH "BUG REPORTS" Report bugs to <bug\-cflow@gnu.org>. .SH COPYRIGHT -Copyright \(co 2014 Sergey Poznyakoff +Copyright \(co 2014-2019 Sergey Poznyakoff .br .na License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> .br .ad This is free software: you are free to change and redistribute it. diff --git a/doc/cflow.texi b/doc/cflow.texi index 50abab4..f4a71f4 100644 --- a/doc/cflow.texi +++ b/doc/cflow.texi @@ -1328,14 +1328,14 @@ For more information, @xref{Symbols}. @item -m @var{name} @itemx --main=@var{name} Assume main function to be called @var{name}. @xref{start symbol}. @cindex @option{--no-main} @item --no-main - There's no main function in the program. This option has the -same effect as @option{--all}, except that, if the program defines + Assume there's no main function in the program. This option has +the same effect as @option{--all}, except that, if the program defines the @code{main} function, it will be treated as any other functions. @cindex @option{-n} @cindex @option{--number} @cindex @option{--no-number} @item -n |