From 12fb506e1627a155bf5b5c6096b72cf25e90c2b6 Mon Sep 17 00:00:00 2001 From: Dale Wilson Date: Wed, 15 Feb 2017 13:15:03 -0600 Subject: [PATCH] Mostly formatting improvements. A few clarifications --- README_ORDER_ENTRY.md | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/README_ORDER_ENTRY.md b/README_ORDER_ENTRY.md index 0a14fbf..f4bb372 100644 --- a/README_ORDER_ENTRY.md +++ b/README_ORDER_ENTRY.md @@ -4,7 +4,22 @@ This program accepts requests typed from the console or read from a script file one or more order books. It displays the results of the callbacks generated by Liquibook in response to those requests. +## The Command Line + +The mt_order_entry command accepts two command line options. Both are optional. + +Parameter: + +* script_file_name + The name of a script file. + * The script file contains a series of requests -- one per line. See below for the syntax of these requests. + * If you don't want a script file, but you want to specify a log file, use '-' for the script file name. The commands will be read from the console. +* log_file_name + The name of a file to which output should be written. + * Prompts (if any) will still be written to the console. + ## Request syntax +Requests are read from the console or from a script file. An empty line or a line beginning with a hash (#) is considered a comment and will be ignored. Other lines read are in the format: @@ -55,6 +70,7 @@ Liquibook itself imposes no limitations on symbol. It accepts an arbitrary stri (actually of 8 bit octets so UTF-8 or other encodings are supported with no special effort.) The manual entry program has a few restrictions on the symbols to ease parsing: + * The symbol may not include spaces. * The symbol may not begin with a plus sign (+) or exclamation mark(!) * The symbol should not be ALL. @@ -149,9 +165,9 @@ Syntax: BUY quantity symbol price [AON | IOC | STOP price]* ; Parameters: * *quantity* is number of shares (or other tradable units) to buy. * *symbol* is an arbitrary character string. - * See the *Symbol" section above for information about this string. + * See the **Symbol** section above for information about this string. * *price* is the price the trader is willing to pay for each tradable unit of the security. - * See the *Price* section above for details about expressing prices. + * See the **Price** section above for details about expressing prices. * AON This optional parameter sets the All-Or-None condition for this order. * IOC This optional parameter sets the Immediate-Or-Cancel condition for this order. * STOP price This optional parameter sets a STOP LOSS price for this order using the same currency units as the price parameter. @@ -168,9 +184,9 @@ Syntax: SELL quantity symbol price [AON | IOC | STOP price]* ; Parameters: * *quantity* is number of shares (or other tradable units) to be sold. * *symbol* is an arbitrary character string. - * See the *Symbol" section above for information about this string. + * See the **Symbol** section above for information about this string. * *price* is the price the trader is willing to acce[t for each tradable unit of the security. - * See the *Price* section above for details about expressing prices. + * See the **Price** section above for details about expressing prices. * AON This optional parameter sets the All-Or-None condition for this order. * IOC This optional parameter sets the Immediate-Or-Cancel condition for this order. * STOP price This optional parameter sets a STOP LOSS price for this order using the same currency units as the price parameter. @@ -184,7 +200,7 @@ Request that an existing order be canceled. Parameter: * orderid, or #orderid, or -relative_order_id. - * See the section on Order Identity above for details. + * See the **Order Identity** section above for details. No trades will be triggered by entering a CANCEL request. @@ -198,9 +214,9 @@ Request that an existing order be modified. Parameters: * orderid, or #orderid, or -relative_order_id. - * See the section on Order Identity above for details. + * See the **Order Identity** section above for details. * PRICE new_price - * See the *Price* section above for details about expressing prices. + * See the **Price** section above for details about expressing prices. * Prices may be increased or decreased. * PRICE is optional. If it is not specified the existing price will be unchanged. * QUANTITY new_initial_quantity @@ -220,7 +236,7 @@ Parameters: * * this optional first parameter requests a more verbose display. * order_id or symbol or ALL. * One of these must appear. - * See the *Order Identity" section above for a description of the ways in which order ID cam be expressed. + * See the **Order Identity** section above for a description of the ways in which order ID cam be expressed. * The literal word ALL will display information about all known symbols. ### FILE or F @@ -247,11 +263,4 @@ Displays a brief form of the information in this document. ### QUIT Exit the program. -## The Command Line - -The mt_order_entry command accepts two command line options. Both are optional. -Parameter: - script_file_name The name of a script file or '-' if commands are to be read from the console. - log_file_name The name of a file to which output should be written. Prompts (if any) will still be written to the console.) -