Take a stab at adding a section on environment variables that affect *shark's behavior. So far, all the emem variables are included.

svn path=/trunk/; revision=30648
This commit is contained in:
Jeff Morriss 2009-10-20 20:14:23 +00:00
parent ef2e5d71cc
commit 9341d5c8fa
3 changed files with 213 additions and 96 deletions

View File

@ -358,6 +358,45 @@ personal preferences file.
=back
=head1 ENVIRONMENT VARIABLES
=over 4
=item WIRESHARK_DEBUG_EP_NO_CHUNKS
Normally per-packet memory is allocated in large "chunks." This behavior
doesn't work well with debugging tools such as Valgrind or ElectricFence.
Export this environment variable to force individual allocations.
Note: disabling chunks also disables canaries (see below).
=item WIRESHARK_DEBUG_SE_NO_CHUNKS
Normally per-file memory is allocated in large "chunks." This behavior
doesn't work well with debugging tools such as Valgrind or ElectricFence.
Export this environment variable to force individual allocations.
Note: disabling chunks also disables canaries (see below).
=item WIRESHARK_DEBUG_EP_NO_CANARY
Normally per-packet memory allocations are separated by "canaries" which
allow detection of memory overruns. This comes at the expense of some extra
memory usage. Exporting this environment variable disables these canaries.
=item WIRESHARK_DEBUG_SE_USE_CANARY
Exporting this environment variable causes per-file memory allocations to be
protected with "canaries" which allow for detection of memory overruns.
This comes at the expense of significant extra memory usage.
=item WIRESHARK_DEBUG_SCRUB_MEMORY
If this environment variable is exported, the contents of per-packet and
per-file memory is initialized to 0xBADDCAFE when the memory is allocated
and is reset to 0xDEADBEEF when the memory is freed. This functionality is
useful mainly to developers looking for bugs in the way memory is handled.
=back
=head1 SEE ALSO
wireshark-filter(4), wireshark(1), tshark(1), editcap(1), tcpdump(8),

View File

@ -961,6 +961,45 @@ personal preferences file.
=back
=head1 ENVIRONMENT VARIABLES
=over 4
=item WIRESHARK_DEBUG_EP_NO_CHUNKS
Normally per-packet memory is allocated in large "chunks." This behavior
doesn't work well with debugging tools such as Valgrind or ElectricFence.
Export this environment variable to force individual allocations.
Note: disabling chunks also disables canaries (see below).
=item WIRESHARK_DEBUG_SE_NO_CHUNKS
Normally per-file memory is allocated in large "chunks." This behavior
doesn't work well with debugging tools such as Valgrind or ElectricFence.
Export this environment variable to force individual allocations.
Note: disabling chunks also disables canaries (see below).
=item WIRESHARK_DEBUG_EP_NO_CANARY
Normally per-packet memory allocations are separated by "canaries" which
allow detection of memory overruns. This comes at the expense of some extra
memory usage. Exporting this environment variable disables these canaries.
=item WIRESHARK_DEBUG_SE_USE_CANARY
Exporting this environment variable causes per-file memory allocations to be
protected with "canaries" which allow for detection of memory overruns.
This comes at the expense of significant extra memory usage.
=item WIRESHARK_DEBUG_SCRUB_MEMORY
If this environment variable is exported, the contents of per-packet and
per-file memory is initialized to 0xBADDCAFE when the memory is allocated
and is reset to 0xDEADBEEF when the memory is freed. This functionality is
useful mainly to developers looking for bugs in the way memory is handled.
=back
=head1 SEE ALSO
wireshark-filter(4), wireshark(1), editcap(1), pcap-filter(4), tcpdump(8),

View File

@ -2557,6 +2557,45 @@ See above in the description of the About:Plugins page.
=back
=head1 ENVIRONMENT VARIABLES
=over 4
=item WIRESHARK_DEBUG_EP_NO_CHUNKS
Normally per-packet memory is allocated in large "chunks." This behavior
doesn't work well with debugging tools such as Valgrind or ElectricFence.
Export this environment variable to force individual allocations.
Note: disabling chunks also disables canaries (see below).
=item WIRESHARK_DEBUG_SE_NO_CHUNKS
Normally per-file memory is allocated in large "chunks." This behavior
doesn't work well with debugging tools such as Valgrind or ElectricFence.
Export this environment variable to force individual allocations.
Note: disabling chunks also disables canaries (see below).
=item WIRESHARK_DEBUG_EP_NO_CANARY
Normally per-packet memory allocations are separated by "canaries" which
allow detection of memory overruns. This comes at the expense of some extra
memory usage. Exporting this environment variable disables these canaries.
=item WIRESHARK_DEBUG_SE_USE_CANARY
Exporting this environment variable causes per-file memory allocations to be
protected with "canaries" which allow for detection of memory overruns.
This comes at the expense of significant extra memory usage.
=item WIRESHARK_DEBUG_SCRUB_MEMORY
If this environment variable is exported, the contents of per-packet and
per-file memory is initialized to 0xBADDCAFE when the memory is allocated
and is reset to 0xDEADBEEF when the memory is freed. This functionality is
useful mainly to developers looking for bugs in the way memory is handled.
=back
=head1 SEE ALSO
wireshark-filter(4), tshark(1), editcap(1), pcap-filter(4), tcpdump(8),