aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-09-05 18:12:14 +0200
committerHarald Welte <laforge@gnumonks.org>2017-09-06 09:17:15 +0200
commit632e843e5f694ba258e716a7f0e0ceb39055f303 (patch)
tree8128db442c876e286c48d97a55d0b0370502f038 /doc
parente80494726c5b36caef58a5999251613453d9e2f0 (diff)
Rename OpenGGSN to OsmoGGSN
Osmocom has maintained this program since about 7 years now, while the original author / copyright holder has completely disappeared. With the introduction of Osmocom-style CTRL and VTY interfaces, the way how the program is used and configured has substantially changed. In order to avoid confusion in terms of configuration file format etc, let's rename it to OsmoGGSN. Change-Id: I2da30f7d4828e185bfac1a4e2d8414b01cbe4f9d
Diffstat (limited to 'doc')
-rw-r--r--doc/Compliance.html2
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/osmo-ggsn.8 (renamed from doc/ggsn.8)46
-rw-r--r--doc/sgsnemu.88
4 files changed, 29 insertions, 29 deletions
diff --git a/doc/Compliance.html b/doc/Compliance.html
index f33bc6f..4c2fc3a 100644
--- a/doc/Compliance.html
+++ b/doc/Compliance.html
@@ -7,7 +7,7 @@
</head>
<body>
<h1>Protocol Compliance List</h1>
-OpenGGSN supports both GTP0 (GSM 09.60) and GTP1 (3GPP 29.060). In the
+OsmoGGSN supports both GTP0 (GSM 09.60) and GTP1 (3GPP 29.060). In the
following tables the support of each individual message type is
detailed. The numbers before each feature indicates the relevant
section in the standard.<br>
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 43b00d0..7e2246c 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-man_MANS = ggsn.8 sgsnemu.8
+man_MANS = osmo-ggsn.8 sgsnemu.8
man_aux = $(man_MANS:.1=.x)
EXTRA_DIST = $(man_MANS)
diff --git a/doc/ggsn.8 b/doc/osmo-ggsn.8
index 89dcb61b..b9f928f 100644
--- a/doc/ggsn.8
+++ b/doc/osmo-ggsn.8
@@ -1,5 +1,5 @@
-.\" * OpenGGSN - Gateway GPRS Support Node
+.\" * OsmoGGSN - Gateway GPRS Support Node
.\" * Copyright (C) 2002, 2003 Mondru AB.
.\" *
.\" * The contents of this file may be used under the terms of the GNU
@@ -12,24 +12,24 @@
.\" *
.\" * Contributor(s):
.\" *
-.\" Manual page for ggsn
+.\" Manual page for osmo-ggsn
.\" SH section heading
.\" SS subsection heading
.\" LP paragraph
.\" IP indented paragraph
.\" TP hanging label
-.TH ggsn 8 "July 2003"
+.TH osmo-ggsn 8 "August 2017"
.SH NAME
-ggsn \- Gateway GPRS Support Node.
+osmo-ggsn \- Gateway GPRS Support Node.
.SH SYNOPSIS
-.B ggsn
+.B osmo-ggsn
\-\-help
-.B ggsn
+.B osmo-ggsn
\-\-version
-.B ggsn
+.B osmo-ggsn
[
.BI \-\-help
] [
@@ -40,9 +40,9 @@ ggsn \- Gateway GPRS Support Node.
.BI \-\-version
]
.SH DESCRIPTION
-.B ggsn
+.B osmo-ggsn
is part of the
-.B OpenGGSN
+.B OsmoGGSN
project, and implements a Gateway GPRS Support Node. It is used by
mobile operators as the interface between the Internet and the rest of
the mobile network infrastructure.
@@ -62,14 +62,14 @@ over IP.
The other interface can be thought of as the uplink interface, and
interfaces the GGSN to an external data network. Gi is most often an
interface to the Internet.
-.B ggsn
+.B osmo-ggsn
uses the
.B TUN/TAP driver
for the Gi interface. A tun network interface is established when the
-.B ggsn
+.B osmo-ggsn
is started.
-.B ggsn
+.B osmo-ggsn
will accept incoming connections from mobile stations through the
radio access network and the SGSN. When a connection request is
received the ggsn will allocate a dynamic IP address for the mobile
@@ -79,7 +79,7 @@ the SGSN. Runtime errors are reported using the Osmocom logging
framework.
Typically
-.B ggsn
+.B osmo-ggsn
will be deployed with two Ethernet interfaces. One for the Gn/Gp
interface, and one for the Gi interface. Policy routing and firewall
rules should be used in order to separate Gi traffic from Gn/Gp
@@ -105,25 +105,25 @@ Read configuration
(default = ./openggsn.cfg)
.SH FILES
-.I ./openggsn.cfg
+.I ./osmo-ggsn.cfg
.RS
The configuration file for
-.B ggsn.
+.B osmo-ggsn.
.RE
-.I /var/run/ggsn.pid
+.I /var/run/osmo-ggsn.pid
.RS
Process ID file.
.RE
-.I /var/lib/ggsn
+.I /var/lib/osmo-ggsn
.RS
Directory holding nonvolatile data.
.RE
.SH BUGS
-Report all bugs to the OpenGGSN bug tracking list at
+Report all bugs to the OsmoGGSN bug tracking list at
.I https://osmocom.org/projects/openggsn
-.B ggsn
+.B osmo-ggsn
has very limited management support. Currently both SNMP as well as
billing mechanisms are missing.
@@ -135,13 +135,13 @@ billing mechanisms are missing.
.LP
Besides the long options documented in this man page
-.B ggsn
+.B osmo-ggsn
also accepts a number of short options with the same functionality. Use
-.B ggsn --help
+.B osmo-ggsn --help
for a full list of all the available options.
The TUN/TAP driver is required for proper operation of
-.B ggsn.
+.B osmo-ggsn.
For linux kernels later than 2.4.7 the TUN/TAP driver is included in the kernel, but typically needs to be loaded manually with
.B modprobe tun.
For automatic loading the line
@@ -152,7 +152,7 @@ For other platforms see
.I http://vtun.sourceforge.net/tun/
for information on how to install and configure the tun driver.
-.B ggsn
+.B osmo-ggsn
uses the GPRS Tunneling Protocol (GTP) as specified by the Third
Generation Partnership Project (3GPP). 3GPP protocols specifications
can be found at
diff --git a/doc/sgsnemu.8 b/doc/sgsnemu.8
index af8f3ff..197bd5d 100644
--- a/doc/sgsnemu.8
+++ b/doc/sgsnemu.8
@@ -1,5 +1,5 @@
-.\" * OpenGGSN - Gateway GPRS Support Node
+.\" * OsmoGGSN - Gateway GPRS Support Node
.\" * Copyright (C) 2002, 2003 Mondru AB.
.\" *
.\" * The contents of this file may be used under the terms of the GNU
@@ -90,7 +90,7 @@ sgsnemu \- Serving GPRS Support Node Emulator
.SH DESCRIPTION
.B sgsnemu
is part of the
-.B OpenGGSN
+.B OsmoGGSN
project, and implements a Serving GPRS Support Node (SGSN)
emulator. It can be used for testing Gateway GPRS Support Nodes
(GGSNs), GPRS core networks as well as GPRS roaming connections.
@@ -348,8 +348,8 @@ Directory holding nonvolatile data.
.RE
.SH BUGS
-Report all bugs to the OpenGGSN bug tracking list at
-.I http://sourceforge.net/projects/sgsnemu/
+Report all bugs to the OsmoGGSN bug tracking list at
+.I http://osmocom.org/projects/openggsn/issues
.SH "SEE ALSO"