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

moved core markdown documentation to live within to repo, this will eventually be the docs hosted on github and allow them to be versioned with the code

Browse source
This commit is contained in:
Blake J. Harnden 2018-07-31 12:57:30 -07:00
parent adfa835886
commit 23f5d7fb8c
55 changed files with 1713 additions and 3635 deletions
Download patch file Download diff file Expand all files Collapse all files

42
man/Makefile.am Normal file
View file

@ -0,0 +1,42 @@
# CORE
# (c)2012-2013 the Boeing Company.
# See the LICENSE file included in this distribution.
#
# author: Jeff Ahrenholz <jeffrey.m.ahrenholz@boeing.com>
#
# Makefile for building man pages.
#
if WANT_GUI
GUI_MANS = core-gui.1
endif
if WANT_DAEMON
DAEMON_MANS = vnoded.1 vcmd.1 netns.1 core-daemon.1 coresendmsg.1 \
core-cleanup.1 core-manage.1
endif
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
.PHONY: diff
diff:
for m in ${man_MANS}; do \
colordiff -u $$m $$m.new | less -R; \
done;
clean-local:
-rm -f $(addsuffix .new,$(GUI_MANS))
-rm -f $(addsuffix .new,$(DAEMON_MANS))
DISTCLEANFILES = Makefile.in
EXTRA_DIST = $(man_MANS)

29
man/core-cleanup.1 Normal file
View file

@ -0,0 +1,29 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-CLEANUP "1" "2014-08-06" "CORE-CLEANUP" "User Commands"
.SH NAME
core-cleanup \- clean-up script for CORE
.SH DESCRIPTION
usage: core\-cleanup [\-d [\-l]]
.IP
Clean up all CORE namespaces processes, bridges, interfaces, and session
directories. Options:
.TP
\fB\-h\fR
show this help message and exit
.TP
\fB\-d\fR
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 core-dev@nrl.navy.mil.

52
man/core-daemon.1 Normal file
View file

@ -0,0 +1,52 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-DAEMON "1" "2014-08-06" "CORE-DAEMON" "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]
.SH DESCRIPTION
CORE daemon instantiates Linux network namespace nodes.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR CONFIGFILE, \fB\-\-configfile\fR=\fICONFIGFILE\fR
read config from specified file; default =
/etc/core/core.conf
.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
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
number of server threads; default = 1
.TP
\fB\-v\fR, \fB\-\-verbose\fR
enable verbose logging; default = 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 core-dev@nrl.navy.mil.

44
man/core-gui.1 Normal file
View file

@ -0,0 +1,44 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-GUI "1" "2014-08-06" "CORE-GUI" "User Commands"
.SH NAME
core-gui \- Common Open Research Emulator (CORE) graphical user interface
.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]
.SH DESCRIPTION
Launches the CORE Tcl/Tk X11 GUI or starts an imn\-based emulation.
.TP
\-(\fB\-h\fR)elp
show help message and exit
.TP
\-(\fB\-v\fR)ersion
show version number and exit
.TP
\-(\fB\-b\fR)atch
batch mode (no X11 GUI)
.TP
\-(\fB\-c\fR)losebatch <sessionid>
stop and clean up a batch mode session <sessionid>
.TP
\-(\fB\-s\fR)tart
start in execute mode, not edit mode
.TP
\-(\fB\-a\fR)ddress
connect to the specified IP address (default 127.0.0.1)
.TP
\-(\fB\-p\fR)ort
connect to the specified TCP port (default 4038)
.TP
<configfile.imn>
(optional) load the specified imn scenario file
.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 core-dev@nrl.navy.mil.

34
man/core-manage.1 Normal file
View file

@ -0,0 +1,34 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-MANAGE "1" "2014-08-06" "CORE-MANAGE" "User Commands"
.SH NAME
core-manage \- helper tool to add, remove, or check for services and models in a CORE installation.
.SH SYNOPSIS
.B core-manage
[\fI-h\fR] [\fIoptions\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
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-userpath\fR=\fIUSERPATH\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
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)

28
man/core-xen-cleanup.1 Normal file
View file

@ -0,0 +1,28 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH CORE-XEN-CLEANUP "1" "2014-08-06" "CORE-XEN-CLEANUP" "User Commands"
.SH NAME
core-xen-cleanup \- clean-up script for CORE Xen domUs
.SH DESCRIPTION
usage: core\-xen\-cleanup [\-d]
.IP
Clean up all CORE Xen domUs, bridges, interfaces, and session
directories. Options:
.TP
\fB\-h\fR
show this help message and exit
.TP
\fB\-d\fR
also kill the Python daemon
.SH "SEE ALSO"
.BR core-gui(1),
.BR core-daemon(1),
.BR coresendmsg(1),
.BR core-cleanup(1),
.BR vcmd(1),
.BR vnoded(1)
.SH BUGS
Warning! This script will remove logical volumes that match the name "/dev/vg*/c*-n*-" on all volume groups. Use with care.
Report bugs to
.BI core-dev@nrl.navy.mil.

85
man/coresendmsg.1 Normal file
View file

@ -0,0 +1,85 @@
.\" 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 core-dev@nrl.navy.mil.

30
man/netns.1 Normal file
View file

@ -0,0 +1,30 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH NETNS "1" "2014-08-06" "NETNS" "User Commands"
.SH NAME
netns \- run commands within a network namespace
.SH SYNOPSIS
.B netns
[\fI-h|-V\fR] [\fI-w\fR] \fI-- command \fR[\fIargs\fR...]
.SH DESCRIPTION
Run the specified command in a new network namespace.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
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 core-dev@nrl.navy.mil.

42
man/vcmd.1 Normal file
View file

@ -0,0 +1,42 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH VCMD "1" "2014-08-06" "VCMD" "User Commands"
.SH NAME
vcmd \- run a command in a network namespace created by vnoded
.SH SYNOPSIS
.B vcmd
[\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.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
show version number and exit
.TP
\fB\-v\fR
enable verbose logging
.TP
\fB\-q\fR
run the command quietly, without local input or output
.TP
\fB\-i\fR
run the command interactively (use PTY)
.TP
\fB\-I\fR
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 core-dev@nrl.navy.mil.

44
man/vnoded.1 Normal file
View file

@ -0,0 +1,44 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
.TH VNODED "1" "2014-08-06" "VNODED" "User Commands"
.SH NAME
vnoded \- network namespace daemon used by CORE to create a lightweight container
.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
.SH DESCRIPTION
Linux namespace container server daemon runs as PID 1 in the container.
Normally this process is launched automatically by the CORE daemon.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
show version number and exit
.TP
\fB\-v\fR
enable verbose logging
.TP
\fB\-n\fR
do not create and run daemon within a new network namespace (for debug)
.TP
\fB\-C\fR
change to the specified <chdir> directory
.TP
\fB\-l\fR
log output to the specified <logfile> file
.TP
\fB\-p\fR
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 core-dev@nrl.navy.mil.