openswan/programs/tncfg/tncfg.5

   1 '\" t
   2 .\"     Title: IPSEC_TNCFG
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 10/06/2010
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "IPSEC_TNCFG" "5" "10/06/2010" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 ipsec_tncfg \- lists IPSEC virtual interfaces attached to real interfaces
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBipsec\fR\ 'u
  25 \fBipsec\fR \fItncfg\fR
  26 .br
  27 \fIcat/proc/net/ipsec_tncfg\fR
  28 .SH "OBSOLETE"
  29 .PP
  30 Note that tncfg is only supported on the classic KLIPS stack\&. It is not supported on any other stack and will be completely removed in future versions\&. A replacement command still needs to be designed
  31 .SH "DESCRIPTION"
  32 .PP
  33 /proc/net/ipsec_tncfg
  34 is a read\-only file which lists which IPSEC virtual interfaces are attached to which real interfaces, through which packets will be forwarded once processed by IPSEC\&.
  35 .PP
  36 Each line lists one ipsec I/F\&. A table entry consists of:
  37 .PP
  38 +
  39 .RS 4
  40 an ipsec virtual I/F name
  41 .RE
  42 .PP
  43 +
  44 .RS 4
  45 a visual and machine parsable separator \'\->\', separating the virtual I/F and the physical I/F,
  46 .RE
  47 .PP
  48 +
  49 .RS 4
  50 a physical I/F name, to which the ipsec virtual I/F is attached or NULL if it is not attached,
  51 .RE
  52 .PP
  53 +
  54 .RS 4
  55 the keyword
  56 \fBmtu=\fR,
  57 .RE
  58 .PP
  59 +
  60 .RS 4
  61 the MTU of the ipsec virtual I/F,
  62 .RE
  63 .PP
  64 +
  65 .RS 4
  66 the automatically adjusted effective MTU for PMTU discovery, in brackets,
  67 .RE
  68 .PP
  69 +
  70 .RS 4
  71 a visual and machine parsable separator \'\->\', separating the virtual I/F MTU and the physical I/F MTU,
  72 .RE
  73 .PP
  74 +
  75 .RS 4
  76 the MTU of the attached physical I/F\&.
  77 .RE
  78 .SH "EXAMPLES"
  79 .PP
  80 \fBipsec2 \-> eth3 mtu=16260(1443) \-> 1500\fR
  81 .RS 4
  82 .RE
  83 .PP
  84 shows that virtual device
  85 \fBipsec2\fR
  86 with an MTU of
  87 16260
  88 is connected to physical device
  89 \fBeth3\fR
  90 with an MTU of
  91 1500
  92 and that the effective MTU as a result of PMTU discovery has been automatically set to
  93 1443\&.
  94 .PP
  95 \fBipsec0 \-> wvlan0 mtu=1400(16260) \-> 1500\fR
  96 .RS 4
  97 .RE
  98 .PP
  99 shows that virtual device
 100 \fBipsec0\fR
 101 with an MTU of
 102 1400
 103 is connected to physical device
 104 \fBwvlan0\fR
 105 with an MTU of
 106 1500
 107 and no PMTU packets have gotten far enough to bump down the effective MTU from its default of 16260\&.
 108 .PP
 109 \fBipsec3 \-> NULL mtu=0(0) \-> 0\fR
 110 .RS 4
 111 .RE
 112 .PP
 113 shows that virtual device
 114 \fBipsec3\fR
 115 is not connected to any physical device\&.
 116 .SH "FILES"
 117 .PP
 118 /proc/net/ipsec_tncfg, /usr/local/bin/ipsec
 119 .SH "SEE ALSO"
 120 .PP
 121 ipsec(8), ipsec_manual(8), ipsec_eroute(5), ipsec_spi(5), ipsec_spigrp(5), ipsec_klipsdebug(5), ipsec_tncfg(8), ipsec_version(5), ipsec_pf_key(5)
 122 .SH "HISTORY"
 123 .PP
 124 Written for the Linux FreeS/WAN project <\m[blue]\fBhttp://www\&.freeswan\&.org/\fR\m[]> by Richard Guy Briggs\&.