Print this page
6205 onbld manuals should be declared as 1onbld
Reviewed by: Dan McDonald <danmcd@omniti.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>


   3 .\"
   4 .\" CDDL HEADER START
   5 .\"
   6 .\" The contents of this file are subject to the terms of the
   7 .\" Common Development and Distribution License (the "License").
   8 .\" You may not use this file except in compliance with the License.
   9 .\"
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  11 .\" or http://www.opensolaris.org/os/licensing.
  12 .\" See the License for the specific language governing permissions
  13 .\" and limitations under the License.
  14 .\"
  15 .\" When distributing Covered Code, include this CDDL HEADER in each
  16 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  17 .\" If applicable, add the following below this CDDL HEADER, with the
  18 .\" fields enclosed by brackets "[]" replaced with your own identifying
  19 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  20 .\"
  21 .\" CDDL HEADER END
  22 .\"
  23 .TH cstyle 1 "28 March 2005"
  24 .SH NAME
  25 .I cstyle
  26 \- check for some common stylistic errors in C source files
  27 .SH SYNOPSIS
  28 \fBcstyle [-chpvCP] [-o constructs] [file...]\fP
  29 .LP
  30 .SH DESCRIPTION
  31 .IX "OS-Net build tools" "cstyle" "" "\fBcstyle\fP"
  32 .LP
  33 .I cstyle
  34 inspects C source files (*.c and *.h) for common sylistic errors.  It
  35 attempts to check for the cstyle documented in 
  36 \fI/shared/ON/general_docs/cstyle.ms.pdf\fP.  Note that there is much
  37 in that document that
  38 .I cannot
  39 be checked for; just because your code is \fBcstyle(1)\fP clean does not
  40 mean that you've followed Sun's C style.  \fICaveat emptor\fP.
  41 .LP
  42 .SH OPTIONS
  43 .LP
  44 The following options are supported:
  45 .TP 4
  46 .B \-c
  47 Check continuation line indentation inside of functions.  Sun's C style
  48 states that all statements must be indented to an appropriate tab stop,
  49 and any continuation lines after them must be indented \fIexactly\fP four
  50 spaces from the start line.  This option enables a series of checks
  51 designed to find contination line problems within functions only.  The
  52 checks have some limitations;  see CONTINUATION CHECKING, below.
  53 .LP
  54 .TP 4
  55 .B \-h
  56 Performs heuristic checks that are sometimes wrong.  Not generally used.
  57 .LP
  58 .TP 4
  59 .B \-p




   3 .\"
   4 .\" CDDL HEADER START
   5 .\"
   6 .\" The contents of this file are subject to the terms of the
   7 .\" Common Development and Distribution License (the "License").
   8 .\" You may not use this file except in compliance with the License.
   9 .\"
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  11 .\" or http://www.opensolaris.org/os/licensing.
  12 .\" See the License for the specific language governing permissions
  13 .\" and limitations under the License.
  14 .\"
  15 .\" When distributing Covered Code, include this CDDL HEADER in each
  16 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  17 .\" If applicable, add the following below this CDDL HEADER, with the
  18 .\" fields enclosed by brackets "[]" replaced with your own identifying
  19 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  20 .\"
  21 .\" CDDL HEADER END
  22 .\"
  23 .TH cstyle 1ONBLD "28 March 2005"
  24 .SH NAME
  25 .I cstyle
  26 \- check for some common stylistic errors in C source files
  27 .SH SYNOPSIS
  28 \fBcstyle [-chpvCP] [-o constructs] [file...]\fP
  29 .LP
  30 .SH DESCRIPTION
  31 .IX "OS-Net build tools" "cstyle" "" "\fBcstyle\fP"
  32 .LP
  33 .I cstyle
  34 inspects C source files (*.c and *.h) for common sylistic errors.  It
  35 attempts to check for the cstyle documented in 
  36 \fI/shared/ON/general_docs/cstyle.ms.pdf\fP.  Note that there is much
  37 in that document that
  38 .I cannot
  39 be checked for; just because your code is \fBcstyle(1ONBLD)\fP clean does not
  40 mean that you've followed Sun's C style.  \fICaveat emptor\fP.
  41 .LP
  42 .SH OPTIONS
  43 .LP
  44 The following options are supported:
  45 .TP 4
  46 .B \-c
  47 Check continuation line indentation inside of functions.  Sun's C style
  48 states that all statements must be indented to an appropriate tab stop,
  49 and any continuation lines after them must be indented \fIexactly\fP four
  50 spaces from the start line.  This option enables a series of checks
  51 designed to find contination line problems within functions only.  The
  52 checks have some limitations;  see CONTINUATION CHECKING, below.
  53 .LP
  54 .TP 4
  55 .B \-h
  56 Performs heuristic checks that are sometimes wrong.  Not generally used.
  57 .LP
  58 .TP 4
  59 .B \-p