man: break long lines in man page sources

No impact for output, just easier to edit.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
This commit is contained in:
Stephen Hemminger 2019-03-22 09:46:40 -07:00
parent b5a754b1db
commit f76ad635f2
4 changed files with 190 additions and 103 deletions

View File

@ -364,28 +364,34 @@ switch.
.TP .TP
.BR "mcast_flood on " or " mcast_flood off " .BR "mcast_flood on " or " mcast_flood off "
Controls whether a given port will flood multicast traffic for which there is no MDB entry. By default this flag is on. Controls whether a given port will flood multicast traffic for which
there is no MDB entry. By default this flag is on.
.TP .TP
.BR "mcast_to_unicast on " or " mcast_to_unicast off " .BR "mcast_to_unicast on " or " mcast_to_unicast off "
Controls whether a given port will replicate packets using unicast instead of multicast. By default this flag is off. Controls whether a given port will replicate packets using unicast
instead of multicast. By default this flag is off.
.TP .TP
.BR "neigh_suppress on " or " neigh_suppress off " .BR "neigh_suppress on " or " neigh_suppress off "
Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off. Controls whether neigh discovery (arp and nd) proxy and suppression is
enabled on the port. By default this flag is off.
.TP .TP
.BR "vlan_tunnel on " or " vlan_tunnel off " .BR "vlan_tunnel on " or " vlan_tunnel off "
Controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off. Controls whether vlan to tunnel mapping is enabled on the port. By
default this flag is off.
.TP .TP
.BR "isolated on " or " isolated off " .BR "isolated on " or " isolated off "
Controls whether a given port will be isolated, which means it will be able to communicate with non-isolated ports only. Controls whether a given port will be isolated, which means it will be
By default this flag is off. able to communicate with non-isolated ports only. By default this
flag is off.
.TP .TP
.BI backup_port " DEVICE" .BI backup_port " DEVICE"
If the port loses carrier all traffic will be redirected to the configured backup port If the port loses carrier all traffic will be redirected to the
configured backup port
.TP .TP
.BR nobackup_port .BR nobackup_port
@ -639,9 +645,9 @@ the VLAN ID that identifies the vlan.
.TP .TP
.BI tunnel_info " TUNNEL_ID" .BI tunnel_info " TUNNEL_ID"
the TUNNEL ID that maps to this vlan. The tunnel id is set in dst_metadata for the TUNNEL ID that maps to this vlan. The tunnel id is set in
every packet that belongs to this vlan (applicable to bridge ports with vlan_tunnel dst_metadata for every packet that belongs to this vlan (applicable to
flag set). bridge ports with vlan_tunnel flag set).
.TP .TP
.BI pvid .BI pvid

View File

