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

Improve AsciiDoc compatibility 

I need two renderers to work: hswg/libasciidoc and asciidoctor
in man page mode (and ideally in HTML as well).  That should be
covered now.

The triple-plus thing was the first thing that showed good results,
after trying backslashes, single-plus quoting and [] after ://.

The change of the source code block kind could be considered as
unification.  I'm combining tabs with spaces within one document
though, and I should get rid of the tabs in the rest of it then...
This commit is contained in:
Přemysl Eric Janouch 2020-09-05 04:30:13 +02:00
parent 2962a644da
commit d57a8bd3c7
Signed by: p
GPG Key ID: A0420B94F92B9493
1 changed files with 19 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
json-rpc-shell.adoc
View File

@ -1,8 +1,8 @@
json-rpc-shell(1) json-rpc-shell(1)
================= =================
:doctype: manpage :doctype: manpage
:man manual: json-rpc-shell Manual :manmanual: json-rpc-shell Manual
:man source: json-rpc-shell {release-version} :mansource: json-rpc-shell {release-version}
Name Name
---- ----
@ -15,7 +15,7 @@ Synopsis
Description Description
----------- -----------
The _ENDPOINT_ must be either an HTTP or a WebSocket URL, with or without TLS The _ENDPOINT_ must be either an HTTP or a WebSocket URL, with or without TLS
(i.e. one of the _http://_, _https://_, _ws://_, _wss://_ schemas). (i.e. one of the _+++http+++://_, _+++https+++://_, _ws://_, _wss://_ schemas).
*json-rpc-shell* will use it to send any JSON-RPC 2.0 requests you enter on its *json-rpc-shell* will use it to send any JSON-RPC 2.0 requests you enter on its
command line. The server's response will be parsed and validated, stripping it command line. The server's response will be parsed and validated, stripping it
@ -133,40 +133,34 @@ distribution of this program (public services are hard to find):
Pretty-printing and Manual IDs Pretty-printing and Manual IDs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``` $ json-rpc-shell -p ws://localhost:1234
$ json-rpc-shell -p ws://localhost:1234 json-rpc> date 1
json-rpc> date 1 {
{
"year": 2020, "year": 2020,
"month": 9, "month": 9,
"day": 5, "day": 5,
"hours": 2, "hours": 2,
"minutes": 23, "minutes": 23,
"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:
``` $ json-rpc-shell ws://localhost:1234
$ json-rpc-shell ws://localhost:1234 json-rpc> notify {"events": ["conquest", "war", "famine", "death"]}
json-rpc> notify {"events": ["conquest", "war", "famine", "death"]} [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:
``` $ echo 'ping | jq ascii_upcase' | json-rpc-shell -a ws://localhost:1234
$ echo 'ping | jq ascii_upcase' | json-rpc-shell -a ws://localhost:1234 json-rpc> ping | jq ascii_upcase
json-rpc> ping | jq ascii_upcase "PONG"
"PONG"
```
Reporting Bugs Reporting Bugs
-------------- --------------