aboutsummaryrefslogtreecommitdiffstats
path: root/doc/randpkt.adoc
AgeCommit message (Collapse)AuthorFilesLines
2021-12-27Docs: Document our diagnostic output options.Gerald Combs1-0/+2
Add docs/diagnostic-options.adoc, which is a snippet that documents our various --log-* options. Include it in the dumpcap, rawshark, and tshark man pages. Make the ws_log_print_usage output more consistent.
2021-10-19Docs: Move includes to the top of our man pages.Gerald Combs1-1/+1
Move our attributes.adoc includes to the very top of each man page. Older versions of Asciidoctor complain if it's not at the top. and additionally generate <file>.man instead of <file>.<section> if we don't explictly supply an output file.
2021-10-01Docs+Packaging: Convert our man pages to Asciidoctor.Gerald Combs1-34/+38
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-01Docs: Prep for POD to Asciidoctor conversion.Gerald Combs1-0/+107
[skip ci] Rename each of our .pod files to .adoc. Add pod2adoc.py, which converts POD markup to Asciidoctor, along with customizations specific to us.