@ -362,15 +362,18 @@ specifies the number of receive queues for new device.
.TP .TP
.BI gso_max_size " BYTES " .BI gso_max_size " BYTES "
specifies the recommended maximum size of a Generic Segment Offload packet the new device should accept. specifies the recommended maximum size of a Generic Segment Offload
packet the new device should accept.
.TP .TP
.BI gso_max_segs " SEGMENTS " .BI gso_max_segs " SEGMENTS "
specifies the recommended maximum number of a Generic Segment Offload segments the new device should accept. specifies the recommended maximum number of a Generic Segment Offload
segments the new device should accept.
.TP .TP
.BI index " IDX " .BI index " IDX "
specifies the desired index of the new virtual device. The link creation fails, if the index is busy. specifies the desired index of the new virtual device. The link
creation fails, if the index is busy.
.TP .TP
VLAN Type Support VLAN Type Support
@ -420,13 +423,14 @@ the following additional arguments are supported:
.in +4 .in +4
If If
.BR reorder_hdr " is " on .BR reorder_hdr " is " on
then VLAN header will be not inserted immediately but only before passing to the then VLAN header will be not inserted immediately but only before
physical device (if this device does not support VLAN offloading), the similar passing to the physical device (if this device does not support VLAN
on the RX direction - by default the packet will be untagged before being offloading), the similar on the RX direction - by default the packet
received by VLAN device. Reordering allows to accelerate tagging on egress and will be untagged before being received by VLAN device. Reordering
to hide VLAN header on ingress so the packet looks like regular Ethernet packet, allows to accelerate tagging on egress and to hide VLAN header on
at the same time it might be confusing for packet capture as the VLAN header ingress so the packet looks like regular Ethernet packet, at the same
does not exist within the packet. time it might be confusing for packet capture as the VLAN header does
not exist within the packet.
VLAN offloading can be checked by VLAN offloading can be checked by
.BR ethtool "(8):" .BR ethtool "(8):"
@ -441,10 +445,12 @@ where <phy_dev> is the physical device to which VLAN device is bound.
.in -4 .in -4
.BR gvrp " { " on " | " off " } " .BR gvrp " { " on " | " off " } "
- specifies whether this VLAN should be registered using GARP VLAN Registration Protocol. - specifies whether this VLAN should be registered using GARP VLAN
Registration Protocol.
.BR mvrp " { " on " | " off " } " .BR mvrp " { " on " | " off " } "
- specifies whether this VLAN should be registered using Multiple VLAN Registration Protocol. - specifies whether this VLAN should be registered using Multiple VLAN
Registration Protocol.
.BR loose_binding " { " on " | " off " } " .BR loose_binding " { " on " | " off " } "
- specifies whether the VLAN device state is bound to the physical device state. - specifies whether the VLAN device state is bound to the physical device state.
@ -467,7 +473,8 @@ Linux packet priority can be set by
-t mangle -A POSTROUTING [...] -j CLASSIFY --set-class 0:4 -t mangle -A POSTROUTING [...] -j CLASSIFY --set-class 0:4
.sp .sp
.in -4 .in -4
and this "4" priority can be used in the egress qos mapping to set VLAN prio "5": and this "4" priority can be used in the egress qos mapping to set
VLAN prio "5":
.sp .sp
.in +4 .in +4
.B ip .B ip
@ -585,7 +592,8 @@ bit is not set.
.sp .sp
.BI dstport " PORT" .BI dstport " PORT"
- specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint. - specifies the UDP destination port to communicate to the remote
VXLAN tunnel endpoint.
.sp .sp
.BI srcport " MIN MAX" .BI srcport " MIN MAX"
@ -1424,22 +1432,39 @@ the following additional arguments are supported:
.in +8 .in +8
.sp .sp
.BI ageing_time " AGEING_TIME " .BI ageing_time " AGEING_TIME "
- configure the bridge's FDB entries ageing time, ie the number of seconds a MAC address will be kept in the FDB after a packet has been received from that address. after this time has passed, entries are cleaned up. - configure the bridge's FDB entries ageing time, ie the number of
seconds a MAC address will be kept in the FDB after a packet has been
received from that address. after this time has passed, entries are
cleaned up.
.BI group_fwd_mask " MASK " .BI group_fwd_mask " MASK "
- set the group forward mask. This is the bitmask that is applied to decide whether to forward incoming frames destined to link-local addresses, ie addresses of the form 01:80:C2:00:00:0X (defaults to 0, ie the bridge does not forward any link-local frames). - set the group forward mask. This is the bitmask that is applied to
decide whether to forward incoming frames destined to link-local
addresses, ie addresses of the form 01:80:C2:00:00:0X (defaults to 0,
ie the bridge does not forward any link-local frames).
.BI group_address " ADDRESS " .BI group_address " ADDRESS "
- set the MAC address of the multicast group this bridge uses for STP. The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..f]. - set the MAC address of the multicast group this bridge uses for STP.
The address must be a link-local address in standard Ethernet MAC
address format, ie an address of the form 01:80:C2:00:00:0X, with X
in [0, 4..f].
.BI forward_delay " FORWARD_DELAY " .BI forward_delay " FORWARD_DELAY "
- set the forwarding delay in seconds, ie the time spent in LISTENING state (before moving to LEARNING) and in LEARNING state (before moving to FORWARDING). Only relevant if STP is enabled. Valid values are between 2 and 30. - set the forwarding delay in seconds, ie the time spent in LISTENING
state (before moving to LEARNING) and in LEARNING state (before
moving to FORWARDING). Only relevant if STP is enabled. Valid values
are between 2 and 30.
.BI hello_time " HELLO_TIME " .BI hello_time " HELLO_TIME "
- set the time in seconds between hello packets sent by the bridge, when it is a root bridge or a designated bridges. Only relevant if STP is enabled. Valid values are between 1 and 10. - set the time in seconds between hello packets sent by the bridge,
when it is a root bridge or a designated bridges.
Only relevant if STP is enabled. Valid values are between 1 and 10.
.BI max_age " MAX_AGE " .BI max_age " MAX_AGE "
- set the hello packet timeout, ie the time in seconds until another bridge in the spanning tree is assumed to be dead, after reception of its last hello message. Only relevant if STP is enabled. Valid values are between 6 and 40. - set the hello packet timeout, ie the time in seconds until another
bridge in the spanning tree is assumed to be dead, after reception of
its last hello message. Only relevant if STP is enabled. Valid values
are between 6 and 40.
.BI stp_state " STP_STATE " .BI stp_state " STP_STATE "
- turn spanning tree protocol on - turn spanning tree protocol on
@ -1449,7 +1474,8 @@ or off
for this bridge. for this bridge.
.BI priority " PRIORITY " .BI priority " PRIORITY "
- set this bridge's spanning tree priority, used during STP root bridge election. - set this bridge's spanning tree priority, used during STP root
bridge election.
.I PRIORITY .I PRIORITY
is a 16bit unsigned integer. is a 16bit unsigned integer.
@ -1509,21 +1535,28 @@ or disable
IGMP querier, ie sending of multicast queries by the bridge (default: disabled). IGMP querier, ie sending of multicast queries by the bridge (default: disabled).
.BI mcast_querier_interval " QUERIER_INTERVAL " .BI mcast_querier_interval " QUERIER_INTERVAL "
- interval between queries sent by other routers. if no queries are seen after this delay has passed, the bridge will start to send its own queries (as if - interval between queries sent by other routers. if no queries are seen
after this delay has passed, the bridge will start to send its own queries
(as if
.BI mcast_querier .BI mcast_querier
was enabled). was enabled).
.BI mcast_hash_elasticity " HASH_ELASTICITY " .BI mcast_hash_elasticity " HASH_ELASTICITY "
- set multicast database hash elasticity, ie the maximum chain length in the multicast hash table (defaults to 4). - set multicast database hash elasticity, ie the maximum chain length
in the multicast hash table (defaults to 4).
.BI mcast_hash_max " HASH_MAX " .BI mcast_hash_max " HASH_MAX "
- set maximum size of multicast hash table (defaults to 512, value must be a power of 2). - set maximum size of multicast hash table (defaults to 512,
value must be a power of 2).
.BI mcast_last_member_count " LAST_MEMBER_COUNT " .BI mcast_last_member_count " LAST_MEMBER_COUNT "
- set multicast last member count, ie the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received (defaults to 2). - set multicast last member count, ie the number of queries the bridge
will send before stopping forwarding a multicast group after a "leave"
message has been received (defaults to 2).
.BI mcast_last_member_interval " LAST_MEMBER_INTERVAL " .BI mcast_last_member_interval " LAST_MEMBER_INTERVAL "
- interval between queries to find remaining members of a group, after a "leave" message is received. - interval between queries to find remaining members of a group,
after a "leave" message is received.
.BI mcast_startup_query_count " STARTUP_QUERY_COUNT " .BI mcast_startup_query_count " STARTUP_QUERY_COUNT "
- set the number of IGMP queries to send during startup phase (defaults to 2). - set the number of IGMP queries to send during startup phase (defaults to 2).
@ -1532,13 +1565,16 @@ was enabled).
- interval between queries in the startup phase. - interval between queries in the startup phase.
.BI mcast_query_interval " QUERY_INTERVAL " .BI mcast_query_interval " QUERY_INTERVAL "
- interval between queries sent by the bridge after the end of the startup phase. - interval between queries sent by the bridge after the end of the
startup phase.
.BI mcast_query_response_interval " QUERY_RESPONSE_INTERVAL " .BI mcast_query_response_interval " QUERY_RESPONSE_INTERVAL "
- set the Max Response Time/Maximum Response Delay for IGMP/MLD queries sent by the bridge. - set the Max Response Time/Maximum Response Delay for IGMP/MLD
queries sent by the bridge.
.BI mcast_membership_interval " MEMBERSHIP_INTERVAL " .BI mcast_membership_interval " MEMBERSHIP_INTERVAL "
- delay after which the bridge will leave a group, if no membership reports for this group are received. - delay after which the bridge will leave a group,
if no membership reports for this group are received.
.BI mcast_stats_enabled " MCAST_STATS_ENABLED " .BI mcast_stats_enabled " MCAST_STATS_ENABLED "
- enable - enable
@ -1615,9 +1651,9 @@ the following additional arguments are supported:
.sp .sp
.BI port " PORT " .BI port " PORT "
- sets the port number component of secure channel for this MACsec device, in a - sets the port number component of secure channel for this MACsec
range from 1 to 65535 inclusive. Numbers with a leading " 0 " or " 0x " are device, in a range from 1 to 65535 inclusive. Numbers with a leading "
interpreted as octal and hexadecimal, respectively. 0 " or " 0x " are interpreted as octal and hexadecimal, respectively.
.sp .sp
.BI sci " SCI " .BI sci " SCI "
@ -1639,7 +1675,8 @@ is a 64bit wide number in hexadecimal format.
.sp .sp
.BR "send_sci on " or " send_sci off" .BR "send_sci on " or " send_sci off"
- specifies whether the SCI is included in every packet, or only when it is necessary. - specifies whether the SCI is included in every packet,
or only when it is necessary.
.sp .sp
.BR "end_station on " or " end_station off" .BR "end_station on " or " end_station off"
@ -1736,9 +1773,9 @@ call.
.TP .TP
.BI dev " DEVICE " .BI dev " DEVICE "
.I DEVICE .I DEVICE
specifies network device to operate on. When configuring SR-IOV Virtual Function specifies network device to operate on. When configuring SR-IOV
(VF) devices, this keyword should specify the associated Physical Function (PF) Virtual Function (VF) devices, this keyword should specify the
device. associated Physical Function (PF) device.
.TP .TP
.BI group " GROUP " .BI group " GROUP "
@ -1770,13 +1807,16 @@ flag on the device.
.BR "protodown on " or " protodown off" .BR "protodown on " or " protodown off"
change the change the
.B PROTODOWN .B PROTODOWN
state on the device. Indicates that a protocol error has been detected on the port. Switch drivers can react to this error by doing a phys down on the switch port. state on the device. Indicates that a protocol error has been detected
on the port. Switch drivers can react to this error by doing a phys
down on the switch port.
.TP .TP
.BR "dynamic on " or " dynamic off" .BR "dynamic on " or " dynamic off"
change the change the
.B DYNAMIC .B DYNAMIC
flag on the device. Indicates that address can change when interface goes down (currently flag on the device. Indicates that address can change when interface
goes down (currently
.B NOT .B NOT
used by the Linux). used by the Linux).
@ -1821,8 +1861,8 @@ move the device to the network namespace associated with name
Some devices are not allowed to change network namespace: loopback, bridge, Some devices are not allowed to change network namespace: loopback, bridge,
ppp, wireless. These are network namespace local devices. In such case ppp, wireless. These are network namespace local devices. In such case
.B ip .B ip
tool will return "Invalid argument" error. It is possible to find out if device is local tool will return "Invalid argument" error. It is possible to find out
to a single network namespace by checking if device is local to a single network namespace by checking
.B netns-local .B netns-local
flag in the output of the flag in the output of the
.BR ethtool ":" .BR ethtool ":"
@ -1834,7 +1874,8 @@ flag in the output of the
To change network namespace for wireless devices the To change network namespace for wireless devices the
.B iw .B iw
tool can be used. But it allows to change network namespace only for physical devices and by process tool can be used. But it allows to change network namespace only for
physical devices and by process
.IR PID . .IR PID .
.TP .TP
@ -1887,11 +1928,12 @@ as 0 disables VLAN tagging and filtering for the VF.
.sp .sp
.BI proto " VLAN-PROTO" .BI proto " VLAN-PROTO"
- assign VLAN PROTOCOL for the VLAN tag, either 802.1Q or 802.1ad. - assign VLAN PROTOCOL for the VLAN tag, either 802.1Q or 802.1ad.
Setting to 802.1ad, all traffic sent from the VF will be tagged with VLAN S-Tag. Setting to 802.1ad, all traffic sent from the VF will be tagged with
Incoming traffic will have VLAN S-Tags stripped before being passed to the VF. VLAN S-Tag. Incoming traffic will have VLAN S-Tags stripped before
Setting to 802.1ad also enables an option to concatenate another VLAN tag, so both being passed to the VF. Setting to 802.1ad also enables an option to
S-TAG and C-TAG will be inserted/stripped for outgoing/incoming traffic, respectively. concatenate another VLAN tag, so both S-TAG and C-TAG will be
If not specified, the value is assumed to be 802.1Q. Both the inserted/stripped for outgoing/incoming traffic, respectively. If not
specified, the value is assumed to be 802.1Q. Both the
.B vf .B vf
and and
.B vlan .B vlan
@ -1909,8 +1951,8 @@ option instead.
.sp .sp
.BI max_tx_rate " TXRATE" .BI max_tx_rate " TXRATE"
- change the allowed maximum transmit bandwidth, in Mbps, for the specified VF. - change the allowed maximum transmit bandwidth, in Mbps, for the
Setting this parameter to 0 disables rate limiting. specified VF. Setting this parameter to 0 disables rate limiting.
.B vf .B vf
parameter must be specified. parameter must be specified.
@ -1927,17 +1969,21 @@ parameter must be specified.
- turn packet spoof checking on or off for the specified VF. - turn packet spoof checking on or off for the specified VF.
.sp .sp
.BI query_rss " on|off" .BI query_rss " on|off"
- toggle the ability of querying the RSS configuration of a specific VF. VF RSS information like RSS hash key may be considered sensitive on some devices where this information is shared between VF and PF and thus its querying may be prohibited by default. - toggle the ability of querying the RSS configuration of a specific
VF. VF RSS information like RSS hash key may be considered sensitive
on some devices where this information is shared between VF and PF
and thus its querying may be prohibited by default.
.sp .sp
.BI state " auto|enable|disable" .BI state " auto|enable|disable"
- set the virtual link state as seen by the specified VF. Setting to auto means a - set the virtual link state as seen by the specified VF. Setting to
reflection of the PF link state, enable lets the VF to communicate with other VFs on auto means a reflection of the PF link state, enable lets the VF to
this host even if the PF link state is down, disable causes the HW to drop any packets communicate with other VFs on this host even if the PF link state is
sent by the VF. down, disable causes the HW to drop any packets sent by the VF.
.sp .sp
.BI trust " on|off" .BI trust " on|off"
- trust the specified VF user. This enables that VF user can set a specific feature - trust the specified VF user. This enables that VF user can set a
which may impact security and/or performance. (e.g. VF multicast promiscuous mode) specific feature which may impact security and/or
performance. (e.g. VF multicast promiscuous mode)
.sp .sp
.BI node_guid " eui64" .BI node_guid " eui64"
- configure node GUID for Infiniband VFs. - configure node GUID for Infiniband VFs.
@ -2045,7 +2091,8 @@ set the IPv6 address generation mode
- disable automatic address generation - disable automatic address generation
.I stable_secret .I stable_secret
- generate the interface identifier based on a preset /proc/sys/net/ipv6/conf/{default,DEVICE}/stable_secret - generate the interface identifier based on a preset
/proc/sys/net/ipv6/conf/{default,DEVICE}/stable_secret
.I random .I random
- like stable_secret, but auto-generate a new random secret if none is set - like stable_secret, but auto-generate a new random secret if none is set
@ -2185,22 +2232,31 @@ queries.
option above. option above.
.BR mcast_flood " { " on " | " off " }" .BR mcast_flood " { " on " | " off " }"
- controls whether a given port will flood multicast traffic for which there is no MDB entry. - controls whether a given port will flood multicast traffic for which
there is no MDB entry.
.BR mcast_to_unicast " { " on " | " off " }" .BR mcast_to_unicast " { " on " | " off " }"
- controls whether a given port will replicate packets using unicast instead of multicast. By default this flag is off. - controls whether a given port will replicate packets using unicast
instead of multicast. By default this flag is off.
.BI group_fwd_mask " MASK " .BI group_fwd_mask " MASK "
- set the group forward mask. This is the bitmask that is applied to decide whether to forward incoming frames destined to link-local addresses, ie addresses of the form 01:80:C2:00:00:0X (defaults to 0, ie the bridge does not forward any link-local frames coming on this port). - set the group forward mask. This is the bitmask that is applied to
decide whether to forward incoming frames destined to link-local
addresses, ie addresses of the form 01:80:C2:00:00:0X (defaults to
0, ie the bridge does not forward any link-local frames coming on
this port).
.BR neigh_suppress " { " on " | " off " }" .BR neigh_suppress " { " on " | " off " }"
- controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off. - controls whether neigh discovery (arp and nd) proxy and suppression
is enabled on the port. By default this flag is off.
.BR vlan_tunnel " { " on " | " off " }" .BR vlan_tunnel " { " on " | " off " }"
- controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off. - controls whether vlan to tunnel mapping is enabled on the port. By
default this flag is off.
.BI backup_port " DEVICE" .BI backup_port " DEVICE"
- if the port loses carrier all traffic will be redirected to the configured backup port - if the port loses carrier all traffic will be redirected to the
configured backup port
.BR nobackup_port .BR nobackup_port
- removes the currently configured backup port - removes the currently configured backup port

