Fix man pages, corrupted from auto-generation

The docbook-to-nroff XSL pages turn indexterms into nroff comments, but have a bug: If the closing indexterm element is not followed by whitespace and cdata, then the following element or cdata is stuck on the same line as the comment. Fixed this temporarily by introducing whitespace between </indexterm> and following cdata or by moving the indexterm elements after any other element (<command>, <term>, etc.) that they reference.
pfuender · Oct 22, 2014 · 29ce5da · 29ce5da
1 parent e9354a4
commit 29ce5da
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 43 deletions.
diff --git a/docs/nmap-update.1 b/docs/nmap-update.1
@@ -2,12 +2,12 @@
 .\"     Title: nmap-update
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 08/29/2014
+.\"      Date: 10/22/2014
 .\"    Manual: nmap-update Reference Guide
 .\"    Source: nmap-update
 .\"  Language: English
 .\"
-.TH "NMAP\-UPDATE" "1" "08/29/2014" "nmap\-update" "nmap\-update Reference Guide"
+.TH "NMAP\-UPDATE" "1" "10/22/2014" "nmap\-update" "nmap\-update Reference Guide"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/docs/nmap.1 b/docs/nmap.1
@@ -2,12 +2,12 @@
 .\"     Title: nmap
 .\"    Author: [see the "Author" section]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 08/29/2014
+.\"      Date: 10/22/2014
 .\"    Manual: Nmap Reference Guide
 .\"    Source: Nmap
 .\"  Language: English
 .\"
-.TH "NMAP" "1" "08/29/2014" "Nmap" "Nmap Reference Guide"
+.TH "NMAP" "1" "10/22/2014" "Nmap" "Nmap Reference Guide"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -521,7 +521,8 @@ and
 .RS 4
 .\" payloads, protocol-specific
 Another host discovery option is the UDP ping, which sends a UDP packet to the given ports\&. For most ports, the packet will be empty, though for a few a protocol\-specific payload will be sent that is more likely to get a response\&.
-.\" protocol-specific payloads: UDPThe payload database is described at \m[blue]\fB\%http://nmap.org/book/nmap-payloads.html\fR\m[]\&.
+The payload database is described at \m[blue]\fB\%http://nmap.org/book/nmap-payloads.html\fR\m[]\&.
+.\" protocol-specific payloads: UDP
 The
 \fB\-\-data\fR
 .\" --data
@@ -607,7 +608,8 @@ While echo request is the standard ICMP ping query, Nmap does not stop there\&.
 .\" RFC 792
 and
 \m[blue]\fBRFC 950\fR\m[]\&\s-2\u[4]\d\s+2
