afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

make building new man pages simpler, updated generated man pages

Browse source
This commit is contained in:
bharnden 2019-06-07 21:50:32 -07:00
parent 7594afec82
commit 1b71061cdb
9 changed files with 94 additions and 193 deletions
Download patch file Download diff file Expand all files Collapse all files

67
man/coresendmsg.1
View file

@ -1,17 +1,17 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORESENDMSG "1" "2014-08-06" "CORESENDMSG" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH CORESENDMSG "1" "June 2019" "CORE" "User Commands"
.SH NAME
coresendmsg \- send a CORE API message to the core-daemon daemon
coresendmsg \- manual page for coresendmsg 5.3.0
.SH SYNOPSIS
.B coresendmsg
[\fI-h|-H\fR] [\fIoptions\fR] [\fImessage-type\fR] [\fIflags=flags\fR] [\fImessage-TLVs\fR]
[\fI\,-h|-H\/\fR] [\fI\,options\/\fR] [\fI\,message-type\/\fR] [\fI\,flags=flags\/\fR] [\fI\,message-TLVs\/\fR]
.SH DESCRIPTION
.SS "Supported message types:"
.IP
['node', 'link', 'exec', 'reg', 'conf', 'file', 'iface', 'event', 'sess', 'excp']
['NODE', 'LINK', 'EXECUTE', 'REGISTER', 'CONFIG', 'FILE', 'INTERFACE', 'EVENT', 'SESSION', 'EXCEPTION']
.SS "Supported message flags (flags=f1,f2,...):"
.IP
['add', 'del', 'cri', 'loc', 'str', 'txt', 'tty']
['ADD', 'DELETE', 'CRI', 'LOCAL', 'STRING', 'TEXT', 'TTY']
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@ -20,13 +20,13 @@ show this help message and exit
\fB\-H\fR
show example usage help message and exit
.TP
\fB\-p\fR PORT, \fB\-\-port\fR=\fIPORT\fR
\fB\-p\fR PORT, \fB\-\-port\fR=\fI\,PORT\/\fR
TCP port to connect to, default: 4038
.TP
\fB\-a\fR ADDRESS, \fB\-\-address\fR=\fIADDRESS\fR
\fB\-a\fR ADDRESS, \fB\-\-address\fR=\fI\,ADDRESS\/\fR
Address to connect to, default: localhost
.TP
\fB\-s\fR SESSION, \fB\-\-session\fR=\fISESSION\fR
\fB\-s\fR SESSION, \fB\-\-session\fR=\fI\,SESSION\/\fR
Session to join, default: None
.TP
\fB\-l\fR, \fB\-\-listen\fR
@ -35,51 +35,6 @@ Listen for a response message and print it.
\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,
\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