From f0fb2c2ddde64f083cb90b3d45baa5dcbb927654 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Thu, 7 Sep 2017 01:02:04 +0200 Subject: [PATCH] OsmoGGSN: Add VTY reference manual Change-Id: Iddf6fe26689172d7db001198943c816eaaed7931 --- doc/manuals/Makefile | 28 +- doc/manuals/osmoggsn-vty-reference.xml | 38 + doc/manuals/vty/ggsn_vty_additions.xml | 30 + doc/manuals/vty/ggsn_vty_reference.xml | 1480 ++++++++++++++++++++++++ 4 files changed, 1575 insertions(+), 1 deletion(-) create mode 100644 doc/manuals/osmoggsn-vty-reference.xml create mode 100644 doc/manuals/vty/ggsn_vty_additions.xml create mode 100644 doc/manuals/vty/ggsn_vty_reference.xml diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile index daf3597..2dfedb2 100644 --- a/doc/manuals/Makefile +++ b/doc/manuals/Makefile @@ -1,6 +1,18 @@ # XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/ # Makefile from BitBake/OpenEmbedded manuals +EXTRA_DEPS = gen-ggsn-vty-docbook + +topdir = . +ggsn_reference = $(topdir)/osmoggsn-vty-reference.xml +manuals = $(ggsn_reference) +# types = pdf txt rtf ps xhtml html man tex texi dvi +# types = pdf txt +types = $(docbooktotypes) +docbooktotypes = pdf +# htmlcssfile = +# htmlcss = + TOPDIR := .. ASCIIDOCS := osmoggsn-usermanual @@ -10,4 +22,18 @@ include $(TOPDIR)/build/Makefile.inc osmoggsn-usermanual.pdf: chapters/*.adoc clean: - rm -rf $(cleanfiles) + -rm -rf $(cleanfiles) + -rm osmoggsn-usermanual__*.svg osmoggsn-usermanual__*.png + -rm osmoggsn-usermanual.check + +gen-ggsn-vty-docbook: FORCE + $(call command,xsltproc -o generated/combined1.xml \ + --stringparam with $(PWD)/../common/vty_additions.xml \ + $(MERGE_DOC) vty/ggsn_vty_reference.xml, \ + XSLTPROC,Merging Common VTY) + $(call command,xsltproc -o generated/combined2.xml \ + --stringparam with $(PWD)/vty/ggsn_vty_additions.xml \ + $(MERGE_DOC) generated/combined1.xml, \ + XSLTPROC,Merging GGSN VTY) + $(call command,xsltproc ../vty_reference.xsl generated/combined2.xml > generated/docbook_vty.xml, \ + XSLTPROC,Converting GGSN VTY to DocBook) diff --git a/doc/manuals/osmoggsn-vty-reference.xml b/doc/manuals/osmoggsn-vty-reference.xml new file mode 100644 index 0000000..44e7bfc --- /dev/null +++ b/doc/manuals/osmoggsn-vty-reference.xml @@ -0,0 +1,38 @@ + + + + +]> + + + + + + v1 + 06th September 2017 + hw + Initial version as of OsmoGGSN v1.0.0 + + + + OsmoGGSN VTY Reference + + + 2017 + + + + This work is copyright by sysmocom - s.f.m.c. GmbH. All rights reserved. + + + + + + &chapter-vty; + + diff --git a/doc/manuals/vty/ggsn_vty_additions.xml b/doc/manuals/vty/ggsn_vty_additions.xml new file mode 100644 index 0000000..1bbeb81 --- /dev/null +++ b/doc/manuals/vty/ggsn_vty_additions.xml @@ -0,0 +1,30 @@ + + + + Telnet/VTY Configuration Node + + Configure parameters of the Telnet/VTY Interface, such as to which IP address it should bind/listen to. + + + + + CTRL Configuration Node + + Configure parameters of the CTRL Interface, such as to which IP address it should bind/listen to. + + + + + GGSN Instance Configuration Node + + Configure an Instance of a (virtual) GGSN + + + + + APN Configuration Node + + Configure an Access Point Name (APN) inside a GGSN Instance + + + diff --git a/doc/manuals/vty/ggsn_vty_reference.xml b/doc/manuals/vty/ggsn_vty_reference.xml new file mode 100644 index 0000000..6809ead --- /dev/null +++ b/doc/manuals/vty/ggsn_vty_reference.xml @@ -0,0 +1,1480 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file