awk - Unix, Linux Command---reference
http://www.tutorialspoint.com/unix_commands/awk.htm gawk - pattern scanning and processing language gawk?[?POSIX?or?GNU?style options ]?-f?program-file?[?--?] file ...?gawk?[?POSIX?or?GNU?style options ] [?--?]?program-text?file ... pgawk?[?POSIX?or?GNU?style options ]?-f?program-file?[?--?] file ...?pgawk?[?POSIX?or?GNU?style options ] [?--?]?program-text?file ... Gawk?is the?GNU?Project’s implementation of the?AWK?programming language. It conforms to the definition of the language in the?POSIX?1003.2 Command Language And Utilities Standard. This version in turn is based on the description in?The AWK Programming Language,by Aho,Kernighan,and Weinberger,with the additional features found in the System V Release 4 version of?UNIX?awk.?Gawk?also provides more recent Bell Laboratories?awk?extensions,and a number of?GNU-specific extensions. Pgawk?is the profiling version of?gawk. It is identical in every way to?gawk,except that programs run more slowly,and it automatically produces an execution profile in the fileawkprof.out?when done. See the?--profile?option,below. The command line consists of options to?gawk?itself,the?AWK?program text (if not supplied via the?-f?or?--file?options),and values to be made available in the?ARGC?andARGV?pre-defined?AWK?variables. Gawk?options may be either traditional?POSIX?one letter options,or?GNU?style long options.?POSIX?options start with a single ‘‘-’’,while long options start with ‘‘--’’. Long options are provided for both?GNU-specific features and for?POSIX-mandated features. Following the?POSIX?standard,?gawk-specific options are supplied via arguments to the?-W?option. Multiple?-W?options may be supplied Each?-W?option has a corresponding long option,as detailed below. Arguments to long options are either joined with the option by an?=?sign,with no intervening spaces,or they may be provided in the next command line argument. Long options may be abbreviated,as long as the abbreviation remains unique. Gawk?accepts the following options,listed alphabetically.
<tr valign="top"> <td colspan="2"> -W profile[=prof_file]?--profile[=prof_file]</td> </tr> </tr> </tr> </tr> </tr> </tr> </tr> </tr> </tr> |
An?AWK?program consists of a sequence of pattern-action statements and optional function definitions.
pattern?{?action statements?}?function?name(parameter list) {?statements?}
Gawk?first reads the program source from the?program-file(s) if specified,from arguments to?--source,or from the first non-option argument on the command line. The?-f?and?--source?options may be used multiple times on the command line.?Gawk?reads the program text as if all the?program-files and command line source texts had been concatenated together. This is useful for building libraries of?AWK?functions,without having to include them in each new?AWK?program that uses them. It also provides the ability to mix library functions with command line programs.
The environment variable?AWKPATH?specifies a search path to use when finding source files named with the?-f?option. If this variable does not exist,the default path is".:/usr/local/share/awk". (The actual directory may vary,depending upon how?gawkwas built and installed.) If a file name given to the?-f?option contains a ‘‘/’’ character,no path search is performed.
Gawk?executes?AWK?programs in the following order. First,all variable assignments specified via the?-v?option are performed. Next,?gawk?compiles the program into an internal form. Then,?gawk?executes the code in the?BEGIN?block(s) (if any),and then proceeds to read each file named in the?ARGV?array. If there are no files named on the command line,?gawk?reads the standard input.
If a filename on the command line has the form?var=val?it is treated as a variable assignment. The variable?var?will be assigned the value?val. (This happens after anyBEGIN?block(s) have been run.) Command line variable assignment is most useful for dynamically assigning values to the variables?AWK?uses to control how input is broken into fields and records. It is also useful for controlling state if multiple passes are needed over a single data file.
If the value of a particular element of?ARGV?is empty (""),?gawk?skips over it.
For each record in the input,?gawk?tests to see if it matches any?pattern?in the?AWKprogram. For each pattern that the record matches,the associated?action?is executed. The patterns are tested in the order they occur in the program.
Finally,after all the input is exhausted,?gawk?executes the code in the?END?block(s) (if any).
AWK?variables are dynamic; they come into existence when they are first used. Their values are either floating-point numbers or strings,or both,depending upon how they are used.?AWK?also has one dimensional arrays; arrays with multiple dimensions may be simulated. Several pre-defined variables are set as a program runs; these will be described as needed and summarized below.
Records
Normally,records are separated by newline characters. You can control how records are separated by assigning values to the built-in variable?RS. If?RS?is any single character,that character separates records. Otherwise,?RS?is a regular expression. Text in the input that matches this regular expression separates the record. However,in compatibility mode,only the first character of its string value is used for separating records. If?RS?is set to the null string,then records are separated by blank lines. WhenRS?is set to the null string,the newline character always acts as a field separator,in addition to whatever value?FS?may have.
Fields
As each input record is read,?gawk?splits the record into?fields,using the value of the?FSvariable as the field separator. If?FS?is a single character,fields are separated by that character. If?FS?is the null string,then each individual character becomes a separate field. Otherwise,?FS?is expected to be a full regular expression. In the special case thatFS?is a single space,fields are separated by runs of spaces and/or tabs and/or newlines. (But see the discussion of?--posix,below).?NOTE:?The value of?IGNORECASE(see below) also affects how fields are split when?FS?is a regular expression,and how records are separated when?RS?is a regular expression.
If the?FIELDWIDTHS?variable is set to a space separated list of numbers,each field is expected to have fixed width,and?gawk?splits up the record using the specified widths. The value of?FS?is ignored. Assigning a new value to?FS?overrides the use ofFIELDWIDTHS,and restores the default behavior.
Each field in the input record may be referenced by its position,?$1,?$2,and so on.?$0?is the whole record. Fields need not be referenced by constants:
n = 5?print $n
prints the fifth field in the input record.
The variable?NF?is set to the total number of fields in the input record.
References to non-existent fields (i.e. fields after?$NF) produce the null-string. However,assigning to a non-existent field (e.g.,?$(NF+2) = 5) increases the value of?NF,creates any intervening fields with the null string as their value,and causes the value of?$0?to be recomputed,with the fields being separated by the value of?OFS. References to negative numbered fields cause a fatal error. Decrementing?NF?causes the values of fields past the new value to be lost,and the value of?$0?to be recomputed,with the fields being separated by the value of?OFS.
Assigning a value to an existing field causes the whole record to be rebuilt when?$0?is referenced. Similarly,assigning a value to?$0?causes the record to be resplit,creating new values for the fields.
Built-in Variables
Gawk’s built-in variables are:
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag
<tr valign="top">
<td>ARGIND</td>
<td valign="bottom">The index in?ARGV?of the current file being processed.</td>
</tr>
<tr valign="top">
<td>ARGV</td>
<td valign="bottom">Array of command line arguments. The array is indexed from 0 to?ARGC?- 1. Dynamically changing the contents of?ARGV?can control the files used for data.</td>
</tr>
<tr valign="top">
<td>BINMODE</td>
<td valign="bottom">On non-POSIX systems,specifies use of ‘‘binary’’ mode for all file I/O. Numeric values of 1,2,or 3,specify that input files,output files,or all files,respectively,should use binary I/O. String values of?"r",or?"w"?specify that input files,or output files,should use binary I/O. String values of?"rw"?or"wr"?specify that all files should use binary I/O. Any other string value is treated as?"rw",but generates a warning message.</td>
</tr>
<tr valign="top">
<td>CONVFMT</td>
<td valign="bottom">The conversion format for numbers,?"%.6g",by default.</td>
</tr>
<tr valign="top">
<td>ENVIRON</td>
<td valign="bottom">An array containing the values of the current environment. The array is indexed by the environment variables,each element being the value of that variable (e.g.,?ENVIRON["HOME"]?might be?/home/arnold). Changing this array does not affect the environment seen by programs which?gawk?spawns via redirection or the?system()?function.</td>
</tr>
<tr valign="top">
<td>ERRNO</td>
<td valign="bottom">If a system error occurs either doing a redirection for?getline,during a read for?getline,or during a?close(),then?ERRNO?will contain a string describing the error. The value is subject to translation in non-English locales.</td>
</tr>
<tr valign="top">
<td>FIELDWIDTHS</td>
<td valign="bottom">A white-space separated list of fieldwidths. When set,?gawkparses the input into fields of fixed width,instead of using the value of the?FS?variable as the field separator.</td>
</tr>
<tr valign="top">
<td>FILENAME</td>
<td valign="bottom">The name of the current input file. If no files are specified on the command line,the value of?FILENAME?is ‘‘-’’. However,FILENAME?is undefined inside the?BEGIN?block (unless set bygetline).</td>
</tr>
<tr valign="top">
<td>FNR</td>
<td valign="bottom">The input record number in the current input file.</td>
</tr>
<tr valign="top">
<td>FS</td>
<td valign="bottom">The input field separator,a space by default. See?<a href="http://www.tutorialspoint.com/#8">Fields,above.</td>
</tr>
<tr valign="top">
<td>IGNORECASE</td>
<td valign="bottom">Controls the case-sensitivity of all regular expression and string operations. If?IGNORECASE?has a non-zero value,then string comparisons and pattern matching in rules,field splitting withFS,record separating with?RS,regular expression matching with?~?and?!~,and the?gensub(),?gsub(),?index(),?match(),split(),and?sub()?built-in functions all ignore case when doing regular expression operations.?NOTE:?Array subscripting is?notaffected. However,the?asort()?and?asorti()?functions are affected.
Thus,if?IGNORECASE?is not equal to zero,?/aB/?matches all of the strings?"ab",?"aB",?"Ab",and?"AB". As with all?AWKvariables,the initial value of?IGNORECASE?is zero,so all regular expression and string operations are normally case-sensitive. Under Unix,the full ISO 8859-1 Latin-1 character set is used when ignoring case. As of?gawk?3.1.4,the case equivalencies are fully locale-aware,based on the C?
</td>
</tr>
<tr valign="top">
<td>LINT</td>
<td valign="bottom">Provides dynamic control of the?--lint?option from within an?AWKprogram. When true,?gawk?prints lint warnings. When false,it does not. When assigned the string value?"fatal",lint warnings become fatal errors,exactly like?--lint=fatal. Any other true value just prints warnings.</td>
</tr>
<tr valign="top">
<td>NF</td>
<td valign="bottom">The number of fields in the current input record.</td>
</tr>
<tr valign="top">
<td>NR</td>
<td valign="bottom">The total number of input records seen so far.</td>
</tr>
<tr valign="top">
<td>OFMT</td>
<td valign="bottom">The output format for numbers,by default.</td>
</tr>
<tr valign="top">
<td>OFS</td>
<td valign="bottom">The output field separator,a space by default.</td>
</tr>
<tr valign="top">
<td>ORS</td>
<td valign="bottom">The output record separator,by default a newline.</td>
</tr>
<tr valign="top">
<td>PROCINFO</td>
<td valign="bottom">The elements of this array provide access to information about the running?AWK?program. On some systems,there may be elements in the array,?"group1"?through?"groupn"?for some?n,which is the number of supplementary groups that the process has. Use the?in?operator to test for these elements. The following elements are guaranteed to be available:
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag
<tr valign="top">
<td>PROCINFO["euid"]</td>
<td valign="bottom">the value of the?geteuid(2) system call.</td>
</tr>
<tr valign="top">
<td>PROCINFO["FS"]</td>
<td valign="bottom">
"FS"?if field splitting with?FS?is in effect,or?"FIELDWIDTHS"?if field splitting with?FIELDWIDTHS?is in effect.</td>
</tr>
<tr valign="top">
<td>PROCINFO["gid"]</td>
<td valign="bottom">the value of the?getgid(2) system call.</td>
</tr>
<tr valign="top">
<td>PROCINFO["pgrpid"]</td>
<td valign="bottom">the process group ID of the current process.</td>
</tr>
<tr valign="top">
<td>PROCINFO["pid"]</td>
<td valign="bottom">the process ID of the current process.</td>
</tr>
<tr valign="top">
<td>PROCINFO["ppid"]</td>
<td valign="bottom">the parent process ID of the current process.</td>
</tr>
<tr valign="top">
<td>PROCINFO["uid"]</td>
<td valign="bottom">the value of the?getuid(2) system call.</td>
</tr>
<tr valign="top">
<td colspan="2">PROCINFO["version"]</td>
</tr>
<tr valign="top">
<td width="17%">?</td>
<td>The version of?gawk. This is available from version 3.1.4 and later.</td>
</tr>
</tr><tr valign="top">
<td>RS</td>
<td valign="bottom">The input record separator,by default a newline.</td>
</tr>
<tr valign="top">
<td>RT</td>
<td valign="bottom">The record terminator.?Gawk?sets?RT?to the input text that matched the character or regular expression specified by?RS.</td>
</tr>
<tr valign="top">
<td>RSTART</td>
<td valign="bottom">The index of the first character matched by?match(); 0 if no match. (This implies that character indices start at one.)</td>
</tr>
<tr valign="top">
<td>RLENGTH</td>
<td valign="bottom">The length of the string matched by?match(); -1 if no match.</td>
</tr>
<tr valign="top">
<td>SUBSEP</td>
<td valign="bottom">The character used to separate multiple subscripts in array elements,by default?" 34".</td>
</tr>
<tr valign="top">
<td>TEXTDOMAIN</td>
<td valign="bottom">The text domain of the?AWK?program; used to find the localized translations for the program’s strings.</td>
</tr>
ArraysArrays are subscripted with an expression between square brackets ([?and?]). If the expression is an expression list (expr,?expr?...) then the array subscript is a string consisting of the concatenation of the (string) value of each expression,separated by the value of the?SUBSEP?variable. This facility is used to simulate multiply dimensioned arrays. For example:
i = "A"; j = "B"; k = "C"?x[i,j,k] = "hello,worldn"
assigns the string?"hello,worldn"?to the element of the array?x?which is indexed by the string?"A 34B 34C". All arrays in?AWK?are associative,i.e. indexed by string values.
The special operator?in?may be used in an?if?or?while?statement to see if an array has an index consisting of a particular value.
<table class="src" cellspacing="5" cellpadding="5">
<tr><td>
if (val in array) ????????print array[val]If the array has multiple subscripts,use?(i,j) in array.
The?in?construct may also be used in a?for?loop to iterate over all the elements of an array.
An element may be deleted from an array using the?delete?statement. The?deletestatement may also be used to delete the entire contents of an array,just by specifying the array name without a subscript.
Variable Typing And Conversion
Variables and fields may be (floating point) numbers,or strings,or both. How the value of a variable is interpreted depends upon its context. If used in a numeric expression,it will be treated as a number,if used as a string it will be treated as a string.
To force a variable to be treated as a number,add 0 to it; to force it to be treated as a string,concatenate it with the null string.
When a string must be converted to a number,the conversion is accomplished usingstrtod(3). A number is converted to a string by using the value of?CONVFMT?as a format string for?sprintf(3),with the numeric value of the variable as the argument. However,even though all numbers in?AWK?are floating-point,integral values are?always?converted as integers. Thus,given
<table class="src" cellspacing="5" cellpadding="5">
<tr><td>
CONVFMT = "%2.2f" a = 12 b = a ""the variable?b?has a string value of?"12"?and not?"12.00".
Gawk?performs comparisons as follows: If two variables are numeric,they are compared numerically. If one value is numeric and the other has a string value that is a ‘‘numeric string,’’ then comparisons are also done numerically. Otherwise,the numeric value is converted to a string and a string comparison is performed. Two strings are compared,of course,as strings. Note that the POSIX standard applies the concept of ‘‘numeric string’’ everywhere,even to string constants. However,this is clearly incorrect,andgawk?does not do this. (Fortunately,this is fixed in the next version of the standard.)
Note that string constants,such as?"57",are?not?numeric strings,they are string constants. The idea of ‘‘numeric string’’ only applies to fields,?getline?input,?FILENAME,ARGV?elements,?ENVIRON?elements and the elements of an array created by?split()that are numeric strings. The basic idea is that?user input,and only user input,that looks numeric,should be treated that way.
Uninitialized variables have the numeric value 0 and the string value "" (the null,or empty,string).
Octal and Hexadecimal Constants
Starting with version 3.1 of?gawk,?you may use C-style octal and hexadecimal constants in your AWK program source code. For example,the octal value?011?is equal to decimal9,and the hexadecimal value?0x11?is equal to decimal 17.
String Constants
String constants in?AWK?are sequences of characters enclosed between double quotes ("). Within strings,certain?escape sequences?are recognized,as in C. These are:
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag
In compatibility mode,the characters represented by octal and hexadecimal escape sequences are treated literally when used in regular expression constants. Thus,/a52b/?is equivalent to?/a*b/.
AWK?is a line-oriented language. The pattern comes first,and then the action. Action statements are enclosed in?{?and?}. Either the pattern may be missing,or the action may be missing,but,not both. If the pattern is missing,the action is executed for every single record of input. A missing action is equivalent to
{ print }
which prints the entire record.
Comments begin with the ‘‘#’’ character,and continue until the end of the line. Blank lines may be used to separate statements. Normally,a statement ends with a newline,this is not the case for lines ending in a ‘‘,’’,?{,??,?:,?&&,or?||. Lines ending indo?or?else?also have their statements automatically continued on the following line. In other cases,a line can be continued by ending it with a ‘‘’’,in which case the newline will be ignored.
Multiple statements may be put on one line by separating them with a ‘‘;’’. This applies to both the statements within the action part of a pattern-action pair (the usual case),and to the pattern-action statements themselves.
Patterns
AWK?patterns may be one of the following:
<table class="src" cellspacing="5" cellpadding="5">
<tr><td>
BEGIN END /regular expression/ relational expression pattern && pattern pattern || pattern pattern ? pattern : pattern (pattern) ! pattern pattern1,pattern2BEGIN?and?END?are two special kinds of patterns which are not tested against the input. The action parts of all?BEGIN?patterns are merged as if all the statements had been written in a single?BEGIN?block. They are executed before any of the input is read. Similarly,all the?END?blocks are merged,and executed when all the input is exhausted (or when an?exit?statement is executed).?BEGIN?and?END?patterns cannot be combined with other patterns in pattern expressions.?BEGIN?and?END?patterns cannot have missing action parts.
For?/regular expression/?patterns,the associated statement is executed for each input record that matches the regular expression. Regular expressions are the same as those in?egrep(1),and are summarized below.
A?relational expression?may use any of the operators defined below in the section on actions. These generally test whether certain fields match certain regular expressions.
The?&&,?||,and?!?operators are logical AND,logical OR,and logical NOT,as in C. They do short-circuit evaluation,also as in C,and are used for combining more primitive pattern expressions. As in most languages,parentheses may be used to change the order of evaluation.
The??:?operator is like the same operator in C. If the first pattern is true then the pattern used for testing is the second pattern,otherwise it is the third. Only one of the second and third patterns is evaluated.
The?pattern1,?pattern2?form of an expression is called a?range pattern. It matches all input records starting with a record that matches?pattern1,and continuing until a record that matches?pattern2,inclusive. It does not combine with any other sort of pattern expression.
Regular Expressions
Regular expressions are the extended kind found in?egrep. They are composed of characters as follows:
Description |
---|
Character classes?are a new feature introduced in the?POSIX?standard. A character class is a special notation for describing lists of characters that have a specific attribute,but where the actual characters themselves can vary from country to country and/or from character set to character set. For example,the notion of what is an alphabetic character differs in the USA and in France.
A character class is only valid in a regular expression?inside?the brackets of a character list. Character classes consist of?[:,a keyword denoting the class,and?:]. The character classes defined by the?POSIX?standard are:
Description |
---|
Two additional special sequences can appear in character lists. These apply to non-ASCII?character sets,which can have single symbols (called?collating elements) that are represented with more than one character,as well as several characters that are equivalent for?collating,or sorting,purposes. (E.g.,in French,a plain ‘‘e’’ and a grave-accented e` are equivalent.)
Description |
---|
Action statements are enclosed in braces,?{?and?}. Action statements consist of the usual assignment,conditional,and looping statements found in most languages. The operators,control statements,and input/output statements available are patterned after those in C.
Operators
The operators in?AWK,in order of decreasing precedence,are
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag
<tr valign="top">
<td>$</td>
<td valign="bottom">Field reference.</td>
</tr>
<tr valign="top">
<td>++ --</td>
<td valign="bottom">Increment and decrement,both prefix and postfix.</td>
</tr>
<tr valign="top">
<td>^</td>
<td valign="bottom">Exponentiation (?may also be used,and?=?for the assignment operator).</td>
</tr>
<tr valign="top">
<td>+ - !</td>
<td valign="bottom">Unary plus,unary minus,and logical negation.</td>
</tr>
<tr valign="top">
<td>* / %</td>
<td valign="bottom">Multiplication,division,and modulus.</td>
</tr>
<tr valign="top">
<td>+ -</td>
<td valign="bottom">Addition and subtraction.</td>
</tr>
<tr valign="top">
<td>space</td>
<td valign="bottom">String concatenation.</td>
</tr>
<tr valign="top">
<td>
< >?<= >=?!= ==
</td>
<td valign="bottom">The regular relational operators.</td>
</tr>
<tr valign="top">
<td>~ !~</td>
<td valign="bottom">Regular expression match,negated match.?NOTE:?Do not use a constant regular expression (/foo/) on the left-hand side of a?~or?!~. Only use one on the right-hand side. The expression/foo/ ~?exp?has the same meaning as?(($0 ~ /foo/) ~?exp). This is usually?not?what was intended.</td>
</tr>
<tr valign="top">
<td>in</td>
<td valign="bottom">Array membership.</td>
</tr>
<tr valign="top">
<td>&&</td>
<td valign="bottom">Logical AND.</td>
</tr>
<tr valign="top">
<td>||</td>
<td valign="bottom">Logical OR.</td>
</tr>
<tr valign="top">
<td>?:</td>
<td valign="bottom">The C conditional expression. This has the form?expr1???expr2?:expr3?. If?expr1?is true,the value of the expression is?expr2,otherwise it is?expr3. Only one of?expr2?and?expr3?is evaluated.</td>
</tr>
<tr valign="top">
<td>
= += -=?*= /= %= ^=
</td>
<td valign="bottom">Assignment. Both absolute assignment?(var?=?value)?and operator-assignment (the other forms) are supported.</td>
</tr>
Control StatementsThe control statements are as follows:
<table class="src" cellspacing="5" cellpadding="5">
<tr><td>
if (condition) statement [ else statement ] while (condition) statement do statement while (condition) for (expr1; expr2; expr3) statement for (var in array) statement break continue delete array[index] delete array exit [ expression ] { statements }I/O Statements
The input/output statements are as follows:
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag
Description |
---|
NOTE:?If using a pipe or co-process to?getline,or from?print?or?printf?within a loop,youmust?use?close()?to create new instances of the command.?AWK?does not automatically close pipes or co-processes when they return EOF.
The printf Statement
The?AWK?versions of the?printf?statement and?sprintf()?function (see below) accept the following conversion specification formats:
Description |
---|
Optional,additional parameters may lie between the?%?and the control letter:
Description |
---|
Special File Names
When doing I/O redirection from either?print?or?printf?into a file,or via?getline?from a file,?gawk?recognizes certain special filenames internally. These filenames allow access to open file descriptors inherited from?gawk’s parent process (usually the shell). These file names may also be used on the command line to name data files. The filenames are:
Description |
---|
print "You blew it!" > "/dev/stderr"
whereas you would otherwise have to use
print "You blew it!" | "cat 1>&2"
The following special filenames may be used with the?|&?co-process operator for creating TCP/IP network connections.
Description |
---|
Description |
---|
AWK?has the following built-in arithmetic functions:
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag
Gawk?has the following built-in string functions:
<table class="src" border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="25%">Tag