jobbautista9
/
iwd
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity
Browse Source

build: Add skeleton manual pages for all installed binaries

upstream/latest
Marcel Holtmann 3 years ago
parent
73f6e0b43b
commit
765bb92084
10 changed files with 233 additions and 56 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      .gitignore
  2. 47
      Makefile.am
  3. 16
      README
  4. 29
      client/iwctl.rst
  5. 19
      configure.ac
  6. 30
      doc/iwmon.txt
  7. 35
      monitor/iwmon.rst
  8. 37
      src/iwd.rst
  9. 35
      tools/hwsim.rst
  10. 35
      wired/ead.rst

6
.gitignore
View File

@ -19,14 +19,18 @@ build-aux
autom4te.cache
ell
src/iwd
src/iwd.8
src/iwd.service
client/iwctl
client/iwctl.1
monitor/iwmon
monitor/iwmon.1
wired/ead
wired/ead.8
wired/ead.service
tools/hwsim
tools/hwsim.1
tools/test-runner
doc/iwmon.1
unit/test-cmac-aes
unit/test-arc4
unit/test-hmac-md5

47
Makefile.am
View File

@ -151,6 +151,10 @@ systemd_modloaddir = @SYSTEMD_MODLOADDIR@
systemd_modload_DATA = src/pkcs8.conf
endif
if MANUAL_PAGES
dist_man_MANS =
endif
eap_sources = src/eap.c src/eap.h src/eap-private.h \
src/eap-wsc.c src/eap-wsc.h \
src/eap-md5.c \
@ -241,6 +245,10 @@ src_iwd_DEPENDENCIES += src/iwd.service
systemd_unit_DATA += src/iwd.service
dbus_bus_DATA += src/net.connman.iwd.service
endif
if MANUAL_PAGES
dist_man_MANS += src/iwd.8
endif
endif
if CLIENT
@ -261,6 +269,10 @@ client_iwctl_SOURCES = client/main.c \
client/properties.h client/properties.c \
client/wsc.c client/station.c
client_iwctl_LDADD = $(ell_ldadd) -lreadline
if MANUAL_PAGES
dist_man_MANS += client/iwctl.1
endif
endif
if MONITOR
@ -282,6 +294,10 @@ monitor_iwmon_SOURCES = monitor/main.c linux/nl80211.h \
src/p2putil.c src/p2putil.h \
src/anqputil.h src/anqputil.c
monitor_iwmon_LDADD = $(ell_ldadd)
if MANUAL_PAGES
dist_man_MANS += monitor/iwmon.1
endif
endif
if WIRED
@ -303,6 +319,10 @@ wired_ead_DEPENDENCIES += wired/ead.service
systemd_unit_DATA += wired/ead.service
dbus_bus_DATA += wired/net.connman.ead.service
endif
if MANUAL_PAGES
dist_man_MANS += wired/ead.8
endif
endif
if HWSIM
@ -317,6 +337,10 @@ tools_hwsim_LDADD = $(ell_ldadd)
if DBUS_POLICY
dist_dbus_data_DATA += tools/hwsim-dbus.conf
endif
if MANUAL_PAGES
dist_man_MANS += tools/hwsim.1
endif
endif
if TOOLS
@ -476,16 +500,11 @@ unit_test_p2p_LDADD = $(ell_ldadd)
TESTS = $(unit_tests)
manual_pages = doc/iwmon.1
if BUILD_DOCS
dist_man_MANS = $(manual_pages)
endif
EXTRA_DIST = src/genbuiltin src/iwd.service.in src/net.connman.iwd.service \
wired/ead.service.in wired/net.connman.ead.service \
src/pkcs8.conf unit/gencerts.cnf \
doc/main.conf $(manual_pages:.1=.txt)
src/pkcs8.conf src/iwd.rst wired/ead.rst \
client/iwctl.rst monitor/iwmon.rst tools/hwsim.rst \
doc/main.conf unit/gencerts.cnf
AM_CFLAGS = $(ell_cflags) -fvisibility=hidden \
-DUNITDIR=\""$(top_srcdir)/unit/"\" \
@ -500,7 +519,7 @@ DISTCHECK_CONFIGURE_FLAGS = --disable-dbus-policy --disable-systemd-service \
--enable-hwsim \
--enable-tools
DISTCLEANFILES = $(BUILT_SOURCES) $(unit_tests) $(manual_pages)
DISTCLEANFILES = $(BUILT_SOURCES) $(unit_tests) $(dist_man_MANS)
MAINTAINERCLEANFILES = Makefile.in configure config.h.in aclocal.m4
@ -576,11 +595,17 @@ SED_PROCESS = $(AM_V_GEN)$(MKDIR_P) $(dir $@) && $(SED) \
-e 's,@libexecdir\@,$(libexecdir),g' \
< $< > $@
RST2MAN_PROCESS = $(AM_V_GEN)$(RST2MAN) --strict --no-raw --no-generator \
--no-datestamp < $< > $@
%.service: %.service.in Makefile
$(SED_PROCESS)
%.1: %.txt
$(AM_V_GEN)$(A2X) --doctype manpage --format manpage $(srcdir)/$<
%.1: %.rst Makefile
$(RST2MAN_PROCESS)
%.8: %.rst Makefile
$(RST2MAN_PROCESS)
install-data-local:
if !SYSTEMD_SERVICE

