osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

wslog: Documentation fixups

This commit is contained in:
João Valverde 2021-06-21 22:39:54 +01:00
parent 585ddc9283
commit 2080661e88
3 changed files with 41 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/tshark.pod
View File

@ -2077,20 +2077,32 @@ troubleshoot a problem with a protocol dissector.
This environment variable controls the verbosity of diagnostic messages to
the console. From less verbose to most verbose levels can be C<critical>,
C<warning>, C<message>, C<info> or C<debug>. Levels above the current level
are also active. Levels C<critical> and C<error> are always active.
C<warning>, C<message>, C<info>, C<debug> or C<noisy>. Levels above the
current level are also active. Levels C<critical> and C<error> are always
active.
=item WIRESHARK_LOG_FATAL
Sets the fatal log level. Fatal log levels cause the progeam to abort.
The fatal log level be set to C<critical> or C<warning>. C<Error> is
always fatal.
=item WIRESHARK_LOG_DOMAINS
This environment variable selects with log domains are active. The filter is
This environment variable selects which log domains are active. The filter is
given as a case-insensitive comma separated list. If set only the included
domains will be enabled. The default domain is always considered to be enabled.
Domain filter lists can be preceded by '!' to invert the sense of the match.
=item WIRESHARK_LOG_DEBUG
List of domains with C<debug> log level. This sets the level of the listed
log domains and takes precedence over the active domains filter.
List of domains with C<debug> log level. This sets the level of the provided
log domains and takes precedence over the active domains filter. If preceded
by '!' this disables the C<debug> level instead.
=item WIRESHARK_LOG_NOISY
Same as above but for C<noisy> log level instead.
=back

22
doc/wireshark.pod
View File

@ -2935,20 +2935,32 @@ of the capture after it stops; it's primarily useful for testing.
This environment variable controls the verbosity of diagnostic messages to
the console. From less verbose to most verbose levels can be C<critical>,
C<warning>, C<message>, C<info> or C<debug>. Levels above the current level
are also active. Levels C<critical> and C<error> are always active.
C<warning>, C<message>, C<info>, C<debug> or C<noisy>. Levels above the
current level are also active. Levels C<critical> and C<error> are always
active.
=item WIRESHARK_LOG_FATAL
Sets the fatal log level. Fatal log levels cause the progeam to abort.
The fatal log level be set to C<critical> or C<warning>. C<Error> is
always fatal.
=item WIRESHARK_LOG_DOMAINS
This environment variable selects with log domains are active. The filter is
This environment variable selects which log domains are active. The filter is
given as a case-insensitive comma separated list. If set only the included
domains will be enabled. The default domain is always considered to be enabled.
Domain filter lists can be preceded by '!' to invert the sense of the match.
=item WIRESHARK_LOG_DEBUG
List of domains with C<debug> log level. This sets the level of the listed
log domains and takes precedence over the active domains filter.
List of domains with C<debug> log level. This sets the level of the provided
log domains and takes precedence over the active domains filter. If preceded
by '!' this disables the C<debug> level instead.
=item WIRESHARK_LOG_NOISY
Same as above but for C<noisy> log level instead.
=back

13
wsutil/wslog.c
View File

@ -798,11 +798,12 @@ void ws_log_add_custom_file(FILE *fp)
void ws_log_print_usage(FILE *fp)
{
fprintf(fp, "Diagnostic output:\n");
fprintf(fp, " --log-level <level> one of \"critical\", \"warning\", \"message\","
fprintf(fp, " --log-level <level> one of \"critical\", \"warning\", \"message\", "
"\"info\", \"debug\" or \"noisy\"\n");
fprintf(fp, " --log-domains <list> comma separated list of the active log domains\n");
fprintf(fp, " --log-fatal <level> one of \"critical\" or \"warning\", causes level to abort the program\n");
fprintf(fp, " --log-file <file> path of file to output messages to (in addition to stderr)\n");
fprintf(fp, " --log-debug <list> comma separated list of domains with \"debug\" level\n");
fprintf(fp, " --log-noisy <list> comma separated list of domains with \"noisy\" level\n");
fprintf(fp, " --log-fatal <level> one of \"critical\" or \"warning\", causes level "
"to abort the program\n");
fprintf(fp, " --log-domains <[!]list> comma separated list of the active log domains\n");
fprintf(fp, " --log-debug <[!]list> comma separated list of domains with \"debug\" level\n");
fprintf(fp, " --log-noisy <[!]list> comma separated list of domains with \"noisy\" level\n");
fprintf(fp, " --log-file <path> path of file to output messages to (in addition to stderr)\n");
}