USAGE.txt

Firescan - path scan client

== Synopsis
  This is the Ruby reference implementation for the Firebind Firescan
  path scanner client.

== Examples
  This invocation performs a path scan on TCP ports 1-100 on target 192.168.100.1
    firescan -s 192.168.100.1 -t 1-100

  Other examples:
    firescan -s 192.168.1.100 -u 1-100
    firescan -n bob -p password123 -s 192.168.1.100 -u 1-100 -v

== Usage
   firescan [options]

  For help use: firescan -h  or  firescan --help

== Options
  Note that when invoked without a command server address, the client will default to the public service
  located at scanme.firebind.com

    -h, --help                       Show help and version
    -v, --verbose                    Show verbose output
    -s, --command-server ADDRESS     Address:port or hostname:port of command server, default port is 80
    -t, --tcp PORT_LIST              TCP Port specification (list), use commas and dashes to specify a list of ports
    -u, --udp PORT_LIST              UDP Port specification (list), use commas and dashes to specify a list of ports
    -i, --timeout TIMEOUT            Timeout (in milliseconds) to use for connect, transmit and receive operations
    -n, --username USERNAME          Specify a username (to connect to command server)
    -p, --password PASSWORD          Specify a password (to connect to command server)
    -r, --protocol PROTOCOL          Specify a protocol
    -g, --tag TAG                    tag the scan with value
    -l, --localaddr LOCAL_ADDRESS    Specify local IP address for client binding
    -d, --xdebug                     Show debug output


== Author
  Jay Houghton (jay@firebind.com)

== Copyright
  Copyright (c) 2013 Firebind Inc. Licensed under the Apache 2.0 License:
  http://www.apache.org/licenses/LICENSE-2.0.html