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
Show stats Download patch file Download diff file Expand all files Collapse all files

16
man/Makefile.am
View file

@ -19,14 +19,14 @@ man_MANS = $(GUI_MANS) $(DAEMON_MANS)
.PHONY: generate-mans
generate-mans:
$(HELP2MAN) --source CORE 'sh $(top_srcdir)/gui/core-gui' -o core-gui.1.new
$(HELP2MAN) --no-info --source CORE $(top_srcdir)/netns/vnoded -o vnoded.1.new
$(HELP2MAN) --no-info --source CORE $(top_srcdir)/netns/vcmd -o vcmd.1.new
$(HELP2MAN) --no-info --source CORE $(top_srcdir)/netns/netns -o netns.1.new
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/core-daemon -o core-daemon.1.new
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/coresendmsg -o coresendmsg.1.new
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/core-cleanup -o core-cleanup.1.new
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/core-manage -o core-manage.1.new
$(HELP2MAN) --source CORE 'sh $(top_srcdir)/gui/core-gui' -o core-gui.1
$(HELP2MAN) --no-info --source CORE $(top_srcdir)/netns/vnoded -o vnoded.1
$(HELP2MAN) --no-info --source CORE $(top_srcdir)/netns/vcmd -o vcmd.1
$(HELP2MAN) --no-info --source CORE $(top_srcdir)/netns/netns -o netns.1
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/core-daemon -o core-daemon.1
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/coresendmsg -o coresendmsg.1
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/core-cleanup -o core-cleanup.1
$(HELP2MAN) --version-string=$(PACKAGE_VERSION) --no-info --source CORE $(top_srcdir)/daemon/scripts/core-manage -o core-manage.1
.PHONY: diff
diff:

21
man/core-cleanup.1
View file

@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-CLEANUP "1" "2014-08-06" "CORE-CLEANUP" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH CORE-CLEANUP "1" "June 2019" "CORE" "User Commands"
.SH NAME
core-cleanup \- clean-up script for CORE
core-cleanup \- manual page for core-cleanup 5.3.0
.SH DESCRIPTION
usage: core\-cleanup [\-d [\-l]]
usage: ../daemon/scripts/core\-cleanup [\-d [\-l]]
.IP
Clean up all CORE namespaces processes, bridges, interfaces, and session
directories. Options:
@ -15,15 +15,4 @@ show this help message and exit
also kill the Python daemon
.TP
\fB\-l\fR
remove the core-daemon.log file
.SH "SEE ALSO"
.BR core-gui(1),
.BR core-daemon(1),
.BR coresendmsg(1),
.BR vcmd(1),
.BR vnoded(1)
.SH BUGS
Report bugs to
.BI https://github.com/coreemu/core/issues
remove the core\-daemon.log file

63
man/core-daemon.1
View file

@ -1,52 +1,37 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-DAEMON "1" "2014-08-06" "CORE-DAEMON" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH CORE-DAEMON "1" "June 2019" "CORE" "User Commands"
.SH NAME
core-daemon \- CORE daemon manages emulation sessions started from GUI or scripts
.SH SYNOPSIS
.B core-daemon
[\fI-h\fR] [\fIoptions\fR] [\fIargs\fR]
core-daemon \- manual page for core-daemon 5.3.0
.SH DESCRIPTION
CORE daemon instantiates Linux network namespace nodes.
.SH OPTIONS
usage: core\-daemon [\-h] [\-f CONFIGFILE] [\-p PORT] [\-n NUMTHREADS] [\-\-ovs]
.IP
[\-\-grpc] [\-\-grpc\-port GRPCPORT]
[\-\-grpc\-address GRPCADDRESS]
.PP
CORE daemon v.5.3.0 instantiates Linux network namespace nodes.
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR CONFIGFILE, \fB\-\-configfile\fR=\fICONFIGFILE\fR
\fB\-f\fR CONFIGFILE, \fB\-\-configfile\fR CONFIGFILE
read config from specified file; default =
/etc/core/core.conf
\fI\,/etc/core/core.conf\/\fP
.TP
\fB\-d\fR, \fB\-\-daemonize\fR
run in background as daemon; default=False
.TP
\fB\-e\fR EXECFILE, \fB\-\-execute\fR=\fIEXECFILE\fR
execute a Python/XML\-based session
.TP
\fB\-l\fR LOGFILE, \fB\-\-logfile\fR=\fILOGFILE\fR
log output to specified file; default =
/var/log/core-daemon.log
.TP
\fB\-p\fR PORT, \fB\-\-port\fR=\fIPORT\fR
\fB\-p\fR PORT, \fB\-\-port\fR PORT
port number to listen on; default = 4038
.TP
\fB\-i\fR PIDFILE, \fB\-\-pidfile\fR=\fIPIDFILE\fR
filename to write pid to; default = /var/run/core-daemon.pid
.TP
\fB\-t\fR NUMTHREADS, \fB\-\-numthreads\fR=\fINUMTHREADS\fR
\fB\-n\fR NUMTHREADS, \fB\-\-numthreads\fR NUMTHREADS
number of server threads; default = 1
.TP
\fB\-v\fR, \fB\-\-verbose\fR
enable verbose logging; default = False
\fB\-\-ovs\fR
enable experimental ovs mode, default is false
.TP
\fB\-g\fR, \fB\-\-debug\fR
enable debug logging; default = False
.SH "SEE ALSO"
.BR core-gui(1),
.BR coresendmsg(1),
.BR netns(1),
.BR vcmd(1),
.BR vnoded(1)
.SH BUGS
Report bugs to
.BI https://github.com/coreemu/core/issues
\fB\-\-grpc\fR
enable grpc api, default is false
.TP
\fB\-\-grpc\-port\fR GRPCPORT
grpc port to listen on; default 50051
.TP
\fB\-\-grpc\-address\fR GRPCADDRESS
grpc address to listen on; default localhost

