home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gawk-2.15.6-src.tgz / tar.out / fsf / gawk / vms / gawk.hlp < prev    next >
Text File  |  1996-09-28  |  62KB  |  1,209 lines

  1. ! Gawk.Hlp
  2. !                                                       Pat Rankin, Jun'90
  3. !                                                          revised, Jun'91
  4. !                                                          revised, Jul'92
  5. !                                                          revised, Jan'95
  6. !   Online help for GAWK.
  7. !
  8. 1 GAWK
  9.  GAWK is GNU awk, the Free Software Foundation's implementation of
  10.  the awk programming language.  awk is an interpretive language which
  11.  can handle many data-reformatting jobs with just a few lines of code.
  12.  It has powerful string manipulation and pattern matching capabilities
  13.  built in.  This version should be compatible with POSIX 1003.2 awk.
  14.  
  15.  The VMS version of GAWK supports both the original UN*X-style command
  16.  interface and a DCL interface.  The only setup requirement for GAWK
  17.  is to define it as a 'foreign' command:  a DCL symbol with a value
  18.  which begins with '$'.
  19.        $ GAWK :== $disk:[directory]GAWK
  20. 2 GNU_syntax
  21.  GAWK's UN*X-style interface uses the 'dash' convention for specifying
  22.  options and uses spaces to separate multiple arguments.
  23.  
  24.  There are two main alternatives, depending on how the awk program is
  25.  to be passed to GAWK.  Both alternatives share most options.
  26.  
  27.  Usage: $ gawk [-W opts] [-F fs] [-v var=val] -f progfile [--] file ...
  28.     or  $ gawk [-W opts] [-F fs] [-v var=val] [--] "program" file ...
  29.  
  30.  The options are case-sensitive.  On VMS, the DCL command interpreter
  31.  converts unquoted text into uppercase before passing it to the running
  32.  program.  However, GAWK is written in 'C' and the C Run-Time Library
  33.  (VAXCRTL) converts unquoted text into *lowercase*.  Therefore, the
  34.  -Fval and -W options must be enclosed in quotes.
  35.  
  36.  Note:  under VMS POSIX, the usual shell command line processing occurs.
  37. 3 options
  38.  -f file    use the specified file as the awk program source; if more
  39.             than one instance of -f is used, each file will be read
  40.             in succession
  41.  -Fstring   define a value for the FS variable (field separator)
  42.  -v var=val assign a value of 'val' to the variable 'var'
  43.  -W 'options'  additional gawk-specific options; multiple values may
  44.             be separated by commas, or by spaces if they're quoted,
  45.             or mulitple occurrences of -W may be used.
  46.  -W compat  use awk "compatibility mode" to disable GAWK extensions
  47.             and get the behavior of UN*X awk.
  48.  -W copyright [or -W copyleft]  display an abbreviated version of
  49.             the GNU copyright information
  50.  -W lint    warn about suspect or non-portable awk program code
  51.  -W posix   compatibility mode with additional restrictions
  52.  -W version display program version number
  53.  --         don't check further arguments for leading dash
  54. 3 program_text
  55.  If the '-f file' option is not used on the command line, then the
  56.  first "non-dash" argument is assumed to be a string of text containing
  57.  the awk source program.  Here is a complete sample program:
  58.        $ gawk -- "BEGIN {print ""\nHello, World!\n""}"
  59.  This program would print a blank line (based on first "\n"), followed
  60.  by a line reading "Hello, World!", followed by another blank line
  61.  (since awk's 'print' statement includes the trailing 'newline').
  62.  
  63.  On VMS, to include a quote character inside of a quoted string, two
  64.  successive quotes ("") must be used.  (Not necessary for VMS POSIX.)
  65. 3 data_files
  66.  After all dash-options are examined, and after the program text if
  67.  there were no occurrences of the -f option, remaining (space separated)
  68.  command line arguments are considered to be data files for the awk
  69.  program to process.  If any of these actually contains an equals sign
  70.  (=), then it is interpreted as a variable assignment instead of a data
  71.  file.  The syntax is 'variable_name=value'.  For example, the command
  72.        $ gawk -f myprog.awk infile.one flag=2 start=0 infile.two
  73.  would read file 'infile.one' for the program in 'myprog.awk', then it
  74.  would set 'flag' to 2 and 'start' to 0, and finally it would read file
  75.  'infile.two' for the program.  Note that in a case like this, the two
  76.  assignments actually occur after the first file has been processed,
  77.  not at program startup when the command line is first scanned.
  78. 3 IO_redirection
  79.  The command parsing in the VMS implementation of GAWK does some
  80.  emulation of a UN*X-style shell, where certain characters on the
  81.  command line have special meaning.  In particular, the symbols '<',
  82.  '>', '|', '*', and '?' receive special handling before the main part
  83.  of the program has a chance to see them.  The symbols '<' and '>'
  84.  perform some file manipulation from the command line:
  85.  
  86.  <ifile     open file 'ifile' (readonly) as 'stdin' [SYS$INPUT]
  87.  >nfile     create 'nfile' as 'stdout' [SYS$OUTPUT], in stream-lf format
  88.  >>ofile    append to 'ofile' for 'stdout'; create it if necessary
  89.  >&efile    point 'stderr' [SYS$ERROR] at 'efile', but don't open it yet
  90.  >$vfile    create 'vfile' as 'stdout', using RMS attributes appropriate
  91.             for a standard text file (variable length records with
  92.             implied carriage control)
  93.  >+bfile    create 'bfile' as 'stdout' using binary mode
  94.  2>&1       route error messages into the regular output stream
  95.  1>&2       send output data to the error destination
  96.  <<sentinel error; reading stdin until 'sentinel' not supported
  97.  <-, >-     error; closure of stdin or stdout from cmd line not supported
  98.  >>$vfile   incorrect; would be interpreted as file "$vfile" in stream-lf
  99.             format rather than as file "vfile" in RMS 'text' format
  100.  |          error; command line pipes not supported
  101.  
  102.  Note:  under VMS POSIX these features are implemented by the shell
  103.  rather than inside GAWK, so consult the shell documentation for
  104.  specific details.
  105. 3 wildcard_expansion
  106.  The command parsing in the VMS implementation of GAWK does some
  107.  emulation of a UN*X-style shell, where certain characters on the
  108.  command line have special meaning.  In particular, the symbols '<',
  109.  '>', '*', '%', and '?' receive special handling before the main part
  110.  of the program has a chance to see them.  The symbols '*', '%' and '?'
  111.  are used as wildcards in filenames.  '*' and '%' have their usual VMS
  112.  meanings of multiple character and single character wildcards,
  113.  respectively, and '?' is also treated as a single character wildcard.
  114.  
  115.  When a command line argument that should be a filename contains any
  116.  of the wildcard characters, a directory lookup is attempted for files
  117.  which match the specified pattern.  If one or more matching files are
  118.  found, those filenames are put into the command line in place of the
  119.  original pattern.  If no matching files are found, the original
  120.  pattern is left in place.
  121.  
  122.  Note:  under VMS POSIX wildcard expansion, or "file globbing", is
  123.  performed by the shell rather than inside GAWK, so consult the shell
  124.  documentation for details.  In particular, the last sentence of the
  125.  previous paragraph does not apply.
  126. 2 DCL_syntax
  127.  GAWK's DCL-style interface is more or less a standard DCL command, with
  128.  one required parameter.  Multiple values--when present--are separated
  129.  by commas.
  130.  
  131.  There are two main alternatives, depending on how the awk program is
  132.  to be passed to GAWK.  Both alternatives share most options.
  133.  
  134.  Usage:  GAWK  /COMMANDS="awk program text"  data_file[,data_file,...]
  135.     or   GAWK  /INPUT=awk_file  data_file[,"Var=value",data_file,...]
  136.  (  or   GAWK  /INPUT=(awk_file1,awk_file2,...)  data_file[,...]       )
  137.  
  138.  Not applicable under VMS POSIX.
  139. 3 Parameter
  140.  data_file[,datafile,...]       (data_file data_file ...)
  141.  data_file[,"Var=value",...,data_file,...]      (data_file Var=value &c)
  142.  
  143.   Data file(s) for the awk program to process.  If any of these
  144.   actually contains an equals sign (=), then it is interpreted as
  145.   a variable assignment instead of a data file.  The syntax is
  146.   "variable_name=value".  Quotes are required for non-file parameters.
  147.  
  148.   For example, the command
  149.        $ gawk/input=myprog.awk infile.one,"flag=2","start=0",infile.two
  150.   would read file 'infile.one' for the program in 'myprog.awk', then it
  151.   would set 'flag' to 2 and 'start' to 0, and finally it would read file
  152.   'infile.two' for the program.  Note that in a case like this, the two
  153.   assignments actually occur after the first file has been processed,
  154.   not at program startup when the command line is first scanned.
  155.  
  156.   Wildcard file lookups are attempted on data file specifications.  See
  157.   subtopic 'GAWK GNU_syntax wildcard_expansion' for details.
  158.  
  159.   At least one data_file parameter value is required.  An exception is
  160.   made if /usage, /version, or /copyright is specified *and* if GAWK is
  161.   defined as a 'foreign' command rather than a 'native' DCL command.
  162. 3 Qualifiers
  163. /COMMANDS
  164.  /COMMANDS="awk program text"   (-- "awk program text")
  165.  
  166.   For short programs, it is possible to include the complete program
  167.   on the command line.  The quotes are required.  Here is a complete
  168.   sample program:
  169.        $ gawk/commands="BEGIN {print ""\nHello, World!\n""}" NL:
  170.   This program would print a blank line (based on first "\n"), followed
  171.   by a line reading "Hello, World!", followed by another blank line
  172.   (since awk's 'print' statement includes the trailing 'newline').
  173.  
  174.   To include a quote character inside of a quoted string, two
  175.   successive quotes ("") must be used.
  176.  
  177.   Either /COMMANDS or /INPUT (but not both) must be supplied.
  178. /INPUT
  179.  /INPUT=(awk_file1,awk_file2)   (-f awk_file1 -f awk_file2)
  180.  
  181.   Used to specify one or more files containing the source code of
  182.   the awk program.  If more than one file is used, separate them
  183.   with commas and enclose the list in parentheses.
  184.  
  185.   Multiple source files are processed in order as if they had been
  186.   concatenated together.
  187.  
  188.   Either /INPUT or /COMMANDS (but not both) must be supplied.
  189. /FIELD_SEPARATOR
  190.  /FIELD_SEPARATOR="FS_value"    (-F"FS_value")
  191.  
  192.   Assign a value to the built in variable FS (field separator).
  193. /VARIABLES
  194.  /VARIABLES=("Var1=val1","Var2=val2",...)  (-v Var1=val1 -v Var2=val2)
  195.  
  196.   Assign value(s) to the specified variable(s).
  197. /REG_EXPR
  198.  /REG_EXPR={AWK | EGREP | POSIX}   (-a vs -e options [obsolete])
  199.  
  200.   This qualifier is obsolete and has no effect.
  201. /STRICT
  202.  /[NO]STRICT            (-"W compat" option)
  203.  
  204.   Use strict awk compatibility mode (/strict) and suppress GAWK
  205.   extensions.  The default is /NOSTRICT.
  206. /POSIX
  207.  /[NO]POSIX             (-"W posix" option)
  208.  
  209.   Use POSIX compatibility mode (/posix) and suppress GAWK extensions.
  210.   The default is /NOPOSIX.  Slightly more restrictive than /strict.
  211. /LINT
  212.  /[NO]LINT              (-"W lint" option)
  213.  
  214.   Check the awk program cafefully for potential problems that might
  215.   be encountered if it were to be used with other awk implementations,
  216.   and print warnings for anything found.  The default in /NOLINT.
  217. /VERSION
  218.  /VERSION               (-"W version" option)
  219.  
  220.   Print GAWK's version number.
  221. /COPYRIGHT
  222.  /COPYRIGHT             (-"W copyright" or -"W copyleft" option)
  223.  
  224.   Print a brief version of GAWK's copyright notice.
  225. /USAGE
  226.  /USAGE                 (no corresponding GNU_syntax option)
  227.  
  228.   Print a compact summary of the command line options.
  229.  
  230.   After the 'usage' message is printed, GAWK terminates regardless
  231.   of any other command line options.
  232. /OUTPUT
  233.  /OUTPUT=out_file       (>$out_file)
  234.  
  235.   Write program output into 'out_file'.  The default is SYS$OUTPUT.
  236. 2 awk_language
  237.  An awk program consists of one or more pattern-action pairs, sometimes
  238.  referred to as "rules".  For each record of an input (data) file, the
  239.  rules are checked sequentially.  Any pattern which matches the input
  240.  record triggers that rule's action.  Actions are instructions which
  241.  resemble statements in the 'C' programming language.  Patterns come
  242.  in several varieties, including field comparisons, regular expression
  243.  matching, and special cases defined by reserved keywords.
  244.  
  245.  All awk keywords and variables are case-sensitive.  Text matching is
  246.  also sensitive to character case unless the builtin variable IGNORECASE
  247.  is set to a non-zero value.
  248. 3 rules
  249.  The syntax for a pattern-action 'rule' is simply
  250.        PATTERN { ACTION }
  251.  where the braces ({}) are required punctuation for the action.
  252.  Semicolons (;) or 'newlines' (ie, having the text on a separate line)
  253.  delimit multiple rules and also multiple actions within a given rule.
  254.  Either the pattern or the action may be omitted; an empty pattern
  255.  matches every record of the input file; a missing action (not an empty
  256.  action inside of braces), is an implicit request to print the current
  257.  record; an empty action (ie, {}) is legal but not very useful.
  258. 3 patterns
  259.  There are several types of patterns available for awk rules.
  260.  
  261.   expression  an 'expression' is something to be evaluated (perhaps
  262.                          a comparison or function call) which will
  263.                          be considered true if non-zero (for numeric
  264.                          results) or if non-null (for strings)
  265.   /regular_expression/ slashes (/) delimit a regular expression
  266.                          which is used as a pattern
  267.   pattern1, pattern2   a pair of patterns separated by a comma (,),
  268.                          which causes a range of records to trigger
  269.                          the associated action; the records which
  270.                          match the patterns are included in the range
  271.   <null>      an omitted pattern (in this text, the  string '<null>'
  272.                          is displayed, but in an awk program, it
  273.                          would really be blank) matches every record
  274.   BEGIN       keyword for specifying a rule to be executed prior to
  275.                          reading the 1st record of the 1st input file
  276.   END         keyword for specifying a rule to be executed after
  277.                          handling the last input record of last file
  278. 4 examples
  279.  Some example patterns (mostly with the corresponding actions omitted)
  280.  
  281.  NF > 0     # comparison expression:  matches non-null records
  282.  $0         # implied comparison:  also matches non-null records
  283.  $2 > 1000 && sum <= 999999     # slightly more elaborate expression
  284.  /x/        # regular expression matching any record with an 'x' in it
  285.  /^ /       # reg-expr matching records beginning with a space
  286.  $1 == "start", $NF == "stop"   # range pattern for input in which
  287.                 some data lines begin with 'start' and/or end with
  288.                 'stop' in order to collect groups of records
  289.         { sum += $1 }   # null pattern:  it's action (add field #1 to
  290.                 variable 'sum') would be executed for every record
  291.  BEGIN  { sum = 0 }     # keyword 'BEGIN':  perform this action before
  292.                 reading the input file (note: initialization to 0 is
  293.                 unnecessary in awk)
  294.  END    { print "total =", sum }    # keyword 'END':  perform this
  295.                 action after the last input record has been processed
  296. 3 actions
  297.  An 'action' is something to do when a given record has matched the
  298.  corresponding pattern in a rule.  In general, actions resemble 'C'
  299.  statements and expressions.  The action in a rule must be enclosed
  300.  in braces ({}).
  301.  
  302.  Each action can contain more than one statement or expression to be
  303.  executed, provided that they're separated by semicolons (;) and/or
  304.  on separate lines.
  305.  
  306.  An omitted action is equivalent to
  307.        { print $0 }
  308.  which prints the current record.
  309. 3 operators
  310.  Relational operators
  311.     ==    compare for equality
  312.     !=    compare for inequality
  313.     <, <=, >, >=  numerical or lexical comparison (less than, less or
  314.                     equal, greater than, greater or equal, respectively)
  315.     ~     match against a regular expression
  316.     !~    match against a regular expression, but accept failed matches
  317.             instead of successful ones
  318.  Arithmetic operators
  319.     +     addition
  320.     -     subtraction
  321.     *     multiplication
  322.     /     division
  323.     %     remainder
  324.     ^, ** exponentiation ('**' is a synonym for '^', unless POSIX
  325.             compatibility is specified, in which case it's invalid)
  326.  Boolean operators (aka Logical operators)
  327.           a value is considered false if it's 0 or a null string,
  328.             it is true otherwise; the result of a boolean operation
  329.             (and also of a comparison operation) will be 0 when false
  330.             or 1 when true
  331.     ||    or [expression (a || b) is true if either a is true or b
  332.             is true or both a and b are true; it is false otherwise;
  333.             b is not evaluated unless a is false (ie, short-circuit)]
  334.     &&    and [expression (a && b) is true if both a and b are true;
  335.             it is false otherwise; b is only evaluated if a is true]
  336.     !     not [expression (!a) is true if a is false, false otherwise]
  337.     in    array membership; the keyword 'in' tests whether the value
  338.             on the left represents a current subscript in the array
  339.             named on the right
  340.  Conditional operator
  341.     ? :   the conditional operator takes three operands; the first is
  342.             an expression to evaluate, the second is the expression to
  343.             use if the first was true, the third is the expression to
  344.             use if it was false [simple example (a < b ? b : a) gives
  345.             the maximum of a and b]
  346.  Assignment operators
  347.     =     store the value on the right into the variable or array slot
  348.             on the left [expression (a = b) stores the value of b in a]
  349.     +=, -=, *=, /=, %=, ^=, **=  perform the indicated arithmetic
  350.            operation using the current value of the variable or array
  351.             element of the left side and the expression on the right
  352.             side, then store the result in the left side
  353.     ++    increment by 1 [expression (++a) gets the current value of
  354.             a and adds 1 to it, stores that back in a, and returns the
  355.             new value; expression (a++) gets the current value of a,
  356.             adds 1 to it, stores that back in a, but returns the
  357.             original value of a]
  358.     --    decrement by 1 (analogous to increment)
  359.  String operators
  360.           there is no explicit operator for string concatenation;
  361.             two values and/or variables side-by-side are implicitly
  362.             concatenated into a string (numeric values are first
  363.             converted into their string equivalents)
  364.  Conversion between numeric and string values
  365.           there is no explicit operator for conversion; adding 0
  366.             to a string with force it to be converted to a number
  367.             (the numeric value will be 0 if the string does not
  368.             represent an integer or floating point number); the
  369.             reverse, converting a number into a string, is done by
  370.             concatenating a null string ("") to it [the expression
  371.             (5.75 "") evaluates to "5.75"]
  372.  Field 'operator'
  373.     $     prefixing a number or variable with a dollar sign ($)
  374.             causes the appropriate record field to be returned [($2)
  375.             gives the second field of the record, ($NF) gives the
  376.             last field (since the builtin variable NF is set to the
  377.             number of fields in the current record)]
  378.  Array subscript operator
  379.     ,     multi-dimensional arrays are simulated by using comma (,)
  380.             separated array indices; the actual index is generated
  381.             by replacing commas with the value of builtin SUBSEP,
  382.             then concatenating the expression into a string index
  383.           [comma is also used to separate arguments in function
  384.             calls and user-defined function definitions]
  385.           [comma is *also* used to indicate a range pattern in an
  386.             awk rule]
  387.  Escape 'operator'
  388.     \     In quoted character strings, the backslash (\) character
  389.             causes the following character to be interpreted in a
  390.             special manner [string "one\ntwo" has an embedded newline
  391.             character (linefeed on VMS, but treated as if it were both
  392.             carriage-return and linefeed); string "\033[" has an ASCII
  393.             'escape' character (which has octal value 033) followed by
  394.             a 'right-bracket' character]
  395.           Backslash is also used in regular expressions
  396.  Redirection operators
  397.     <     Read-from -- valid with 'getline'
  398.     >     Write-to (create new file) -- valid with 'print' and 'printf'
  399.     >>    Append-to (create file if it doesn't already exist)
  400.     |     Pipe-from/to -- valid with 'getline', 'print', and 'printf'
  401. 4 precedence
  402.  Operator precedence, listed from highest to lowest.  Assignment,
  403.  conditional, and exponentiation operators group from right to left;
  404.  all others group from left to right.  Parentheses may be used to
  405.  override the normal order.
  406.  
  407.      field ($)
  408.      increment (++), decrement (--)
  409.      exponentiation (^, **)
  410.      unary plus (+), unary minus (-), boolean not (!)
  411.      multiplication (*), division (/), remainder (%)
  412.      addition (+), subtraction (-)
  413.      concatenation (no special symbol; implied by context)
  414.      relational (==, !=, <, >=, etc), and redirection (<, >, >>, |)
  415.        Relational and redirection operators have the same precedence
  416.        and use similar symbols; context distinguishes between them
  417.      matching (~, !~)
  418.      array membership ('in')
  419.      boolean and (&&)
  420.      boolean or (||)
  421.      conditional (? :)
  422.      assignment (=, +=, etc)
  423. 4 escaped_characters
  424.  Inside of a quoted string or constant regular expression, the
  425.  backslash (\) character gives special meaning to the character(s)
  426.  after it.  Special character letters are case sensitive.
  427.     \\    results in one backslash in the string
  428.     \a    is an 'alert' (<ctrl/G>. the ASCII <bell> character)
  429.     \b    is a backspace (BS, <ctrl/H>)
  430.     \f    is a form feed (FF, <ctrl/L>)
  431.     \n    'newline' (<ctrl/J> [line feed treated as CR+LF]
  432.     \r    carriage return (CR, <ctrl/M> [re-positions at the
  433.             beginning of the current line]
  434.     \t    tab (HT, <ctrl/I>)
  435.     \v    vertical tab (VT, <ctrl/K>)
  436.     \###  is an arbitrary character, where '###' represents 1 to 3
  437.             octal (ie, 0 thru 7) digits
  438.     \x##  is an alternate arbitrary character, where '##' represents
  439.             1 or more hexadecimal (ie, 0 thru 9 and/or A through E
  440.             and/or a through e) digits; if more than two digits
  441.             follow, the result is undefined; not recognized if POSIX
  442.             compatibility mode is specified.
  443. 3 statements
  444.  A statement refers to a unit of instruction found in the action
  445.  part of an awk rule, and also found in the definition of a function.
  446.  The distinction between action, statement, and expression usually
  447.  won't matter to an awk programmer.
  448.  
  449.  Compound statements consist of multiple statements separated by
  450.  semicolons or newlines and enclosed within braces ({}).  They are
  451.  sometimes referred to as 'blocks'.
  452. 4 expressions
  453.  An expression such as 'a = 10' or 'n += i++' is a valid statement.
  454.  
  455.  Function invocations such as 'reformat_field($3)' are also valid
  456.  statements.
  457. 4 if-then-else
  458.  A conditional statement in awk uses the same syntax as for the 'C'
  459.  programming language:  the 'if' keyword, followed by an expression
  460.  in parentheses, followed by a statement--or block of statements
  461.  enclosed within braces ({})--which will be executed if the expression
  462.  is true but skipped if it's false.  This can optionally be followed
  463.  by the 'else' keyword and another statement--or block of statements--
  464.  which will be executed if (and only if) the expression was false.
  465. 5 examples
  466.  Simple example showing a statement used to control how many numbers
  467.  are printed on a given line.
  468.        if ( ++i <= 10 )     #check whether this would be the 11th
  469.               printf(" %5d", k)     #print on current line if not
  470.        else {
  471.               printf("\n %5d", k)   #print on next line if so
  472.               i = 1                 #and reset the counter
  473.        }
  474.  Another example ('next' is described under 'action-controls')
  475.        if ($1 > $2) { print "rejected"; next } else diff = $2 - $1
  476. 4 loops
  477.  Three types of loop statements are available in awk.  Each uses
  478.  the same syntax as 'C'.  The simplest of the three is the 'while'
  479.  statement.  It consists of the 'while' keyword, followed by an
  480.  expression enclosed within parentheses, followed by a statement--or
  481.  block of statements in braces ({})--which will be executed if the
  482.  expression evaluates to true.  The expression is evaluated before
  483.  attempting to execute the statement; if it's true, the statement is
  484.  executed (the entire block of statements if there is a block) and
  485.  then the expression is re-evaluated.
  486.  
  487.  The second type of loop is the do-while loop.  It consists of the
  488.  'do' keyword, followed by a statement (usually a block of statements
  489.  enclosed within braces), followed by the 'while' keyword, followed
  490.  by a test expression enclosed within parentheses.  The statement--or
  491.  block--is always executed at least once.  Then the test expression
  492.  is evaluated, and the statement(s) re-executed if the result was
  493.  true (followed by re-evaluation of the test, and so on).
  494.  
  495.  The most complex of the three loops is the 'for' statement, and it
  496.  has a second variant that is not found in 'C'.  The ordinary for-loop
  497.  consists of the 'for' keyword, followed by three semicolon-separated
  498.  expressions enclosed within parentheses, followed by a statement or
  499.  brace-enclosed block of statements.  The first of the three
  500.  expressions is an initialization clause; it is done before starting
  501.  the loop.  The second expression is used as a test, just like the
  502.  expression in a while-loop.  It is checked before attempting to
  503.  execute the statement block, and then re-checked after each execution
  504.  (if any) of the block.  The third expression is an 'increment' clause;
  505.  it is evaluated after an execution of the statement block and before
  506.  re-evaluation of the test (2nd) expression.  Normally, the increment
  507.  clause will change a variable used in the test clause, in such a
  508.  fashion that the test clause will eventually evaluate to false and
  509.  cause the loop to finish.
  510.  
  511.  Note to 'C' programmers:  the comma (,) operator commonly used in
  512.  'C' for-loop expressions is not valid in awk.
  513.  
  514.  The awk-specific variant of the for-loop is used for processing
  515.  arrays.  Its syntax is 'for' keyword, followed by variable_name 'in'
  516.  array_name (where 'var in array' is enclosed in parentheses),
  517.  followed by a statement (or block).  Each valid subscript value for
  518.  the array in question is successively placed--in no particular
  519.  order--into the specified 'index' variable.
  520. 5 while_example
  521.  # strip fields from the input record until there's nothing left
  522.  while (NF > 0) {
  523.      $1 = ""    #this will affect the value of $0
  524.      $0 = $0    #this causes $0 and NF to be re-evaluated
  525.      print
  526.  }
  527. 5 do_while_example
  528.  # This is a variation of the while_example; it gives a slightly
  529.  #   different display due to the order of operation.
  530.  # echo input record until all fields have been stripped
  531.  do {
  532.      print      #output $0
  533.      $1 = ""    #this will affect the value of $0
  534.      $0 = $0    #this causes $0 and NF to be re-evaluated
  535.  } while (NF > 0)
  536. 5 for_example
  537.  # echo command line arguments (won't include option switches)
  538.  for ( i = 0; i < ARGC; i++ )  print ARGV[i]
  539.  
  540.  # display contents of builtin environment array
  541.  for (itm in ENVIRON)
  542.      print itm, ENVIRON[itm]
  543. 4 loop-controls
  544.  There are two special statements--both from 'C'--for changing the
  545.  behavior of loop execution.  The 'continue' statement is useful in
  546.  a compound (block) statement; when executed, it effectively skips
  547.  the rest of the block so that the increment-expression (only for
  548.  for-loops) and loop-termination expression can be re-evaluated.
  549.  
  550.  The 'break' statement, when executed, effectively skips the rest
  551.  of the block and also treats the test expression as if it were
  552.  false (instead of actually re-evaluating it).  In this case, the
  553.  increment-expression of a for-loop is also skipped.
  554.  
  555.  Inside nested loops, both 'break' and 'continue' only apply to the
  556.  innermost loop.  When in compatibility mode, 'break' or 'continue'
  557.  may be used outside of a loop; either will be treated like 'next'
  558.  (see action-controls).
  559. 4 action-controls
  560.  There are two special statements for controlling statement execution.
  561.  The 'next' statement, when executed, causes the rest of the current
  562.  action and all further pattern-action rules to be skipped, so that
  563.  the next input record will be immediately processed.  This is useful
  564.  if any early action knows that the current record will fail all the
  565.  remaining patterns; skipping those rules will reduce processing time.
  566.  An extended form, 'next file', is also available.  It causes the
  567.  remainder of the current file to be skipped, and then either the
  568.  next input file will be processed, if any, or the END action will be
  569.  performed.  'next file' is not available in traditional awk.
  570.  
  571.  The 'exit' statement causes GAWK execution to terminate.  All open
  572.  files are closed, and no further processing is done.  The END rule,
  573.  if any, is executed.  'exit' takes an optional numeric value as a
  574.  argument which is used as an exit status value, so that some sort
  575.  of indication of why execution has stopped can be passed on to the
  576.  user's environment.
  577. 4 other_statements
  578.  The delete statement is used to remove an element from an array.
  579.  The syntax is 'delete' keyword followed by array name, followed
  580.  by index value enclosed in square brackets ([]).  Starting with
  581.  gawk version 2.15.4, 'delete' may also be used on an entire array.
  582.  
  583.  The return statement is used in user-defined functions.  The syntax
  584.  is the keyword 'return' optionally followed by a string or numeric
  585.  expression.
  586.  
  587.  See also subtopic 'functions IO_functions' for a description of
  588.  'print', 'printf', and 'getline'.
  589. 3 fields
  590.  When an input record is read, it is automatically split into fields
  591.  based on the current values of FS (builtin variable defining field
  592.  separator expression) and RS (builtin variable defining record
  593.  separator character).  The default value of FS is an expression
  594.  which matches one or more spaces and tabs; the default for RS is
  595.  newline.  If the FIELDWIDTHS variable is set to a space separated
  596.  list of numbers (as in ``FIELDWIDTHS = "2 3 2"'') then the input
  597.  is treated as if it had fixed-width fields of the indicated sizes
  598.  and the FS value will be ignored.
  599.  
  600.  The field prefix operator ($), is used to reference a particular
  601.  field.  For example, $3 designates the third field of the current
  602.  record.  The entire record can be referenced via $0 (and it holds
  603.  the actual input record, not the values of $1, $2, ... concatenated
  604.  together, so multiple spaces--when present--remain intact, unless
  605.  a new value gets assigned).
  606.  
  607.  The builtin variable NF holds the number of fields in the current
  608.  record.  $NF is therefore the value of the last field.  Attempts to
  609.  access fields beyond NF result in null values (if a record contained
  610.  3 fields, the value of $5 would be "").
  611.  
  612.  Assigning a new value to $0 causes all the other field values (and NF)
  613.  to be re-evaluated.  Changing a specific field will cause $0 to receive
  614.  a new value once it's re-evaluated, but until then the other existing
  615.  fields remain unchanged.
  616. 3 variables
  617.  Variables in awk can hold both numeric and string values and do not
  618.  have to be pre-declared.  In fact, there is no way to explicitly
  619.  declare them at all.  Variable names consist of a leading letter
  620.  (either upper or lower case, which are distinct from each other)
  621.  or underscore (_) character followed by any number of letters,
  622.  digits, or underscores.
  623.  
  624.  When a variable that didn't previously exist is referenced, it is
  625.  created and given a null value.  A null value is treated as 0 when
  626.  used as a number, and is a string of zero characters in length if
  627.  used as a string.
  628. 4 builtin_variables
  629.  GAWK maintains several 'built-in' variables.  All have default values;
  630.  some are updated automatically.  All the builtins have uppercase-only
  631.  names.
  632.  
  633.  These builtin variables control how awk behaves
  634.    FS  input field separator; default is a single space, which is
  635.          treated as if it were a regular expression for matching
  636.          one or more spaces and/or tabs; a value of " " also has a
  637.          second special-case side-effect of causing leading blanks
  638.          to be ignored instead of producing a null first field;
  639.          initial value can be specified on the command line with
  640.          the -F option (or /field_separator); the value can be a
  641.          regular expression
  642.    RS  input record separator; default value is a newline ("\n");
  643.          only a single character is allowed [no regular expressions
  644.          or multi-character strings; expected to be remedied in a
  645.          future release of gawk]
  646.    OFS output field separator; value to place between variables in
  647.          a 'print' statement; default is one space; can be arbitrary
  648.          string
  649.    ORS output record separator; value to implicitly terminate 'print'
  650.          statement with; default is newline ("\n"); can be arbitrary
  651.          string
  652.    OFMT default output format used for printing numbers; default
  653.          value is "%.6g"
  654.    CONVFMT conversion format used for string-to-number conversions;
  655.          default value is also "%.6g", like OFMT
  656.    SUBSEP subscript separator for array indices; used when an array
  657.          subscript is specified as a comma separated list of values:
  658.          the comma is replaced by SUBSEP and the resulting index
  659.          is a concatenation of the values and SUBSEP(s); default
  660.          value is "\034"; value may be arbitrary string
  661.    IGNORECASE string and regular expression matching flag; if true
  662.          (non-zero) matching ignores differences between upper and
  663.          lower case letters; affects the '~' and '!~' operators,
  664.          the 'index', 'match', 'split', 'sub', and 'gsub' functions,
  665.          and the field splitting based on FS; default value is false (0);
  666.          has no effect if GAWK is in strict compatibility mode
  667.    FIELDWIDTHS space or tab separated list of width sizes; takes
  668.          precedence over FS when set, but is cleared if FS has a
  669.          value assigned to it; [note: the current implementation
  670.          of fixed-field input is considered experimental and is
  671.          expected to evolve over time]
  672.  
  673.  These builtin variables provide useful information
  674.    NF  number of fields in the current record
  675.    NR  record number (accumulated over all files when more than one
  676.          input file is processed by the same program)
  677.    FNR current record number of the current input file; reset to 0
  678.          each time an input file is completed
  679.    RSTART starting position of substring matched by last invocation
  680.          of the 'match' function; set to 0 if a match fails and at
  681.          the start of each input record
  682.    RLENGTH length of substring matched by the last invocation of the
  683.          'match' function; set to -1 if a match fails
  684.    FILENAME name of the input file currently being processed; the
  685.          special name "-" is used to represent the standard input
  686.    ENVIRON array of miscellaneous user environment values; the VMS
  687.          implementation of GAWK provides values for ["USER"] (the
  688.          username), ["PATH"] (current default directory), ["HOME"]
  689.          (the user's login directory), and "[TERM]" (terminal type
  690.          if available) [all info provided by VAXCRTL's environ]
  691.    ERRNO information about the cause of failure for 'getline' or
  692.          'close'; "0" if no such failure has occured.
  693.    ARGC number of elements in the ARGV array, counting [0] which is
  694.          the program name (ie, "gawk")
  695.    ARGV array of command-line arguments (in [0] to [ARGC-1]); the
  696.          program name (ie, "gawk") in held in ARGV[0]; command line
  697.          parameters (data files and "var=value" expressions, but not
  698.          program options or the awk program text string if present)
  699.          are stored in ARGV[1] through ARGV[ARGC-1]; the awk program
  700.          can change values of ARGC and ARGV[] during execution in
  701.          order to alter which files are processed or which between-
  702.          file assignments are made
  703.    ARGIND current index into ARGV[]
  704. 4 arrays
  705.  awk supports associative arrays to collect data into tables.  Array
  706.  elements can be either numeric or string, as can the indices used to
  707.  access them.  Each array must have a unique name, but a given array
  708.  can hold both string and numeric elements at the same time.  Arrays
  709.  are one-dimensional only, but multi-dimensional arrays can be
  710.  simulated using comma (,) separated indices, whereby a single index
  711.  value gets created by replacing commas with SUBSEP and concatenating
  712.  the resulting expression into a single string.
  713.  
  714.  Referencing an array element is done with the expression
  715.        Array[Index]
  716.  where 'Array' represents the array's name and 'Index' represents a
  717.  value or expression used for a subscript.  If the requested array
  718.  element did not exist, it will be created and assigned an initial
  719.  null value.  To check whether an element exists without creating it,
  720.  use the 'in' boolean operator.
  721.        Index in Array
  722.  would check 'Array' for element 'Index' and return 1 if it existed
  723.  or 0 otherwise.  To remove an element from an array, use the 'delete'
  724.  statement
  725.        delete Array[Index]
  726.  Note:  there is no way to delete an ordinary variable or an entire
  727.  array; 'delete' only works on a specific array element.
  728.  
  729.  To process all elements of an array (in succession) when their
  730.  subscripts might be unknown, use the 'in' variant of the for-loop
  731.        for (Index in Array) { ... }
  732. 3 functions
  733.  awk supports both built-in and user-defined functions.  A function
  734.  may be considered a 'black-box' which accepts zero or more input
  735.  parameters, performs some calculations or other manipulations based
  736.  on them, and returns a single result.
  737.  
  738.  The syntax for calling a function consists of the function name
  739.  immediately followed by an open parenthesis (left parenthesis '('),
  740.  followed by an argument list, followed by a closing parenthesis
  741.  (right parenthesis ')').  The argument list is a sequence of values
  742.  (numbers, strings, variables, array references, or expressions
  743.  involving the above and/or nested function calls), separated by
  744.  commas and optional white space.
  745.  
  746.  The parentheses are required punctuation, except for the 'print' and
  747.  'printf' builtin IO functions, where they're optional, and for the
  748.  builtin IO function 'getline', where they're not allowed.  Some
  749.  functions support optional [trailing] arguments which can be simply
  750.  omitted (along with the corresponding comma if applicable).
  751. 4 numeric_functions
  752.  Builtin numeric functions
  753.    int(n)      returns the value of 'n' with any fraction truncated
  754.                  [truncation of negative values is towards 0]
  755.    sqrt(n)     the square root of n
  756.    exp(n)      the exponential of n ('e' raised to the 'n'th power)
  757.    log(n)      natural logarithm of n
  758.    sin(n)      sine of n (in radians)
  759.    cos(n)      cosine of n (radians)
  760.    atan2(m,n)  arctangent of m/n (radians)
  761.    rand()      random number in the range 0 to 1 (exclusive)
  762.    srand(s)    sets the random number 'seed' to s, so that a sequence
  763.                  of 'random' numbers can be repeated; returns the
  764.                  previous seed value; srand() [argument omitted] sets
  765.                  the seed to an 'unpredictable' value (based on date
  766.                  and time, for instance, so should be unrepeatable)
  767. 4 string_functions
  768.  Builtin string functions
  769.    index(s,t)  search string s for substring t; result is 1-based
  770.                  offset of t within s, or 0 if not found
  771.    length(s)   returns the length of string s; either 'length()'
  772.                  with its argument omitted or 'length' without any
  773.                  parenthesized argument list will return length of $0
  774.    match(s,r)  search string s for regular expression r; the offset
  775.                  of the longest, left-most substring which matches
  776.                  is returned, or 0 if no match was found; the builtin
  777.                  variables RSTART and RLENGTH are also set [RSTART to
  778.                  the return value and RLENGTH to the size of the
  779.                  matching substring, or to -1 if no match was found]
  780.    split(s,a,f) break string s into components based on field
  781.                  separator f and store them in array a (into elements
  782.                  [1], [2], and so on); the last argument is optional,
  783.                  if omitted, the value of FS is used; the return value
  784.                  is the number of components found
  785.    sprintf(f,e,...) format expression(s) e using format string f and
  786.                  return the result as a string; formatting is similar
  787.                  to the printf function
  788.    sub(r,t,s)  search string target s for regular expression r, and
  789.                  if a match is found, replace the matching text with
  790.                  substring t, then store the result back in s; if s
  791.                  is omitted, use $0 for the string; the result is
  792.                  either 1 if a match+substitution was made, or 0
  793.                  otherwise; if substring t contains the character
  794.                  '&', the text which matched the regular expression
  795.                  is used instead of '&' [to suppress this feature
  796.                  of '&', 'quote' it with a backslash (\); since this
  797.                  will be inside a quoted string which will receive
  798.                  'backslash' processing before being passed to sub(),
  799.                  *two* consecutive backslashes will be needed "\\&"]
  800.    gsub(r,t,s) similar to sub(), but gsub() replaces all nonoverlapping
  801.                  substrings instead of just the first, and the return
  802.                  value is the number of substitutions made
  803.    substr(s,p,l) extract a substring l characters long starting at
  804.                  offset p in string s; l is optional, if omitted then
  805.                  the remainder of the string (p thru end) is returned
  806.    tolower(s)  return a copy of string s in which every uppercase
  807.                  letter has been converted into lowercase
  808.    toupper(s)  analogous to tolower(); convert lowercase to uppercase
  809. 4 time_functions
  810.  Builtin time functions
  811.    systime()   return the current time of day as the number of seconds
  812.                  since some reference point; on VMS the reference point
  813.                  is January 1, 1970, at 12 AM local time (not UTC)
  814.    strftime(f,t) format time value t using format f; if t is omitted,
  815.                  the default is systime()
  816. 5 time_formats
  817.  Formatting directives similar to the 'printf' & 'sprintf' functions
  818.  (each is introduced in the format string by preceding it with a
  819.  percent sign (%)); the directive is substituted by the corresponding
  820.  value
  821.    a   abbreviated weekday name (Sun,Mon,Tue,Wed,Thu,Fri,Sat)
  822.    A   full weekday name
  823.    b   abbreviated month name (Jan,Feb,...)
  824.    B   full month name
  825.    c   date and time (Unix-style "aaa bbb dd HH:MM:SS YYYY" format)
  826.    C   century prefix (19 or 20) [not century number, ie 20th]
  827.    d   day of month as two digit decimal number (01-31)
  828.    D   date in mm/dd/yy format
  829.    e   day of month with leading space instead of leading 0 ( 1-31)
  830.    E   ignored; following format character used
  831.    H   hour (24 hour clock) as two digit number (00-23)
  832.    h   abbreviated month name (Jan,Feb,...) [same as %b]
  833.    I   hour (12 hour clock) as two digit number (01-12)
  834.    j   day of year as three digit number (001-366)
  835.    m   month as two digit number (01-12)
  836.    M   minute as two digit number (00-59)
  837.    n   'newline' (ie, treat %n as \n)
  838.    O   ignored; following format character used
  839.    p   AM/PM designation for 12 hour clock
  840.    r   time in AM/PM format ("II:MM:SS p")
  841.    R   time without seconds ("HH:MM")
  842.    S   second as two digit number (00-59)
  843.    t   tab (ie, treat %t as \t)
  844.    T   time ("HH:MM:SS")
  845.    U   week of year (00-53) [first Sunday is first day of week 1]
  846.    V   date (VMS-style "dd-bbb-YYYY" with 'bbb' forced to uppercase)
  847.    w   weekday as decimal digit (0 [Sunday] through 6 [Saturday])
  848.    W   week of year (00-53) [first _Monday_ is first day of week 1]
  849.    x   date ("aaa bbb dd YYYY")
  850.    X   time ("HH:MM:SS")
  851.    y   year without century (00-99)
  852.    Y   year with century (19yy-20yy)
  853.    Z   time zone name (always "local" for VMS)
  854.    %   literal percent sign (%)
  855. 4 IO_functions
  856.  Builtin I/O functions
  857.    print x,... print the values of one or more expressions; if none
  858.                  are listed, $0 is used; parentheses are optional;
  859.                  when multiple values are printed, the current value
  860.                  of builtin OFS (default is 1 space) is used to
  861.                  separate them; the print line is implicitly
  862.                  terminated with the current value of ORS (default
  863.                  is newline); print does not have a return value
  864.    printf(f,x,...) print the values of one or more expressions, using
  865.                  the specified format string; null strings are used
  866.                  to supply missing values (if any); no between field
  867.                  or trailing newline characters are printed, they
  868.                  should be specified within the format string; the
  869.                  argument-enclosing parentheses are optional;
  870.                  printf does not have a return value
  871.    getline v   read a record into variable v; if v is omitted, $0 is
  872.                  used (and NF, NR, and FNR are updated); if v is
  873.                  specified, then field-splitting won't be performed;
  874.                  note:  parentheses around the argument are *not*
  875.                  allowed; return value is 1 for successful read, 0
  876.                  if end of file is encountered, or -1 if some sort
  877.                  of error occurred; [see 'redirection' for several
  878.                  variants]
  879.    close(s)    close a file or pipe specified by the string s; the
  880.                  string used should have the same value as the one
  881.                  used in a getline or print/printf redirection
  882.    system(s)   pass string s to executed by the operating system;
  883.                  the command string is executed in a subprocess
  884. 5 redirection
  885.  Both getline and print/printf support variant forms which use
  886.  redirection and pipes.
  887.  
  888.  To read from a file (instead of from the primary input file), use
  889.      getline var < "file"
  890.  or  getline < "file"    (read into $0)
  891.  where the string "file" represents either an actual file name (in
  892.  quotes) or a variable which contains a file name string value or an
  893.  expression which evaluates to a string filename.
  894.  
  895.  To create a pipe executing some command and read the result into
  896.  a variable (or into $0), use
  897.      "command" | getline var
  898.  or  "command" | getline    (read into $0)
  899.  where "command" is a literal string containing an operating system
  900.  command or a variable with a string value representing such a
  901.  command.
  902.  
  903.  To output into a file other that the primary output, use
  904.      print x,... > "file"    (or >> "file")
  905.  or  printf(f,x,...) > "file"    (or >> "file")
  906.  similar to the 'getline' example above.  '>>' causes output to be
  907.  appended to an existing file if it exists, or create the file if
  908.  it doesn't already exist.  '>' always creates a new file.  The
  909.  alternate redirection method of '>$' (for RMS text file attributes)
  910.  is *only* available on the command line, not with 'print' or
  911.  'printf' in  the current release.
  912.  
  913.  To output an error message, use 'print' or 'printf' and redirect
  914.  the output to file "/dev/stderr" (or equivalently to "SYS$ERROR:"
  915.  on VMS).  'stderr' will normally be the user's terminal, even if
  916.  ordinary output is being redirected into a file.
  917.  
  918.  To feed awk output into another command, use
  919.      print x,... | "command"    (similarly for 'printf')
  920.  similar to the second 'getline' example.  In this case, output
  921.  from awk will be passed as input to the specified operating system
  922.  command.  The command must be capable of reading input from 'stdin'
  923.  ("SYS$INPUT:" on VMS) in order to receive data in this manner.
  924.  
  925.  The 'close' function operates on the "file" or "command" argument
  926.  specified here (either a literal string or a variable or expression
  927.  resulting in a string value).  It completely closes the file or
  928.  pipe so that further references to the same file or command string
  929.  would re-open that file or command at the beginning.  Closing a
  930.  pipe or redirection also releases some file-oriented resources.
  931.  
  932.  Note:  the VMS implementation of GAWK uses temporary files to
  933.  simulate pipes, so a command must finish before 'getline' can get
  934.  any input from it, and 'close' must be called for an output pipe
  935.  before any data can be passed to the specified command.
  936. 5 formats
  937.  Formatting characters used by the 'printf' and 'sprintf' functions
  938.  (each is introduced in the format string by preceding it with a
  939.  percent sign (%))
  940.    %   include a literal percent sign (%) in the result
  941.    c   format the next argument as a single ASCII character
  942.          (prints first character of string argument, or corresponding
  943.          ASCII character if numeric argument, e.g. 65 is 'A')
  944.    s   format the next argument as a string (numeric arguments are
  945.          converted into strings on demand)
  946.    d   decimal number (ie, integer value in base 10)
  947.    i   integer (equivalent to decimal)
  948.    o   octal number (integer in base 8)
  949.    x   hexadecimal number (integer in base 16) [lowercase]
  950.    X   hexadecimal number [digits 'A' thru 'E' in uppercase]
  951.    f   floating point number (digits, decimal point, fraction digits)
  952.    e   exponential (scientific notation) number (digit, decimal
  953.          point, fraction digits, letter 'e', sign '+' or '-',
  954.          exponent digits)
  955.    g   'fractional' number in either 'e' or 'f' format, whichever
  956.          produces shorter result
  957.  
  958.  Three optional modifiers can be placed between the initiating
  959.  percent sign and the format character (doesn't apply to %%).
  960.    -   left justify (only matters when width specifier is present)
  961.    NN  width ['NN' represents 1 or more decimal digits]; actually
  962.          minimum width to use, longer items will not be truncated; a
  963.          leading 0 will cause right-justified numbers to be padded on
  964.          the left with zeroes instead of spaces when they're aligned
  965.    .MM precision [decimal point followed by 1 or more digits]; used
  966.          as maximum width for strings (causing truncation if they're
  967.          actually longer) or as number of fraction digits for 'f' or
  968.          'e' numeric formats, or number of significant digits for 'g'
  969.          numeric format
  970. 4 user_defined_functions
  971.  User-defined functions may be created as needed to simplify awk
  972.  programs or to collect commonly used code into one place.  The
  973.  general syntax of a user-defined function is the 'function' keyword
  974.  followed by unique function name, followed by a comma-separated
  975.  parameter list enclosed in parentheses, followed by statement(s)
  976.  enclosed within braces ({}).  A 'return' statement is customary
  977.  but is not required.
  978.        function FuncName(arg1,arg2) {
  979.            # arbitrary statements
  980.            return (arg1 + arg2) / 2
  981.        }
  982.  If a function does not use 'return' to specify an output value, the
  983.  result received by the caller will be unpredictable.
  984.  
  985.  Functions may be placed in an awk program before, between, or after
  986.  the pattern-action rules.  The abbreviation 'func' may be used in
  987.  place of 'function', unless POSIX compatibility mode is in effect.
  988. 3 regular_expressions
  989.  A regular expression is a shorthand way of specifying a 'wildcard'
  990.  type of string comparison.  Regular expression matching is very
  991.  fundamental to awk's operation.
  992.  
  993.  Meta symbols
  994.    ^   matches beginning of line or beginning of string; note that
  995.          embedded newlines ('\n') create multi-line strings, so
  996.          beginning of line is not necessarily beginning of string
  997.    $   matches end of line or end of string
  998.    .   any single character (except newline)
  999.    [ ] set of characters; [ABC] matches either 'A' or 'B' or 'C'; a
  1000.          dash (other than first or last of the set) denotes a range
  1001.          of characters: [A-Z] matches any upper case letter; if the
  1002.          first character of the set is '^', then the sense of match
  1003.          is reversed: [^0-9] matches any non-digit; several
  1004.          characters need to be quoted with backslash (\) if they
  1005.          occur in a set:  '\', ']', '-', and '^'
  1006.    |   alternation (similar to boolean 'or'); match either of two
  1007.          patterns [for example "^start|stop$" matches leading 'start'
  1008.          or trailing 'stop']
  1009.    ( ) grouping, alter normal precedence [for example, "^(start|stop)$"
  1010.          matches lines reading either 'start' or 'stop']
  1011.    *   repeated matching; when placed after a pattern, indicates that
  1012.          the pattern should match any number of times [for example,
  1013.          "[a-z][0-9]*" matches a lower case letter followed by zero or
  1014.          more digits]
  1015.    +   repeated matching; when placed after a pattern, indicates that
  1016.          the pattern should match one or more times ["[0-9]+" matches
  1017.          any non-empty sequence of digits]
  1018.    ?   optional matching; indicates that the pattern can match zero or
  1019.          one times ["[a-z][0-9]?" matches lower case letter alone or
  1020.          followed by a single digit]
  1021.    \   quote; prevent the character which follows from having special
  1022.          meaning
  1023.  
  1024.  A regular expression which matches a string or line will match against
  1025.  the first (left-most) substring which meets the pattern and include
  1026.  the longest sequence of characters which still meets that pattern.
  1027. 3 comments
  1028.  Comments in awk programs are introduced with '#'.  Anything after
  1029.  '#' on a line is ignored by GAWK.  It's a good idea to include an
  1030.  explanation of what an awk program is doing and also who wrote it
  1031.  and when.
  1032. 3 further_information
  1033.  For complete documentation on GAWK, see "The_GAWK_Manual" from FSF.
  1034.  Source text for it is present in the file GAWK.TEXINFO.  A postscript
  1035.  version is available via anonymous FTP from host prep.ai.mit.edu in
  1036.  directory pub/gnu/.
  1037.  
  1038.  For additional documentation on awk--above and beyond that provided in
  1039.  The_GAWK_Manual--see "The_AWK_Programming_Language" by Aho, Weinberger,
  1040.  and Kernighan (2nd edition, 1988), published by Addison-Wesley.  It is
  1041.  both a reference on the awk language and a tutorial on awk's use, with
  1042.  many sample programs.
  1043. 3 authors
  1044.  The awk programming language was originally created by Alfred V. Aho,
  1045.  Peter J. Weinberger, and Brian W. Kernighan in 1977.  The language
  1046.  was revised and enhanced in a new version which was released in 1985.
  1047.  
  1048.  GAWK, the GNU implementation of awk, was written in 1986 by Paul Rubin
  1049.  and Jay Fenlason, with advice from Richard Stallman, and with
  1050.  contributions from John Woods.  In 1988 and 1989, David Trueman and
  1051.  Arnold Robbins revised GAWK for compatibility with the newer awk.
  1052.  
  1053.  GAWK version 2.11.1 was ported to VMS by Pat Rankin in November, 1989,
  1054.  with further revisions in the Spring of 1990.  The VMS port was
  1055.  incorporated into the official GNU distribution of version 2.13 in
  1056.  Spring 1991.  (Version 2.12 was never publically released.)
  1057. 2 release_notes
  1058.  GAWK 2.15.6 tested under VAX/VMS V5.5-2, January, 1995; should be
  1059.  compatible with VMS versions V4.6 and later.  Current source code
  1060.  compatible with DEC's VAX C v3.x and v2.4, or DEC C v4.x; also
  1061.  compiles successfully with GNU C (GNU's gcc).  VMS POSIX uses c89 and
  1062.  requires VAX C V3.x (DEC C might work too, but hasn't been confirmed).
  1063. 3 AWK_LIBRARY
  1064.  GAWK uses a built in search path when looking for a program file
  1065.  specified by the -f option (or the /input qualifier) when that file
  1066.  name does not include a device and/or directory.  GAWK will first
  1067.  look in the current default directory, then if the file wasn't found
  1068.  it will look in the directory specified by the translation of logical
  1069.  name "AWK_LIBRARY".
  1070.  
  1071.  Not applicable under VMS POSIX.
  1072. 3 known_problems
  1073.  There are several known problems with GAWK running on VMS.  Some can
  1074.  be ignored, others require work-arounds.  Note: GAWK in the VMS POSIX
  1075.  environment does not have these problems.
  1076. 4 command_line_parsing
  1077.  The command
  1078.        gawk "program text"
  1079.  will pass the first phase of DCL parsing (the single required
  1080.  parameter is present), then it will give an error that a required
  1081.  element (either /input=awk_file or /commands="program text") is
  1082.  missing.  If what was intended (as is most likely) is to pass the
  1083.  program text to the UN*X-style command interface, the following
  1084.  variation is required
  1085.        gawk -- "program text"
  1086.  The presence of "--", which is normally optional, will inhibit the
  1087.  attempt to use DCL parsing (as will any '-' option or redirection).
  1088. 4 file_formats
  1089.  If a file having the RMS attribute "Fortran carriage control" is
  1090.  read as input, it will generate an empty first record if the first
  1091.  actual record begins with a space (leading space becomes a newline).
  1092.  Also, the last record of the file will give a "record not terminated"
  1093.  warning.  Both of these minor problems are due to the way that the
  1094.  C Run-Time Library (VAXCRTL) converts record attributes.
  1095.  
  1096.  Another poor feature without a work-around is that there's no way to
  1097.  specify "append if possible, create with RMS text attributes if not"
  1098.  with the current command line I/O redirection.  '>>$' isn't supported.
  1099.  Ditto for binary output; '>>+' isn't supported.
  1100. 4 RS_peculiarities
  1101.  Changing the record separator to something other than newline ('\n')
  1102.  will produce anomalous results for ordinary files.  For example,
  1103.  using RS = "\f" and FS = "\n" with the following input
  1104.        |rec 1, line 1
  1105.        |rec 1, line 2
  1106.        |^L    (form feed)
  1107.        |rec 2, line 1
  1108.        |rec 2, line 2
  1109.        |^L    (form feed)
  1110.        |rec 3, line 1
  1111.        |rec 3, line 2
  1112.        |(end of file)
  1113.  will produce two fields for record 1, but three fields each for
  1114.  records 2 and 3.  This is because the form-feed record delimiter is
  1115.  on its own line, so awk sees a newline after it.  Since newline is
  1116.  now a field separator, records 2 and 3 will have null first fields.
  1117.  The following awk code will work-around this problem by inserting
  1118.  a null first field in the first record, so that all records can be
  1119.  handled the same by subsequent processing.
  1120.        # fix up for first record (RS != "\n")
  1121.        FNR == 1  { if ( $0 == "" )     #leading separator
  1122.                      next              #skip its null record
  1123.                    else                #otherwise,
  1124.                      $0 = FS $0        #realign fields
  1125.                  }
  1126.  There is a second problem with this same example.  It will always
  1127.  trigger a "record not terminated" warning when it reaches the end of
  1128.  file.  In the sample shown, there is no final separator; however, if
  1129.  a trailing form-feed were present, it would produce a spurious final
  1130.  record with two null fields.  This occurs because the I/O system
  1131.  sees an implicit newline at the end of the last record, so awk sees
  1132.  a pair of null fields separated by that newline.  The following code
  1133.  fragment will fix that provided there are no null records (in this
  1134.  case, that would be two consecutive lines containing just form-feeds).
  1135.        # fix up for last record (RS != "\n")
  1136.        $0 == FS  { next }      #drop spurious final record
  1137.  Note that the "record not terminated" warning will persist.
  1138. 4 cmd_inconsistency
  1139.  The DCL qualifier /OUTPUT is internally equivalent to '>$' output
  1140.  redirection, but the qualifier /INPUT corresponds to the -f option
  1141.  rather than to '<' input redirection.
  1142. 4 exit
  1143.  The exit statement can optionally pass a final status value to the
  1144.  operating system.  GAWK expects a UN*X-style value instead of a
  1145.  VMS status value, so 0 indicates success and non-zero indicates
  1146.  failure.  The final exit status will be 1 (VMS success) if 0 is
  1147.  used, or even (VMS non-success) if non-zero is used.
  1148. 3 changes
  1149.  Changes between version 2.15.6 and 2.14
  1150.  
  1151.    General
  1152.      Many obscure bugs fixed
  1153.      `delete' may operate on an entire array
  1154.      ARGIND and ERRNO builtin variables added
  1155.  
  1156.    VMS-specific
  1157.      `>+ file' binary-mode output redirection added
  1158.      /variable=(foo=42) fixed
  1159.      Floating point number formatting improved
  1160. 3 prior_changes
  1161.  Changes between version 2.14 and 2.13.2:
  1162.  
  1163.    General
  1164.      'next file' construct added
  1165.      'continue' outside of any loop is treated as 'next'
  1166.      Assorted bug fixes and efficiency improvements
  1167.      _The_GAWK_Manual_ updated
  1168.      Test suite expanded
  1169.  
  1170.    VMS-specific
  1171.      VMS POSIX support added
  1172.      Disk I/O throughput enhanced
  1173.      Pipe emulation improved and incorrect interaction with user-mode
  1174.          redefinition of SYS$OUTPUT eliminated
  1175.  
  1176.  Changes between version 2.13 and 2.11.1:  (2.12 was not released)
  1177.  
  1178.    General
  1179.      CONVFMT and FIELDWIDTHS builtin control variables added
  1180.      systime() and strftime() date/time functions added
  1181.      'lint' and 'posix' run-time options added
  1182.      '-W' command line option syntax supercedes '-c', '-C', and '-V'
  1183.      '-a' and '-e' regular expression options made obsolete
  1184.      Various bug fixes and efficiency improvements
  1185.      More platforms supported ('officially' including VMS)
  1186.  
  1187.    VMS-specific
  1188.      %g printf format fixed
  1189.      Handling of '\' on command line modified; no longer necessary to
  1190.          double it up
  1191.      Problem redirecting stderr (>&efile) at same time as stdin (<ifile)
  1192.          or stdout (>ofile) has been fixed
  1193.      ``2>&1'' and ``1>&2'' redirection constructs added
  1194.      Interaction between command line I/O redirection and gawk pipes
  1195.          fixed; also, name used for pseudo-pipe temporary file expanded
  1196. 3 license
  1197.  GAWK is covered by the "GNU General Public License", the gist of which
  1198.  is that if you supply this software to a third party, you are expressly
  1199.  forbidden to prevent them from supplying it to a fourth party, and if
  1200.  you supply binaries you must make the source code available to them
  1201.  at no additional cost.  Any revisions or modified versions are also
  1202.  covered by the same license.  There is no warranty, express or implied,
  1203.  for this software.  It is provided "as is."
  1204.  
  1205.  [Disclaimer:  This is just an informal summary with no legal basis;
  1206.  refer to the actual GNU General Public License for specific details.]
  1207. !2 examples
  1208. !
  1209.