wireshark/docbook/asciidoctor-macros
Gerald Combs 84ab55cf75 Docs+Packaging: Convert our man pages to Asciidoctor.
Convert doc/*.pod to Asciidoctor. This:

* Means we use the same markup for our man pages, the guides, and
  release notes.
* Lets us add versions to our man pages.
* Gives us more formatting options, e.g. AsciiDoc supports `commands`,
  nested lists and makes it easy to include version information. The
  manpage backend doesn't seem to support tables very well,
  unfortunately.

Convert our CMake configuration to produce *roff and html man pages
using Asciidoctor. Add a "manarg" block macro which makes our synopses
wrap correctly.

Similar to the release notes, guides, and FAQ, if Asciidoctor isn't
found the man pages won't be generated or installed.

Move Asciidoctor to the list of package build dependencies in various
places.

This commit includes the conversion script (pod2adoc.py), which will be
removed later.

Line count sanity check:

Man page         .pod .adoc
androiddump       260  280
asn2deb            93  105
capinfos          401  471
captype            54   55
ciscodump         241  269
dftest             42   42
dpauxmon          153  169
dumpcap           464  534
editcap           528  583
etwdump           136  156
extcap            157  181
idl2deb            91  103
idl2wrs           120  100
mergecap          206  207
mmdbresolve        75   75
randpkt           107  111
randpktdump       158  184
rawshark          558  610
reordercap         76   78
sdjournal         145  157
sshdump           272  302
text2pcap         274  312
tshark           2135 2360
udpdump           133  151
wireshark-filter  486  479
wireshark        2967 3420
2021-10-01 16:42:34 +00:00
..
commaize-block Revert "docbook: remove equivalent case." 2018-06-27 17:07:37 +00:00
cveidlink-inline-macro Minor doc cleanups. 2021-03-20 17:14:07 +00:00
manarg-block Docs+Packaging: Convert our man pages to Asciidoctor. 2021-10-01 16:42:34 +00:00
wsbuglink-inline-macro Minor doc cleanups. 2021-03-20 17:14:07 +00:00
wssalink-inline-macro Minor doc cleanups. 2021-03-20 17:14:07 +00:00
README.adoc
commaize-block.rb
cveidlink-inline-macro.rb Asciidoctor: Remove underscores from macro names. 2018-05-24 20:00:56 +00:00
manarg-block.rb Docs+Packaging: Convert our man pages to Asciidoctor. 2021-10-01 16:42:34 +00:00
ws_utils.rb Minor doc cleanups. 2021-03-20 17:14:07 +00:00
wsbuglink-inline-macro.rb Asciidoctor: Remove underscores from macro names. 2018-05-24 20:00:56 +00:00
wssalink-inline-macro.rb Asciidoctor: Remove underscores from macro names. 2018-05-24 20:00:56 +00:00

README.adoc

Asciidoctor macros.

These files are available under the MIT license to match the
https://github.com/asciidoctor/asciidoctor-extensions-lab[Asciidoctor Extensions Lab]
and Asciidoctor itself.