aboutsummaryrefslogtreecommitdiffstats
path: root/doc/captype.adoc
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2021-09-30 15:31:36 -0700
committerWireshark GitLab Utility <gerald+gitlab-utility@wireshark.org>2021-10-01 16:42:34 +0000
commit9f1607ab473c578d714320fa735fb0bc4e1d1e96 (patch)
tree6e8ae12807953db651f60aaf6a29c9589ebca9bc /doc/captype.adoc
parent04b0e2b80be9654bbe307c66943222fadf1f93c1 (diff)
Docs: Prep for POD to Asciidoctor conversion.
[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.
Diffstat (limited to 'doc/captype.adoc')
-rw-r--r--doc/captype.adoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/captype.adoc b/doc/captype.adoc
new file mode 100644
index 0000000000..1ea31d2558
--- /dev/null
+++ b/doc/captype.adoc
@@ -0,0 +1,54 @@
+=begin man
+
+=encoding utf8
+
+=end man
+
+=head1 NAME
+
+captype - Prints the types of capture files
+
+=head1 SYNOPSIS
+
+B<captype>
+E<lt>I<infile>E<gt>
+I<...>
+
+=head1 DESCRIPTION
+
+B<Captype> is a program that opens one or more capture files and
+prints the capture file type of each E<lt>I<infile>E<gt>.
+
+B<Captype> is able to detect and read the same capture files that are
+supported by B<Wireshark>.
+The input files don't need a specific filename extension; the file
+format and an optional gzip, zstd or lz4 compression will be automatically detected.
+Near the beginning of the DESCRIPTION section of wireshark(1) or
+L<https://www.wireshark.org/docs/man-pages/wireshark.html>
+is a detailed description of the way B<Wireshark> handles this, which is
+the same way B<Captype> handles this.
+
+=head1 SEE ALSO
+
+pcap(3), wireshark(1), mergecap(1), editcap(1), tshark(1),
+dumpcap(1), capinfos(1), pcap-filter(7) or tcpdump(8)
+
+=head1 NOTES
+
+B<Captype> is part of the B<Wireshark> distribution. The latest version
+of B<Wireshark> can be found at L<https://www.wireshark.org>.
+
+HTML versions of the Wireshark project man pages are available at:
+L<https://www.wireshark.org/docs/man-pages>.
+
+=head1 AUTHORS
+
+ Original Author
+ -------- ------
+ Ian Schorr <ian[AT]ianschorr.com>
+
+
+ Contributors
+ ------------
+ Gerald Combs <gerald[AT]wireshark.org>
+ Jim Young <jyoung[AT]gsu.edu>