===============================================================================
 darumaClient
===============================================================================

----------------
* How to Build *
----------------
Execute 'make' command at top level directory of this package.
  % make

--------------
* How to Run *
--------------
  % cd ./bin
  % ./darumaClient [OPTION ...] [INPUT_FILE ...]

  If INPUT_FILE has not specified, darumaClient shall read input data
  from standard input.

------------------
* How to Install *
------------------
  Copy ./bin/* to your directory in PATH environment variable or add bin
  directory of this package to PATH.
 
    (example 1)
    % cp ./bin/* ${HOME}/bin

-----------
* Options *
-----------
     --help            : Show usage and exit.

     --version         : Show version of this program and exit.

 -h, --host HOST       : Specify destination host. (default: "127.0.0.1")

 -p, --port PORT       : Specify destination port number. (default: 5050)

 -4, --ipv4-only       : Enforce IPv4 connection.
                         (default: use all available protocols including IPv6)

     --print-io        : Print input/output data.
     --debug           : Print debug information (implies --print-io).

----------
* Sample *
----------

  Ensure PATH environment variable to execute darumaClient and
  http-darumaClient.

    % which darumaClient
    % which http-darumaClient

  If above command returns empty response or returns failure, set PATH
  environment variable first.


  -- Check with standalone DaRuMa --
  Before check sample, ensure stanalone daruma has been running.

    % cd ./sample-data

  Send each sample input file.
  Default host and port are 127.0.0.1(IPv4 localhost) and 5050. If your DaRuMa
  is waiting at another host or port, use --host, --port options.
    % http-darumaClient --help

    % darumaClient SAMPLE_FILE.input.xml

  You can simply execute check-direct-connection script instead of sending each
  file.
    % ./check-direct-connection
  This script is also a sample to understand how to use darumaClient. See
  content of script.


  -- Check with servlet DaRuMa --
  Before check sample, ensure servlet daruma has been running.

    % cd ./sample-data

  Send each sample input file over http.
    % http-darumaClient SAMPLE_FILE.input.xml

  http-darumaClient has some options, you can see it as following.
    % http-darumaClient --help


--------------------
* Trouble Shooting *
--------------------
  * Check directory is extracted correctly.
    If you extract this package on Windows OS, try extracting on UNIX OS or
    Cygwin environment. On Windows OS, many applications for extracting cannot
    extract tar archive correctly even though famous applications.
