aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2023-11-13 16:01:25 -0800
committerAndersBroman <a.broman58@gmail.com>2023-11-14 06:07:53 +0000
commit6ce97e418b9eeebf217b41b92a97f2fe868a8982 (patch)
treedd3d9ce3d52cb5a76484d8d8a4d129220f48f5be /doc
parenta0839b6e5ed8a4326552477bcd3efeaa3f10d66f (diff)
Docs: Move attributes.adoc to the doc directory
Diffstat (limited to 'doc')
-rw-r--r--doc/androiddump.adoc2
-rw-r--r--doc/asn2deb.adoc2
-rw-r--r--doc/attributes.adoc107
-rw-r--r--doc/capinfos.adoc2
-rw-r--r--doc/captype.adoc2
-rw-r--r--doc/ciscodump.adoc2
-rw-r--r--doc/dpauxmon.adoc2
-rw-r--r--doc/dumpcap.adoc2
-rw-r--r--doc/editcap.adoc2
-rw-r--r--doc/etwdump.adoc2
-rw-r--r--doc/extcap.adoc2
-rw-r--r--doc/falcodump.adoc2
-rw-r--r--doc/faq.adoc2
-rw-r--r--doc/idl2deb.adoc2
-rw-r--r--doc/idl2wrs.adoc2
-rw-r--r--doc/mergecap.adoc2
-rw-r--r--doc/mmdbresolve.adoc2
-rw-r--r--doc/randpkt.adoc2
-rw-r--r--doc/randpktdump.adoc2
-rw-r--r--doc/rawshark.adoc2
-rw-r--r--doc/release-notes.adoc2
-rw-r--r--doc/reordercap.adoc2
-rw-r--r--doc/sdjournal.adoc2
-rw-r--r--doc/sshdump.adoc2
-rw-r--r--doc/text2pcap.adoc2
-rw-r--r--doc/tshark.adoc2
-rw-r--r--doc/udpdump.adoc2
-rw-r--r--doc/wifidump.adoc2
-rw-r--r--doc/wireshark-filter.adoc2
-rw-r--r--doc/wireshark.adoc2
30 files changed, 136 insertions, 29 deletions
diff --git a/doc/androiddump.adoc b/doc/androiddump.adoc
index d68a3a3ac9..39e199255b 100644
--- a/doc/androiddump.adoc
+++ b/doc/androiddump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= androiddump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/asn2deb.adoc b/doc/asn2deb.adoc
index db97652296..c04e23badc 100644
--- a/doc/asn2deb.adoc
+++ b/doc/asn2deb.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= asn2deb(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/attributes.adoc b/doc/attributes.adoc
new file mode 100644
index 0000000000..ded54845fe
--- /dev/null
+++ b/doc/attributes.adoc
@@ -0,0 +1,107 @@
+// Common attributes
+
+:wireshark-version: 4.3.0
+:logray-version: 0.9.0
+
+// Required for btn, kbd:, and menu: macros.
+:experimental:
+
+// We want footers (which include page numbers) in our PDF output but
+// not elsewhere, particularly in our man pages.
+// We could use the "reproducible" attribute here, but it generates an
+// empty black box.
+ifndef::backend-pdf[]
+:nofooter:
+endif::[]
+
+// Create PA4 (210 × 280mm) pages: https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4
+// This is the approximate intersection of A4 (210 × 297mm) and U.S. Letter
+// (216 × 279mm).
+:pdf-page-size: 210mm x 280mm
+
+// Include glyphs for up/down arrows
+:pdf-theme: default-with-fallback-font
+
+//
+// URLs
+//
+
+// Wireshark top level URLs (sites)
+:wireshark-main-url: https://www.wireshark.org/
+:wireshark-gitlab-project-url: https://gitlab.com/wireshark/wireshark
+:wireshark-qa-url: https://ask.wireshark.org/
+:wireshark-foundation-url: https://wiresharkfoundation.org/
+:sharkfest-url: https://sharkfest.wireshark.org/
+
+// Wireshark secondary URLs (pages)
+:wireshark-bugs-url: {wireshark-gitlab-project-url}/-/issues
+:wireshark-code-review-url: {wireshark-gitlab-project-url}/-/merge_requests
+:wireshark-wiki-url: {wireshark-gitlab-project-url}/-/wikis/
+:wireshark-authors-url: {wireshark-main-url}about.html#authors
+:wireshark-code-browse-url: {wireshark-gitlab-project-url}/-/tree/master
+:wireshark-code-file-url: {wireshark-gitlab-project-url}/-/blob/master/
+:wireshark-commits-url: {wireshark-gitlab-project-url}/-/commits/master
+:wireshark-merge-request-url: {wireshark-gitlab-project-url}/-/merge_requests
+:wireshark-developers-guide-url: {wireshark-main-url}docs/wsdg_html_chunked/
+:wireshark-display-filter-reference-url: {wireshark-main-url}docs/dfref/
+:wireshark-download-url: {wireshark-main-url}download.html
+:wireshark-faq-url: {wireshark-main-url}faq.html
+:wireshark-git-anonhttp-url: https://gitlab.com/wireshark/wireshark.git
+:wireshark-git-ssh-url: \git@gitlab.com:wireshark/wireshark.git
+:wireshark-mailing-lists-url: {wireshark-main-url}lists/
+:wireshark-man-page-url: {wireshark-main-url}docs/man-pages/
+:wireshark-snapshots-url: {wireshark-main-url}download/automated/src/
+:wireshark-users-guide-url: {wireshark-main-url}docs/wsug_html_chunked/
+:wireshark-wiki-moin-import-url: {wireshark-wiki-url}uploads/__moin_import__/attachments/
+
+// External URLs
+:tcpdump-main-url: https://www.tcpdump.org/
+:pcap-filter-man-page-url: {tcpdump-main-url}manpages/pcap-filter.7.html
+:tcpdump-man-page-url: {tcpdump-main-url}manpages/tcpdump.1.html
+
+:npcap-main-url: https://npcap.com/
+:npcap-development-url: https://github.com/nmap/npcap
+:npcap-license-url: https://raw.githubusercontent.com/nmap/npcap/master/LICENSE
+:vcpkg-main-url: https://github.com/Microsoft/vcpkg/
+
+:sysfs-main-url: http://linux-diag.sourceforge.net/Sysfsutils.html
+:wikipedia-main-url: https://en.wikipedia.org/wiki/
+:pcre2pattern-url: https://www.pcre.org/current/doc/html/pcre2pattern.html
+
+:greenwichmeantime-main-url: https://wwp.greenwichmeantime.com/
+:timeanddate-main-url: https://www.timeanddate.com/worldclock/
+:ntp-main-url: http://www.ntp.org/
+
+:gplv2-url: https://www.gnu.org/licenses/gpl-2.0.html
+:spdx-license-url: https://spdx.org/licenses/
+
+// Email addresses
+:at-separator: &#91;AT&#93;
+:wireshark-dev-list-email: wireshark-dev{at-separator}wireshark.org
+:wsdg-author-email: ulf.lamping{at-separator}web.de
+:wsdg-author-email2: graham.bloice{at-separator}trihedral.com
+
+:wsug-author-email: ulf.lamping{at-separator}web.de
+:wsug-author-email2: rsharpe{at-separator}ns.aus.com
+:wsug-author-email3: hagbard{at-separator}physics.rutgers.edu
+:wsug-author-email4: luis{at-separator}ontanon.org
+
+//
+// Image formatting
+//
+
+// "scaledwidth" only applies to PDF output
+:pdf-scaledwidth: scaledwidth="85%"
+:screenshot-attrs: scaledwidth="85%"
+:medium-screenshot-attrs: scaledwidth="60%"
+:small-screenshot-attrs: scaledwidth="35%"
+:related-attrs: height=18
+// XXX height=22 results in content-height="22px" in the .fo file. Not sure
+// how to make scaledwidth take precedence.
+:statusbar-attrs: scaledwidth="85%",height=22
+
+:multiplication: ×
+:underscore: _
+:cmd: ⌘
+
+:missing: Not yet written. If you would like to fix this, see https://gitlab.com/wireshark/wireshark/-/wikis/Development/SubmittingPatches.
diff --git a/doc/capinfos.adoc b/doc/capinfos.adoc
index 4dec8136eb..848013a11b 100644
--- a/doc/capinfos.adoc
+++ b/doc/capinfos.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= capinfos(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/captype.adoc b/doc/captype.adoc
index 11eb6bf044..f8c8e985b7 100644
--- a/doc/captype.adoc
+++ b/doc/captype.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= captype(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/ciscodump.adoc b/doc/ciscodump.adoc
index b721b28436..4a09c10f1d 100644
--- a/doc/ciscodump.adoc
+++ b/doc/ciscodump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= ciscodump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/dpauxmon.adoc b/doc/dpauxmon.adoc
index cf98cecbdd..d091c76644 100644
--- a/doc/dpauxmon.adoc
+++ b/doc/dpauxmon.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= dpauxmon(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/dumpcap.adoc b/doc/dumpcap.adoc
index 672599bceb..a8116a0d77 100644
--- a/doc/dumpcap.adoc
+++ b/doc/dumpcap.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= dumpcap(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/editcap.adoc b/doc/editcap.adoc
index 20fadc1a4f..9ac5c8a36f 100644
--- a/doc/editcap.adoc
+++ b/doc/editcap.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= editcap(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/etwdump.adoc b/doc/etwdump.adoc
index b1070d38b8..4798c54930 100644
--- a/doc/etwdump.adoc
+++ b/doc/etwdump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= etwdump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/extcap.adoc b/doc/extcap.adoc
index 511a59cc48..96aa1fa9d0 100644
--- a/doc/extcap.adoc
+++ b/doc/extcap.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= extcap(4)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/falcodump.adoc b/doc/falcodump.adoc
index cecca0176a..72bd06695b 100644
--- a/doc/falcodump.adoc
+++ b/doc/falcodump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= falcodump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/faq.adoc b/doc/faq.adoc
index 6cbd55d2e3..43cfa20764 100644
--- a/doc/faq.adoc
+++ b/doc/faq.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
:stylesheet: ws.css
:linkcss:
:copycss: {stylesheet}
diff --git a/doc/idl2deb.adoc b/doc/idl2deb.adoc
index 146672fda9..eabac0d00a 100644
--- a/doc/idl2deb.adoc
+++ b/doc/idl2deb.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= idl2deb(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/idl2wrs.adoc b/doc/idl2wrs.adoc
index c046c536e8..43a910fc2a 100644
--- a/doc/idl2wrs.adoc
+++ b/doc/idl2wrs.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= idl2wrs(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/mergecap.adoc b/doc/mergecap.adoc
index a5c9a6c3bd..014331ca8d 100644
--- a/doc/mergecap.adoc
+++ b/doc/mergecap.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= mergecap(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/mmdbresolve.adoc b/doc/mmdbresolve.adoc
index 4b8804012b..2509c54b56 100644
--- a/doc/mmdbresolve.adoc
+++ b/doc/mmdbresolve.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= mmdbresolve(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/randpkt.adoc b/doc/randpkt.adoc
index 97104b7010..0d399e140b 100644
--- a/doc/randpkt.adoc
+++ b/doc/randpkt.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= randpkt(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/randpktdump.adoc b/doc/randpktdump.adoc
index 3e13a77f60..03763c8e1d 100644
--- a/doc/randpktdump.adoc
+++ b/doc/randpktdump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= randpktdump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/rawshark.adoc b/doc/rawshark.adoc
index 180c256f7b..b0976e2db1 100644
--- a/doc/rawshark.adoc
+++ b/doc/rawshark.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= rawshark(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/release-notes.adoc b/doc/release-notes.adoc
index 883cb6246f..5f3e479d8b 100644
--- a/doc/release-notes.adoc
+++ b/doc/release-notes.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
:stylesheet: ws.css
:linkcss:
:copycss: {stylesheet}
diff --git a/doc/reordercap.adoc b/doc/reordercap.adoc
index fd57b0a7c7..71069a0afc 100644
--- a/doc/reordercap.adoc
+++ b/doc/reordercap.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= reordercap(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/sdjournal.adoc b/doc/sdjournal.adoc
index bf9a36892d..d81c5e3355 100644
--- a/doc/sdjournal.adoc
+++ b/doc/sdjournal.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= sdjournal(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/sshdump.adoc b/doc/sshdump.adoc
index 8acacd1f81..ec9abf1345 100644
--- a/doc/sshdump.adoc
+++ b/doc/sshdump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= sshdump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/text2pcap.adoc b/doc/text2pcap.adoc
index ab8947479d..213eb348c4 100644
--- a/doc/text2pcap.adoc
+++ b/doc/text2pcap.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= text2pcap(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/tshark.adoc b/doc/tshark.adoc
index a9f844734e..d688a6d9c8 100644
--- a/doc/tshark.adoc
+++ b/doc/tshark.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= tshark(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/udpdump.adoc b/doc/udpdump.adoc
index 8739ab6fa9..4c68488ae6 100644
--- a/doc/udpdump.adoc
+++ b/doc/udpdump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= udpdump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/wifidump.adoc b/doc/wifidump.adoc
index e202d05a78..930ee27a37 100644
--- a/doc/wifidump.adoc
+++ b/doc/wifidump.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= wifidump(1)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/wireshark-filter.adoc b/doc/wireshark-filter.adoc
index 6fcbf24716..3ff6f0e901 100644
--- a/doc/wireshark-filter.adoc
+++ b/doc/wireshark-filter.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= wireshark-filter(4)
:doctype: manpage
:stylesheet: ws.css
diff --git a/doc/wireshark.adoc b/doc/wireshark.adoc
index ca34f549bb..91c87ff689 100644
--- a/doc/wireshark.adoc
+++ b/doc/wireshark.adoc
@@ -1,4 +1,4 @@
-include::../docbook/attributes.adoc[]
+include::attributes.adoc[]
= wireshark(1)
:doctype: manpage
:stylesheet: ws.css