From 3be4c9444623b2f328bddaddeaf5ba5f7bd2adf6 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Wed, 6 Apr 2016 15:08:42 +0200 Subject: [PATCH 1/7] docs: don't set the online-location attribute It causes the links to be based on a latest online version rather than on the current one. --- docs/libnm-glib/libnm-glib-docs.xml | 2 +- docs/libnm-util/libnm-util-docs.sgml | 2 +- docs/libnm/libnm-docs.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/libnm-glib/libnm-glib-docs.xml b/docs/libnm-glib/libnm-glib-docs.xml index 761192462..798ea5f87 100644 --- a/docs/libnm-glib/libnm-glib-docs.xml +++ b/docs/libnm-glib/libnm-glib-docs.xml @@ -10,7 +10,7 @@ for libnm-glib &version; The latest version of this documentation can be found on-line at - https://developer.gnome.org/libnm-glib/0.9/. + https://developer.gnome.org/libnm-glib/stable/. diff --git a/docs/libnm-util/libnm-util-docs.sgml b/docs/libnm-util/libnm-util-docs.sgml index 14139181d..9ec760eb0 100644 --- a/docs/libnm-util/libnm-util-docs.sgml +++ b/docs/libnm-util/libnm-util-docs.sgml @@ -11,7 +11,7 @@ for libnm-util &version; The latest version of this documentation can be found on-line at - https://developer.gnome.org/libnm-util/0.9/. + https://developer.gnome.org/libnm-util/stable/. diff --git a/docs/libnm/libnm-docs.xml b/docs/libnm/libnm-docs.xml index 6629a241c..fdc836667 100644 --- a/docs/libnm/libnm-docs.xml +++ b/docs/libnm/libnm-docs.xml @@ -10,7 +10,7 @@ for libnm &version; The latest version of this documentation can be found on-line at - https://developer.gnome.org/libnm/1.0/. + https://developer.gnome.org/libnm/stable/. From 2a28bb4d044d969a2b03b23b0ddc2d1f6a403805 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Wed, 6 Apr 2016 16:33:51 +0200 Subject: [PATCH 2/7] docs: toplevel document nitpicks --- docs/api/network-manager-docs.xml | 32 ++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml index 3cf2c9edb..ff1cb82d0 100644 --- a/docs/api/network-manager-docs.xml +++ b/docs/api/network-manager-docs.xml @@ -5,11 +5,14 @@ ]> - NetworkManager D-Bus API Reference Manual + NetworkManager Reference Manual Version &version; 2012 + 2013 + 2014 + 2015 2016 The NetworkManager Authors @@ -37,6 +40,19 @@ + + Manual Pages + + + + + + + + + + + D-Bus API Reference @@ -142,20 +158,6 @@ - - UNIX Manual Pages - - - - - - - - - - - - Index From 37271b68272f2716ce2be9d50c63cab803cda635 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Wed, 6 Apr 2016 15:10:50 +0200 Subject: [PATCH 3/7] man: fix nmcli-examples synopsis formatting --- man/nmcli-examples.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 9c28e15fe..df12874a1 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -31,7 +31,8 @@ Copyright 2013 - 2014 Red Hat, Inc. - nmcli OPTIONS + nmcli + OPTIONS From f73649db5c0e0b84ca7eff68248c289029c94948 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Wed, 6 Apr 2016 15:14:02 +0200 Subject: [PATCH 4/7] man: fix prompt and user input formatting --- man/nmcli-examples.xml | 73 +++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 37 deletions(-) diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index df12874a1..7b167edc9 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -55,7 +55,7 @@ Copyright 2013 - 2014 Red Hat, Inc. Examples Listing available Wi-Fi APs -$ nmcli device wifi list +$ nmcli device wifi list * SSID MODE CHAN RATE SIGNAL BARS SECURITY netdatacomm_local Infra 6 54 Mbit/s 37 ▂▄__ WEP * F1 Infra 11 54 Mbit/s 98 ▂▄▆█ WPA1 @@ -76,7 +76,7 @@ Copyright 2013 - 2014 Red Hat, Inc. Showing general information and properties for a Wi-Fi interface -$ nmcli -p -f general,wifi-properties device show wlan0 +$ nmcli -p -f general,wifi-properties device show wlan0 =========================================================================== Device details (wlan0) =========================================================================== @@ -116,7 +116,7 @@ WIFI-PROPERTIES.ADHOC: yes Listing NetworkManager polkit permissions -$ nmcli general permissions +$ nmcli general permissions PERMISSION VALUE org.freedesktop.NetworkManager.enable-disable-network yes org.freedesktop.NetworkManager.enable-disable-wifi yes @@ -143,7 +143,7 @@ org.freedesktop.NetworkManager.settings.modify.hostname auth Listing NetworkManager log level and domains -$ nmcli general logging +$ nmcli general logging LEVEL DOMAINS INFO PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,A UTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC, @@ -153,10 +153,9 @@ B,DISPATCH This command shows current NetworkManager logging status. - Changing NetworkManager logging -$ nmcli g log level DEBUG domains CORE,ETHER,IP -$ nmcli g log level INFO domains DEFAULT +$ nmcli g log level DEBUG domains CORE,ETHER,IP +$ nmcli g log level INFO domains DEFAULT The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and IP domains. The second command restores the default logging state. Please refer to the @@ -166,9 +165,9 @@ B,DISPATCH Adding a bonding master and two slave connection profiles -$ nmcli con add type bond ifname mybond0 mode active-backup -$ nmcli con add type ethernet ifname eth1 master mybond0 -$ nmcli con add type ethernet ifname eth2 master mybond0 +$ nmcli con add type bond ifname mybond0 mode active-backup +$ nmcli con add type ethernet ifname eth1 master mybond0 +$ nmcli con add type ethernet ifname eth2 master mybond0 This example demonstrates adding a bond master connection and two slaves. The first command adds a master bond connection, naming the bonding interface @@ -180,9 +179,9 @@ B,DISPATCH Adding a team master and two slave connection profiles -$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf -$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1 -$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1 +$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf +$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1 +$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1 This example demonstrates adding a team master connection profile and two slaves. It is very similar to the bonding example. The first command adds a master team profile, naming @@ -195,8 +194,8 @@ B,DISPATCH em2. The slaves don't specify config and thus teamd will use its default configuration. You will activate the whole setup by activating both slaves: - $ nmcli con up Team1-slave1 - $ nmcli con up Team1-slave2 + $ nmcli con up Team1-slave1 + $ nmcli con up Team1-slave2 By default, the created profiles are marked for auto-activation. But if another connection has been activated on the device, the new profile won't activate automatically and you need to activate it manually. @@ -204,10 +203,10 @@ B,DISPATCH Adding a bridge and two slave profiles -$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge -$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge -$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge -$ nmcli con modify TowerBridge bridge.stp no +$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge +$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge +$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge +$ nmcli con modify TowerBridge bridge.stp no This example demonstrates adding a bridge master connection and two slaves. The first command adds a master bridge connection, naming the bridge interface and @@ -221,12 +220,12 @@ B,DISPATCH Adding an ethernet connection profile with manual IP configuration -$ nmcli con add con-name my-con-em1 ifname em1 type ethernet \ +$ nmcli con add con-name my-con-em1 ifname em1 type ethernet \ ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe -$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4" -$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4 -$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844" -$ nmcli -p con show my-con-em1 +$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4" +$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4 +$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844" +$ nmcli -p con show my-con-em1 The first command adds an Ethernet connection profile named my-con-em1 that is bound to interface name em1. The profile is configured @@ -242,7 +241,7 @@ B,DISPATCH Escaping colon characters in tabular mode -$ nmcli -t -f general -e yes -m tab dev show eth0 +$ nmcli -t -f general -e yes -m tab dev show eth0 GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reas on given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no: @@ -292,7 +291,7 @@ fi Example sessions of interactive connection editor Adding an ethernet connection profile in interactive editor (a) -$ nmcli connection edit type ethernet +$ nmcli connection edit type ethernet ===| nmcli interactive connection editor |=== @@ -303,7 +302,7 @@ Type 'describe [<setting>.<prop>]' for detailed property description You may edit the following settings: connection, 802-3-ethernet (ethernet), 802-1x, ipv4, ipv6, dcb -nmcli> print +nmcli> print =========================================================================== Connection details =========================================================================== @@ -363,13 +362,13 @@ ipv6.may-fail: yes ipv6.ip6-privacy: -1 (unknown) ipv6.dhcp-hostname: -- --------------------------------------------------------------------------- -nmcli> goto ethernet +nmcli> goto ethernet You may edit the following properties: port, speed, duplex, auto-negotiate, mac-address, cloned-mac-address, mac-address-blacklist, mtu, s390-subchann els, s390-nettype, s390-options nmcli 802-3-ethernet> set mtu 1492 nmcli 802-3-ethernet> b -nmcli> goto ipv4.addresses +nmcli> goto ipv4.addresses nmcli ipv4.addresses> desc === [addresses] === @@ -390,10 +389,10 @@ nmcli ipv4.addresses> print addresses: 192.168.1.100/24 nmcli ipv4.addresses> back nmcli ipv4> b -nmcli> set ipv4.gateway 192.168.1.1 -nmcli> verify +nmcli> set ipv4.gateway 192.168.1.1 +nmcli> verify Verify connection: OK -nmcli> print +nmcli> print =========================================================================== Connection details =========================================================================== @@ -452,8 +451,8 @@ ipv6.may-fail: yes ipv6.ip6-privacy: -1 (unknown) ipv6.dhcp-hostname: -- --------------------------------------------------------------------------- -nmcli> set ipv4.dns 8.8.8.8 8.8.4.4 -nmcli> print +nmcli> set ipv4.dns 8.8.8.8 8.8.4.4 +nmcli> print =========================================================================== Connection details =========================================================================== @@ -513,12 +512,12 @@ ipv6.may-fail: yes ipv6.ip6-privacy: -1 (unknown) ipv6.dhcp-hostname: -- --------------------------------------------------------------------------- -nmcli> verify +nmcli> verify Verify connection: OK -nmcli> save +nmcli> save Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully saved. -nmcli> quit +nmcli> quit Example session in the nmcli interactive connection editor. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). From 22fb039435a4052487c4f983e3fda22c4e84d965 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Wed, 6 Apr 2016 15:59:23 +0200 Subject: [PATCH 5/7] man: remove work-in-progress warning --- man/nmcli-examples.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 7b167edc9..a9b54d6a7 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -48,7 +48,6 @@ Copyright 2013 - 2014 Red Hat, Inc. The purpose of this manual page is to provide you with various examples and usage scenarios of nmcli. - Note: this page has "work-in-progress" status. From 530af7009ecca099372fd50a9b2b130c875a6524 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Wed, 6 Apr 2016 16:55:34 +0200 Subject: [PATCH 6/7] man: don't template NetworkManager.conf.xml Use XML entities instead. --- .gitignore | 1 - man/Makefile.am | 10 ---------- ...nager.conf.xml.in => NetworkManager.conf.xml} | 16 ++++++++++------ man/common.ent.in | 4 ++++ 4 files changed, 14 insertions(+), 17 deletions(-) rename man/{NetworkManager.conf.xml.in => NetworkManager.conf.xml} (98%) diff --git a/.gitignore b/.gitignore index d8bf11c6c..00210f420 100644 --- a/.gitignore +++ b/.gitignore @@ -215,7 +215,6 @@ test-*.trs /m4/xsize.m4 /man/*.[1785] -/man/NetworkManager.conf.xml /man/nm-settings.xml /man/nm-settings-ifcfg-rh.xml /man/nm-settings-keyfile.xml diff --git a/man/Makefile.am b/man/Makefile.am index ce84194cd..9338edbbe 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -31,16 +31,6 @@ if ENABLE_GTK_DOC endif -CLEANFILES += NetworkManager.conf.xml -EXTRA_DIST += NetworkManager.conf.xml.in -NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in - $(AM_V_GEN) sed \ - -e 's|[@]NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT[@]|$(NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT)|g' \ - -e 's|[@]NM_CONFIG_KEYFILE_PATH_DEFAULT[@]|$(nmconfdir)/conf.d|g' \ - -e 's|[@]NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT[@]|$(NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT)|g' \ - -e 's|[@]NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT[@]|$(NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT)|g' \ - $< >$@ - if BUILD_SETTING_DOCS nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml diff --git a/man/NetworkManager.conf.xml.in b/man/NetworkManager.conf.xml similarity index 98% rename from man/NetworkManager.conf.xml.in rename to man/NetworkManager.conf.xml index 2736065e5..ad5245e2b 100644 --- a/man/NetworkManager.conf.xml.in +++ b/man/NetworkManager.conf.xml @@ -1,6 +1,10 @@ + +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +%entities; +]> diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index 3c4b733e5..1088cc9c3 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -7,9 +7,22 @@ ]> diff --git a/man/nm-online.xml b/man/nm-online.xml index f1f7a0d4b..7fdd2f3e6 100644 --- a/man/nm-online.xml +++ b/man/nm-online.xml @@ -9,26 +9,18 @@ diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index a9b54d6a7..50d4738bd 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -7,7 +7,20 @@ ]> diff --git a/man/nmcli.xml b/man/nmcli.xml index 619546678..62e102549 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -9,26 +9,18 @@ diff --git a/man/nmtui.xml b/man/nmtui.xml index d92f525bc..357472fe3 100644 --- a/man/nmtui.xml +++ b/man/nmtui.xml @@ -9,26 +9,18 @@