Skip to content

Start converting our man pages to AsciiDoc.

Gerald Combs requested to merge geraldcombs/wireshark:asciidoc-man-pages into master

Add pod2adoc.py, which converts our .pod files to Asciidoctor. This:

  • Uses 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 nested lists and tables.

Convert our CMake configuration to produce nroff 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.

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

Line count sanity check:

Man page .pod .adoc
androiddump 260 279
asn2deb 93 104
capinfos 401 470
captype 54 54
ciscodump 241 268
dftest 42 41
dpauxmon 153 168
dumpcap 464 533
editcap 528 582
etwdump 136 155
extcap 157 180
idl2deb 91 102
idl2wrs 120 99
mergecap 206 206
mmdbresolve 75 74
randpkt 107 110
randpktdump 158 183
rawshark 558 609
reordercap 76 77
sdjournal 145 156
sshdump 272 301
text2pcap 274 311
tshark 2135 2359
udpdump 133 150
wireshark-filter 486 478
wireshark 2967 3419

Edited by Gerald Combs

Merge request reports