-.\" RFC 950) also specify timestamp request, information request, and address mask request packets as codes 13, 15, and 17, respectively\&. While the ostensible purpose for these queries is to learn information such as address masks and current times, they can easily be used for host discovery\&. A system that replies is up and available\&. Nmap does not currently implement information request packets, as they are not widely supported\&. RFC 1122 insists that
+.\" RFC 950
+) also specify timestamp request, information request, and address mask request packets as codes 13, 15, and 17, respectively\&. While the ostensible purpose for these queries is to learn information such as address masks and current times, they can easily be used for host discovery\&. A system that replies is up and available\&. Nmap does not currently implement information request packets, as they are not widely supported\&. RFC 1122 insists that
 \(lqa host SHOULD NOT implement these messages\(rq\&. Timestamp and address mask queries can be sent with the
 \fB\-PP\fR
 and
@@ -625,9 +627,11 @@ nmap\&.h\&. Note that for the ICMP, IGMP, TCP (protocol 6), UDP (protocol 17) an
 .\" protocol-specific payloads: IP
 while other protocols are sent with no additional data beyond the IP header (unless any of
 \fB\-\-data\fR
-.\" --data,
+.\" --data
+,
 \fB\-\-data\-string\fR
-.\" --data-string, or
+.\" --data-string
+, or
 \fB\-\-data\-length\fR
 .\" --data-length
 options are specified)\&.
@@ -1316,8 +1320,9 @@ value (such as 1) speeds Nmap up, though you miss out on retries which could pot
 .\" Nmap Scripting Engine (NSE)
 .PP
 The Nmap Scripting Engine (NSE) is one of Nmap\*(Aqs most powerful and flexible features\&. It allows users to write (and share) simple scripts (using the
-\m[blue]\fBLua programming language\fR\m[]\&\s-2\u[11]\d\s+2,
-.\" Lua programming language) to automate a wide variety of networking tasks\&. Those scripts are executed in parallel with the speed and efficiency you expect from Nmap\&. Users can rely on the growing and diverse set of scripts distributed with Nmap, or write their own to meet custom needs\&.
+\m[blue]\fBLua programming language\fR\m[]\&\s-2\u[11]\d\s+2
+.\" Lua programming language
+) to automate a wide variety of networking tasks\&. Those scripts are executed in parallel with the speed and efficiency you expect from Nmap\&. Users can rely on the growing and diverse set of scripts distributed with Nmap, or write their own to meet custom needs\&.
 .PP
 Tasks we had in mind when creating the system include network discovery, more sophisticated version detection, vulnerability detection\&. NSE can even be used for vulnerability exploitation\&.
 .PP
@@ -1777,8 +1782,9 @@ and
 \fBT2\fR
 are similar but they only wait 15 seconds and 0\&.4 seconds, respectively, between probes\&.
 \fBT3\fR
+.\" normal (-T3) timing template
 is Nmap\*(Aqs default behavior, which includes parallelization\&.
-.\" normal (-T3) timing template\fB\-T4\fR
+\fB\-T4\fR
 does the equivalent of
 \fB\-\-max\-rtt\-timeout 1250ms \-\-initial\-rtt\-timeout 500ms \-\-max\-retries 6\fR
 and sets the maximum TCP scan delay to 10 milliseconds\&.
@@ -2023,7 +2029,8 @@ Cisco\&. This option only affects raw packet scans such as SYN scan or OS detect
 \fB\-\-proxies \fR\fB\fIComma\-separated list of proxy URLs\fR\fR (Relay TCP connections through a chain of proxies) .\" --proxies .\" proxy .\" proxies
 .RS 4
 Asks Nmap to establish TCP connections with a final target through supplied chain of one or more HTTP or SOCKS4
-.\" proxies\&. Proxies can help hide the true source of a scan or evade certain firewall restrictions, but they can hamper scan performance by increasing latency\&. Users may need to adjust Nmap timeouts and other scan parameters accordingly\&. In particular, a lower
+.\" proxies
+proxies\&. Proxies can help hide the true source of a scan or evade certain firewall restrictions, but they can hamper scan performance by increasing latency\&. Users may need to adjust Nmap timeouts and other scan parameters accordingly\&. In particular, a lower
 \fB\-\-max\-parallelism\fR
 may help because some proxies refuse to handle as many concurrent connections as Nmap opens by default\&.
 .sp
@@ -2572,32 +2579,37 @@ For testing purposes, you have permission to scan the host scanme\&.nmap\&.org\&
 This permission only includes scanning via Nmap and not testing exploits or denial of service attacks\&. To conserve bandwidth, please do not initiate more than a dozen scans against that host per day\&. If this free scanning target service is abused, it will be taken down and Nmap will report
 Failed to resolve given hostname/IP: scanme\&.nmap\&.org\&. These permissions also apply to the hosts scanme2\&.nmap\&.org, scanme3\&.nmap\&.org, and so on, though those hosts do not currently exist\&.
 .PP
-.\" -v: example of\fBnmap \-v scanme\&.nmap\&.org\fR
+\fBnmap \-v scanme\&.nmap\&.org\fR
+.\" -v: example of
 .PP
 This option scans all reserved TCP ports on the machine
 scanme\&.nmap\&.org
 \&. The
 \fB\-v\fR
 option enables verbose mode\&.
 .PP
+\fBnmap \-sS \-O scanme\&.nmap\&.org/24\fR
 .\" -sS: example of
-.\" -O: example of\fBnmap \-sS \-O scanme\&.nmap\&.org/24\fR
+.\" -O: example of
 .PP
 Launches a stealth SYN scan against each machine that is up out of the 256 IPs on the class C sized network where Scanme resides\&. It also tries to determine what operating system is running on each host that is up and running\&. This requires root privileges because of the SYN scan and OS detection\&.
 .PP
-.\" -p: example of\fBnmap \-sV \-p 22,53,110,143,4564 198\&.116\&.0\-255\&.1\-127\fR
+\fBnmap \-sV \-p 22,53,110,143,4564 198\&.116\&.0\-255\&.1\-127\fR
+.\" -p: example of
 .PP
 Launches host enumeration and a TCP scan at the first half of each of the 255 possible eight\-bit subnets in the 198\&.116 class B address space\&. This tests whether the systems run SSH, DNS, POP3, or IMAP on their standard ports, or anything on port 4564\&. For any of these ports found open, version detection is used to determine what application is running\&.
 .PP
+\fBnmap \-v \-iR 100000 \-Pn \-p 80\fR
 .\" -iR: example of
-.\" -Pn: example of\fBnmap \-v \-iR 100000 \-Pn \-p 80\fR
+.\" -Pn: example of
 .PP
 Asks Nmap to choose 100,000 hosts at random and scan them for web servers (port 80)\&. Host enumeration is disabled with
 \fB\-Pn\fR
 since first sending a couple probes to determine whether a host is up is wasteful when you are only probing one port on each target host anyway\&.
 .PP
+\fBnmap \-Pn \-p80 \-oX logs/pb\-port80scan\&.xml \-oG logs/pb\-port80scan\&.gnmap 216\&.163\&.128\&.20/20\fR
 .\" -oX: example of
-.\" -oG: example of\fBnmap \-Pn \-p80 \-oX logs/pb\-port80scan\&.xml \-oG logs/pb\-port80scan\&.gnmap 216\&.163\&.128\&.20/20\fR
+.\" -oG: example of
 .PP
 This scans 4096 IPs for any web servers (without pinging them) and saves the output in grepable and XML formats\&.
 .SH "NMAP BOOK"
@@ -2646,7 +2658,7 @@ file which is distributed with Nmap and also available from
 .\" copyright
 .\" GNU General Public License
 .PP
-The Nmap Security Scanner is (C) 1996\(en2013 Insecure\&.Com LLC\&. Nmap is also a registered trademark of Insecure\&.Com LLC\&. This program is free software; you may redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; Version 2 (\(lqGPL\(rq), BUT ONLY WITH ALL OF THE CLARIFICATIONS AND EXCEPTIONS DESCRIBED HEREIN\&. This guarantees your right to use, modify, and redistribute this software under certain conditions\&. If you wish to embed Nmap technology into proprietary software, we sell alternative licenses (contact
+The Nmap Security Scanner is (C) 1996\(en2014 Insecure\&.Com LLC\&. Nmap is also a registered trademark of Insecure\&.Com LLC\&. This program is free software; you may redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; Version 2 (\(lqGPL\(rq), BUT ONLY WITH ALL OF THE CLARIFICATIONS AND EXCEPTIONS DESCRIBED HEREIN\&. This guarantees your right to use, modify, and redistribute this software under certain conditions\&. If you wish to embed Nmap technology into proprietary software, we sell alternative licenses (contact
 <sales@nmap\&.com>)\&. Dozens of software vendors already license Nmap technology such as host discovery, port scanning, OS detection, version detection, and the Nmap Scripting Engine\&.
 .PP
 Note that the GPL places important restrictions on

diff --git a/docs/refguide.xml b/docs/refguide.xml
@@ -649,9 +649,10 @@ you would expect.</para>
           sends a UDP packet to the given ports. For most ports, the
           packet will be empty, though for a few a protocol-specific
           payload will be sent that is more likely to get a
-          response.<indexterm><primary>protocol-specific payloads</primary><secondary>UDP</secondary></indexterm>
+          response.
 <man>The payload database is described at <ulink url="http://nmap.org/book/nmap-payloads.html" />.</man>
 <notman>See <xref linkend="nmap-payloads"/> for a description of the database of payloads.</notman>
+<indexterm><primary>protocol-specific payloads</primary><secondary>UDP</secondary></indexterm>
  The <option>--data</option><indexterm><primary><option>--data</option></primary></indexterm> and <option>--data-string</option><indexterm><primary><option>--data-string</option></primary></indexterm> options can be used to send custom payloads to every port. For example: <option>--data 0xCAFE09</option> or <option>--data-string "Gort! Klaatu barada nikto!"</option>
  The <option>--data-length</option><indexterm><primary><option>--data-length</option></primary></indexterm> option can be used to send a fixed-length random payload to every port or (if you specify a value of <literal>0</literal>) to disable payloads.  You can also disable payloads by specifying <option>--data-length 0</option>.</para>
           <para>The port list
@@ -777,7 +778,8 @@ you would expect.</para>
           Nmap does not stop there.  The ICMP standards
           (<ulink role="hidepdf" url="http://www.rfc-editor.org/rfc/rfc792.txt">RFC 792</ulink><indexterm><primary>RFC 792</primary></indexterm>
           and
-          <ulink role="hidepdf" url="http://www.rfc-editor.org/rfc/rfc950.txt">RFC 950</ulink><indexterm><primary>RFC 950</primary></indexterm>)
+          <ulink role="hidepdf" url="http://www.rfc-editor.org/rfc/rfc950.txt">RFC 950</ulink><indexterm><primary>RFC 950</primary></indexterm>
+          )
           also specify timestamp request, information
           request, and address mask request packets as codes 13, 15,
           and 17, respectively.  While the ostensible purpose for
@@ -823,8 +825,8 @@ you would expect.</para>
           headers<indexterm><primary>protocol-specific payloads</primary><secondary>IP</secondary></indexterm>
           while other protocols are
           sent with no additional data beyond the IP header (unless any of
-          <option>--data</option><indexterm><primary><option>--data</option></primary></indexterm>,
-          <option>--data-string</option><indexterm><primary><option>--data-string</option></primary></indexterm>, or
+          <option>--data</option><indexterm><primary><option>--data</option></primary></indexterm> ,
+          <option>--data-string</option><indexterm><primary><option>--data-string</option></primary></indexterm> , or
           <option>--data-length</option><indexterm><primary><option>--data-length</option></primary></indexterm>
           options are specified).</para>
 
@@ -2230,7 +2232,9 @@ way.</para>
 
     <para>The Nmap Scripting Engine (NSE) is one of Nmap's most
     powerful and flexible features.  It allows users to write (and
-    share) simple scripts (using the <ulink url="http://lua.org">Lua programming language</ulink>, <indexterm><primary>Lua programming language</primary></indexterm>) to automate a wide variety of
+    share) simple scripts (using the <ulink url="http://lua.org">Lua programming language</ulink>
+    <indexterm><primary>Lua programming language</primary></indexterm>
+    ) to automate a wide variety of
     networking tasks.  Those scripts are executed in parallel with the
     speed and efficiency you expect from Nmap.  Users can rely on the
     growing and diverse set of scripts distributed with Nmap, or write
@@ -3014,9 +3018,8 @@ values.</para>
 so only one port is scanned at a time, and waiting five minutes
 between sending each probe.  <option>T1</option> and
 <option>T2</option> are similar but they only wait 15 seconds and 0.4
-seconds, respectively, between probes.  <option>T3</option> is Nmap's
-default behavior, which includes
-parallelization.<indexterm><primary><literal>normal</literal> (<option>-T3</option>) timing template</primary></indexterm>
+seconds, respectively, between probes.  <option>T3</option><indexterm><primary><literal>normal</literal> (<option>-T3</option>) timing template</primary></indexterm> is Nmap's
+default behavior, which includes parallelization.
 <option>-T4</option>
 does the equivalent of <option>--max-rtt-timeout 1250ms
 --initial-rtt-timeout 500ms --max-retries 6</option> and sets the maximum TCP scan delay
@@ -3516,7 +3519,8 @@ work properly.</para>
 
           <para>Asks Nmap to establish TCP connections with a final
           target through supplied chain of one or more HTTP or SOCKS4
-          <indexterm><primary>proxies</primary></indexterm>.  Proxies
+          <indexterm><primary>proxies</primary></indexterm>
+          proxies.  Proxies
           can help hide the true source of a scan or evade certain
           firewall restrictions, but they can hamper scan performance
           by increasing latency.  Users may need to adjust Nmap
@@ -4494,16 +4498,16 @@ Service scan Timing: About 33.33% done; ETC: 20:57 (0:00:12 remaining)
     do not currently exist.</para>
 
     <para>
-      <indexterm><primary><option>-v</option></primary><secondary>example of</secondary></indexterm>
       <command>nmap -v scanme.nmap.org</command>
+      <indexterm><primary><option>-v</option></primary><secondary>example of</secondary></indexterm>
     </para>
     <para>This option scans all reserved TCP ports on the machine
     <literal>scanme.nmap.org</literal> . The <option>-v</option>
     option enables verbose mode.</para>
     <para>
+      <command>nmap -sS -O scanme.nmap.org/24</command>
       <indexterm><primary><option>-sS</option></primary><secondary>example of</secondary></indexterm>
       <indexterm><primary><option>-O</option></primary><secondary>example of</secondary></indexterm>
-      <command>nmap -sS -O scanme.nmap.org/24</command>
     </para>
     <para>Launches a stealth SYN scan against each machine that is
     up out of the 256 IPs on the class C sized network where
@@ -4512,9 +4516,9 @@ Service scan Timing: About 33.33% done; ETC: 20:57 (0:00:12 remaining)
     running. This requires root privileges because of the SYN scan
     and OS detection.</para>
     <para>
-      <indexterm><primary><option>-p</option></primary><secondary>example of</secondary></indexterm>
       <command>nmap -sV -p 22,53,110,143,4564
       198.116.0-255.1-127</command>
+      <indexterm><primary><option>-p</option></primary><secondary>example of</secondary></indexterm>
     </para>
 
     <para>Launches host enumeration and a TCP scan at the first half
@@ -4525,9 +4529,9 @@ Service scan Timing: About 33.33% done; ETC: 20:57 (0:00:12 remaining)
     what application is running.</para>
 
     <para>
+      <command>nmap -v -iR 100000 -Pn -p 80</command>
       <indexterm><primary><option>-iR</option></primary><secondary>example of</secondary></indexterm>
       <indexterm><primary><option>-Pn</option></primary><secondary>example of</secondary></indexterm>
-      <command>nmap -v -iR 100000 -Pn -p 80</command>
     </para>
 
     <para>Asks Nmap to choose 100,000 hosts at random and scan them
@@ -4537,10 +4541,10 @@ Service scan Timing: About 33.33% done; ETC: 20:57 (0:00:12 remaining)
     probing one port on each target host anyway.</para>
 
     <para>
-      <indexterm><primary><option>-oX</option></primary><secondary>example of</secondary></indexterm>
-      <indexterm><primary><option>-oG</option></primary><secondary>example of</secondary></indexterm>
       <command>nmap -Pn -p80 -oX logs/pb-port80scan.xml -oG
       logs/pb-port80scan.gnmap 216.163.128.20/20</command>
+      <indexterm><primary><option>-oX</option></primary><secondary>example of</secondary></indexterm>
+      <indexterm><primary><option>-oG</option></primary><secondary>example of</secondary></indexterm>
     </para>
     <para>This scans 4096 IPs for any web servers (without pinging
     them) and saves the output in grepable and XML formats.</para>

diff --git a/docs/zenmap.1 b/docs/zenmap.1
@@ -2,12 +2,12 @@
 .\"     Title: zenmap
 .\"    Author: [see the "Authors" section]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 08/29/2014
+.\"      Date: 10/22/2014
 .\"    Manual: Zenmap Reference Guide
 .\"    Source: Zenmap
 .\"  Language: English
 .\"
-.TH "ZENMAP" "1" "08/29/2014" "Zenmap" "Zenmap Reference Guide"
+.TH "ZENMAP" "1" "10/22/2014" "Zenmap" "Zenmap Reference Guide"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/ncat/docs/ncat.1 b/ncat/docs/ncat.1
@@ -2,12 +2,12 @@
 .\"     Title: Ncat
 .\"    Author: [see the "Authors" section]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 08/29/2014
+.\"      Date: 10/22/2014
 .\"    Manual: Ncat Reference Guide
 .\"    Source: Ncat
 .\"  Language: English
 .\"
-.TH "NCAT" "1" "08/29/2014" "Ncat" "Ncat Reference Guide"
+.TH "NCAT" "1" "10/22/2014" "Ncat" "Ncat Reference Guide"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------