GitLab/ocserv
1
0
Fork 0
mirror of https://gitlab.com/openconnect/ocserv.git synced 2026-02-10 08:46:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc update

Browse Source
This commit is contained in:
Nikos Mavrogiannopoulos
2013-11-02 16:25:23 +01:00
parent 1d4d4e731a
commit 05a8f946c4
3 changed files with 45 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/ocserv-args.c
View File

@@ -2,7 +2,7 @@
*
* DO NOT EDIT THIS FILE (ocserv-args.c)
*
* It has been AutoGen-ed October 30, 2013 at 09:30:09 AM by AutoGen 5.17
* It has been AutoGen-ed November 2, 2013 at 04:25:18 PM by AutoGen 5.17
* From the definitions ocserv-args.def
* and the template file options
*
@@ -65,7 +65,7 @@ extern FILE * option_usage_fp;
/*
* ocserv option static const strings
*/
static char const ocserv_opt_strs[1834] =
static char const ocserv_opt_strs[1582] =
/* 0 */ "ocserv 0.2.0\n"
"Copyright (C) 2013 Nikos Mavrogiannopoulos, all rights reserved.\n"
"This is free software. It is licensed for use, modification and\n"
@@ -106,13 +106,9 @@ static char const ocserv_opt_strs[1834] =
/* 1320 */ "\n"
"Openconnect VPN server (ocserv) is a VPN server compatible with the\n"
"openconnect VPN client. It follows the AnyConnect VPN protocol which is\n"
"used by several CISCO routers.\n\n"
"This server supports multiple authentication methods, including PAM and\n"
"certificate authentication. Authenticated users are assigned an\n"
"unprivileged worker process and obtain a networking (tun) device and an IP\n"
"from a configurable pool of addresses.\n\0"
/* 1746 */ "ocserv 0.2.0\0"
/* 1759 */ "Usage: ocserv [options] -c [config]\n"
"used by several CISCO routers.\n\0"
/* 1494 */ "ocserv 0.2.0\0"
/* 1507 */ "Usage: ocserv [options] -c [config]\n"
"ocserv --help for usage instructions.\n";
/*
@@ -288,7 +284,7 @@ static tOptDesc optDesc[OPTION_CT] = {
#define zBugsAddr (ocserv_opt_strs+1279)
#define zExplain (ocserv_opt_strs+1317)
#define zDetail (ocserv_opt_strs+1320)
#define zFullVersion (ocserv_opt_strs+1746)
#define zFullVersion (ocserv_opt_strs+1494)
/* extracted from optcode.tlib near line 353 */
#if defined(ENABLE_NLS)
@@ -302,7 +298,7 @@ static tOptDesc optDesc[OPTION_CT] = {
#define ocserv_full_usage (NULL)
#define ocserv_short_usage (ocserv_opt_strs+1759)
#define ocserv_short_usage (ocserv_opt_strs+1507)
#endif /* not defined __doxygen__ */

42
src/ocserv-args.def
View File

@@ -15,11 +15,7 @@ explain = "";
detail = "Openconnect VPN server (ocserv) is a VPN server compatible with the
openconnect VPN client. It follows the AnyConnect VPN protocol which
is used by several CISCO routers.
This server supports multiple authentication methods,
including PAM and certificate authentication. Authenticated users are
assigned an unprivileged worker process and obtain a networking (tun) device
and an IP from a configurable pool of addresses.";
";
copyright = {
date = "2013";
@@ -309,6 +305,42 @@ route = 192.168.5.0/255.255.255.0
_EOT_;
};
doc-section = {
ds-type = 'SYNOPSIS';
ds-format = 'texi';
ds-text = <<-_EOT_
Openconnect VPN server (ocserv) is a VPN server compatible with the
openconnect VPN client. It follows the AnyConnect VPN protocol which
is used by several CISCO routers.
_EOT_;
};
doc-section = {
ds-type = 'DESCRIPTION';
ds-format = 'texi';
ds-text = <<-_EOT_
This a standalone server that reads a configuration file (see below for more details),
and waits for client connections.
The server maintains two connections/channels with the client. The main VPN
channel is established over TCP and TLS. This is the control channel as well
as the backup data channel. After its establishment a UDP channel using DTLS
is initiated which serves as the main data channel. If the UDP channel fails
to establish or is temporarily unavailable the backup channel over TCP/TLS
is being used.
This server supports multiple authentication methods,
including PAM and certificate authentication. Authenticated users are
assigned an unprivileged worker process and obtain a networking (tun) device
and an IP from a configurable pool of addresses.
Once authenticated, the server provides the client with an IP address and a list
of routes that it may access. In order to allow high-speed transfers the
server does not process or filter packets. It is expected that the server has
or will set up any required routes or firewall rules.
_EOT_;
};
doc-section = {
ds-type = 'AUTHENTICATION';
ds-format = 'texi';

2
src/ocserv-args.h
View File

@@ -2,7 +2,7 @@
*
* DO NOT EDIT THIS FILE (ocserv-args.h)
*
* It has been AutoGen-ed October 30, 2013 at 09:30:09 AM by AutoGen 5.17
* It has been AutoGen-ed November 2, 2013 at 04:25:18 PM by AutoGen 5.17
* From the definitions ocserv-args.def
* and the template file options
*