From 47d39a7fb7fe035e85b4e85748451ce85bc40608 Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Tue, 2 Jun 2020 19:24:12 +0200 Subject: docs: add more nm-settings manpages (dbus,nmcli,keyfile,ifcfg-rh) A significant part of NetworkManager's API are the connection profiles, documented in `man nm-settings*`. But there are different aspects about profiles, depending on what you are interested. There is the D-Bus API, nmcli options, keyfile format, and ifcfg-rh format. Additionally, there is also libnm API. Add distinct manual pages for the four aspects. Currently the two new manual pages "nm-settings-dbus" and "nm-settings-nmcli" are still identical to the former "nm-settings.5" manual. In the future, they will diverge to account for the differences. There are the following aspects: - "dbus" - "keyfile" - "ifcfg-rh" - "nmcli" For "libnm" we don't generate a separate "nm-settings-libnm" manual page. That is instead documented via gtk-doc. Currently the keyfile and ifcfg-rh manual pages only detail settings which differ. But later I think also these manual pages should contain all settings that apply. --- docs/api/Makefile.am | 3 ++- docs/api/network-manager-docs.xml | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/api') diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am index 5a79197c8f..520bb3f14d 100644 --- a/docs/api/Makefile.am +++ b/docs/api/Makefile.am @@ -88,8 +88,9 @@ content_files = \ $(top_builddir)/man/NetworkManager.xml \ $(top_builddir)/man/NetworkManager.conf.xml \ $(top_builddir)/man/nmcli-examples.xml \ - $(top_builddir)/man/nm-settings.xml \ + $(top_builddir)/man/nm-settings-dbus.xml \ $(top_builddir)/man/nm-settings-keyfile.xml \ + $(top_builddir)/man/nm-settings-nmcli.xml \ version.xml \ $(NULL) diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml index 883df41d78..a97eaa895d 100644 --- a/docs/api/network-manager-docs.xml +++ b/docs/api/network-manager-docs.xml @@ -73,7 +73,8 @@ - + + -- cgit v1.2.1