Builtin Functions

Vortex has many builtin functions that provide additional functionality. Most of these functions take arguments; each argument is either a single variable or a literal string. Each function returns a value in the special variable $ret (except as noted).

• sum - return sum of variable values
• fmt, strfmt - formatted output
  • Escape Sequences
  • Standard Formats
  • Standard Flags
  • Printing Date/Time Values
  • Printing Latitude, Longitude or Location/Geocode Values
  • Other Format Codes
  • Extended Flags
  • Metamorph Hit Mark-up
  • Automatic Typecasting
• fmtcp - set fmt control parameters
• fmtinfo - get fmt control parameters
• mm - enable/disable automatic hit markup
• sb - enable/disable automatic search and replace
• apicp - modify Metamorph query control parameters
  • Query Protection
  • Query Processing
• apiinfo - get current Metamorph query control parameters
• sqlcp - modify low-level SQL control parameters
• pagelinks - paginate SQL results
• read - read files
• send - print raw data
• spew - print files
• flush - flush output
• header - print HTTP header
• rex, split - regular expression search
  • REX Expression Syntax
  • REX Expression Repetition Operators
  • REX Caveats and Commentary
  • Some Useful REX Expressions
• sandr - regular expression search and replace
  • Replacement Strings
• strstr, strstri - find substring in string
• substr - extract substring from string
• strcmp, strcmpi - compare strings
• strncmp, strnicmp - compare strings, fixed length
• strlen - length of string
• strrev - reverse string
• upper - convert to upper case
• lower - convert to lower case
• strfold - fold string by case
• strfoldcmp - compare strings folded by case
• sort - sort variables
• uniq, uniqcount - produce unique list of values
• count - return number of variable values
• strtonum - convert string to number
• rand - generate pseudo-random number
• randpick - return pseudo-random value of a variable
• srand - seed the pseudo-random number generator
• exit - exit program
• fetch - fetch URLs
• submit - submit HTML form
• urlinfo - get detailed page info
• urltext, urllinks - get formatted text, URL links
• urlcp - modify URL control parameters
  • Resource Limits
  • Page Fetching
  • Server Authorization
  • SSL/HTTPS
  • Formatted Text
  • Links
  • Headers
  • JavaScript
  • Cookies
  • Hostname Resolution
  • Informational/Trace
  • Miscellaneous
• urlutil - URL parsing utility
• nslookup - domain name and IP address lookup
• nsinfo - get info from last name lookup
• options - print options list
• radiobutton - print radio buttons list
• checkbox - print checkbox list
• doctype - print DOCTYPE declaration
• cal - print a calendar with links
• calrule - translate a calendar rule and iterate dates
• calendar - print calendar form
• caldate - create date list from calendar submission
• clist - create comma-separated list
• slist - create Metamorph set list
• wordlist, wordcount, wordoccurrencecounts - get words and frequencies from index
• createdb - create database
• adminsql - execute arbitrary SQL
• loguser - log user accesses
• userstats - get user statistics
• resetstats - reset user statistics
• abstract - generate an abstract from text
• rmcommon - remove common prefix/suffix from text
• pwencrypt - encrypt Unix-style password
• encrypt - encrypt data
• decrypt - decrypt data
• readvars - read URL-encoded variables
• varinfo - get miscellaneous variable information
• getvar - get variable values
• setvar - set a named variable
• vxcp - set Vortex control parameters
• vxinfo - get miscellaneous Vortex information
• hash - produce a hash or checksum for data
• geo2code - latitude/longitude encoding for regional search
• code2geo - decode latitude/longitude encoding
• pdfxml - convert Metamorph hit to PDF markup information
• xtree - maintain sorted list of values
• profiler - assist in searching query profiles
• sleep - sleep for a while
• sysinfo - get system-specific information
• syscp - set system-specific information
• sysutil - file and system utilities
• stat - obtain file size and attributes
• getpid - get process id
• procexists - see if process exists
• kill - terminate or send a signal to a process
• loadavg - return system load averages