diff options
author | Harald Welte <laforge@gnumonks.org> | 2017-04-16 03:09:47 +0200 |
---|---|---|
committer | Neels Hofmeyr <neels@hofmeyr.de> | 2018-11-27 18:46:12 +0100 |
commit | 46c4b92926c4fd51aa049cf204d556f520e1e401 (patch) | |
tree | b49cbb68d49aa3220e28ed39037821b5040d8683 /doc | |
parent | 7dd567979a6dda057e19c88adc599a7e4aff8ae5 (diff) |
First step towards an OsmoSTP manual
Change-Id: I450bfac7444ac9cb7f50c086d87cf7157c2e2a31
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manuals/Makefile | 11 | ||||
-rw-r--r-- | doc/manuals/chapters/overview.adoc | 0 | ||||
-rw-r--r-- | doc/manuals/osmostp-usermanual-docinfo.xml | 47 | ||||
-rw-r--r-- | doc/manuals/osmostp-usermanual.adoc | 34 | ||||
-rw-r--r-- | doc/manuals/osmostp-vty-reference.xml | 38 | ||||
-rw-r--r-- | doc/manuals/vty/stp_vty_reference.xml | 2 |
6 files changed, 132 insertions, 0 deletions
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 --- /dev/null +++ b/doc/manuals/chapters/overview.adoc 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 @@ +<revhistory> + <revision> + <revnumber>1</revnumber> + <date>April 16, 2017</date> + <authorinitials>HW</authorinitials> + <revremark> + Initial OsmoSTP manual + </revremark> + </revision> +</revhistory> + +<authorgroup> + <author> + <firstname>Harald</firstname> + <surname>Welte</surname> + <email>hwelte@sysmocom.de</email> + <authorinitials>HW</authorinitials> + <affiliation> + <shortaffil>sysmocom</shortaffil> + <orgname>sysmocom - s.f.m.c. GmbH</orgname> + <jobtitle>Managing Director</jobtitle> + </affiliation> + </author> +</authorgroup> + +<copyright> + <year>2012-2017</year> + <holder>sysmocom - s.f.m.c. GmbH</holder> +</copyright> + +<legalnotice> + <para> + 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". + </para> + <para> + The Asciidoc source code of this manual can be found at + <ulink url="http://git.osmocom.org/osmo-gsm-manuals/"> + http://git.osmocom.org/osmo-gsm-manuals/ + </ulink> + </para> +</legalnotice> 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 <hwelte@sysmocom.de> + + +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 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ex:ts=2:sw=42sts=2:et + -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- +--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0//EN" +"http://www.docbook.org/xml/5.0/dtd/docbook.dtd" [ +<!ENTITY chapter-vty SYSTEM "../common/chapters/vty.xml" > +<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" > +]> + +<book> + <info> + <revhistory> + <revision> + <revnumber>v1</revnumber> + <date>April 16, 2017</date> + <authorinitials>h2</authorinitials> + <revremark>Initial</revremark> + </revision> + </revhistory> + + <title>OsmoSTP VTY Reference</title> + + <copyright> + <year>2012-2017</year> + </copyright> + + <legalnotice> + <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved. + </para> + </legalnotice> + </info> + + <!-- Main chapters--> + &chapter-vty; +</book> + 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 @@ +<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'> +</vtydoc> |