usr.bin/wc/wc.1

   1 .\"     $NetBSD: wc.1,v 1.12 2002/03/05 15:09:46 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Institute of Electrical and Electronics Engineers, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     from: @(#)wc.1  8.2 (Berkeley) 4/19/94
  34 .\"
  35 .Dd April 19, 1994
  36 .Dt WC 1
  37 .Os
  38 .Sh NAME
  39 .Nm wc
  40 .Nd word, line, and byte count
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl c | Fl m
  44 .Op Fl lw
  45 .Op Ar file ...
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility displays the number of lines, words, bytes and characters contained in each
  50 input
  51 .Ar file
  52 (or standard input, by default) to the standard output.
  53 A line is defined as a string of characters delimited by a \*[Lt]newline\*[Gt]
  54 character,
  55 and a word is defined as a string of characters delimited by white space
  56 characters.
  57 White space characters are the set of characters for which the
  58 .Xr iswspace 3
  59 function returns true.
  60 If more than one input file is specified, a line of cumulative counts
  61 for all the files is displayed on a separate line after the output for
  62 the last file.
  63 .Pp
  64 The following options are available:
  65 .Bl -tag -width Ds
  66 .It Fl c
  67 The number of bytes in each input file
  68 is written to the standard output.
  69 .It Fl l
  70 The number of lines in each input file
  71 is written to the standard output.
  72 .It Fl m
  73 The number of characters in each input file
  74 is written to the standard output.
  75 .It Fl w
  76 The number of words in each input file
  77 is written to the standard output.
  78 .El
  79 .Pp
  80 When an option is specified,
  81 .Nm
  82 only
  83 reports the
  84 information requested by that option. The
  85 default action is equivalent to all the
  86 flags
  87 .Fl clw
  88 having been specified.
  89 .Pp
  90 The following operands are available:
  91 .Bl -tag -width Ds
  92 .It Ar file
  93 A pathname of an input file.
  94 .El
  95 .Pp
  96 If no file names
  97 are specified, the standard input is used and
  98 no file name is displayed.
  99 .Pp
 100 By default, the standard output contains a line for each
 101 input file of the form:
 102 .Bd -literal -offset indent
 103 lines    words  bytes   file_name
 104 .Ed
 105 .Pp
 106 The
 107 .Nm
 108 utility exits 0 on success, and \*[Gt]0 if an error occurs.
 109 .Sh SEE ALSO
 110 .Xr iswspace 3
 111 .Sh COMPATIBILITY
 112 Historically, the
 113 .Nm
 114 utility was documented to define a word as a ``maximal string of
 115 characters delimited by \*[Lt]space\*[Gt], \*[Lt]tab\*[Gt] or \*[Lt]newline\*[Gt] characters''.
 116 The implementation, however, didn't handle non-printing characters
 117 correctly so that ``  ^D^E  '' counted as 6 spaces, while ``foo^D^Ebar''
 118 counted as 8 characters.
 119 .Bx 4
 120 systems after
 121 .Bx 4.3
 122 modified the implementation to be consistent
 123 with the documentation.
 124 This implementation defines a ``word'' in terms of the
 125 .Xr iswspace 3
 126 function, as required by
 127 .St -p1003.2 .
 128 .Sh STANDARDS
 129 The
 130 .Nm
 131 utility conforms to
 132 .St -p1003.2-92 .