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$
  33 .\"
  34 .Dd December 1, 2015
  35 .Dt WC 1
  36 .Os
  37 .Sh NAME
  38 .Nm wc
  39 .Nd word, line, character, and byte count
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl -libxo
  43 .Op Fl Lclmw
  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 (if no file is specified) to the standard output.
  52 A line is defined as a string of characters delimited by a
  53 .Aq newline
  54 character.
  55 Characters beyond the final
  56 .Aq newline
  57 character will not be included
  58 in the line count.
  59 .Pp
  60 A word is defined as a string of characters delimited by white space
  61 characters.
  62 White space characters are the set of characters for which the
  63 .Xr iswspace 3
  64 function returns true.
  65 If more than one input file is specified, a line of cumulative counts
  66 for all the files is displayed on a separate line after the output for
  67 the last file.
  68 .Pp
  69 The following options are available:
  70 .Bl -tag -width indent
  71 .It Fl -libxo
  72 Generate output via
  73 .Xr libxo 3
  74 in a selection of different human and machine readable formats.
  75 See
  76 .Xr xo_parse_args 3
  77 for details on command line arguments.
  78 .It Fl L
  79 The number of characters in the longest input line
  80 is written to the standard output.
  81 When more than one
  82 .Ar file
  83 argument is specified, the longest input line of
  84 .Em all
  85 files is reported as the value of the final
  86 .Dq total .
  87 .It Fl c
  88 The number of bytes in each input file
  89 is written to the standard output.
  90 This will cancel out any prior usage of the
  91 .Fl m
  92 option.
  93 .It Fl l
  94 The number of lines in each input file
  95 is written to the standard output.
  96 .It Fl m
  97 The number of characters in each input file is written to the standard output.
  98 If the current locale does not support multibyte characters, this
  99 is equivalent to the
 100 .Fl c
 101 option.
 102 This will cancel out any prior usage of the
 103 .Fl c
 104 option.
 105 .It Fl w
 106 The number of words in each input file
 107 is written to the standard output.
 108 .El
 109 .Pp
 110 When an option is specified,
 111 .Nm
 112 only reports the information requested by that option.
 113 The order of output always takes the form of line, word,
 114 byte, and file name.
 115 The default action is equivalent to specifying the
 116 .Fl c , l
 117 and
 118 .Fl w
 119 options.
 120 .Pp
 121 If no files are specified, the standard input is used and no
 122 file name is displayed.
 123 The prompt will accept input until receiving EOF, or
 124 .Bq ^D
 125 in most environments.
 126 .Sh ENVIRONMENT
 127 The
 128 .Ev LANG , LC_ALL
 129 and
 130 .Ev LC_CTYPE
 131 environment variables affect the execution of
 132 .Nm
 133 as described in
 134 .Xr environ 7 .
 135 .Sh EXIT STATUS
 136 .Ex -std
 137 .Sh EXAMPLES
 138 Count the number of characters, words and lines in each of the files
 139 .Pa report1
 140 and
 141 .Pa report2
 142 as well as the totals for both:
 143 .Pp
 144 .Dl "wc -mlw report1 report2"
 145 .Pp
 146 Find the longest line in a list of files:
 147 .Pp
 148 .Dl "wc -L file1 file2 file3 | fgrep total"
 149 .Sh COMPATIBILITY
 150 Historically, the
 151 .Nm
 152 utility was documented to define a word as a
 153 .Do
 154 maximal string of
 155 characters delimited by <space>, <tab> or <newline> characters
 156 .Dc .
 157 The implementation, however, did not handle non-printing characters
 158 correctly so that
 159 .Dq Li "\ \ ^D^E\ \ "
 160 counted as 6 spaces, while
 161 .Dq Li foo^D^Ebar
 162 counted as 8 characters.
 163 .Bx 4
 164 systems after
 165 .Bx 4.3
 166 modified the implementation to be consistent
 167 with the documentation.
 168 This implementation defines a
 169 .Dq word
 170 in terms of the
 171 .Xr iswspace 3
 172 function, as required by
 173 .St -p1003.2 .
 174 .Pp
 175 The
 176 .Fl L
 177 option is a non-standard
 178 .Fx
 179 extension, compatible with the
 180 .Fl L
 181 option of the GNU
 182 .Nm
 183 utility.
 184 .Sh SEE ALSO
 185 .Xr iswspace 3 ,
 186 .Xr libxo 3 ,
 187 .Xr xo_parse_args 3
 188 .Sh STANDARDS
 189 The
 190 .Nm
 191 utility conforms to
 192 .St -p1003.1-2001 .
 193 .Sh HISTORY
 194 A
 195 .Nm
 196 command appeared in
 197 .At v1 .