~ubuntu-branches/ubuntu/oneiric/openvpn/oneiric

« back to all changes in this revision

Viewing changes to openvpn.8

  • Committer: Bazaar Package Importer
  • Author(s): Thierry Carrez
  • Date: 2008-10-07 16:30:44 UTC
  • mfrom: (1.1.11 upstream) (10.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20081007163044-ixx04wg588z1972e
Tags: 2.1~rc11-1ubuntu1
* Merge with Debian (LP: #279655), remaining diffs:
  - debian/openvpn.init.d: Added 'status' action to init script, show
    per-VPN result messages and add "--script-security 2" by default for
    backwards compatibility
  - debian/control: Added lsb-base>=3.2-14 depend to allow status_of_proc()
* Fixes regression when calling commands with arguments (LP: #277447)

Show diffs side-by-side

added added

removed removed

Lines of Context:
98
98
.ti -4
99
99
.B openvpn
100
100
[\ \fB\-\-allow\-nonadmin\fR\ \fI[TAP\-adapter]\fR\ ]
 
101
[\ \fB\-\-allow\-pull\-fqdn\fR\ ]
101
102
[\ \fB\-\-askpass\fR\ \fI[file]\fR\ ]
102
103
[\ \fB\-\-auth\-nocache\fR\ ]
103
104
[\ \fB\-\-auth\-retry\fR\ \fItype\fR\ ]
1214
1215
address if OpenVPN is being run in client mode, and is undefined in server mode.
1215
1216
.\"*********************************************************
1216
1217
.TP
1217
 
.B --route-gateway gw
 
1218
.B --route-gateway gw|'dhcp'
1218
1219
Specify a default gateway
1219
1220
.B gw
1220
1221
for use with
1221
1222
.B --route.
 
1223
 
 
1224
If
 
1225
.B dhcp
 
1226
is specified as the parameter,
 
1227
the gateway address will be extracted from a DHCP
 
1228
negotiation with the OpenVPN server-side LAN.
 
1229
.\"*********************************************************
1222
1230
.TP
1223
1231
.B --route-metric m
1224
1232
Specify a default metric
1293
1301
to set the TCP/IP properties of the client's TUN/TAP interface.
1294
1302
.\"*********************************************************
1295
1303
.TP
 
1304
.B --allow-pull-fqdn
 
1305
Allow client to pull DNS names from server (rather than being limited
 
1306
to IP address) for
 
1307
.B --ifconfig,
 
1308
.B --route,
 
1309
and
 
1310
.B --route-gateway.
 
1311
.\"*********************************************************
 
1312
.TP
1296
1313
.B --redirect-gateway flags...
1297
1314
(Experimental) Automatically execute routing commands to cause all outgoing IP traffic
1298
1315
to be redirected over the VPN.
2607
2624
instead.
2608
2625
.\"*********************************************************
2609
2626
.TP
2610
 
.B --server-bridge gateway netmask pool-start-IP pool-end-IP
 
2627
.B --server-bridge [ gateway netmask pool-start-IP pool-end-IP ]
2611
2628
 
2612
2629
A helper directive similar to
2613
2630
.B --server
2614
2631
which is designed to simplify the configuration
2615
2632
of OpenVPN's server mode in ethernet bridging configurations.
2616
2633
 
 
2634
If
 
2635
.B --server-bridge
 
2636
is used without any parameters, it will enable a DHCP-proxy
 
2637
mode, where connecting OpenVPN clients will receive an IP
 
2638
address for their TAP adapter from the DHCP server running
 
2639
on the OpenVPN server-side LAN.
 
2640
Note that only clients that support
 
2641
the binding of a DHCP client with the TAP adapter (such as
 
2642
Windows) can support this mode.
 
2643
 
2617
2644
To configure ethernet bridging, you 
2618
2645
must first use your OS's bridging capability
2619
2646
to bridge the TAP interface with the ethernet
2662
2689
.LP
2663
2690
.RE
2664
2691
.fi
 
2692
 
 
2693
In another example,
 
2694
.B --server-bridge
 
2695
(without parameters) expands as follows:
 
2696
 
 
2697
.RS
 
2698
.ft 3
 
2699
.nf
 
2700
.sp
 
2701
mode server
 
2702
tls-server
 
2703
 
 
2704
push "route-gateway dhcp"
 
2705
.ft
 
2706
.LP
 
2707
.RE
 
2708
.fi
2665
2709
.\"*********************************************************
2666
2710
.TP
2667
2711
.B --push "option"