Go to file
David Ward cbec021913 xfrm: Update documentation
The ip(8) man page and the "ip xfrm [ XFRM-OBJECT ] help" command output
are updated to include missing options, fix errors, and improve grammar.
There are no functional changes made.

The documentation for the ip command has many different meanings for the
same formatting symbols (which really needs to be fixed). This patch makes
consistent use of brackets [ ] to indicate optional parameters, pipes | to
mean "OR", braces { } to group things together, and dashes - instead of
underscores _ inside of parameter names. The parameters are listed in the
order in which they are parsed in the source code.

There are several parameters and options that are still not mentioned or
need to be described more thoroughly in the "COMMAND SYNTAX" section of
the ip(8) man page. I would appreciate help from the developers with this.

Signed-off-by: David Ward <david.ward@ll.mit.edu>
2011-07-11 10:12:06 -07:00
doc doc: add pdf targets 2011-04-12 14:28:04 -07:00
etc/iproute2 iproute2: support listing devices by group 2011-02-25 12:38:50 -08:00
examples gaiconf: /etc/gai.conf configuration helper. 2010-03-29 13:59:28 -07:00
genl Add no-strict-aliasing to genl 2011-04-12 14:23:06 -07:00
include v2.6.39 2011-06-29 16:01:48 -07:00
ip xfrm: Update documentation 2011-07-11 10:12:06 -07:00
lib libnetlink: fix set never used warning 2011-06-20 14:34:46 -07:00
man xfrm: Update documentation 2011-07-11 10:12:06 -07:00
misc ss: check result of readlink 2011-06-29 15:58:37 -07:00
netem netem: fix installs of dist files 2010-07-31 19:31:04 -07:00
tc xt match: fix set-never-used warning 2011-06-29 15:59:41 -07:00
testsuite Fix modes of test files 2007-09-05 12:00:01 +01:00
.gitignore Ignore GDB related files 2009-11-13 14:20:41 -08:00
COPYING Update address of FSF in license 2008-03-08 13:31:03 -08:00
ChangeLog Backout the 2.4 utsname hash patch. 2006-03-22 00:07:49 +00:00
Makefile Remove -L flags from link 2011-03-09 10:18:03 -08:00
README iproute2: fix minor typo in comments 2011-07-11 10:11:09 -07:00
README.decnet Decnet documentation update 2005-06-13 18:47:56 +00:00
README.devel iproute2: fix minor typo in comments 2011-07-11 10:11:09 -07:00
README.distribution Rename: tc/README.distribution -> README.distribution 2004-08-23 20:21:21 +00:00
README.iproute2+tc (Logical change 1.3) 2004-04-15 20:56:59 +00:00
README.lnstat Rename: misc/README.lnstat -> README.lnstat 2004-10-19 20:24:47 +00:00
RELNOTES (Logical change 1.3) 2004-04-15 20:56:59 +00:00
configure iproute2: fix minor typo in comments 2011-07-11 10:11:09 -07:00

README

This is a set of utilities for Linux networking.

Information:
    http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2

Download:
    http://devresources.linuxfoundation.org/dev/iproute2/download

Repository:
    git://git.kernel.org/pub/scm/linux/kernel/git/shemminger/iproute2.git

How to compile this.
--------------------
1. libdbm

arpd needs to have the db4 development libraries. For debian
users this is the package with a name like libdb4.x-dev.
DBM_INCLUDE points to the directory with db_185.h which
is the include file used by arpd to get to the old format Berkely
database routines.  Often this is in the db-devel package.

2. make

The makefile will automatically build a Config file which
contains whether or not ATM is available, etc.

3. To make documentation, cd to doc/ directory , then
   look at start of Makefile and set correct values for
   PAGESIZE=a4		, ie: a4 , letter ...	(string)
   PAGESPERPAGE=2	, ie: 1 , 2 ...		(numeric)
   and make there. It assumes, that latex, dvips and psnup
   are in your path.

4. This package includes matching sanitized kernel headers because
   the build environment may not have up to date versions. See Makefile
   if you have special requirements and need to point at different
   kernel include files.

Stephen Hemminger
shemminger@linux-foundation.org

Alexey Kuznetsov
kuznet@ms2.inr.ac.ru