print_index

NAME

SYNOPSIS

print_index [ "field separator" [ indent [ columns [ fixwidth [ nospace ]]]]]

AVAILABILITY

DESCRIPTION

The output is limited to the current terminal width if the environment variable $PRINT_FIT2WIDTH is not set to False.

OPTIONS

-h

usage message.

"field separator"

field separator of the input data given via stdin. If not specified, the field separator defaults to the semicolon ( ; ).

indent

left indent of the output in characters. If not specified the output is not indented.

columns

number of columns of the column index output. If not specified a default of 2 applies.

fixwidth

set to False for dynamic description column with, else (True) all columns have the identical width.

nospace

set to True to eliminate tailing spaces at index lines, else (False) all lines have the identical width filled with tailing spaces.

ENVIRONMENT

$PRINT_FIT2WIDTH

If this environment variable is not set to False , the output is limited to the current width of the terminal window and rows extending the window width are marked with '>>'.

EXIT STATUS

0

no error.

4

usage displayed.

FILES

EXAMPLES

1) print a column index to the terminal

This report is intended to be viewed on the terminal. All lines extending the terminal window width will be cut an marked with '>>' to show that there is hidden information.

  #!/bin/sh
  :  
  :  
  cat<<EOM | print_index
  ZIP;Postal Zip Code
  CITY;Name of the City
  STATE;State
  CNT;Country Shortcut
  COUNTRY; Country Full Name
  EOM
  :
  :

Result of this script when the terminal window width is smaller then the output width:

COLUMN INDEX:

  ZIP .............. Postal Zip Code       CNT ...... >>
  CITY ............. Name of the City      COUNTRY .. >>
  STATE ............ State

2) print a column index to be saved to a file

This report is intended to be saved to a file. This is why the environment variable $PRINT_FIT2WIDTH is set to False in this example.

  #!/bin/sh
  :
  :
  PRINT_FIT2WIDTH=False; export PRINT_FIT2WIDTH

  cat<<EOM | print_index
  ZIP;Postal Zip Code
  CITY;Name of the City
  STATE;State
  CNT;Country Shortcut
  COUNTRY; Country Full Name
  EOM
  :
  :

SEE ALSO

NOTES

BUGS

AUTHOR

COPYRIGHT

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.