Introduce a VTY, factually turning OpenGGSN into an Osmocom program

Change-Id: I9613ca3436e77ea132c47f0096df7c5050d7e826

1 files changed, 12 insertions, 99 deletions

diff --git a/doc/ggsn.8 b/doc/ggsn.8
index 62d467a..89dcb61b 100644
--- a/doc/ggsn.8
+++ b/doc/ggsn.8
@@ -31,33 +31,13 @@ ggsn \- Gateway GPRS Support Node.
 
 .B ggsn
 [
-.BI \-\-fg
+.BI \-\-help
 ] [
-.BI \-\-debug
+.BI \-\-daemonize
 ] [
-.BI \-\-conf " file"
+.BI \-\-config-file " file"
 ] [
-.BI \-\-pidfile " file"
-] [
-.BI \-\-statedir " file" 
-] [ 
-.BI \-\-listen " host" 
-] [
-.BI \-\-net " net" 
-] [
-.BI \-\-ipup " script" 
-] [
-.BI \-\-ipdown " script" 
-] [
-.BI \-\-dynip " net" 
-] [
-.BI \-\-statip " net" 
-] [
-.BI \-\-pcodns1 " host" 
-] [
-.BI \-\-pcodns2 " host" 
-] [
-.BI \-\-timelimit " seconds" 
+.BI \-\-version
 ]
 .SH DESCRIPTION
 .B ggsn
@@ -115,86 +95,17 @@ Print help and exit.
 Print version and exit.
 
 .TP
-.BI --fg
-Run in foreground (default = off)
+.BI --daemonize
+Run in background as a daemon (default = off)
 
 .TP
-.BI --debug
-Run in debug mode (default = off)
-
-.TP
-.BI --conf " file"
+.BI --config-file " file"
 Read configuration 
 .I file
-(default = /etc/ggsn.conf) where each line corresponds to one command
-line option, but with the leading '--' removed. Command line options
-override the options given in the configuration file.
-
-.TP
-.BI --pidfile " file"
-Filename of process id 
-.I file
-(default = /var/run/ggsn.pid)
-
-.TP
-.BI --statedir " path"
-.I path
-to directory of nonvolatile data (default = /var/lib/ggsn/)
-
-.TP
-.BI --listen " host"
-Local interface IP address to use for the Gn/Gp interface. This option
-must be specified. For security issues it is not possible to use
-INADDR_ANY.
-
-.TP
-.BI --net " net"
-Network address of the Gi interface (default = 192.168.0.0/24). The
-network address is set during initialisation when
-.B ggsn
-establishes a tun device for the Gi interface.
-
-.TP
-.BI --ipup " script"
-Script executed after the Gi tun network interface has been brought
-up.  Executed with the following parameters: <devicename> <ip address>
-
-.TP
-.BI --ipdown " script"
-Script executed after the Gi tun network interface has been taken
-down.  Executed with the following parameters: <devicename> <ip
-address>
-
-.TP
-.BI --dynip " net"
-Dynamic IP address pool. Specifies a pool of dynamic IP addresses. If
-this option is omitted the network address specified by the
-.BI --net
-option is used for dynamic IP address allocation.
-
-.TP
-.BI --pcodns1 " host"
-PCO DNS Server 1 (default = 0.0.0.0). PCO stands for Protocol
-Configuration options, and is part of the GPRS protocols. It is used
-to inform the mobile station about the DNS address to use for host
-name resolution.
-
-.TP
-.BI --pcodns2 " host"
-PCO DNS Server 2 (default = 0.0.0.0). PCO stands for Protocol
-Configuration options, and is part of the GPRS protocols. It is used
-to inform the mobile station about the DNS address to use for host
-name resolution.
-
-.TP
-.BI --timelimit " seconds"
-Exit 
-.B ggsn
-after \fIseconds\fP. Used for debugging.
-
+(default = ./openggsn.cfg)
 
 .SH FILES
-.I /etc/ggsn.conf
+.I ./openggsn.cfg
 .RS
 The configuration file for
 .B ggsn.
@@ -210,7 +121,7 @@ Directory holding nonvolatile data.
 
 .SH BUGS
 Report all bugs to the OpenGGSN bug tracking list at 
-.I http://sourceforge.net/projects/ggsn/
+.I https://osmocom.org/projects/openggsn
 
 .B ggsn
 has very limited management support. Currently both SNMP as well as
@@ -250,6 +161,7 @@ can be found at
 .SH COPYRIGHT
 
 Copyright (C) 2002, 2003 by Mondru AB.
+Copyright (C) 2017 Harald Welte
 
 The contents of this file may be used under the terms of the GNU
 General Public License Version 2, provided that the above copyright
@@ -258,3 +170,4 @@ substantial portions of the software.
 
 .SH AUTHORS
 Jens Jakobsen <jj@openggsn.org>
+Harald Welte <laforge@gnumonks.org>