SCAN

Command: #scan {abort|csv|tsv|txt} {filename}

         The scan command is a file reading utility.

         #scan {abort}
           This command must be called from with a SCAN event and will
           abort the scan if one is in progress.

         #scan {csv} <filename>
           The scan csv command reads in a comma separated value file
           without printing the content to the screen. Instead it triggers one
           of two events.

           The SCAN CSV HEADER event is triggered on the first line of the csv
           file. The SCAN CSV LINE event is triggered on the second and each
           subsequent line of the csv file. The %0 argument contains the entire
           line, with  %1 containing the first value, %2 the second value, etc,
           all the way up to %99.

           Values containing spaces must be surrounded with quotes, keep in mind
           newlines within quotes are not supported. Use two quotes to print one
           literal quote character.

         #scan {dir} <filename> <variable>

          The scan dir command will read the given filename or directory and
          store any gathered information into the provided variable.

         #scan {tsv} <filename>

           The scan tsv <filename> command reads in a tab separated value file
           without printing the content to the screen. Instead it triggers the
           SCAN TSV HEADER event for the first line and SCAN TSV LINE for all
           subsequent lines.

         #scan {file} <filename> {commands}

           The scan file command reads the given files and executes the
            commands argument. &0 contains the raw content of the file and
            &1 contains the plain content. &2 contains the raw byte size of the
            file and &3 the plain byte size. &5 contains the line count.

         #scan {txt} <filename>

           The scan txt <filename> command reads in a file and sends its content
           to the screen as if it was send by a server. After using scan you can
           use page-up and down to view the file.

           This command is useful to convert ansi color files to html or viewing
           raw log files.

           Actions, highlights, and substitutions will trigger as normal, and it
           is possible to create an action to execute #scan abort to prematurely
           stop the scan.

Related: read and textin.