mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
4c370022d0
core-lightning/doc/lightning-sendonionmessage.7.md

44 lines
1002 B
Markdown
Raw Normal View History

doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 04:36:49 +01:00
lightning-sendonionmessage -- low-level command to send an onion message
================================================================
SYNOPSIS
--------
**(WARNING: experimental-onion-messages only)**
doc: escape more naughty underscores The only time underscores aren't special in Markdown is when they appear in preformatted text. We have gotten away with not escaping underscores where an asterisk-enclosed span or the paragraph ends before the next underscore appears, but this is fragile and bad practice. Conversely, there are many places where we have not escaped underscores but needed to. Escape all underscores that do not appear in preformatted blocks or preformatted spans and are not themselves delineating emphasized spans. The changes in this commit are exactly the result of executing the following Bash code: ```bash e=':x;' # begin loop e+='s/^' # anchor match at beginning of line e+='(' # begin capturing subexpression e+='(' # begin list of alternatives e+='[^`_\\]|' # any mundane character, or e+='`([^`\\]|\\.)*`|' # backtick-enclosed span, or e+='\b_|_\b|' # underscore at boundary, or e+='\\.' # backslash-escaped character e+=')*' # any number of the preceding alternatives e+=')' # end capturing subexpression e+='\B_\B/\1\\_/;' # escape non-formatting underscore e+='tx' # repeat loop if we escaped an underscore escape_underscores=( sed # use extended regular expressions -E # skip over indented blocks (following an empty line) -e '/^$/{:i;n;/^( {4,}|\t)/bi}' # skip over preformatted blocks -e '/^\s*```/,/^\s*```/{p;d}' # skip over generated sections -e '/GENERATE-FROM-SCHEMA-START/,/GENERATE-FROM-SCHEMA-END/{p;d}' # escape underscores -e "${e}" ) "${escape_underscores[@]}" -i doc/*.[0-9].md ``` Changelog-None
2022-11-11 02:44:56 +01:00
**sendonionmessage** *first\_id* *blinding* *hops*
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 04:36:49 +01:00
DESCRIPTION
-----------
The **sendonionmessage** RPC command can be used to send a message via
doc: Markdown cleanup This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
2024-02-02 05:50:25 +01:00
the lightning network. These are currently used by *offers* to request
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 04:36:49 +01:00
and receive invoices.
RETURN VALUE
------------
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an empty object is returned.
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 12:07:59 +02:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 04:36:49 +01:00
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-fetchinvoice(7), lightning-offer(7).
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: update references to old BOLTs repo. This reveals that common/test/run-bolt12_merkle-json.c was broken! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-29 05:49:03 +02:00
[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 04:36:49 +01:00
schemas: deprecated is now a range. Don't assume removal is +6 months, but have a start deprecation/end support range. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-01-25 01:28:53 +01:00
[comment]: # ( SHA256STAMP:3faddc7dd03a73725f4a3e7249c7a417a11c6ac31f8666a9df2a8e5ebcfe2875)
Reference in New Issue Copy Permalink