32
man/core-gui.1
View file

@ -1,11 +1,14 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-GUI "1" "2014-08-06" "CORE-GUI" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH CORE-GUI "1" "June 2019" "CORE" "User Commands"
.SH NAME
core-gui \- Common Open Research Emulator (CORE) graphical user interface
core-gui \- manual page for core-gui version 5.3.0 (20190607)
.SH SYNOPSIS
.B core-gui
[\fI-h|-v\fR] [\fI-b|-c <sessionid>\fR] [\fI-s\fR] [\fI-a address\fR] [\fI-p port\fR] [\fI<configfile.imn>\fR]
[\fI\,-h|-v\/\fR] [\fI\,-b|-c <sessionid>\/\fR] [\fI\,-s\/\fR] [\fI\,-a address\/\fR] [\fI\,-p port\/\fR]
.SH DESCRIPTION
.IP
[<configfile.imn>]
.PP
Launches the CORE Tcl/Tk X11 GUI or starts an imn\-based emulation.
.TP
\-(\fB\-h\fR)elp
@ -26,7 +29,7 @@ start in execute mode, not edit mode
\-(\fB\-a\fR)ddress
connect to the specified IP address (default 127.0.0.1)
.TP
\-(\fB\-p\fR)ort
\-(\fB\-p\fR)port
connect to the specified TCP port (default 4038)
.TP
<configfile.imn>
@ -34,11 +37,14 @@ connect to the specified TCP port (default 4038)
.PP
With no parameters, starts the GUI in edit mode with a blank canvas.
.SH "SEE ALSO"
.BR core-daemon(1),
.BR coresendmsg(1),
.BR vcmd(1),
.BR vnoded(1)
.SH BUGS
Report bugs to
.BI https://github.com/coreemu/core/issues
The full documentation for
.B core-gui
is maintained as a Texinfo manual. If the
.B info
and
.B core-gui
programs are properly installed at your site, the command
.IP
.B info core-gui
.PP
should give you access to the complete manual.

33
man/core-manage.1
View file

@ -1,34 +1,31 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-MANAGE "1" "2014-08-06" "CORE-MANAGE" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH CORE-MANAGE "1" "June 2019" "CORE" "User Commands"
.SH NAME
core-manage \- helper tool to add, remove, or check for services and models in a CORE installation.
core-manage \- manual page for core-manage 5.3.0
.SH SYNOPSIS
.B core-manage
[\fI-h\fR] [\fIoptions\fR] \fI<action> <target> <string>\fR
[\fI\,-h\/\fR] [\fI\,options\/\fR] \fI\,<action> <target> <string>\/\fR
.SH DESCRIPTION
.TP
<action> should be one of: add, remove, check
.TP
<target> should be one of: service, model
.TP
<string> is the text to add, remove, check
Helper tool to add, remove, or check for services, models, and node types
in a CORE installation.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-userpath\fR=\fIUSERPATH\fR
\fB\-\-userpath\fR=\fI\,USERPATH\/\fR
use the specified user path (e.g. "$HOME/.core") to
access nodes.conf
.TP
\fB\-v\fR, \fB\-\-verbose\fR
be verbose when performing action
.SH EXAMPLES
.TP
.IP
core\-manage add service newrouting
.TP
core\-manage \fB\-v\fR check model RfPipe
.TP
core\-manage \fB\-\-userpath=\fR"$HOME/.core" add nodetype "{ftp ftp.gif ftp.gif {DefaultRoute FTP} netns {FTP server} }"
.SH "SEE ALSO"
.BR core-daemon(1)
core\-manage \-v check model RfPipe
core\-manage \-\-userpath="$HOME/.core" add nodetype "{ftp ftp.gif ftp.gif {DefaultRoute FTP} netns {FTP server} }"
.SS "Arguments:"
.IP
<action> should be one of: add, remove, check
<target> should be one of: service, model, nodetype
<string> is the text to add, remove, check

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

