mirror of
https://git.proxmox.com/git/mirror_iproute2
synced 2025-10-07 14:17:22 +00:00
Update ip address manual page
* update synopsis to match "ip address help" output * specify IPv4, since "IP" is ambiguous * remove deprecated site scope * document lifetimes, home, and nodad * update wording to make sense since page was split from the ip(8) page * git rid of extra spaces
This commit is contained in:
parent
90d98edf39
commit
43d29f782f
@ -1,4 +1,4 @@
|
|||||||
.TH "IP\-ADDRESS" 8 "20 Dec 2011" "iproute2" "Linux"
|
.TH "IP\-ADDRESS" 8 "04 March 2012" "iproute2" "Linux"
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
ip-address \- protocol address management
|
ip-address \- protocol address management
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
@ -14,7 +14,12 @@ ip-address \- protocol address management
|
|||||||
.sp
|
.sp
|
||||||
|
|
||||||
.ti -8
|
.ti -8
|
||||||
.BR "ip address" " { " add " | " del " } "
|
.BR "ip address" " { " add " | " change " | " replace " } "
|
||||||
|
.IB IFADDR " dev " STRING
|
||||||
|
.RI "[ " LIFETIME " ] [ " CONFFLAG-LIST " ]"
|
||||||
|
|
||||||
|
.ti -8
|
||||||
|
.BR "ip address del"
|
||||||
.IB IFADDR " dev " STRING
|
.IB IFADDR " dev " STRING
|
||||||
|
|
||||||
.ti -8
|
.ti -8
|
||||||
@ -51,12 +56,30 @@ ip-address \- protocol address management
|
|||||||
.ti -8
|
.ti -8
|
||||||
.IR FLAG " := "
|
.IR FLAG " := "
|
||||||
.RB "[ " permanent " | " dynamic " | " secondary " | " primary " | "\
|
.RB "[ " permanent " | " dynamic " | " secondary " | " primary " | "\
|
||||||
tentative " | " deprecated " | " dadfailed " | " temporary " ]"
|
tentative " | " deprecated " | " dadfailed " | " temporary " | " CONFFLAG-LIST " ]"
|
||||||
|
|
||||||
|
.ti -8
|
||||||
|
.IR CONFFLAG-LIST " := [ " CONFFLAG-LIST " ] " CONFFLAG
|
||||||
|
|
||||||
|
.ti -8
|
||||||
|
.IR CONFFLAG " := "
|
||||||
|
.RB "[ " home " | " nodad " ]"
|
||||||
|
|
||||||
|
.ti -8
|
||||||
|
.IR LIFETIME " := [ "
|
||||||
|
.BI valid_lft " LFT"
|
||||||
|
.RB "| " preferred_lft
|
||||||
|
.IR LFT " ]"
|
||||||
|
|
||||||
|
.ti -8
|
||||||
|
.IR LFT " := [ "
|
||||||
|
.BR forever " |"
|
||||||
|
.IR SECONDS " ]"
|
||||||
|
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
The
|
The
|
||||||
.B address
|
.B address
|
||||||
is a protocol (IP or IPv6) address attached
|
is a protocol (IPv4 or IPv6) address attached
|
||||||
to a network device. Each device must have at least one address
|
to a network device. Each device must have at least one address
|
||||||
to use the corresponding protocol. It is possible to have several
|
to use the corresponding protocol. It is possible to have several
|
||||||
different addresses attached to one device. These addresses are not
|
different addresses attached to one device. These addresses are not
|
||||||
@ -123,10 +146,6 @@ Predefined scope values are:
|
|||||||
.B global
|
.B global
|
||||||
- the address is globally valid.
|
- the address is globally valid.
|
||||||
.sp
|
.sp
|
||||||
.B site
|
|
||||||
- (IPv6 only) the address is site local, i.e. it is
|
|
||||||
valid inside this site.
|
|
||||||
.sp
|
|
||||||
.B link
|
.B link
|
||||||
- the address is link local, i.e. it is valid only on this device.
|
- the address is link local, i.e. it is valid only on this device.
|
||||||
.sp
|
.sp
|
||||||
@ -134,6 +153,28 @@ valid inside this site.
|
|||||||
- the address is valid only inside this host.
|
- the address is valid only inside this host.
|
||||||
.in -8
|
.in -8
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI valid_lft " LFT"
|
||||||
|
(IPv6 only) the valid lifetime of this address; see section 5.5.4 of
|
||||||
|
RFC 4862. Defaults to
|
||||||
|
.BR "forever" .
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI preferred_lft " LFT"
|
||||||
|
(IPv6 only) the preferred lifetime of this address; see section 5.5.4
|
||||||
|
of RFC 4862. Defaults to
|
||||||
|
.BR "forever" .
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B home
|
||||||
|
(IPv6 only) designates this address the "home address" as defined in
|
||||||
|
RFC 6275.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B nodad
|
||||||
|
(IPv6 only) do not perform Duplicate Address Detection (RFC 4862) when
|
||||||
|
adding this address.
|
||||||
|
|
||||||
.SS ip address delete - delete protocol address
|
.SS ip address delete - delete protocol address
|
||||||
.B Arguments:
|
.B Arguments:
|
||||||
coincide with the arguments of
|
coincide with the arguments of
|
||||||
@ -200,17 +241,16 @@ The difference is that it does not run when no arguments are given.
|
|||||||
|
|
||||||
.PP
|
.PP
|
||||||
.B Warning:
|
.B Warning:
|
||||||
This command (and other
|
This command and other
|
||||||
.B flush
|
.B flush
|
||||||
commands described below) is pretty dangerous. If you make a mistake,
|
commands are unforgiving. They will cruelly purge all the addresses.
|
||||||
it will not forgive it, but will cruelly purge all the addresses.
|
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
With the
|
With the
|
||||||
.B -statistics
|
.B -statistics
|
||||||
option, the command becomes verbose. It prints out the number of deleted
|
option, the command becomes verbose. It prints out the number of deleted
|
||||||
addresses and the number of rounds made to flush the address list. If
|
addresses and the number of rounds made to flush the address list.
|
||||||
this option is given twice,
|
If this option is given twice,
|
||||||
.B ip address flush
|
.B ip address flush
|
||||||
also dumps all the deleted addresses in the format described in the
|
also dumps all the deleted addresses in the format described in the
|
||||||
previous subsection.
|
previous subsection.
|
||||||
|
Loading…
Reference in New Issue
Block a user