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>
This commit is contained in:
Peter Wu 2019-07-29 01:17:04 +01:00 committed by Jeff Morriss
parent fb055b1c4f
commit 04c12dd67b
3 changed files with 15 additions and 12 deletions

View File

@ -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

View File

@ -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

View File

@ -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