From c6f9e8974840d2f70dd641e5d9e753c07e948706 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Tue, 5 Nov 2019 22:14:09 +0100 Subject: [PATCH] doc: Add manual page for debugging information --- .gitignore | 1 + Makefile.am | 7 +++++-- src/iwd.debug.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ src/iwd.rst | 16 +++++----------- 4 files changed, 55 insertions(+), 13 deletions(-) create mode 100644 src/iwd.debug.rst diff --git a/.gitignore b/.gitignore index 671bd9a5..54a765a5 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ autom4te.cache ell src/iwd src/iwd.8 +src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 src/iwd.service diff --git a/Makefile.am b/Makefile.am index 9c54cef0..7ef18784 100644 --- a/Makefile.am +++ b/Makefile.am @@ -159,7 +159,7 @@ if MANUAL_PAGES man_MANS = endif -manual_pages = src/iwd.8 src/iwd.config.5 src/iwd.network.5 \ +manual_pages = src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 \ client/iwctl.1 monitor/iwmon.1 wired/ead.8 tools/hwsim.1 eap_sources = src/eap.c src/eap.h src/eap-private.h \ @@ -256,7 +256,7 @@ systemd_network_DATA += src/80-iwd.link endif if MANUAL_PAGES -man_MANS += src/iwd.8 src/iwd.config.5 src/iwd.network.5 +man_MANS += src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 endif endif @@ -642,6 +642,9 @@ endif %.5: %.rst Makefile $(RST2MAN_PROCESS) +%.7: %.rst Makefile + $(RST2MAN_PROCESS) + %.8: %.rst Makefile $(RST2MAN_PROCESS) diff --git a/src/iwd.debug.rst b/src/iwd.debug.rst new file mode 100644 index 00000000..857738ef --- /dev/null +++ b/src/iwd.debug.rst @@ -0,0 +1,44 @@ +=========== + iwd.debug +=========== + +----------------------------------------- +Debugging information for wireless daemon +----------------------------------------- + +:Author: Marcel Holtmann +:Author: Denis Kenzior +:Author: Andrew Zaborowski +:Author: Tim Kourt +:Author: James Prestwood +:Copyright: 2013-2019 Intel Corporation +:Version: iwd +:Date: 22 September 2019 +:Manual section: 7 +:Manual group: Linux Connectivity + +SYNOPSIS +======== + +Debugging information for wireless daemon + +DESCRIPTION +=========== + +Common methods of obtaining extra debugging information. + +ENVIRONMENT +=========== + +*$IWD_RTNL_DEBUG* set to ``1`` enables RTNL debugging. + +*$IWD_DHCP_DEBUG* set to ``1`` enables DHCP debugging. + +*$IWD_TLS_DEBUG* set to ``1`` enables TLS debugging. + +*$IWD_WSC_DEBUG_KEYS* set to ``1`` enables WSC debug keys. + +SEE ALSO +======== + +iwd(8), diff --git a/src/iwd.rst b/src/iwd.rst index 169b1f30..c719fbc2 100644 --- a/src/iwd.rst +++ b/src/iwd.rst @@ -44,25 +44,19 @@ OPTIONS ENVIRONMENT =========== -*$STATE_DIRECTORY* is used for network configuration files. See section -*iwd.network* for details. +*$STATE_DIRECTORY* is used for network configuration files. See *iwd.network* +for details. *$CONFIGURATION_DIRECTORY* is used for daemon configuration settings. Only the file **main.conf** is currently read from this directory. See *iwd.config* for details. -*$IWD_RTNL_DEBUG* set to ``1`` enables RTNL debugging. - -*$IWD_DHCP_DEBUG* set to ``1`` enables DHCP debugging. - -*$IWD_TLS_DEBUG* set to ``1`` enables TLS debugging. - -*$IWD_WSC_DEBUG_KEYS* set to ``1`` enables WSC debug keys. +See *iwd.debug* for further environment variables for debugging. SEE ALSO ======== -iwd.config(5), iwd.network(5), iwctl(1), iwmon(1), hwsim(1), ead(8), -systemd.exec(5) +iwd.config(5), iwd.network(5), iwd.debug(7), iwctl(1), iwmon(1), hwsim(1), +ead(8), systemd.exec(5) http://iwd.wiki.kernel.org