View File

@ -72,8 +72,9 @@ First failure will cause termination of ip.
.TP .TP
.BR "\-force" .BR "\-force"
Don't terminate ip on errors in batch mode. Don't terminate ip on errors in batch mode. If there were any errors
If there were any errors during execution of the commands, the application return code will be non zero. during execution of the commands, the application return code will be
non zero.
.TP .TP
.BR "\-s" , " \-stats" , " \-statistics" .BR "\-s" , " \-stats" , " \-statistics"
@ -93,7 +94,8 @@ Zero (0) means loop until all addresses are removed.
.TP .TP
.BR "\-f" , " \-family " <FAMILY> .BR "\-f" , " \-family " <FAMILY>
Specifies the protocol family to use. The protocol family identifier can be one of Specifies the protocol family to use. The protocol family identifier
can be one of
.BR "inet" , " inet6" , " bridge" , " mpls" .BR "inet" , " inet6" , " bridge" , " mpls"
or or
.BR link . .BR link .
@ -174,7 +176,8 @@ to
.TP .TP
.BR "\-a" , " \-all" .BR "\-a" , " \-all"
executes specified command over all objects, it depends if command supports this option. executes specified command over all objects, it depends if command
supports this option.
.TP .TP
.BR \-c [ color ][ = { always | auto | never } .BR \-c [ color ][ = { always | auto | never }
@ -182,7 +185,8 @@ Configure color output. If parameter is omitted or
.BR always , .BR always ,
color output is enabled regardless of stdout state. If parameter is color output is enabled regardless of stdout state. If parameter is
.BR auto , .BR auto ,
stdout is checked to be a terminal before enabling color output. If parameter is stdout is checked to be a terminal before enabling color output. If
parameter is
.BR never , .BR never ,
color output is disabled. If specified multiple times, the last one takes color output is disabled. If specified multiple times, the last one takes
precedence. This flag is ignored if precedence. This flag is ignored if
@ -215,7 +219,8 @@ print human readable rates in IEC units (e.g. 1Ki = 1024).
.TP .TP
.BR "\-br" , " \-brief" .BR "\-br" , " \-brief"
Print only basic information in a tabular format for better readability. This option is currently only supported by Print only basic information in a tabular format for better
readability. This option is currently only supported by
.BR "ip addr show " and " ip link show " commands. .BR "ip addr show " and " ip link show " commands.
.TP .TP
@ -224,8 +229,9 @@ Output results in JavaScript Object Notation (JSON).
.TP .TP
.BR "\-p", " \-pretty" .BR "\-p", " \-pretty"
The default JSON format is compact and more efficient to parse but hard for most users to read. The default JSON format is compact and more efficient to parse but
This flag adds indentation for readability. hard for most users to read. This flag adds indentation for
readability.
.SH IP - COMMAND SYNTAX .SH IP - COMMAND SYNTAX
@ -339,7 +345,8 @@ or, if the objects of this class cannot be listed,
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
.B COLORFGBG .B COLORFGBG
If set, it's value is used for detection whether background is dark or light and use contrast colors for it. If set, it's value is used for detection whether background is dark or
light and use contrast colors for it.
COLORFGBG environment variable usually contains either two or three COLORFGBG environment variable usually contains either two or three
values separated by semicolons; we want the last value in either case. values separated by semicolons; we want the last value in either case.

View File

@ -9,11 +9,11 @@ ss \- another utility to investigate sockets
is used to dump socket statistics. It allows showing information similar is used to dump socket statistics. It allows showing information similar
to to
.IR netstat . .IR netstat .
It can display more TCP and state informations than other tools. It can display more TCP and state information than other tools.
.SH OPTIONS .SH OPTIONS
When no option is used ss displays a list of When no option is used ss displays a list of open non-listening
open non-listening sockets (e.g. TCP/UNIX/UDP) that have established connection. sockets (e.g. TCP/UNIX/UDP) that have established connection.
.TP .TP
.B \-h, \-\-help .B \-h, \-\-help
Show summary of options. Show summary of options.
@ -31,13 +31,14 @@ Do not try to resolve service names.
Try to resolve numeric address/ports. Try to resolve numeric address/ports.
.TP .TP
.B \-a, \-\-all .B \-a, \-\-all
Display both listening and non-listening (for TCP this means established connections) sockets. Display both listening and non-listening (for TCP this means
established connections) sockets.
.TP .TP
.B \-l, \-\-listening .B \-l, \-\-listening
Display only listening sockets (these are omitted by default). Display only listening sockets (these are omitted by default).
.TP .TP
.B \-o, \-\-options .B \-o, \-\-options
Show timer information. For tcp protocol, the output format is: Show timer information. For TCP protocol, the output format is:
.RS .RS
.P .P
timer:(<timer_name>,<expire_time>,<retrans>) timer:(<timer_name>,<expire_time>,<retrans>)
@ -47,7 +48,9 @@ timer:(<timer_name>,<expire_time>,<retrans>)
the name of the timer, there are five kind of timer names: the name of the timer, there are five kind of timer names:
.RS .RS
.P .P
.BR on ": means one of these timers: tcp retrans timer, tcp early retrans timer and tail loss probe timer" .B on
: means one of these timers: TCP retrans timer, TCP early retrans
timer and tail loss probe timer
.P .P
.BR keepalive ": tcp keep alive timer" .BR keepalive ": tcp keep alive timer"
.P .P
@ -63,7 +66,7 @@ how long time the timer will expire
.P .P
.TP .TP
.B <retrans> .B <retrans>
how many times the retran occurs how many times the retransmission occured
.RE .RE
.TP .TP
.B \-e, \-\-extended .B \-e, \-\-extended
@ -121,19 +124,25 @@ the total memory can be allocated for sending packet
.P .P
.TP .TP
.B <fwd_alloc> .B <fwd_alloc>
the memory allocated by the socket as cache, but not used for receiving/sending packet yet. If need memory to send/receive packet, the memory in this cache will be used before allocate additional memory. the memory allocated by the socket as cache, but not used for
receiving/sending packet yet. If need memory to send/receive packet,
the memory in this cache will be used before allocate additional
memory.
.P .P
.TP .TP
.B <wmem_queued> .B <wmem_queued>
The memory allocated for sending packet (which has not been sent to layer 3) The memory allocated for sending packet (which has not been sent to layer 3)
.P .P
.TP .TP
.B <opt_mem> .B <ropt_mem>
The memory used for storing socket option, e.g., the key for TCP MD5 signature The memory used for storing socket option, e.g., the key for TCP MD5 signature
.P .P
.TP .TP
.B <back_log> .B <back_log>
The memory used for the sk backlog queue. On a process context, if the process is receiving packet, and a new packet is received, it will be put into the sk backlog queue, so it can be received by the process immediately The memory used for the sk backlog queue. On a process context, if the
process is receiving packet, and a new packet is received, it will be
put into the sk backlog queue, so it can be received by the process
immediately
.RE .RE
.TP .TP
.B \-p, \-\-processes .B \-p, \-\-processes
@ -169,7 +178,8 @@ the congestion algorithm name, the default congestion algorithm is "cubic"
.P .P
.TP .TP
.B wscale:<snd_wscale>:<rcv_wscale> .B wscale:<snd_wscale>:<rcv_wscale>
if window scale option is used, this field shows the send scale factor and receive scale factor if window scale option is used, this field shows the send scale factor
and receive scale factor
.P .P
.TP .TP
.B rto:<icsk_rto> .B rto:<icsk_rto>
@ -177,11 +187,13 @@ tcp re-transmission timeout value, the unit is millisecond
.P .P
.TP .TP
.B backoff:<icsk_backoff> .B backoff:<icsk_backoff>
used for exponential backoff re-transmission, the actual re-transmission timeout value is icsk_rto << icsk_backoff used for exponential backoff re-transmission, the actual
re-transmission timeout value is icsk_rto << icsk_backoff
.P .P
.TP .TP
.B rtt:<rtt>/<rttvar> .B rtt:<rtt>/<rttvar>
rtt is the average round trip time, rttvar is the mean deviation of rtt, their units are millisecond rtt is the average round trip time, rttvar is the mean deviation of
rtt, their units are millisecond
.P .P
.TP .TP
.B ato:<ato> .B ato:<ato>
@ -258,7 +270,8 @@ IPv6 Traffic Class byte
.P .P
.TP .TP
.B class_id .B class_id
Class id set by net_cls cgroup. If class is zero this shows priority set by SO_PRIORITY. Class id set by net_cls cgroup. If class is zero this shows priority
set by SO_PRIORITY.
.RE .RE
.TP .TP
.B \-K, \-\-kill .B \-K, \-\-kill
@ -309,7 +322,8 @@ and is therefore a useful reference.
Switch to the specified network namespace name. Switch to the specified network namespace name.
.TP .TP
.B \-b, \-\-bpf .B \-b, \-\-bpf
Show socket BPF filters (only administrators are allowed to get these information). Show socket BPF filters (only administrators are allowed to get these
information).
.TP .TP
.B \-4, \-\-ipv4 .B \-4, \-\-ipv4
Display only IP version 4 sockets (alias for -f inet). Display only IP version 4 sockets (alias for -f inet).
@ -345,8 +359,8 @@ Display vsock sockets (alias for -f vsock).
Display XDP sockets (alias for -f xdp). Display XDP sockets (alias for -f xdp).
.TP .TP
.B \-f FAMILY, \-\-family=FAMILY .B \-f FAMILY, \-\-family=FAMILY
Display sockets of type FAMILY. Display sockets of type FAMILY. Currently the following families are
Currently the following families are supported: unix, inet, inet6, link, netlink, vsock, xdp. supported: unix, inet, inet6, link, netlink, vsock, xdp.
.TP .TP
.B \-A QUERY, \-\-query=QUERY, \-\-socket=QUERY .B \-A QUERY, \-\-query=QUERY, \-\-socket=QUERY
List of socket tables to dump, separated by commas. The following identifiers List of socket tables to dump, separated by commas. The following identifiers
@ -358,11 +372,12 @@ prefixed by an exclamation mark
to exclude that socket table from being dumped. to exclude that socket table from being dumped.
.TP .TP
.B \-D FILE, \-\-diag=FILE .B \-D FILE, \-\-diag=FILE
Do not display anything, just dump raw information about TCP sockets to FILE after applying filters. If FILE is - stdout is used. Do not display anything, just dump raw information about TCP sockets
to FILE after applying filters. If FILE is - stdout is used.
.TP .TP
.B \-F FILE, \-\-filter=FILE .B \-F FILE, \-\-filter=FILE
Read filter information from FILE. Read filter information from FILE. Each line of FILE is interpreted
Each line of FILE is interpreted like single command line option. If FILE is - stdin is used. like single command line option. If FILE is - stdin is used.
.TP .TP
.B FILTER := [ state STATE-FILTER ] [ EXPRESSION ] .B FILTER := [ state STATE-FILTER ] [ EXPRESSION ]
Please take a look at the official documentation for details regarding filters. Please take a look at the official documentation for details regarding filters.
@ -370,7 +385,9 @@ Please take a look at the official documentation for details regarding filters.
.SH STATE-FILTER .SH STATE-FILTER
.B STATE-FILTER .B STATE-FILTER
allows to construct arbitrary set of states to match. Its syntax is sequence of keywords state and exclude followed by identifier of state. allows to construct arbitrary set of states to match. Its syntax is
sequence of keywords state and exclude followed by identifier of
state.
.TP .TP
Available identifiers are: Available identifiers are:
@ -417,7 +434,8 @@ Display all established ssh connections.
Find all local processes connected to X server. Find all local processes connected to X server.
.TP .TP
.B ss -o state fin-wait-1 '( sport = :http or sport = :https )' dst 193.233.7/24 .B ss -o state fin-wait-1 '( sport = :http or sport = :https )' dst 193.233.7/24
List all the tcp sockets in state FIN-WAIT-1 for our apache to network 193.233.7/24 and look at their timers. List all the tcp sockets in state FIN-WAIT-1 for our apache to network
193.233.7/24 and look at their timers.
.TP .TP
.B ss -a -A 'all,!tcp' .B ss -a -A 'all,!tcp'
List sockets in all states from all socket tables but TCP. List sockets in all states from all socket tables but TCP.