usr.bin/wc/wc.1

   1 .\"     $NetBSD: wc.1,v 1.16 2014/09/19 16:02:59 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 February 18, 2010
  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 Llw
  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 characters in the longest line of each input file
  71 is written to the standard output.
  72 .It Fl l
  73 The number of lines in each input file
  74 is written to the standard output.
  75 .It Fl m
  76 The number of characters in each input file
  77 is written to the standard output.
  78 .It Fl w
  79 The number of words in each input file
  80 is written to the standard output.
  81 .El
  82 .Pp
  83 When an option is specified,
  84 .Nm
  85 only
  86 reports the
  87 information requested by that option.
  88 The default action is equivalent to all the flags
  89 .Fl clw
  90 having been specified.
  91 .Pp
  92 The following operands are available:
  93 .Bl -tag -width Ds
  94 .It Ar file
  95 A pathname of an input file.
  96 .El
  97 .Pp
  98 If no file names
  99 are specified, the standard input is used and
 100 no file name is displayed.
 101 .Pp
 102 By default, the standard output contains a line for each
 103 input file of the form:
 104 .Bd -literal -offset indent
 105 lines    words  bytes   file_name
 106 .Ed
 107 .Sh EXIT STATUS
 108 .Ex -std wc
 109 .Sh COMPATIBILITY
 110 Historically, the
 111 .Nm
 112 utility was documented to define a word as a ``maximal string of
 113 characters delimited by
 114 .Aq space ,
 115 .Aq tab
 116 or
 117 .Aq newline
 118 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 iswspace 3
 129 function, as required by
 130 .St -p1003.2 .
 131 .Pp
 132 The
 133 .Fl L
 134 option is a non-standard extension, compatible with the
 135 .Fl L
 136 option of the GNU and
 137 .Fx
 138 .Nm
 139 utilities.
 140 .Sh SEE ALSO
 141 .Xr iswspace 3
 142 .Sh STANDARDS
 143 The
 144 .Nm
 145 utility conforms to
 146 .St -p1003.2-92 .