Commit 61f541fe authored by esr@thyrsus.com's avatar esr@thyrsus.com Committed by Stephen Hemminger

First set of manpage markup fixes

Enclosed patch fixes inappropriate uses of the .SS macro.  Fuller explanation
in the change comment.

There are other problems in these pages that block lifting to
XML-DocBook, most notably in the command synopses.  They will take
some creativity to fix.  I'm working on it

>From 75745adba4b45b87577b61a2daa886dd444f44da Mon Sep 17 00:00:00 2001
From: "Eric S. Raymond" <esr@thyrsus.com>
Date: Fri, 21 Jun 2013 15:27:38 -0400
Subject: [PATCH] Abolish presentation-level misuse of the .SS macro.

This change fixes most (but not all) fatal errors in attempts to lift
the iproute2 manual pages to XML-DocBook.  Where .SS is still used it
is a real subsection header, not just a way to outdent and bold text.
Presentation-level instances are turned into .TP calls and tables.
parent 8fd8f6ed
...@@ -31,13 +31,17 @@ objects are multicast addresses. ...@@ -31,13 +31,17 @@ objects are multicast addresses.
.BI dev " NAME " (default) .BI dev " NAME " (default)
the device name. the device name.
.SS ip maddress add - add a multicast address .TP
.SS ip maddress delete - delete a multicast address .B ip maddress add - add a multicast address
these commands attach/detach a static link-layer multicast address .TP
.B ip maddress delete - delete a multicast address
.sp
These commands attach/detach a static link-layer multicast address
to listen on the interface. to listen on the interface.
Note that it is impossible to join protocol multicast groups Note that it is impossible to join protocol multicast groups
statically. This command only manages link-layer addresses. statically. This command only manages link-layer addresses.
.RS
.TP .TP
.BI address " LLADDRESS " (default) .BI address " LLADDRESS " (default)
the link-layer multicast address. the link-layer multicast address.
...@@ -45,6 +49,7 @@ the link-layer multicast address. ...@@ -45,6 +49,7 @@ the link-layer multicast address.
.TP .TP
.BI dev " NAME" .BI dev " NAME"
the device to join/leave this multicast address. the device to join/leave this multicast address.
.RE
.SH SEE ALSO .SH SEE ALSO
.br .br
......
...@@ -46,10 +46,17 @@ is also known by another name - the ARP table. ...@@ -46,10 +46,17 @@ is also known by another name - the ARP table.
The corresponding commands display neighbour bindings The corresponding commands display neighbour bindings
and their properties, add new neighbour entries and delete old ones. and their properties, add new neighbour entries and delete old ones.
.SS ip neighbour add - add a new neighbour entry .TP
.SS ip neighbour change - change an existing entry ip neighbour add
.SS ip neighbour replace - add a new entry or change an existing one add a new neighbour entry
.TP
ip neighbour change
change an existing entry
.TP
ip neighbour replace
add a new entry or change an existing one
.PP
These commands create new neighbour records or update existing ones. These commands create new neighbour records or update existing ones.
.TP .TP
...@@ -74,31 +81,28 @@ the state of the neighbour entry. ...@@ -74,31 +81,28 @@ the state of the neighbour entry.
is an abbreviation for 'Neighbour Unreachability Detection'. is an abbreviation for 'Neighbour Unreachability Detection'.
The state can take one of the following values: The state can take one of the following values:
.in +8 .TP
.B permanent .B permanent
- the neighbour entry is valid forever and can be only the neighbour entry is valid forever and can be only
be removed administratively. be removed administratively.
.sp .TP
.B noarp .B noarp
- the neighbour entry is valid. No attempts to validate the neighbour entry is valid. No attempts to validate
this entry will be made but it can be removed when its lifetime expires. this entry will be made but it can be removed when its lifetime expires.
.sp .TP
.B reachable .B reachable
- the neighbour entry is valid until the reachability the neighbour entry is valid until the reachability
timeout expires. timeout expires.
.sp .TP
.B stale .B stale
- the neighbour entry is valid but suspicious. the neighbour entry is valid but suspicious.
This option to This option to
.B ip neigh .B ip neigh
does not change the neighbour state if it was valid and the address does not change the neighbour state if it was valid and the address
is not changed by this command. is not changed by this command.
.in -8 .RS
ip neighbour delete - delete a neighbour entry
.SS ip neighbour delete - delete a neighbour entry .RE
This command invalidates a neighbour entry. This command invalidates a neighbour entry.
.PP .PP
...@@ -120,9 +124,11 @@ on a ...@@ -120,9 +124,11 @@ on a
.B NOARP .B NOARP
interface or if the address is multicast or broadcast. interface or if the address is multicast or broadcast.
.SS ip neighbour show - list neighbour entries .RS
ip neighbour show - list neighbour entries
.RE
This commands displays neighbour tables. This command displays neighbour tables.
.TP .TP
.BI to " ADDRESS " (default) .BI to " ADDRESS " (default)
...@@ -154,7 +160,10 @@ lists all entries except for ...@@ -154,7 +160,10 @@ lists all entries except for
and and
.BR "noarp" . .BR "noarp" .
.SS ip neighbour flush - flush neighbour entries .RS
ip neighbour flush - flush neighbour entries
.RE
This command flushes neighbour tables, selecting This command flushes neighbour tables, selecting
entries to flush by some criteria. entries to flush by some criteria.
......
...@@ -64,35 +64,41 @@ namespace unaware applications, by creating a mount namespace and ...@@ -64,35 +64,41 @@ namespace unaware applications, by creating a mount namespace and
bind mounting all of the per network namespace configure files into bind mounting all of the per network namespace configure files into
their traditional location in /etc. their traditional location in /etc.
.SS ip netns list - show all of the named network namespaces .TP
.B ip netns list - show all of the named network namespaces
.sp
This command displays all of the network namespaces in /var/run/netns This command displays all of the network namespaces in /var/run/netns
.SS ip netns add NAME - create a new named network namespace .TP
.B ip netns add NAME - create a new named network namespace
.sp
If NAME is available in /var/run/netns/ this command creates a new If NAME is available in /var/run/netns/ this command creates a new
network namespace and assigns NAME. network namespace and assigns NAME.
.SS ip netns delete NAME - delete the name of a network namespace .TP
.B ip netns delete NAME - delete the name of a network namespace
.sp
If NAME is present in /var/run/netns it is umounted and the mount If NAME is present in /var/run/netns it is umounted and the mount
point is removed. If this is the last user of the network namespace the point is removed. If this is the last user of the network namespace the
network namespace will be freed, otherwise the network namespace network namespace will be freed, otherwise the network namespace
persists until it has no more users. ip netns delete may fail if persists until it has no more users. ip netns delete may fail if
the mount point is in use in another mount namespace. the mount point is in use in another mount namespace.
.SS ip netns identify PID - Report network namespaces names for process .TP
.B ip netns identify PID - Report network namespaces names for process
.sp
This command walks through /var/run/netns and finds all the network This command walks through /var/run/netns and finds all the network
namespace names for network namespace of the specified process. namespace names for network namespace of the specified process.
.SS ip netns pids NAME - Report processes in the named network namespace .TP
.B ip netns pids NAME - Report processes in the named network namespace
.sp
This command walks through proc and finds all of the process who have This command walks through proc and finds all of the process who have
the named network namespace as their primary network namespace. the named network namespace as their primary network namespace.
.SS ip netns exec NAME cmd ... - Run cmd in the named network namespace .TP
.B ip netns exec NAME cmd ... - Run cmd in the named network namespace
.sp
This command allows applications that are network namespace unaware This command allows applications that are network namespace unaware
to be run in something other than the default network namespace with to be run in something other than the default network namespace with
all of the configuration for the specified network namespace appearing all of the configuration for the specified network namespace appearing
...@@ -100,8 +106,9 @@ in the customary global locations. A network namespace and bind mounts ...@@ -100,8 +106,9 @@ in the customary global locations. A network namespace and bind mounts
are used to move files from their network namespace specific location are used to move files from their network namespace specific location
to their default locations without affecting other processes. to their default locations without affecting other processes.
.SS ip netns monitor - Report as network namespace names are added and deleted .TP
.B ip netns monitor - Report as network namespace names are added and deleted
.sp
This command watches network namespace name addition and deletion events This command watches network namespace name addition and deletion events
and prints a line for each event it sees. and prints a line for each event it sees.
......
...@@ -246,10 +246,16 @@ The multiple routing tables enter the game when ...@@ -246,10 +246,16 @@ The multiple routing tables enter the game when
.I policy routing .I policy routing
is used. is used.
.SS ip route add - add new route .TP
.SS ip route change - change route ip route add
.SS ip route replace - change or add new one add new route
.TP
ip route change
change route
.TP
ip route replace
change or add new one
.RS
.TP .TP
.BI to " TYPE PREFIX " (default) .BI to " TYPE PREFIX " (default)
the destination prefix of the route. If the destination prefix of the route. If
...@@ -502,9 +508,12 @@ to assign (or not to assign) protocol tags. ...@@ -502,9 +508,12 @@ to assign (or not to assign) protocol tags.
.B onlink .B onlink
pretend that the nexthop is directly attached to this link, pretend that the nexthop is directly attached to this link,
even if it does not match any interface prefix. even if it does not match any interface prefix.
.RE
.SS ip route delete - delete route .TP
ip route delete
delete route
.RS
.B ip route del .B ip route del
has the same arguments as has the same arguments as
.BR "ip route add" , .BR "ip route add" ,
...@@ -518,8 +527,12 @@ verifies that they coincide with the attributes of the route to delete. ...@@ -518,8 +527,12 @@ verifies that they coincide with the attributes of the route to delete.
If no route with the given key and attributes was found, If no route with the given key and attributes was found,
.B ip route del .B ip route del
fails. fails.
.RE
.SS ip route show - list routes .TP
ip route show
list routes
.RS
the command displays the contents of the routing tables or the route(s) the command displays the contents of the routing tables or the route(s)
selected by some criteria. selected by some criteria.
...@@ -628,8 +641,12 @@ by ...@@ -628,8 +641,12 @@ by
.TP .TP
.BI realms " FROMREALM/TOREALM" .BI realms " FROMREALM/TOREALM"
only list routes with these realms. only list routes with these realms.
.RE
.SS ip route flush - flush routing tables .TP
ip route flush
flush routing tables
.RS
this command flushes routes selected by some criteria. this command flushes routes selected by some criteria.
.sp .sp
...@@ -652,8 +669,12 @@ twice, ...@@ -652,8 +669,12 @@ twice,
.B ip route flush .B ip route flush
also dumps all the deleted routes in the format described in the also dumps all the deleted routes in the format described in the
previous subsection. previous subsection.
.RE
.SS ip route get - get a single route .TP
ip route get
get a single route
.RS
this command gets a single route to a destination and prints its this command gets a single route to a destination and prints its
contents exactly as the kernel sees it. contents exactly as the kernel sees it.
...@@ -707,21 +728,30 @@ however, no packets are actually sent. With the ...@@ -707,21 +728,30 @@ however, no packets are actually sent. With the
.B iif .B iif
argument, the kernel pretends that a packet arrived from this interface argument, the kernel pretends that a packet arrived from this interface
and searches for a path to forward the packet. and searches for a path to forward the packet.
.RE
.SS ip route save - save routing table information to stdout .TP
this command behaves like ip route save
save routing table information to stdout
.RS
This command behaves like
.BR "ip route show" .BR "ip route show"
except that the output is raw data suitable for passing to except that the output is raw data suitable for passing to
.BR "ip route restore" . .BR "ip route restore" .
.RE
.SS ip route restore - restore routing table information from stdin .TP
this command expects to read a data stream as returned from ip route restore
restore routing table information from stdin
.RS
This command expects to read a data stream as returned from
.BR "ip route save" . .BR "ip route save" .
It will attempt to restore the routing table information exactly as It will attempt to restore the routing table information exactly as
it was at the time of the save, so any translation of information it was at the time of the save, so any translation of information
in the stream (such as device indexes) must be done first. Any existing in the stream (such as device indexes) must be done first. Any existing
routes are left unchanged. Any routes specified in the data stream that routes are left unchanged. Any routes specified in the data stream that
already exist in the table will be ignored. already exist in the table will be ignored.
.RE
.SH EXAMPLES .SH EXAMPLES
.PP .PP
......
...@@ -88,10 +88,16 @@ The encapsulating (or outer) address family is specified by the ...@@ -88,10 +88,16 @@ The encapsulating (or outer) address family is specified by the
.B -f .B -f
option. The default is IPv4. option. The default is IPv4.
.SS ip tunnel add - add a new tunnel .TP
.SS ip tunnel change - change an existing tunnel .B ip tunnel add
.SS ip tunnel delete - destroy a tunnel add a new tunnel
.TP
.B ip tunnel change
change an existing tunnel
.TP
.B ip tunnel delete
destroy a tunnel
.RS
.TP .TP
.BI name " NAME " (default) .BI name " NAME " (default)
select the tunnel device name. select the tunnel device name.
...@@ -223,9 +229,12 @@ set a fixed encapsulation limit. Default is 4. ...@@ -223,9 +229,12 @@ set a fixed encapsulation limit. Default is 4.
.BI flowlabel " FLOWLABEL" .BI flowlabel " FLOWLABEL"
.RB ( " only IPv6 tunnels " ) .RB ( " only IPv6 tunnels " )
set a fixed flowlabel. set a fixed flowlabel.
.RE
.SS ip tunnel prl - potential router list (ISATAP only) .TP
.B ip tunnel prl
potential router list (ISATAP only)
.RS
.TP .TP
.BI dev " NAME" .BI dev " NAME"
mandatory device name. mandatory device name.
...@@ -238,8 +247,11 @@ mandatory device name. ...@@ -238,8 +247,11 @@ mandatory device name.
.BI prl-delete " ADDR" .BI prl-delete " ADDR"
.RB "Add or delete " ADDR .RB "Add or delete " ADDR
as a potential router or default router. as a potential router or default router.
.RE
.SS ip tunnel show - list tunnels .TP
.B ip tunnel show
list tunnels
This command has no arguments. This command has no arguments.
.SH SEE ALSO .SH SEE ALSO
......
...@@ -369,23 +369,19 @@ object operating on the Security Association Database, and the ...@@ -369,23 +369,19 @@ object operating on the Security Association Database, and the
object operating on the Security Policy Database). It is also used for object operating on the Security Policy Database). It is also used for
the IP Payload Compression Protocol and features of Mobile IPv6. the IP Payload Compression Protocol and features of Mobile IPv6.
.SS ip xfrm state add - add new state into xfrm .TS
l l.
.SS ip xfrm state update - update existing state in xfrm ip xfrm state add add new state into xfrm
ip xfrm state update update existing state in xfrm
.SS ip xfrm state allocspi - allocate an SPI value ip xfrm state allocspi allocate an SPI value
ip xfrm state delete delete existing state in xfrm
.SS ip xfrm state delete - delete existing state in xfrm ip xfrm state get get existing state in xfrm
ip xfrm state deleteall delete all existing state in xfrm
.SS ip xfrm state get - get existing state in xfrm ip xfrm state list print out the list of existing state in xfrm
ip xfrm state flush flush all state in xfrm
.SS ip xfrm state deleteall - delete all existing state in xfrm ip xfrm state count count all existing state in xfrm
ip xfrm monitor state monitoring for xfrm objects
.SS ip xfrm state list - print out the list of existing state in xfrm .TE
.SS ip xfrm state flush - flush all state in xfrm
.SS ip xfrm state count - count all existing state in xfrm
.TP .TP
.IR ID .IR ID
...@@ -506,22 +502,18 @@ encapsulates packets with protocol ...@@ -506,22 +502,18 @@ encapsulates packets with protocol
.BR espinudp " or " espinudp-nonike "," .BR espinudp " or " espinudp-nonike ","
.RI "using source port " SPORT ", destination port " DPORT .RI "using source port " SPORT ", destination port " DPORT
.RI ", and original address " OADDR "." .RI ", and original address " OADDR "."
.sp
.SS ip xfrm policy add - add a new policy .TS
l l.
.SS ip xfrm policy update - update an existing policy ip xfrm policy add add a new policy
ip xfrm policy update update an existing policy
.SS ip xfrm policy delete - delete an existing policy ip xfrm policy delete delete an existing policy
ip xfrm policy get get an existing policy
.SS ip xfrm policy get - get an existing policy ip xfrm policy deleteall delete all existing xfrm policies
ip xfrm policy list print out the list of xfrm policies
.SS ip xfrm policy deleteall - delete all existing xfrm policies ip xfrm policy flush flush policies
ip xfrm policy count count existing policies
.SS ip xfrm policy list - print out the list of xfrm policies .TE
.SS ip xfrm policy flush - flush policies
.SS ip xfrm policy count - count existing policies
.TP .TP
.IR SELECTOR .IR SELECTOR
...@@ -615,7 +607,6 @@ and inbound trigger ...@@ -615,7 +607,6 @@ and inbound trigger
can be can be
.BR required " (default) or " use "." .BR required " (default) or " use "."
.SS ip xfrm monitor - state monitoring for xfrm objects
The xfrm objects to monitor can be optionally specified. The xfrm objects to monitor can be optionally specified.
.SH AUTHOR .SH AUTHOR
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment