usr.bin/wc/wc.1

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)wc.1        8.2 (Berkeley) 4/19/94
  36 .\" $FreeBSD$
  37 .\"
  38 .Dd February 23, 2005
  39 .Dt WC 1
  40 .Os
  41 .Sh NAME
  42 .Nm wc
  43 .Nd word, line, character, and byte count
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl clmw
  47 .Op Ar
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility displays the number of lines, words, and bytes contained in each
  52 input
  53 .Ar file ,
  54 or standard input (if no file is specified) to the standard output.
  55 A line is defined as a string of characters delimited by a
  56 .Aq newline
  57 character.
  58 Characters beyond the final
  59 .Aq newline
  60 character will not be included
  61 in the line count.
  62 .Pp
  63 A word is defined as a string of characters delimited by white space
  64 characters.
  65 White space characters are the set of characters for which the
  66 .Xr iswspace 3
  67 function returns true.
  68 If more than one input file is specified, a line of cumulative counts
  69 for all the files is displayed on a separate line after the output for
  70 the last file.
  71 .Pp
  72 The following options are available:
  73 .Bl -tag -width Ds
  74 .It Fl c
  75 The number of bytes in each input file
  76 is written to the standard output.
  77 This will cancel out any prior usage of the
  78 .Fl m
  79 option.
  80 .It Fl l
  81 The number of lines in each input file
  82 is written to the standard output.
  83 .It Fl m
  84 The number of characters in each input file is written to the standard output.
  85 If the current locale does not support multibyte characters, this
  86 is equivalent to the
  87 .Fl c
  88 option.
  89 This will cancel out any prior usage of the
  90 .Fl c
  91 option.
  92 .It Fl w
  93 The number of words in each input file
  94 is written to the standard output.
  95 .El
  96 .Pp
  97 When an option is specified,
  98 .Nm
  99 only reports the information requested by that option.
 100 The order of output always takes the form of line, word,
 101 byte, and file name.
 102 The default action is equivalent to specifying the
 103 .Fl c , l
 104 and
 105 .Fl w
 106 options.
 107 .Pp
 108 If no files are specified, the standard input is used and no
 109 file name is displayed.
 110 The prompt will accept input until receiving EOF, or
 111 .Bq ^D
 112 in most environments.
 113 .Sh ENVIRONMENT
 114 The
 115 .Ev LANG , LC_ALL
 116 and
 117 .Ev LC_CTYPE
 118 environment variables affect the execution of
 119 .Nm
 120 as described in
 121 .Xr environ 7 .
 122 .Sh EXIT STATUS
 123 .Ex -std
 124 .Sh EXAMPLES
 125 Count the number of characters, words and lines in each of the files
 126 .Pa report1
 127 and
 128 .Pa report2
 129 as well as the totals for both:
 130 .Pp
 131 .Dl "wc -mlw report1 report2"
 132 .Sh COMPATIBILITY
 133 Historically, the
 134 .Nm
 135 utility was documented to define a word as a ``maximal string of
 136 characters delimited by <space>, <tab> or <newline> characters''.
 137 The implementation, however, did not handle non-printing characters
 138 correctly so that
 139 .Dq Li "  ^D^E  "
 140 counted as 6 spaces, while
 141 .Dq Li foo^D^Ebar
 142 counted as 8 characters.
 143 .Bx 4
 144 systems after
 145 .Bx 4.3
 146 modified the implementation to be consistent
 147 with the documentation.
 148 This implementation defines a ``word'' in terms of the
 149 .Xr iswspace 3
 150 function, as required by
 151 .St -p1003.2 .
 152 .Sh SEE ALSO
 153 .Xr iswspace 3
 154 .Sh STANDARDS
 155 The
 156 .Nm
 157 utility conforms to
 158 .St -p1003.1-2001 .
 159 .Sh HISTORY
 160 A
 161 .Nm
 162 command appeared in
 163 .At v1 .