p/json-rpc-shell
1
1
Fork 0
Code Issues 8 Pull Requests Projects 1 Releases 2 Wiki Activity

Streamline the manual page a bit

Browse Source 
I have consulted `man 7 man-pages` but overall it's a huge mess.
This commit is contained in:
Přemysl Eric Janouch 2020-09-05 06:31:00 +02:00
parent 984e5b4e7f
commit ba68585d14
Signed by: p
GPG Key ID: A0420B94F92B9493
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
json-rpc-shell.adoc
View File

@ -43,13 +43,13 @@ this action as they might conflict with method names.
Options Options
------- -------
Controlling Output Controlling output
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
*-c*, *--compact-output*:: *-c*, *--compact-output*::
Do not pretty-print responses. Normally, spaces and newlines are added Do not pretty-print responses. Normally, spaces and newlines are added
where appropriate to improve readability. where appropriate to improve readability.
*--color* _WHEN_:: *--color*=_WHEN_::
By default, when the output of the program is a terminal, JSON responses By default, when the output of the program is a terminal, JSON responses
are syntax-highlighted. This corresponds to the _auto_ setting. You may are syntax-highlighted. This corresponds to the _auto_ setting. You may
also set this to _always_ or _never_. In either case, color is never also set this to _always_ or _never_. In either case, color is never
@ -73,10 +73,10 @@ Protocol
self-signed, or when the CA isn't in your CA store. Beware that this option self-signed, or when the CA isn't in your CA store. Beware that this option
is about as good as using plain unencrypted HTTP. is about as good as using plain unencrypted HTTP.
*-o*, *--origin* _ORIGIN_:: *-o* _ORIGIN_, *--origin*=_ORIGIN_::
Set the HTTP Origin header to _ORIGIN_. Some servers may need this. Set the HTTP Origin header to _ORIGIN_. Some servers may need this.
Program Information Program information
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
*-h*, *--help*:: *-h*, *--help*::
Display a help message and exit. Display a help message and exit.
@ -84,7 +84,7 @@ Program Information
*-V*, *--version*:: *-V*, *--version*::
Output version information and exit. Output version information and exit.
*--write-default-cfg*:: *--write-default-cfg*[**=**__PATH__]::
Write a default configuration file, show its path and exit. Write a default configuration file, show its path and exit.
Files Files
@ -115,7 +115,7 @@ WebSockets
The JSON-RPC 2.0 specification doesn't say almost anything about underlying The JSON-RPC 2.0 specification doesn't say almost anything about underlying
transports. As far as the author is aware, he is the only person combining it transports. As far as the author is aware, he is the only person combining it
with WebSockets. The way it's implemented here is that every request is sent as with WebSockets. The way it's implemented here is that every request is sent as
a single text message. If it has an "id" field, i.e. it's not just a single text message. If it has an "id" field, i.e., it's not just
a notification, the client waits for a message from the server in response. a notification, the client waits for a message from the server in response.
Should any message arrive unexpectedly, you will receive a warning. Should any message arrive unexpectedly, you will receive a warning.
@ -132,7 +132,7 @@ Examples
Running some queries against json-rpc-test-server, included in the source Running some queries against json-rpc-test-server, included in the source
distribution of this program (public services are hard to find): distribution of this program (public services are hard to find):
Methods Without Parameters Methods without parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
$ json-rpc-shell ws://localhost:1234 $ json-rpc-shell ws://localhost:1234
json-rpc> ping json-rpc> ping
@ -147,7 +147,7 @@ Methods Without Parameters
"seconds": 51 "seconds": 51
} }
Notification With a Parameter Notification with a parameter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Notifications never produce a response, not even when the method is not known Notifications never produce a response, not even when the method is not known
to the server: to the server:
@ -156,7 +156,7 @@ to the server:
json-rpc> notify {"events": ["conquest", "war", "famine", "death"]} null json-rpc> notify {"events": ["conquest", "war", "famine", "death"]} null
[Notification] [Notification]
Piping In and Out Piping in and out
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
GNU Readline always repeats the prompt, which makes this a bit less useful GNU Readline always repeats the prompt, which makes this a bit less useful
for invoking from other programs: for invoking from other programs:
@ -165,12 +165,12 @@ for invoking from other programs:
json-rpc> ping | jq ascii_upcase json-rpc> ping | jq ascii_upcase
"PONG" "PONG"
Reporting Bugs Reporting bugs
-------------- --------------
Use https://git.janouch.name/p/json-rpc-shell to report bugs, request features, Use https://git.janouch.name/p/json-rpc-shell to report bugs, request features,
or submit pull requests. or submit pull requests.
See Also See also
-------- --------
*jq*(1), *readline*(3) or *editline*(7) *jq*(1), *readline*(3) or *editline*(7)