id       = "wireshark"
name     = "Wireshark"
homepage = "https://www.wireshark.org"
description = "The world's leading network protocol analyzer."
icon     = "SimpleIcons:wireshark"
# The GUI and the two command-line captures that ship with it and read the same
# personal configuration folder.
executables   = ["wireshark", "tshark", "dumpcap"]

[dotfiles]

# The User's Guide, appendix "Configuration Files and Folders"
# (https://www.wireshark.org/docs/wsug_html_chunked/ChAppFilesConfigurationSection.html),
# gives the personal configuration folder as "%APPDATA%\Wireshark" on Windows
# and "$XDG_CONFIG_HOME/wireshark" — or "$HOME/.wireshark" for backward
# compatibility — everywhere else, macOS included. XDG on Unix plus %APPDATA%
# on Windows is [configHome]; the Windows spelling capitalises the folder,
# which resolves to the same directory on that platform's case-insensitive
# filesystem.
#
# The files below are that appendix's own Configuration Files table, one line
# each, with its description quoted:
#
#   cfilters         "Capture filters."
#   colorfilters     "Coloring rules."
#   dfilter_buttons  "Display filter buttons."
#   dfilters         "Display filters."
#   disabled_protos  "Disabled protocols."
#   dmacros          "Display filter macros."
#   ethers           "Ethernet name resolution."
#   hosts            "IPv4 and IPv6 name resolution."
#   ipxnets          "IPX name resolution."
#   manuf            "Ethernet name resolution."
#   preferences      "Settings from the Preferences dialog box."
#   services         "Network services."
#   ss7pcs           "SS7 point code resolution."
#   subnets          "IPv4 subnet name resolution."
#   subnetsipv6      "IPv6 subnet name resolution."
#   vlans            "VLAN ID name resolution."
#   wka              "Well-known MAC addresses."
#
# The folder is named file by file rather than as a directory on purpose. It
# also collects per-dissector tables that this appendix does not document —
# written by the protocol preference dialogs, and the place a decryption key
# typed into one of them ends up — and a directory path would carry those too,
# unnamed and unexamined.
paths = [
  "[configHome]/wireshark/cfilters",
  "[configHome]/wireshark/colorfilters",
  "[configHome]/wireshark/dfilter_buttons",
  "[configHome]/wireshark/dfilters",
  "[configHome]/wireshark/disabled_protos",
  "[configHome]/wireshark/dmacros",
  "[configHome]/wireshark/ethers",
  "[configHome]/wireshark/hosts",
  "[configHome]/wireshark/ipxnets",
  "[configHome]/wireshark/manuf",
  "[configHome]/wireshark/preferences",
  "[configHome]/wireshark/services",
  "[configHome]/wireshark/ss7pcs",
  "[configHome]/wireshark/subnets",
  "[configHome]/wireshark/subnetsipv6",
  "[configHome]/wireshark/vlans",
  "[configHome]/wireshark/wka",
]

# Nothing to carve out: the two files in the same table that are GUI state
# rather than settings — recent, "Per-profile GUI settings", which the page
# describes as holding "column widths and toolbar visibility", and
# recent_common, "Common GUI settings" — are simply not listed above.
exclude = []

# None of the files named above is a credential. Wireshark's decryption keys
# are a different matter, and the reason the directory is not synced as a
# whole; see the note over `paths`.
secret = []

# No machine_lines. `preferences` is a flat `name: value` file of column
# layouts, protocol options and appearance settings, all of which a user wants
# on the next machine, and the name-resolution files beside it describe a
# network rather than a machine.