From 46c4b92926c4fd51aa049cf204d556f520e1e401 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Sun, 16 Apr 2017 03:09:47 +0200 Subject: First step towards an OsmoSTP manual Change-Id: I450bfac7444ac9cb7f50c086d87cf7157c2e2a31 --- doc/manuals/Makefile | 11 +++++++ doc/manuals/chapters/overview.adoc | 0 doc/manuals/osmostp-usermanual-docinfo.xml | 47 ++++++++++++++++++++++++++++++ doc/manuals/osmostp-usermanual.adoc | 34 +++++++++++++++++++++ doc/manuals/osmostp-vty-reference.xml | 38 ++++++++++++++++++++++++ doc/manuals/vty/stp_vty_reference.xml | 2 ++ 6 files changed, 132 insertions(+) create mode 100644 doc/manuals/Makefile create mode 100644 doc/manuals/chapters/overview.adoc create mode 100644 doc/manuals/osmostp-usermanual-docinfo.xml create mode 100644 doc/manuals/osmostp-usermanual.adoc create mode 100644 doc/manuals/osmostp-vty-reference.xml create mode 100644 doc/manuals/vty/stp_vty_reference.xml (limited to 'doc') diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile new file mode 100644 index 0000000..6832dd4 --- /dev/null +++ b/doc/manuals/Makefile @@ -0,0 +1,11 @@ +TOPDIR = .. + +ASCIIDOC = osmostp-usermanual.adoc +include $(TOPDIR)/build/Makefile.asciidoc.inc +osmostp-usermanual.pdf: chapters/*.adoc +aoip-mgw-options.pdf: aoip-mgw-options.adoc mgw/*.msc + +VTY_REFERENCE = osmostp-vty-reference.xml +include $(TOPDIR)/build/Makefile.vty-reference.inc + +include $(TOPDIR)/build/Makefile.common.inc diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc new file mode 100644 index 0000000..e69de29 diff --git a/doc/manuals/osmostp-usermanual-docinfo.xml b/doc/manuals/osmostp-usermanual-docinfo.xml new file mode 100644 index 0000000..4253957 --- /dev/null +++ b/doc/manuals/osmostp-usermanual-docinfo.xml @@ -0,0 +1,47 @@ + + + 1 + April 16, 2017 + HW + + Initial OsmoSTP manual + + + + + + + Harald + Welte + hwelte@sysmocom.de + HW + + sysmocom + sysmocom - s.f.m.c. GmbH + Managing Director + + + + + + 2012-2017 + sysmocom - s.f.m.c. GmbH + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.3 or any later version published by the Free Software + Foundation; with the Invariant Sections being just 'Foreword', + 'Acknowledgements' and 'Preface', with no Front-Cover Texts, + and no Back-Cover Texts. A copy of the license is included in + the section entitled "GNU Free Documentation License". + + + The Asciidoc source code of this manual can be found at + + http://git.osmocom.org/osmo-gsm-manuals/ + + + diff --git a/doc/manuals/osmostp-usermanual.adoc b/doc/manuals/osmostp-usermanual.adoc new file mode 100644 index 0000000..6dc1d08 --- /dev/null +++ b/doc/manuals/osmostp-usermanual.adoc @@ -0,0 +1,34 @@ +OsmoSTP User Manual +=================== +Harald Welte + + +include::../common/chapters/preface.adoc[] + +// include::chapters/overview.adoc[] + +include::../common/chapters/sigtran.adoc[] + +include::../common/chapters/sigtran-osmocom.adoc[] + +//include::chapters/running.adoc[] +// include::chapters/control.adoc[] + +include::../common/chapters/vty.adoc[] + +include::../common/chapters/logging.adoc[] + +//include::../common/chapters/bts.adoc[] + +//include::../OsmoNITB/chapters/bts-examples.adoc[] + +//include::../common/chapters/control_if.adoc[] + +include::../common/chapters/port_numbers.adoc[] + +include::../common/chapters/bibliography.adoc[] + +include::../common/chapters/glossary.adoc[] + +include::../common/chapters/gfdl.adoc[] + diff --git a/doc/manuals/osmostp-vty-reference.xml b/doc/manuals/osmostp-vty-reference.xml new file mode 100644 index 0000000..807d427 --- /dev/null +++ b/doc/manuals/osmostp-vty-reference.xml @@ -0,0 +1,38 @@ + + + + +]> + + + + + + v1 + April 16, 2017 + h2 + Initial + + + + OsmoSTP VTY Reference + + + 2012-2017 + + + + This work is copyright by sysmocom - s.f.m.c. GmbH. All rights reserved. + + + + + + &chapter-vty; + + diff --git a/doc/manuals/vty/stp_vty_reference.xml b/doc/manuals/vty/stp_vty_reference.xml new file mode 100644 index 0000000..a4c675e --- /dev/null +++ b/doc/manuals/vty/stp_vty_reference.xml @@ -0,0 +1,2 @@ + + -- cgit v1.2.3 From 51ef55b6d442b1caf5592f2b3a912d819f80606b Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Sun, 12 Nov 2017 08:18:47 +0900 Subject: STP: Update vty reference XML file This ensures useful content in the STP vty reference manual Change-Id: Ica4b1c0172255ec2328562fdd8fac190e3ad448d --- doc/manuals/vty/osmo-stp_vty_reference.xml | 1742 ++++++++++++++++++++++++++++ doc/manuals/vty/stp_vty_reference.xml | 2 - 2 files changed, 1742 insertions(+), 2 deletions(-) create mode 100644 doc/manuals/vty/osmo-stp_vty_reference.xml delete mode 100644 doc/manuals/vty/stp_vty_reference.xml (limited to 'doc') diff --git a/doc/manuals/vty/osmo-stp_vty_reference.xml b/doc/manuals/vty/osmo-stp_vty_reference.xml new file mode 100644 index 0000000..9d25d44 --- /dev/null +++ b/doc/manuals/vty/osmo-stp_vty_reference.xml @@ -0,0 +1,1742 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/manuals/vty/stp_vty_reference.xml b/doc/manuals/vty/stp_vty_reference.xml deleted file mode 100644 index a4c675e..0000000 --- a/doc/manuals/vty/stp_vty_reference.xml +++ /dev/null @@ -1,2 +0,0 @@ - - -- cgit v1.2.3 From 5fab07911dad6a34200f2900e3e9c26e27f07432 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 6 Mar 2018 14:59:00 +0100 Subject: OsmoSTP: update VTY reference This is the first update since the libosmocore changes to the 'show online-help' generated output. Hence the produced document now benefits from the structural improvements: - not repeating common commands for every node; - using section names that match the VTY prompt. Change-Id: I98cdfcb6c1c7db49ab106e775be92e4c6adeab17 --- doc/manuals/vty/osmo-stp_vty_reference.xml | 3101 ++++++++++++---------------- 1 file changed, 1359 insertions(+), 1742 deletions(-) (limited to 'doc') diff --git a/doc/manuals/vty/osmo-stp_vty_reference.xml b/doc/manuals/vty/osmo-stp_vty_reference.xml index 9d25d44..4ab24f5 100644 --- a/doc/manuals/vty/osmo-stp_vty_reference.xml +++ b/doc/manuals/vty/osmo-stp_vty_reference.xml @@ -1,1742 +1,1359 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + + + Common Commands + These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + view + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + enable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-log + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-line + + + + + + + + + + + + + + + + + + + + config-cs7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-as + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-asp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-listen + + + + + + + + + + + + + + + + config-cs7-rt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-sccpaddr + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-cs7-sccpaddr-gt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3 From fcc95f960b2c5e3202499f092c8086b4e52fee50 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Sat, 17 Mar 2018 14:15:38 +0100 Subject: vty-ref: Update URI of docbook 5.0 schema ... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d --- doc/manuals/osmostp-vty-reference.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/manuals/osmostp-vty-reference.xml b/doc/manuals/osmostp-vty-reference.xml index 807d427..b4ee500 100644 --- a/doc/manuals/osmostp-vty-reference.xml +++ b/doc/manuals/osmostp-vty-reference.xml @@ -3,8 +3,8 @@ ex:ts=2:sw=42sts=2:et -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- --> - ]> -- cgit v1.2.3 From 3508df220073775833a4f89b2716a89b11b71b9e Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 5 Nov 2018 03:19:56 +0100 Subject: stp: update vty reference Change-Id: Id5f1067760db7a11ec380a541bfe7357a21a3bb3 --- doc/manuals/vty/osmo-stp_vty_reference.xml | 185 ++++++++++++++++++++--------- 1 file changed, 130 insertions(+), 55 deletions(-) (limited to 'doc') diff --git a/doc/manuals/vty/osmo-stp_vty_reference.xml b/doc/manuals/vty/osmo-stp_vty_reference.xml index 4ab24f5..cbda3fc 100644 --- a/doc/manuals/vty/osmo-stp_vty_reference.xml +++ b/doc/manuals/vty/osmo-stp_vty_reference.xml @@ -85,12 +85,6 @@ - - - - - - @@ -175,7 +169,7 @@ - + @@ -183,6 +177,7 @@ + @@ -192,20 +187,10 @@ - - - - - - - - - - + - @@ -224,7 +209,6 @@ - @@ -232,6 +216,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -286,6 +302,16 @@ + + + + + + + + + + @@ -376,12 +402,6 @@ - - - - - - @@ -446,7 +466,8 @@ - + + @@ -478,7 +499,7 @@ - + @@ -486,6 +507,7 @@ + @@ -495,20 +517,10 @@ - - - - - - - - - - + - @@ -527,7 +539,6 @@ - @@ -535,6 +546,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -589,6 +632,16 @@ + + + + + + + + + + @@ -891,7 +944,7 @@ - + @@ -899,13 +952,13 @@ + - + - @@ -924,7 +977,6 @@ - @@ -932,6 +984,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + config-line @@ -983,8 +1067,7 @@ - - + @@ -1043,15 +1126,6 @@ - - - - - - - - - @@ -1310,7 +1384,8 @@ - + + -- cgit v1.2.3 From e6a0409d6eecdb3ec936418c5db0bd1ad8b4eb96 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 5 Nov 2018 03:33:44 +0100 Subject: stp: update vty reference with added SCCP commands After I66e97706de0c546db3c6ff77fb5e6ac6e32bff55 which adds the missing sccp_vty_init(), update VTY reference with the new SCCP show / config commands. Depends: I66e97706de0c546db3c6ff77fb5e6ac6e32bff55 Change-Id: Id941b8e31d3b4cfdb3f912beedc1e7af321a0113 --- doc/manuals/vty/osmo-stp_vty_reference.xml | 100 ++++++++++++++++++++++++++++- 1 file changed, 99 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/manuals/vty/osmo-stp_vty_reference.xml b/doc/manuals/vty/osmo-stp_vty_reference.xml index cbda3fc..308c369 100644 --- a/doc/manuals/vty/osmo-stp_vty_reference.xml +++ b/doc/manuals/vty/osmo-stp_vty_reference.xml @@ -321,6 +321,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -651,6 +692,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1067,7 +1149,8 @@ - + + @@ -1164,6 +1247,21 @@ + + + + + + + + + + + + + + + config-cs7-as -- cgit v1.2.3