From 347068b6726f6948b658fbb091b0c2607d1d6cb6 Mon Sep 17 00:00:00 2001 From: Reijo Tomperi Date: Fri, 19 Dec 2008 19:19:26 +0000 Subject: [PATCH] Update man page and readme to reflect the new syntax --- man/cppcheck.1.xml | 41 +++++++++++++++++++++++------------------ readme.txt | 38 +++++++++++++++++++------------------- 2 files changed, 42 insertions(+), 37 deletions(-) diff --git a/man/cppcheck.1.xml b/man/cppcheck.1.xml index 745bd10ac..cce6c03f5 100644 --- a/man/cppcheck.1.xml +++ b/man/cppcheck.1.xml @@ -102,12 +102,23 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ &dhpackage; - - - - - - + + + + + + + + + + + + + + + + + @@ -132,24 +143,18 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ found a bug. When this option is given, all messages are shown. + + + + Only print something when there is an error. + + Check coding style. - - - - Recursively check all *.cpp, *.cxx, *.cc and *.c files. - - - - - - Only print something when there is an error. - - diff --git a/readme.txt b/readme.txt index 02d906ca4..fabcc9ecb 100644 --- a/readme.txt +++ b/readme.txt @@ -1,19 +1,19 @@ ========= -C++ check +Cppcheck ========= -About - - The original name of this program is "C++check". - The name was changed to "cppcheck" (a google search is more successful now). - +About + + The original name of this program is "C++check". + The name was changed to "cppcheck" (a google search is more successful now). + Compiling - Any C++ compiler should work. + Any C++ compiler should work. The Makefile works under Linux. To make it work under Windows with DJGPP, change "g++" to "gxx". @@ -22,24 +22,24 @@ Compiling Usage The syntax is: - cppcheck [--all] [--errorsonly] [--style] [--recursive] [filename1] [filename2] + cppcheck [--all] [--quiet] [--style] [file or path] [file or path] The error messages will be printed to stderr. Example (Check all files. Use all checks): - cppcheck --style --all --recursive - - To output error messages to a file use this syntax (works both on Windows and Linux): - cppcheck file.cpp 2> err.txt + cppcheck --style --all ./ + + To output error messages to a file use this syntax (works both on Windows and Linux): + cppcheck file.cpp 2> err.txt + - Recommendations When the "--all" flag is given you may get a lot of error messages. - -Webpage - - http://www.sf.net/projects/cppcheck - - + +Webpage + + http://www.sf.net/projects/cppcheck + +