diff options
| author | Peter Wu <peter@lekensteyn.nl> | 2019-07-29 01:17:04 +0100 |
|---|---|---|
| committer | Jeff Morriss <jeff.morriss.ws@gmail.com> | 2019-07-29 19:15:20 +0000 |
| commit | 04c12dd67bd040958e295584e340905b0ec680ff (patch) | |
| tree | ae8dd02b3fd887ad291721280430e7c89328cf46 /doc | |
| parent | fb055b1c4f2c49314313c0e2072d56998bd74701 (diff) | |
doc: document WIRESHARK_CONFIG_DIR
WIRESHARK_CONFIG_DIR was introduced with Wireshark 3.0 and is more
cross-platform than WIRESHARK_APPDATA. The latter was presumably created
for use by PortableApps. Let's consider that an internal, undocumented
detail that might be change, and document WIRESHARK_CONFIG_DIR instead.
Change-Id: I0042d607b282cc6dee4b017b1e80b44087bd62e9
Reviewed-on: https://code.wireshark.org/review/34113
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot
Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rawshark.pod | 9 | ||||
| -rw-r--r-- | doc/tshark.pod | 9 | ||||
| -rw-r--r-- | doc/wireshark.pod.template | 9 |
3 files changed, 15 insertions, 12 deletions
diff --git a/doc/rawshark.pod b/doc/rawshark.pod index 94973d7956..bd81e37143 100644 --- a/doc/rawshark.pod +++ b/doc/rawshark.pod @@ -470,11 +470,12 @@ personal preferences file. =over 4 -=item WIRESHARK_APPDATA +=item WIRESHARK_CONFIG_DIR -On Windows, Wireshark normally stores all application data in %APPDATA% or -%USERPROFILE%. You can override the default location by exporting this -environment variable to specify an alternate location. +This environment variable overrides the location of personal configuration +files. It defaults to F<$XDG_CONFIG_HOME/wireshark> (or F<$HOME/.wireshark> if +the former is missing while the latter exists). On Windows, +F<%APPDATA%\Wireshark> is used instead. Available since Wireshark 3.0. =item WIRESHARK_DEBUG_WMEM_OVERRIDE diff --git a/doc/tshark.pod b/doc/tshark.pod index 5cb7116cc1..d11df4a1e4 100644 --- a/doc/tshark.pod +++ b/doc/tshark.pod @@ -2015,11 +2015,12 @@ encoded as UTF-16LE. =over 4 -=item WIRESHARK_APPDATA +=item WIRESHARK_CONFIG_DIR -On Windows, Wireshark normally stores all application data in %APPDATA% or -%USERPROFILE%. You can override the default location by exporting this -environment variable to specify an alternate location. +This environment variable overrides the location of personal configuration +files. It defaults to F<$XDG_CONFIG_HOME/wireshark> (or F<$HOME/.wireshark> if +the former is missing while the latter exists). On Windows, +F<%APPDATA%\Wireshark> is used instead. Available since Wireshark 3.0. =item WIRESHARK_DEBUG_WMEM_OVERRIDE diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template index 7cee691244..6affa68d79 100644 --- a/doc/wireshark.pod.template +++ b/doc/wireshark.pod.template @@ -2867,11 +2867,12 @@ See above in the description of the About:Plugins page. =over 4 -=item WIRESHARK_APPDATA +=item WIRESHARK_CONFIG_DIR -On Windows, Wireshark normally stores all application data in %APPDATA% or -%USERPROFILE%. You can override the default location by exporting this -environment variable to specify an alternate location. +This environment variable overrides the location of personal configuration +files. It defaults to F<$XDG_CONFIG_HOME/wireshark> (or F<$HOME/.wireshark> if +the former is missing while the latter exists). On Windows, +F<%APPDATA%\Wireshark> is used instead. Available since Wireshark 3.0. =item WIRESHARK_DEBUG_WMEM_OVERRIDE |