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. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)wc.1        8.2 (Berkeley) 4/19/94
  32 .\" $FreeBSD: src/usr.bin/wc/wc.1,v 1.6.2.4 2002/08/25 02:47:04 tjr Exp $
  33 .\" $DragonFly: src/usr.bin/wc/wc.1,v 1.3 2006/02/17 19:39:16 swildner Exp $
  34 .\"
  35 .Dd June 13, 2002
  36 .Dt WC 1
  37 .Os
  38 .Sh NAME
  39 .Nm wc
  40 .Nd word, line, character, and byte count
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl clmw
  44 .Op Ar
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility displays the number of lines, words, and bytes contained in each
  49 input
  50 .Ar file
  51 (or standard input, by default) to the standard output.
  52 A line is defined as a string of characters delimited by a <newline>
  53 character,
  54 and a word is defined as a string of characters delimited by white space
  55 characters.
  56 White space characters are the set of characters for which the
  57 .Xr isspace 3
  58 function returns true.
  59 If more than one input file is specified, a line of cumulative counts
  60 for all the files is displayed on a separate line after the output for
  61 the last file.
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width Ds
  65 .It Fl c
  66 The number of bytes in each input file
  67 is written to the standard output.
  68 .It Fl l
  69 The number of lines in each input file
  70 is written to the standard output.
  71 .It Fl m
  72 The number of characters in each input file is written to the standard output.
  73 If the current locale does not support multibyte characters, this
  74 is equivalent to the
  75 .Fl c
  76 option.
  77 .It Fl w
  78 The number of words in each input file
  79 is written to the standard output.
  80 .El
  81 .Pp
  82 When an option is specified,
  83 .Nm
  84 only reports the information requested by that option.
  85 The default action is equivalent to specifying the
  86 .Fl c ,
  87 .Fl l
  88 and
  89 .Fl w
  90 options.
  91 .Pp
  92 If no files are specified, the standard input is used and no
  93 file name is displayed.
  94 .Sh ENVIRONMENT
  95 The
  96 .Ev LANG ,
  97 .Ev LC_ALL
  98 and
  99 .Ev LC_CTYPE
 100 environment variables affect the execution of
 101 .Nm
 102 as described in
 103 .Xr environ 7 .
 104 .Sh EXIT STATUS
 105 .Ex -std
 106 .Sh EXAMPLES
 107 Count the number of characters, words and lines in each of the files
 108 .Pa report1
 109 and
 110 .Pa report2
 111 as well as the totals for both:
 112 .Pp
 113 .Dl "wc -mlw report1 report2"
 114 .Sh COMPATIBILITY
 115 Historically, the
 116 .Nm
 117 utility was documented to define a word as a ``maximal string of
 118 characters delimited by <space>, <tab> or <newline> characters''.
 119 The implementation, however, didn't handle non-printing characters
 120 correctly so that ``  ^D^E  '' counted as 6 spaces, while ``foo^D^Ebar''
 121 counted as 8 characters.
 122 .Bx 4
 123 systems after
 124 .Bx 4.3
 125 modified the implementation to be consistent
 126 with the documentation.
 127 This implementation defines a ``word'' in terms of the
 128 .Xr isspace 3
 129 function, as required by
 130 .St -p1003.2 .
 131 .Sh SEE ALSO
 132 .Xr isspace 3
 133 .Sh STANDARDS
 134 The
 135 .Nm
 136 utility conforms to
 137 .St -p1003.1-2001 .
 138 .Sh HISTORY
 139 A
 140 .Nm
 141 command appeared in
 142 .At v1 .