BSD 4_3_Tahoe development

[unix-history] / usr / man / cat1 / awk.0

AWK(1)		    UNIX Programmer's Manual		   AWK(1)



N\bNA\bAM\bME\bE
     awk - pattern scanning and processing language

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     a\baw\bwk\bk [ -\b-F\bF_\bc ] [ prog ] [ file ] ...

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     _\bA_\bw_\bk scans each input _\bf_\bi_\bl_\be for lines that match any of a set
     of patterns specified in _\bp_\br_\bo_\bg.  With each pattern in _\bp_\br_\bo_\bg
     there can be an associated action that will be performed
     when a line of a _\bf_\bi_\bl_\be matches the pattern.  The set of pat-
     terns may appear literally as _\bp_\br_\bo_\bg, or in a file specified
     as -\b-f\bf _\bf_\bi_\bl_\be.

     Files are read in order; if there are no files, the standard
     input is read.  The file name `-' means the standard input.
     Each line is matched against the pattern portion of every
     pattern-action statement; the associated action is performed
     for each matched pattern.

     An input line is made up of fields separated by white space.
     (This default can be changed by using FS, _\bv_\bi_\bd_\be _\bi_\bn_\bf_\br_\ba.) The
     fields are denoted $1, $2, ... ; $0 refers to the entire
     line.

     A pattern-action statement has the form

	  pattern { action }

     A missing { action } means print the line; a missing pattern
     always matches.

     An action is a sequence of statements.  A statement can be
     one of the following:

	  if ( conditional ) statement [ else statement ]
	  while ( conditional ) statement
	  for ( expression ; conditional ; expression ) statement
	  break
	  continue
	  { [ statement ] ... }
	  variable = expression
	  print [ expression-list ] [ >expression ]
	  printf format [ , expression-list ] [ >expression ]
	  next # skip remaining patterns on this input line
	  exit # skip the rest of the input

     Statements are terminated by semicolons, newlines or right
     braces.  An empty expression-list stands for the whole line.
     Expressions take on string or numeric values as appropriate,
     and are built using the operators +, -, *, /, %,  and con-
     catenation (indicated by a blank).  The C operators ++, --,



Printed 7/9/88		 April 29, 1985                         1






AWK(1)		    UNIX Programmer's Manual		   AWK(1)



     +=, -=, *=, /=, and %= are also available in expressions.
     Variables may be scalars, array elements (denoted x[i]) or
     fields.  Variables are initialized to the null string.
     Array subscripts may be any string, not necessarily numeric;
     this allows for a form of associative memory.  String con-
     stants are quoted "...".

     The _\bp_\br_\bi_\bn_\bt statement prints its arguments on the standard
     output (or on a file if >_\bf_\bi_\bl_\be is present), separated by the
     current output field separator, and terminated by the output
     record separator.	The _\bp_\br_\bi_\bn_\bt_\bf statement formats its expres-
     sion list according to the format (see _\bp_\br_\bi_\bn_\bt_\bf(3S)).

     The built-in function _\bl_\be_\bn_\bg_\bt_\bh returns the length of its argu-
     ment taken as a string, or of the whole line if no argument.
     There are also built-in functions _\be_\bx_\bp, _\bl_\bo_\bg, _\bs_\bq_\br_\bt, and _\bi_\bn_\bt.
     The last truncates its argument to an integer.
     _\bs_\bu_\bb_\bs_\bt_\br(_\bs, _\bm, _\bn) returns the _\bn-character substring of _\bs that
     begins at position _\bm.  The function
     _\bs_\bp_\br_\bi_\bn_\bt_\bf(_\bf_\bm_\bt, _\be_\bx_\bp_\br, _\be_\bx_\bp_\br, ...) formats the expressions
     according to the _\bp_\br_\bi_\bn_\bt_\bf(3S) format given by _\bf_\bm_\bt and returns
     the resulting string.

     Patterns are arbitrary Boolean combinations (!, ||, &&, and
     parentheses) of regular expressions and relational expres-
     sions.  Regular expressions must be surrounded by slashes
     and are as in _\be_\bg_\br_\be_\bp.  Isolated regular expressions in a pat-
     tern apply to the entire line.  Regular expressions may also
     occur in relational expressions.

     A pattern may consist of two patterns separated by a comma;
     in this case, the action is performed for all lines between
     an occurrence of the first pattern and the next occurrence
     of the second.

     A relational expression is one of the following:

	  expression matchop regular-expression
	  expression relop expression

     where a relop is any of the six relational operators in C,
     and a matchop is either ~ (for contains) or !~ (for does not
     contain).	A conditional is an arithmetic expression, a
     relational expression, or a Boolean combination of these.

     The special patterns BEGIN and END may be used to capture
     control before the first input line is read and after the
     last.  BEGIN must be the first pattern, END the last.

     A single character _\bc may be used to separate the fields by
     starting the program with




Printed 7/9/88		 April 29, 1985                         2






AWK(1)		    UNIX Programmer's Manual		   AWK(1)



	  BEGIN { FS = "c" }

     or by using the -\b-F\bF_\bc option.

     Other variable names with special meanings include NF, the
     number of fields in the current record; NR, the ordinal
     number of the current record; FILENAME, the name of the
     current input file; OFS, the output field separator (default
     blank); ORS, the output record separator (default newline);
     and OFMT, the output format for numbers (default "%.6g").

E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
     Print lines longer than 72 characters:

	  length > 72

     Print first two fields in opposite order:

	  { print $2, $1 }

     Add up first column, print sum and average:

	       { s += $1 }
	  END  { print "sum is", s, " average is", s/NR }

     Print fields in reverse order:

	  { for (i = NF; i > 0; --i) print $i }

     Print all lines between start/stop pairs:

	  /start/, /stop/

     Print all lines whose first field is different from previous
     one:

	  $1 != prev { print; prev = $1 }

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     lex(1), sed(1)
     A. V. Aho, B. W. Kernighan, P. J. Weinberger, _\bA_\bw_\bk - _\ba _\bp_\ba_\bt_\b-
     _\bt_\be_\br_\bn _\bs_\bc_\ba_\bn_\bn_\bi_\bn_\bg _\ba_\bn_\bd _\bp_\br_\bo_\bc_\be_\bs_\bs_\bi_\bn_\bg _\bl_\ba_\bn_\bg_\bu_\ba_\bg_\be

B\bBU\bUG\bGS\bS
     There are no explicit conversions between numbers and
     strings.  To force an expression to be treated as a number
     add 0 to it; to force it to be treated as a string concaten-
     ate "" to it.







Printed 7/9/88		 April 29, 1985                         3