THRIFT-5074: Crosstest client/server command line [skip ci]
Client: Documentation
Patch: Jano Svitok
diff --git a/test/README.md b/test/README.md
index 10955f1..d5d1b92 100755
--- a/test/README.md
+++ b/test/README.md
@@ -123,43 +123,43 @@
$ ./TestServer -h
Allowed options:
- -h [ --help ] produce help message
- --port arg (=9090) Port number to listen
- --domain-socket arg Unix Domain Socket (e.g. /tmp/ThriftTest.thrift)
- --named-pipe arg Windows Named Pipe (e.g. MyThriftPipe)
- --server-type arg (=simple) type of server, "simple", "thread-pool",
- "threaded", or "nonblocking"
- --transport arg (=buffered) transport: buffered, framed, http, anonpipe, zlib
- --protocol arg (=binary) protocol: binary, compact, header, json
- --multiplex Add TMultiplexedProtocol service name "ThriftTest"
- --abstract-namespace Create the domain socket in the Abstract Namespace
- (no connection with filesystem pathnames)
- --ssl Encrypted Transport using SSL
- --zlib Wrapped Transport using Zlib
- --processor-events processor-events
- -n [ --workers ] arg (=4) Number of thread pools workers. Only valid for
- thread-pool server type
+ -h | --help produce help message
+ --port=arg (9090) Port number to listen
+ --domain-socket=arg Unix Domain Socket (e.g. /tmp/ThriftTest.thrift)
+ --named-pipe=arg Windows Named Pipe (e.g. MyThriftPipe)
+ --server-type=arg (simple) type of server, "simple", "thread-pool",
+ "threaded", or "nonblocking"
+ --transport=arg (buffered) transport: buffered, framed, http, anonpipe, zlib
+ --protocol=arg (binary) protocol: binary, compact, header, json
+ --multiplex Add TMultiplexedProtocol service name "ThriftTest"
+ --abstract-namespace Create the domain socket in the Abstract Namespace
+ (no connection with filesystem pathnames)
+ --ssl Encrypted Transport using SSL
+ --zlib Wrapped Transport using Zlib
+ --processor-events processor-events
+ -n=arg | --workers=arg (=4) Number of thread pools workers. Only valid for
+ thread-pool server type
**Client command line interface:**
$ ./TestClient -h
Allowed options:
- -h [ --help ] produce help message
- --host arg (=localhost) Host to connect
- --port arg (=9090) Port number to connect
- --domain-socket arg Domain Socket (e.g. /tmp/ThriftTest.thrift),
- instead of host and port
- --named-pipe arg Windows Named Pipe (e.g. MyThriftPipe)
- --anon-pipes hRead hWrite Windows Anonymous Pipes pair (handles)
- --abstract-namespace Create the domain socket in the Abstract Namespace
- (no connection with filesystem pathnames)
- --transport arg (=buffered) Transport: buffered, framed, http, evhttp, zlib
- --protocol arg (=binary) Protocol: binary, compact, header, json
- --multiplex Add TMultiplexedProtocol service name "ThriftTest"
- --ssl Encrypted Transport using SSL
- --zlib Wrap Transport with Zlib
- -n [ --testloops ] arg (=1) Number of Tests
- -t [ --threads ] arg (=1) Number of Test threads
+ -h | --help produce help message
+ --host=arg (localhost) Host to connect
+ --port=arg (9090) Port number to connect
+ --domain-socket=arg Domain Socket (e.g. /tmp/ThriftTest.thrift),
+ instead of host and port
+ --named-pipe=arg Windows Named Pipe (e.g. MyThriftPipe)
+ --anon-pipes hRead hWrite Windows Anonymous Pipes pair (handles)
+ --abstract-namespace Create the domain socket in the Abstract Namespace
+ (no connection with filesystem pathnames)
+ --transport=arg (buffered) Transport: buffered, framed, http, evhttp, zlib
+ --protocol=arg (binary) Protocol: binary, compact, header, json
+ --multiplex Add TMultiplexedProtocol service name "ThriftTest"
+ --ssl Encrypted Transport using SSL
+ --zlib Wrap Transport with Zlib
+ -n=arg | --testloops=arg (1) Number of Tests
+ -t=arg | --threads=arg (1) Number of Test threads
If you have executed the **make check** or **make cross** then you will be able to browse
[gen-html/ThriftTest.html](gen-html/ThriftTest.html) with the test documentation.