From: Y Giridhar Appaji Nag Date: Mon, 17 Dec 2007 14:43:33 +0530 Subject: Remove references to lint, invalid header/footer. Correct typos. Description: Remove references to lint, invalid header/footer. Correct typos. Author: Y Giridhar Appaji Nag --- This patch header follows DEP-3: http://dep.debian.net/deps/dep3/ --- doc/splint.1 | 56 ++++++++++++++++++++++++++------------------------------ 1 file changed, 26 insertions(+), 30 deletions(-) diff --git a/doc/splint.1 b/doc/splint.1 index 51495c6..e93ceaa 100644 --- a/doc/splint.1 +++ b/doc/splint.1 @@ -1,5 +1,4 @@ - .\" $Id: splint.1,v 1.2 2003/03/31 18:19:38 drl7x Exp $ -.TH splint 1 "A tool for statically checking C programs" +.TH splint 1 .SH NAME splint \- A tool for statically checking C programs @@ -9,14 +8,14 @@ splint \- A tool for statically checking C programs [options] .SH DESCRIPTION -.BR Splint +.BR splint is a tool for statically checking C programs for security vulnerabilities and common programming mistakes. With minimal effort, -Splint can be used as a better lint(1).If additional effort is invested -adding annotations to programs, Splint can perform stronger checks than -can be done by any standard lint. For full documentation, please see -http://www.splint.org. This man page only covers a few of the available -options. +splint can be used as a better lint. If additional effort is invested +adding annotations to programs, splint can perform stronger checks than +can be done by any standard lint. For full documentation, install the +splint-doc-html Debian package. This man page only covers a few of the +available options. .SH OPTIONS @@ -27,7 +26,7 @@ Shows help .PP .B Initialization -These flags control directories and files used by Splint. They may be used from the +These flags control directories and files used by splint. They may be used from the command line or in an options file, but may not be used as control comments in the source code. Except where noted. they have the same meaning preceded by \- or +. @@ -52,19 +51,19 @@ not loaded. This flag may be used in an options file to load in another options .TP 6 .B \-nof Prevents the default options files (./.splintrc and ~/.splintrc) from being loaded. (Setting --nof overrides +nof, causing the options files to be loaded normally.) +\-nof overrides +nof, causing the options files to be loaded normally.) .TP 6 .BI \-systemdirs " directories" Set directories for system files (default is "/usr/include"). Separate directories with colons (e.g., "/usr/include:/usr/local/lib"). Flag settings propagate to files in a system directory. If --systemdirerrors is set, no errors are reported for files in system directories. +\-systemdirerrors is set, no errors are reported for files in system directories. .PP .B Pre-processor These flags are used to define or undefine pre-processor constants. -The -I flag is also passed to the C pre-processor. +The \-I flag is also passed to the C pre-processor. .TP 6 .BI \-D " initializer" @@ -84,10 +83,10 @@ Save state in for loading. The default extension .lcd is added if .TP 6 .BI \-load " file" -Load state from (created by -dump). The default extension .lcd is added if has no +Load state from (created by \-dump). The default extension .lcd is added if has no extension. Only one library file may be loaded. -By default, the standard library is loaded if the -load flag is not used to load a user library. If no user library is +By default, the standard library is loaded if the \-load flag is not used to load a user library. If no user library is loaded, one of the following flags may be used to select a different standard library. Precede the flag by + to load the described library (or prevent a library from being loaded using nolib). See Apppendix F for information on the provided libraries. @@ -123,12 +122,14 @@ Use the strict version of the UNIX standard library. .PP .B Output -These flags control what additional information is printed by Splint. Setting + causes the described +These flags control what additional information is printed by splint. Setting + causes the described information to be printed; setting - prevents it. By default, all these flags are off. .TP 6 .B \-usestderr -Send error messages to standard error (instead of standard out). +Send error messages to standard error (instead of standard out). This flag +has been replaced by more precise flags for controlling the warning, status +message and fatal error streams independently. See the output of splint +usestderr .TP 6 .B \-showsummary @@ -139,7 +140,7 @@ reported. .TP 6 .B \-showscan -Show file names are they are processed. +Show file names as they are processed. .TP 6 .B \-showalluses @@ -155,7 +156,7 @@ Display distribution of where checking time is spent. .TP 6 .B \-quiet -Suppress herald and error count. (If quiet is not set, Splint prints out a herald with version +Suppress herald and error count. (If quiet is not set, splint prints out a herald with version information before checking begins, and a line summarizing the total number of errors reported.) .TP 6 @@ -170,14 +171,14 @@ message showing the number of suppressed messages is printed. .PP .B Expected Errors -Normally, Splint will expect to report no errors. The exit status will be success (0) if no errors are reported, +Normally, splint will expect to report no errors. The exit status will be success (0) if no errors are reported, and failure if any errors are reported. Flags can be used to set the expected number of reported errors. Because of the provided error suppression mechanisms, these options should probably not be used for final checking real programs but may be useful in developing programs using make. .TP 6 .B \-expect -Exactly code errors are expected. Splint will exit with failure exit status unless +Exactly code errors are expected. splint will exit with failure exit status unless code errors are detected. .TP 6 @@ -216,7 +217,7 @@ class. Default: - .TP 6 .BI \-linelen " number" -Set length of maximum message line to characters. Splint will split messages longer +Set length of maximum message line to characters. splint will split messages longer than characters long into multiple lines. Default: 80 .PP @@ -229,7 +230,7 @@ command line flag settings. A warning is produced if a mode flag is used after a set. These are brief descriptions to give a general idea of what each mode does. To see the complete flag settings -in each mode, use splint -help modes. A mode flag has the same effect when used with either + or -. +in each mode, use splint \-help modes. A mode flag has the same effect when used with either + or \-. .TP 6 .B \-weak @@ -258,13 +259,8 @@ reward will be presented to the first person to produce a real program that prod strict checking. .SH AUTHOR +.PP If you need to get in contact with the authors send email to -.UR mailto:info@splint.org -.UE - +info@splint.org or visit -.UR http://www.splint.org -.UE - -.SH "SEE ALSO" -lint(1) +.