Changes between Initial Version and Version 1 of Usage

Timestamp:

Mar 1, 2011, 11:28:25 AM (13 years ago)

Author:

Sebastien Decugis

Comment:

--

Usage

@@ +1 @@
+= Usage =
+
+The freeDiameter daemon ({{{freeDiameterd}}}) accepts the following command-line arguments (all are optional):
+ {{{-h}}} or {{{--help}}}::
+   Displays this usage and exits.
+
+ {{{-V}}} or {{{--version}}}::
+   Displays the version of the daemon and exits.
+
+ {{{-c /path/to/conf}}} or {{{--config=path/to/conf}}}::
+   Use the ''/path/to/conf'' configuration file instead of [wiki:Installation#cmakeflags ${DEFAULT_CONF_PATH}]/freeDiameter.conf (use {{{-h}}} to see what the default prefix is).
+
+ {{{-d}}}, {{{-q}}}, {{{--debug}}} or {{{--quiet}}}::
+   Increases or decreases the verbosity of the debug messages. The flags can be specified several times. See [wiki:Troubleshooting] page for more information.
+
+The additional command-line options bellow are also available, but only if the daemon has been compiled in the "Debug" configuration ({{{-DCMAKE_BUILD_TYPE:STRING=Debug}}}):
+
+ {{{-f funcname}}} or {{{--dbg_func=funcname}}}::
+   The debug level will be set to maximum only inside functions with the name ''funcname''. Since this is dynamically evaluated, it works even with static functions and extension functions (that use debug macro from the library), but it is also quite slow. To get detailed information about the handling of incoming messages, you might use for example:
+{{{
+$ freeDiameterd --dbg_func=msg_rt_in
+}}}
+
+ {{{-F filename}}} or {{{--dbg_file=filename}}}::
+   Same as previous one, but all functions from the file ''filename'' will be logged at maximum trace level. Only the basename is compared, ignoring the path, as follow:
+{{{
+$ freeDiameterd --dbg_file=app_acct.c
+}}}
+
+At the moment, all debug messages from the {{{freeDiameter}}} daemon are sent to {{{stdout}}}. If you want to capture them in a file, you should redirect the stream as follow:
+{{{
+$ freeDiameterd -dd > ~/fD.log 2>&1
+}}}
+Or, using the command {{{tee}}}:
+{{{
+$ freeDiameterd -dd 2>&1 | tee -i ~/fD.log
+}}}
+
+----