16
README
View File

@ -110,6 +110,16 @@ configuration options which are generally useful and enabled by default:
Note: This option affects all systemd unit setups.
--disable-manual-pages
Disable generation and installation of manual pages
By default all available manual pages will be generated
and installed. When disabling this options, no manual
pages are installed.
Note: This options affects all manual pages.
When building for a system that wants to use wireless technology, disabling
any of the above options makes only limited sense. It may break the general
setup and usability for wireless connections.
@ -172,12 +182,6 @@ that can be enabled if the functionality is required:
Note: With --disable-daemon this option is ignored
--enable-docs
Enable generation of documentation and manual pages
Note: This option does not provide any value right now
Netlink monitoring
==================

29
client/iwctl.rst
View File

@ -0,0 +1,29 @@
=======
iwctl
=======
---------------------------------
Internet wireless control utility
---------------------------------
:Author: Marcel Holtmann <marcel@holtmann.org>
:Copyright: 2013-2019 Intel Corporation
:Version: iwctl
:Date: 22 September 2019
:Manual section: 1
:Manual group: Linux Connectivity
SYNOPSIS
========
**iwctl** [*options* ...]
DESCRIPTION
===========
Tool for configuring **iwd** daemon via D-Bus interface.
SEE ALSO
========
iwd(8)

19
configure.ac
View File

