6:48 a.m.
commit f3187971d3723e3eed7126937e5fe9b4956b6745
Author: Radek Pazdera <rpazdera(a)redhat.com>
Date: Wed Nov 21 13:14:42 2012 +0100
man pages: Adding man templates
This patch adds man templates to the install/ directory. These templates
are processed by setup.py during the installation and turned into an
actuall man pages to be installed.
The man pages are for the following commands:
* lnst-ctl(1)
* lnst-slave(1)
Signed-off-by: Radek Pazdera <rpazdera(a)redhat.com>
install/lnst-ctl.1.in | 117 +++++++++++++++++++++++++++++++++++++++++++++++
install/lnst-slave.1.in | 99 +++++++++++++++++++++++++++++++++++++++
2 files changed, 216 insertions(+), 0 deletions(-)
---
diff --git a/install/lnst-ctl.1.in b/install/lnst-ctl.1.in
new file mode 100644
index 0000000..34afdbf
--- /dev/null
+++ b/install/lnst-ctl.1.in
@@ -0,0 +1,117 @@
+.TH LNST-CTL "1" "@date@"
+
+.\" To view this file while editing, run it through groff:
+.\" groff -Tascii -man lnst-ctl.1 | less -r
+
+.\" This file is a template that contains placeholders for
+.\" certain values. It needs to be processed before it can
+.\" be used as a man-page.
+
+.SH NAME
+lnst-ctl \- Linux Network Stack Test controller
+.SH SYNOPSIS
+.BR
+.B lnst-ctl
+[\fIOPTION\fR]... \fIRECIPE\fR... \fIACTION\fR
+.SH DESCRIPTION
+Linux Network Stack Test is a tool that supports development and execution
+of automated and portable network tests. For detailed description of the
+architecture of LNST please refer to project website
+(link listed on
+.B INTERNET RESOURCES
+bellow).
+
+.B lnst-ctl
+is a script used for managing slaves. It reads a recipe XML file as an
+input and executes tests on the specified slave machines.
+.SH OPTIONS
+.TP
+.B \-c, \-\-cleanup
+Cleanup all slave machines berfore executing the recipes.
+.TP
+.B \-d, \-\-debug
+Toggle emitting debugging messages.
+.TP
+.B \-h, \-\-help
+Display usage of this command.
+.TP
+.B \-p, \-\-packet_capture
+Capture and log all ongoing network communication between the slaves
+during the test.
+.TP
+.BI "\-x, \-\-result" =file
+Write results in XML format to the specified
+.IR file .
+.PP
+.I RECIPE
+can be either a LNST recipe file or a directory containing recipe files.
+One or more files/directories can be passed at the same time. Each recipe
+is a XML file. The format is described in detail in the online documentation
+available at LNST wiki (link is listed on
+.B INTERNET RESOURCES
+bellow).
+
+.I ACTION
+can be one from
+.BR "run",
+.BR "config_only" ", and"
+.BR "dump".
+
+When it is set to
+.BR "run",
+all provided recipe files will be sequentially executed. The network will
+be configured accordingly to each recipe file and clean up
+afterwards.
+
+In case of
+.BR "config_only",
+the recipes provided are processed up to the point where all the machines
+are prepared and properly configured. No tests will be executed and the
+cleanup phase is omitted as well. This mode of operation is useful if you
+want to perform some specific actions or tests outside of LNST using
+the configuration specified in a recipe file.
+
+At last, when the
+.I ACTION
+chosen is
+.BR "dump",
+the network will be configured as specified in the recipe.
+.B lnst-ctl
+will then dump contents of its internal data structures to the standard
+output. This feature can be used for debugging recipes or network setups.
+.SH CONFIGURATION
+.B lnst-ctl
+will look for configuration in the following locations:
+
+.I @conf_dir(a)lnst-ctl.conf
+.br
+.I ~/.lnst/lnst-ctl.conf
+
+For further description of file format or configuration options available,
+please refer to the configuration file itself, where each option is
+documented.
+
+.SH INTERNET RESOURCES
+Project Wiki: https://fedorahosted.org/lnst/
+.br
+Documentation: https://fedorahosted.org/lnst/wiki/Documentation
+.br
+Git Source Tree: http://git.fedorahosted.org/cgit/lnst.git/
+
+Mailing List: <lnst-developers(a)lists.fedorahosted.org>
+.SH AUTHORS
+\fBJiri Pirko\fR <jpirko(a)redhat.com>
+.br
+\fBJiri Zupka\fR <jzupka(a)redhat.com>
+.br
+\fBJan Tluka\fR <jtluka(a)redhat.com>
+.br
+\fBRadek Pazdera\fR <rpazdera(a)redhat.com>
+.br
+\fBOndrej Lichtner\fR <olichtne(a)redhat.com>
+.SH COPYRIGHT
+Copyright (C) 2012 Red Hat, Inc.
+
+LNST is distributed under GNU General Public License version 2. See
+the file "COPYING" in the source distribution for information on terms &
+conditions for accessing and otherwise using LNST.
diff --git a/install/lnst-slave.1.in b/install/lnst-slave.1.in
new file mode 100644
index 0000000..ceec0b7
--- /dev/null
+++ b/install/lnst-slave.1.in
@@ -0,0 +1,99 @@
+.TH LNST-SLAVE "1" "@date@"
+
+.\" To view this file while editing, run it through groff:
+.\" groff -Tascii -man lnst-slave.1 | less -r
+
+.\" This file is a template that contains placeholders for
+.\" certain values. It needs to be processed before it can
+.\" be used as a man-page.
+
+.SH NAME
+lnst-slave \- Linux Network Stack Test slave daemon
+.SH SYNOPSIS
+.BR
+.B lnst-slave
+[\fB-d\fR] [\fB-e\fR] [\fB-h\fR] [\fB-i \fIpidfile\fR]
+[\fB-p \fIport_number\fR]
+.SH DESCRIPTION
+Linux Network Stack Test is a tool that supports development and execution
+of automated and portable network tests. For detailed description of the
+architecture of LNST please refer to project website
+(link listed on
+.B INTERNET RESOURCES
+bellow).
+
+.B lnst-slave
+is a daemon script that runs in the background and waits for incomming
+commands from a controller.
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+Toggle emitting debugging messages.
+.TP
+.B \-e, \-\-daemonize
+Detach from parent process and run in background.
+.TP
+.B \-h, \-\-help
+Display usage of this command.
+.TP
+.BI "\-i, \-\-pidfile" =file
+File to write damonized process' PID to.
+.TP
+.BI "\-p, \-\-port" =port_number
+The port number
+.B lnst-slave
+should listen on for incomming commands.
+.SH CONFIGURATION
+.B lnst-slave
+will look for configuration in the following location:
+
+.I @conf_dir(a)lnst-slave.conf
+
+For further description of file format or configuration options available,
+please refer to the configuration file itself, where each option is
+documented.
+.SH FILES
+Apart from configuration, there are few important locations that
+.B lnst-slave
+works with. All bellow mentioned paths can be changed in the
+configuration file.
+.SS Log Path
+Every test exectution and all the commands run by
+.B lnst-slave
+during the test are logged to the following location:
+
+.I @slave_logs_dir@
+.SS Cache Location
+Test modules and tools used by the controllers with this slave are cached
+in resources cache. The cache is by default located at:
+
+.I @slave_cache_dir@
+
+The cache is fully under control of the
+.B lnst-slave
+daemon and is managed automatically. Making any modifications by hand is
+not recommended.
+.SH INTERNET RESOURCES
+Project Wiki: https://fedorahosted.org/lnst/
+.br
+Documentation: https://fedorahosted.org/lnst/wiki/Documentation
+.br
+Git Source Tree: http://git.fedorahosted.org/cgit/lnst.git/
+
+Mailing List: <lnst-developers(a)lists.fedorahosted.org>
+.SH AUTHORS
+\fBJiri Pirko\fR <jpirko(a)redhat.com>
+.br
+\fBJiri Zupka\fR <jzupka(a)redhat.com>
+.br
+\fBJan Tluka\fR <jtluka(a)redhat.com>
+.br
+\fBRadek Pazdera\fR <rpazdera(a)redhat.com>
+.br
+\fBOndrej Lichtner\fR <olichtne(a)redhat.com>
+.SH COPYRIGHT
+Copyright (C) 2012 Red Hat, Inc.
+
+LNST is distributed under GNU General Public License version 2. See
+the file "COPYING" in the source distribution for information on terms &
+conditions for accessing and otherwise using LNST.