installation_instructions

r_extcap

Function installation_instructions 

Source 
pub fn installation_instructions() -> String
Expand description

Get the installation instructions. This is useful to show if the program is used in unexpected ways (e.g. not as an extcap program), so users can easily install with a copy-pastable command.

assert_eq!(
    r_extcap::installation_instructions(),
    formatdoc!{"
        This is an extcap plugin meant to be used with Wireshark or tshark.
        To install this plugin for use with Wireshark, symlink or copy this executable \
        to your Wireshark extcap directory

        For Wireshark 4.0 or before:
          mkdir -p \"$HOME/.config/wireshark/extcap/\" && ln -s \"{executable_path}\" \"$HOME/.config/wireshark/extcap/{exe_name}\"
        For Wireshark 4.1 or later:
          mkdir -p \"$HOME/.local/lib/wireshark/extcap/\" && ln -s \"{executable_path}\" \"$HOME/.local/lib/wireshark/extcap/{exe_name}\"\
    "}
)