@ -188,6 +188,17 @@ AC_ARG_ENABLE([systemd-service], AC_HELP_STRING([--disable-systemd-service],
[enable_systemd_service=${enableval}])
AM_CONDITIONAL(SYSTEMD_SERVICE, test "${enable_systemd_service}" != "no")
AC_ARG_ENABLE([manual-pages], AC_HELP_STRING([--disable-manual-pages],
[don't install manual pages]),
[enable_manual_pages=${enableval}])
if (test "${manual_pages}" != "no"); then
AC_CHECK_PROGS(RST2MAN, [rst2man rst2man-3], "no")
if (test "x$RST2MAN" = "xno"); then
AC_MSG_WARN([rst2man required for building manual pages])
fi
fi
AM_CONDITIONAL(MANUAL_PAGES, test "${manual_pages}" != "no")
AC_ARG_WITH([dbus-busdir], AC_HELP_STRING([--with-dbus-busdir=DIR],
[path to D-Bus bus services directory]),
[path_dbus_busdir=${withval}])
@ -273,14 +284,6 @@ AC_ARG_ENABLE([sim_hardcoded], AC_HELP_STRING([--enable-sim-hardcoded],
[enable_sim_hardcoded=${enableval}])
AM_CONDITIONAL(SIM_HARDCODED, test "${enable_sim_hardcoded}" = "yes")
AC_ARG_ENABLE([docs], AC_HELP_STRING([--enable-docs],
[build documentation and manual pages]),
[enable_docs=${enableval}])
if (test "${enable_docs}" = "yes"); then
AC_PATH_PROG(A2X, [a2x], [], $PATH:/sbin:/usr/sbin)
fi
AM_CONDITIONAL(BUILD_DOCS, test "$A2X" != "")
AC_CONFIG_FILES(Makefile)
AC_OUTPUT

30
doc/iwmon.txt
View File

@ -1,30 +0,0 @@
IWMON(1)
========
:doctype: manpage
NAME
----
iwmon - Wireless monitor
SYNOPSIS
--------
*iwmon* ['OPTIONS']
DESCRIPTION
-----------
The iwmon(1) command provides access to the wireless subsystem commands,
responses and events from the nl80211 generic netlink interface.
AUTHOR
------
iwmon was originally written by Marcel Holtmann.
COPYING
-------
Free use of this software is granted under ther terms of the GNU Lesser
General Public Licenses (LGPL).

35
monitor/iwmon.rst
View File

@ -0,0 +1,35 @@
=======
iwmon
=======
---------------------------------
Internet wireless monitor utility
---------------------------------
:Author: Marcel Holtmann <marcel@holtmann.org>
:Copyright: 2013-2019 Intel Corporation
:Version: iwmon
:Date: 22 September 2019
:Manual section: 1
:Manual group: Linux Connectivity
SYNOPSIS
========
**iwmon** [*options* ...]
DESCRIPTION
===========
Tool for monitoring and logging of Wireless control messages from nl80211.
OPTIONS
=======
--version, -v Show version number and exit.
--help, -h Show help message and exit.
SEE ALSO
========
iwd(8)

37
src/iwd.rst
View File

@ -0,0 +1,37 @@
=====
iwd
=====
------------------------
Internet wireless daemon
------------------------
:Author: Marcel Holtmann <marcel@holtmann.org>
:Copyright: 2013-2019 Intel Corporation
:Version: iwd
:Date: 22 September 2019
:Manual section: 8
:Manual group: Linux Connectivity
SYNOPSIS
========
**iwd** [*options* ...]
DESCRIPTION
===========
Daemon for managing Wireless devices on Linux.
OPTIONS
=======
--version, -v Show version number and exit.
--help, -h Show help message and exit.
SEE ALSO
========
iwctl(1), iwmon(1), hwsim(1), ead(8)
http://iwd.wiki.kernel.org

35
tools/hwsim.rst
View File

@ -0,0 +1,35 @@
=======
hwsim
=======
------------------------------------
Internet wireless simulation utility
------------------------------------
:Author: Marcel Holtmann <marcel@holtmann.org>
:Copyright: 2013-2019 Intel Corporation
:Version: hwsim
:Date: 22 September 2019
:Manual section: 1
:Manual group: Linux Connectivity
SYNOPSIS
========
**hwsim** [*options* ...]
DESCRIPTION
===========
Tool for configuration of *mac80211_hwsim* simulation driver.
OPTIONS
=======
--version, -v Show version number and exit.
--help, -h Show help message and exit.
SEE ALSO
========
iwd(8)

35
wired/ead.rst
View File

@ -0,0 +1,35 @@
=====
ead
=====
------------------------------
Ethernet authentication daemon
------------------------------
:Author: Marcel Holtmann <marcel@holtmann.org>
:Copyright: 2017-2019 Intel Corporation
:Version: ead
:Date: 22 September 2019
:Manual section: 8
:Manual group: Linux Connectivity
SYNOPSIS
========
**ead** [*options* ...]
DESCRIPTION
===========
Daemon for managing Ethernet authentication on Linux.
OPTIONS
=======
--version, -v Show version number and exit.
--help, -h Show help message and exit.
SEE ALSO
========
iwd(8)
Write Preview
Loading…
Cancel
Save