85 lines
2.3 KiB
Groff
85 lines
2.3 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
|
|
.TH CORESENDMSG "1" "2014-08-06" "CORESENDMSG" "User Commands"
|
|
.SH NAME
|
|
coresendmsg \- send a CORE API message to the core-daemon daemon
|
|
.SH SYNOPSIS
|
|
.B coresendmsg
|
|
[\fI-h|-H\fR] [\fIoptions\fR] [\fImessage-type\fR] [\fIflags=flags\fR] [\fImessage-TLVs\fR]
|
|
.SH DESCRIPTION
|
|
.SS "Supported message types:"
|
|
.IP
|
|
['node', 'link', 'exec', 'reg', 'conf', 'file', 'iface', 'event', 'sess', 'excp']
|
|
.SS "Supported message flags (flags=f1,f2,...):"
|
|
.IP
|
|
['add', 'del', 'cri', 'loc', 'str', 'txt', 'tty']
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
show this help message and exit
|
|
.TP
|
|
\fB\-H\fR
|
|
show example usage help message and exit
|
|
.TP
|
|
\fB\-p\fR PORT, \fB\-\-port\fR=\fIPORT\fR
|
|
TCP port to connect to, default: 4038
|
|
.TP
|
|
\fB\-a\fR ADDRESS, \fB\-\-address\fR=\fIADDRESS\fR
|
|
Address to connect to, default: localhost
|
|
.TP
|
|
\fB\-s\fR SESSION, \fB\-\-session\fR=\fISESSION\fR
|
|
Session to join, default: None
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-listen\fR
|
|
Listen for a response message and print it.
|
|
.TP
|
|
\fB\-t\fR, \fB\-\-list\-tlvs\fR
|
|
List TLVs for the specified message type.
|
|
.TP
|
|
\fB\-T\fR, \fB\-\-tcp\fR
|
|
Use TCP instead of UDP and connect to a session,
|
|
default: False
|
|
.PP
|
|
Usage: coresendmsg [\-h|\-H] [options] [message\-type] [flags=flags] [message\-TLVs]
|
|
.SS "Supported message types:"
|
|
.IP
|
|
['node', 'link', 'exec', 'reg', 'conf', 'file', 'iface', 'event', 'sess', 'excp']
|
|
.SS "Supported message flags (flags=f1,f2,...):"
|
|
.IP
|
|
['add', 'del', 'cri', 'loc', 'str', 'txt', 'tty']
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
show this help message and exit
|
|
.TP
|
|
\fB\-H\fR
|
|
show example usage help message and exit
|
|
.TP
|
|
\fB\-p\fR PORT, \fB\-\-port\fR=\fIPORT\fR
|
|
TCP port to connect to, default: 4038
|
|
.TP
|
|
\fB\-a\fR ADDRESS, \fB\-\-address\fR=\fIADDRESS\fR
|
|
Address to connect to, default: localhost
|
|
.TP
|
|
\fB\-s\fR SESSION, \fB\-\-session\fR=\fISESSION\fR
|
|
Session to join, default: None
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-listen\fR
|
|
Listen for a response message and print it.
|
|
.TP
|
|
\fB\-t\fR, \fB\-\-list\-tlvs\fR
|
|
List TLVs for the specified message type.
|
|
.TP
|
|
\fB\-T\fR, \fB\-\-tcp\fR
|
|
Use TCP instead of UDP and connect to a session,
|
|
default: False
|
|
.SH "EXAMPLES"
|
|
.TP
|
|
A list of examples is available using the following command:
|
|
coresendmsg \-H
|
|
.SH "SEE ALSO"
|
|
.BR core-gui(1),
|
|
.BR core-daemon(1),
|
|
.BR vcmd(1),
|
|
.BR vnoded(1)
|
|
.SH BUGS
|
|
Report bugs to
|
|
.BI https://github.com/coreemu/core/issues
|