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 April 19, 1994
  39 .Dt WC 1
  40 .Os
  41 .Sh NAME
  42 .Nm wc
  43 .Nd word, line, and byte count
  44 .Sh SYNOPSIS
  45 .Nm wc
  46 .Op Fl clw
  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, by default) to the standard output.
  55 A line is defined as a string of characters delimited by a <newline>
  56 character,
  57 and a word is defined as a string of characters delimited by white space
  58 characters.
  59 White space characters are the set of characters for which the
  60 .Xr isspace 3
  61 function returns true.
  62 If more than one input file is specified, a line of cumulative counts
  63 for all the files is displayed on a separate line after the output for
  64 the last file.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width Ds
  68 .It Fl c
  69 The number of bytes in each input file
  70 is written to the standard output.
  71 .It Fl l
  72 The number of lines in each input file
  73 is written to the standard output.
  74 .It Fl w
  75 The number of words in each input file
  76 is written to the standard output.
  77 .El
  78 .Pp
  79 When an option is specified,
  80 .Nm
  81 only reports the information requested by that option.
  82 The default action is equivalent to specifying all of the flags.
  83 .Pp
  84 If no files are specified, the standard input is used and no
  85 file name is displayed.
  86 .Sh DIAGNOSTICS
  87 The
  88 .Nm
  89 utility exits 0 on success, and >0 if an error occurs.
  90 .Sh SEE ALSO
  91 .Xr isspace 3
  92 .Sh COMPATIBILITY
  93 Historically, the
  94 .Nm
  95 utility was documented to define a word as a ``maximal string of
  96 characters delimited by <space>, <tab> or <newline> characters''.
  97 The implementation, however, didn't handle non-printing characters
  98 correctly so that ``  ^D^E  '' counted as 6 spaces, while ``foo^D^Ebar''
  99 counted as 8 characters.
 100 4BSD systems after 4.3BSD modified the implementation to be consistent
 101 with the documentation.
 102 This implementation defines a ``word'' in terms of the
 103 .Xr isspace 3
 104 function, as required by
 105 .St -p1003.2 .
 106 .Sh STANDARDS
 107 The
 108 .Nm
 109 function conforms to
 110 .St -p1003.2 .
 111 .Sh HISTORY
 112 A
 113 .Nm
 114 command appeared in
 115 .At v1 .