20
man/netns.1
View file

@ -1,10 +1,10 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH NETNS "1" "2014-08-06" "NETNS" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH NETNS "1" "June 2019" "CORE" "User Commands"
.SH NAME
netns \- run commands within a network namespace
netns \- manual page for netns version 5.3.0
.SH SYNOPSIS
.B netns
[\fI-h|-V\fR] [\fI-w\fR] \fI-- command \fR[\fIargs\fR...]
[\fI\,-h|-V\/\fR] [\fI\,-w\/\fR] \fI\,-- command \/\fR[\fI\,args\/\fR...]
.SH DESCRIPTION
Run the specified command in a new network namespace.
.SH OPTIONS
@ -17,15 +17,3 @@ show version number and exit
.TP
\fB\-w\fR
wait for command to complete (useful for interactive commands)
.SH "SEE ALSO"
.BR core-gui(1),
.BR core-daemon(1),
.BR coresendmsg(1),
.BR unshare(1),
.BR vcmd(1),
.BR vnoded(1)
.SH BUGS
Report bugs to
.BI https://github.com/coreemu/core/issues

18
man/vcmd.1
View file

@ -1,10 +1,10 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH VCMD "1" "2014-08-06" "VCMD" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH VCMD "1" "June 2019" "CORE" "User Commands"
.SH NAME
vcmd \- run a command in a network namespace created by vnoded
vcmd \- manual page for vcmd version 5.3.0
.SH SYNOPSIS
.B vcmd
[\fI-h|-V\fR] [\fI-v\fR] [\fI-q|-i|-I\fR] \fI-c <channel name> -- command args\fR...
[\fI\,-h|-V\/\fR] [\fI\,-v\/\fR] [\fI\,-q|-i|-I\/\fR] \fI\,-c <channel name> -- command args\/\fR...
.SH DESCRIPTION
Run the specified command in the Linux namespace container specified by the
control <channel name>, with the specified arguments.
@ -30,13 +30,3 @@ run the command non\-interactively (without PTY)
.TP
\fB\-c\fR
control channel name (e.g. '/tmp/pycore.45647/n3')
.SH "SEE ALSO"
.BR core-gui(1),
.BR core-daemon(1),
.BR coresendmsg(1),
.BR netns(1),
.BR vnoded(1),
.SH BUGS
Report bugs to
.BI https://github.com/coreemu/core/issues

17
man/vnoded.1
View file

@ -1,10 +1,10 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH VNODED "1" "2014-08-06" "VNODED" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH VNODED "1" "June 2019" "CORE" "User Commands"
.SH NAME
vnoded \- network namespace daemon used by CORE to create a lightweight container
vnoded \- manual page for vnoded version 5.3.0
.SH SYNOPSIS
.B vnoded
[\fI-h|-V\fR] [\fI-v\fR] [\fI-n\fR] [\fI-C <chdir>\fR] [\fI-l <logfile>\fR] [\fI-p <pidfile>\fR] \fI-c <control channel>\fR
[\fI\,-h|-V\/\fR] [\fI\,-v\/\fR] [\fI\,-n\/\fR] [\fI\,-C <chdir>\/\fR] [\fI\,-l <logfile>\/\fR] [\fI\,-p <pidfile>\/\fR] \fI\,-c <control channel>\/\fR
.SH DESCRIPTION
Linux namespace container server daemon runs as PID 1 in the container.
Normally this process is launched automatically by the CORE daemon.
@ -33,12 +33,3 @@ write process id to the specified <pidfile> file
.TP
\fB\-c\fR
establish the specified <control channel> for receiving control commands
.SH "SEE ALSO"
.BR core-gui(1),
.BR core-daemon(1),
.BR coresendmsg(1),
.BR vcmd(1),
.SH BUGS
Report bugs to
.BI https://github.com/coreemu/core/issues