From 2bfb3eb7d0323e69affca154395f51d8b577414d Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 6 Apr 2016 00:46:19 +0200 Subject: Imported Upstream version 1.1.93 --- man/Makefile.am | 121 +- man/Makefile.in | 176 ++- man/NetworkManager.8 | 8 +- man/NetworkManager.conf.5 | 6 +- man/NetworkManager.conf.xml | 10 +- man/NetworkManager.conf.xml.in | 10 +- man/NetworkManager.xml | 11 +- man/common.ent.in | 2 + man/nm-online.1 | 96 ++ man/nm-online.1.in | 76 - man/nm-online.xml | 171 +++ man/nm-settings-ifcfg-rh.5 | 22 +- man/nm-settings-ifcfg-rh.xml | 17 +- man/nm-settings-ifcfg-rh.xsl | 48 +- man/nm-settings-keyfile.5 | 36 +- man/nm-settings-keyfile.xml | 29 +- man/nm-settings-keyfile.xsl | 48 +- man/nm-settings.5 | 19 +- man/nm-settings.xml | 7 +- man/nm-settings.xsl | 41 +- man/nm-system-settings.conf.5.in | 25 - man/nmcli-examples.5 | 693 --------- man/nmcli-examples.7 | 619 ++++++++ man/nmcli-examples.xml | 759 +++++----- man/nmcli.1 | 1905 +++++++++++++++++++++++ man/nmcli.1.in | 1282 ---------------- man/nmcli.xml | 3116 ++++++++++++++++++++++++++++++++++++++ man/nmtui.1 | 76 + man/nmtui.1.in | 66 - man/nmtui.xml | 137 ++ 30 files changed, 6820 insertions(+), 2812 deletions(-) create mode 100644 man/common.ent.in create mode 100644 man/nm-online.1 delete mode 100644 man/nm-online.1.in create mode 100644 man/nm-online.xml delete mode 100644 man/nm-system-settings.conf.5.in delete mode 100644 man/nmcli-examples.5 create mode 100644 man/nmcli-examples.7 create mode 100644 man/nmcli.1 delete mode 100644 man/nmcli.1.in create mode 100644 man/nmcli.xml create mode 100644 man/nmtui.1 delete mode 100644 man/nmtui.1.in create mode 100644 man/nmtui.xml (limited to 'man') diff --git a/man/Makefile.am b/man/Makefile.am index 65d8d007..ce84194c 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -17,10 +17,16 @@ XSLTPROC_MAN_FLAGS = \ if ENABLE_GTK_DOC -%.8: %.xml +%.1: %.xml common.ent $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< -%.5: %.xml +%.5: %.xml common.ent + $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +%.7: %.xml common.ent + $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +%.8: %.xml common.ent $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< endif @@ -38,25 +44,13 @@ NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in if BUILD_SETTING_DOCS nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml - $(AM_V_GEN) xsltproc \ - --output $@ \ - --stringparam version $(NM_VERSION) \ - --stringparam date "`date +'%d %B %Y'`" \ - $^ + $(AM_V_GEN) xsltproc --output $@ $^ nm-settings-keyfile.xml: nm-settings-keyfile.xsl $(top_builddir)/libnm/nm-keyfile-docs.xml - $(AM_V_GEN) xsltproc \ - --output $@ \ - --stringparam version $(NM_VERSION) \ - --stringparam date "`date +'%d %B %Y'`" \ - $^ + $(AM_V_GEN) xsltproc --output $@ $^ nm-settings-ifcfg-rh.xml: nm-settings-ifcfg-rh.xsl $(top_builddir)/libnm/nm-ifcfg-rh-docs.xml - $(AM_V_GEN) xsltproc \ - --output $@ \ - --stringparam version $(NM_VERSION) \ - --stringparam date "`date +'%d %B %Y'`" \ - $^ + $(AM_V_GEN) xsltproc --output $@ $^ CLEANFILES += \ nm-settings.xml \ @@ -65,63 +59,78 @@ CLEANFILES += \ endif -configure_generated_man_pages = \ - nmcli.1 \ - nmtui.1 \ - nm-online.1 \ - nm-system-settings.conf.5 - -docbook_generated_man_pages = \ - NetworkManager.8 \ - NetworkManager.conf.5 \ - nmcli-examples.5 +man_pages = \ + nmcli.1 \ + nmtui.1 \ + nm-online.1 \ + NetworkManager.conf.5 \ + nmcli-examples.7 \ + NetworkManager.8 -docbook_autogenerated_man_pages = \ - nm-settings.5 \ +autogenerated_man_pages = \ + nm-settings.5 \ nm-settings-keyfile.5 if CONFIG_PLUGIN_IFCFG_RH -docbook_autogenerated_man_pages += nm-settings-ifcfg-rh.5 +autogenerated_man_pages += nm-settings-ifcfg-rh.5 else EXTRA_DIST += nm-settings-ifcfg-rh.5 endif -EXTRA_DIST += \ - nm-settings.xml \ - nm-settings.xsl \ - nm-settings-keyfile.xml \ - nm-settings-keyfile.xsl \ - nm-settings-ifcfg-rh.xml \ - nm-settings-ifcfg-rh.xsl \ - $(addsuffix .xml,$(basename $(docbook_generated_man_pages))) \ - $(docbook_generated_man_pages) \ - $(docbook_autogenerated_man_pages) - -man_MANS += $(configure_generated_man_pages) - -links = nmtui-edit nmtui-connect nmtui-hostname +EXTRA_DIST += \ + nm-settings.xml \ + nm-settings.xsl \ + nm-settings-keyfile.xml \ + nm-settings-keyfile.xsl \ + nm-settings-ifcfg-rh.xml \ + nm-settings-ifcfg-rh.xsl \ + $(addsuffix .xml,$(basename $(man_pages))) \ + $(man_pages) \ + $(autogenerated_man_pages) + +nmtui_links = nmtui-edit nmtui-connect nmtui-hostname +NetworkManager_conf_links = nm-system-settings.conf + +# Implement a || condition +if INSTALL_PREGEN_MANPAGES +install_manpages = true +else +if ENABLE_GTK_DOC +install_manpages = true +endif +endif install-data-hook: - for link in $(links); do \ - ln -f $(DESTDIR)$(mandir)/man1/nmtui.1 $(DESTDIR)$(mandir)/man1/$$link.1; \ - done + if test -n "$(install_manpages)"; then \ + for link in $(nmtui_links); do \ + ln -f $(DESTDIR)$(mandir)/man1/nmtui.1 $(DESTDIR)$(mandir)/man1/$$link.1; \ + done; \ + for link in $(NetworkManager_conf_links); do \ + ln -f $(DESTDIR)$(mandir)/man5/NetworkManager.conf.5 $(DESTDIR)$(mandir)/man5/$$link.5; \ + done; \ + fi uninstall-hook: - for link in $(links); do \ - rm -f $(DESTDIR)$(mandir)/man1/$$link.1; \ - done + if test -n "$(install_manpages)"; then \ + for link in $(nmtui_links); do \ + rm -f $(DESTDIR)$(mandir)/man1/$$link.1; \ + done; \ + for link in $(NetworkManager_conf_links); do \ + rm -f $(DESTDIR)$(mandir)/man5/$$link.5; \ + done; \ + fi if ENABLE_GTK_DOC -man_MANS += $(docbook_generated_man_pages) -CLEANFILES += $(docbook_generated_man_pages) +man_MANS += $(man_pages) +CLEANFILES += $(man_pages) if SETTING_DOCS_AVAILABLE -man_MANS += $(docbook_autogenerated_man_pages) -CLEANFILES += $(docbook_autogenerated_man_pages) +man_MANS += $(autogenerated_man_pages) +CLEANFILES += $(autogenerated_man_pages) endif else if INSTALL_PREGEN_MANPAGES man_MANS += \ - $(docbook_generated_man_pages) \ - $(docbook_autogenerated_man_pages) + $(man_pages) \ + $(autogenerated_man_pages) endif endif diff --git a/man/Makefile.in b/man/Makefile.in index 07c8d369..551f1a90 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -94,13 +94,13 @@ host_triplet = @host@ @CONFIG_PLUGIN_IFCFG_RH_TRUE@am__append_2 = nm-settings-ifcfg-rh.5 @CONFIG_PLUGIN_IFCFG_RH_FALSE@am__append_3 = nm-settings-ifcfg-rh.5 -@ENABLE_GTK_DOC_TRUE@am__append_4 = $(docbook_generated_man_pages) -@ENABLE_GTK_DOC_TRUE@am__append_5 = $(docbook_generated_man_pages) -@ENABLE_GTK_DOC_TRUE@@SETTING_DOCS_AVAILABLE_TRUE@am__append_6 = $(docbook_autogenerated_man_pages) -@ENABLE_GTK_DOC_TRUE@@SETTING_DOCS_AVAILABLE_TRUE@am__append_7 = $(docbook_autogenerated_man_pages) +@ENABLE_GTK_DOC_TRUE@am__append_4 = $(man_pages) +@ENABLE_GTK_DOC_TRUE@am__append_5 = $(man_pages) +@ENABLE_GTK_DOC_TRUE@@SETTING_DOCS_AVAILABLE_TRUE@am__append_6 = $(autogenerated_man_pages) +@ENABLE_GTK_DOC_TRUE@@SETTING_DOCS_AVAILABLE_TRUE@am__append_7 = $(autogenerated_man_pages) @ENABLE_GTK_DOC_FALSE@@INSTALL_PREGEN_MANPAGES_TRUE@am__append_8 = \ -@ENABLE_GTK_DOC_FALSE@@INSTALL_PREGEN_MANPAGES_TRUE@ $(docbook_generated_man_pages) \ -@ENABLE_GTK_DOC_FALSE@@INSTALL_PREGEN_MANPAGES_TRUE@ $(docbook_autogenerated_man_pages) +@ENABLE_GTK_DOC_FALSE@@INSTALL_PREGEN_MANPAGES_TRUE@ $(man_pages) \ +@ENABLE_GTK_DOC_FALSE@@INSTALL_PREGEN_MANPAGES_TRUE@ $(autogenerated_man_pages) subdir = man ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 @@ -122,8 +122,7 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h -CONFIG_CLEAN_FILES = nm-system-settings.conf.5 nm-online.1 nmcli.1 \ - nmtui.1 +CONFIG_CLEAN_FILES = common.ent CONFIG_CLEAN_VPATH_FILES = AM_V_P = $(am__v_P_@AM_V@) am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) @@ -173,15 +172,14 @@ am__uninstall_files_from_dir = { \ } man1dir = $(mandir)/man1 am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \ - "$(DESTDIR)$(man8dir)" + "$(DESTDIR)$(man7dir)" "$(DESTDIR)$(man8dir)" man5dir = $(mandir)/man5 +man7dir = $(mandir)/man7 man8dir = $(mandir)/man8 NROFF = nroff MANS = $(man_MANS) am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) -am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/nm-online.1.in \ - $(srcdir)/nm-system-settings.conf.5.in $(srcdir)/nmcli.1.in \ - $(srcdir)/nmtui.1.in +am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/common.ent.in DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ ALL_LINGUAS = @ALL_LINGUAS@ @@ -446,17 +444,14 @@ with_dhcpcd = @with_dhcpcd@ with_netconfig = @with_netconfig@ with_resolvconf = @with_resolvconf@ with_valgrind = @with_valgrind@ -man_MANS = $(configure_generated_man_pages) $(am__append_4) \ - $(am__append_6) $(am__append_8) +man_MANS = $(am__append_4) $(am__append_6) $(am__append_8) CLEANFILES = NetworkManager.conf.xml $(am__append_1) $(am__append_5) \ $(am__append_7) EXTRA_DIST = NetworkManager.conf.xml.in $(am__append_3) \ nm-settings.xml nm-settings.xsl nm-settings-keyfile.xml \ nm-settings-keyfile.xsl nm-settings-ifcfg-rh.xml \ nm-settings-ifcfg-rh.xsl $(addsuffix .xml,$(basename \ - $(docbook_generated_man_pages))) \ - $(docbook_generated_man_pages) \ - $(docbook_autogenerated_man_pages) + $(man_pages))) $(man_pages) $(autogenerated_man_pages) XSLTPROC = xsltproc XSLTPROC_FLAGS = --xinclude --nonet XSLTPROC_MAN_FLAGS = \ @@ -468,20 +463,22 @@ XSLTPROC_MAN_FLAGS = \ --stringparam man.copyright.section.enabled 0 \ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl -configure_generated_man_pages = \ - nmcli.1 \ - nmtui.1 \ - nm-online.1 \ - nm-system-settings.conf.5 +man_pages = \ + nmcli.1 \ + nmtui.1 \ + nm-online.1 \ + NetworkManager.conf.5 \ + nmcli-examples.7 \ + NetworkManager.8 -docbook_generated_man_pages = \ - NetworkManager.8 \ - NetworkManager.conf.5 \ - nmcli-examples.5 - -docbook_autogenerated_man_pages = nm-settings.5 nm-settings-keyfile.5 \ +autogenerated_man_pages = nm-settings.5 nm-settings-keyfile.5 \ $(am__append_2) -links = nmtui-edit nmtui-connect nmtui-hostname +nmtui_links = nmtui-edit nmtui-connect nmtui-hostname +NetworkManager_conf_links = nm-system-settings.conf +@ENABLE_GTK_DOC_TRUE@@INSTALL_PREGEN_MANPAGES_FALSE@install_manpages = true + +# Implement a || condition +@INSTALL_PREGEN_MANPAGES_TRUE@install_manpages = true all: all-am .SUFFIXES: @@ -514,13 +511,7 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(am__aclocal_m4_deps): -nm-system-settings.conf.5: $(top_builddir)/config.status $(srcdir)/nm-system-settings.conf.5.in - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ -nm-online.1: $(top_builddir)/config.status $(srcdir)/nm-online.1.in - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ -nmcli.1: $(top_builddir)/config.status $(srcdir)/nmcli.1.in - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ -nmtui.1: $(top_builddir)/config.status $(srcdir)/nmtui.1.in +common.ent: $(top_builddir)/config.status $(srcdir)/common.ent.in cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ mostlyclean-libtool: @@ -614,6 +605,49 @@ uninstall-man5: } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \ -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ dir='$(DESTDIR)$(man5dir)'; $(am__uninstall_files_from_dir) +install-man7: $(man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(man_MANS)'; \ + test -n "$(man7dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man7dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man7dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.7[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^7][0-9a-z]*$$,7,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man7dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man7dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man7dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man7dir)" || exit $$?; }; \ + done; } + +uninstall-man7: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man7dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.7[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^7][0-9a-z]*$$,7,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man7dir)'; $(am__uninstall_files_from_dir) install-man8: $(man_MANS) @$(NORMAL_INSTALL) @list1=''; \ @@ -698,7 +732,7 @@ check-am: all-am check: check-am all-am: Makefile $(MANS) installdirs: - for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(man8dir)"; do \ + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(man7dir)" "$(DESTDIR)$(man8dir)"; do \ test -z "$$dir" || $(MKDIR_P) "$$dir"; \ done install: install-am @@ -769,7 +803,7 @@ install-info: install-info-am install-info-am: -install-man: install-man1 install-man5 install-man8 +install-man: install-man1 install-man5 install-man7 install-man8 install-pdf: install-pdf-am @@ -800,7 +834,8 @@ ps-am: uninstall-am: uninstall-man @$(NORMAL_INSTALL) $(MAKE) $(AM_MAKEFLAGS) uninstall-hook -uninstall-man: uninstall-man1 uninstall-man5 uninstall-man8 +uninstall-man: uninstall-man1 uninstall-man5 uninstall-man7 \ + uninstall-man8 .MAKE: install-am install-data-am install-strip uninstall-am @@ -811,20 +846,27 @@ uninstall-man: uninstall-man1 uninstall-man5 uninstall-man8 install-data-hook install-dvi install-dvi-am install-exec \ install-exec-am install-html install-html-am install-info \ install-info-am install-man install-man1 install-man5 \ - install-man8 install-pdf install-pdf-am install-ps \ - install-ps-am install-strip installcheck installcheck-am \ - installdirs maintainer-clean maintainer-clean-generic \ - mostlyclean mostlyclean-generic mostlyclean-libtool pdf pdf-am \ - ps ps-am tags-am uninstall uninstall-am uninstall-hook \ - uninstall-man uninstall-man1 uninstall-man5 uninstall-man8 + install-man7 install-man8 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am tags-am uninstall \ + uninstall-am uninstall-hook uninstall-man uninstall-man1 \ + uninstall-man5 uninstall-man7 uninstall-man8 .PRECIOUS: Makefile -@ENABLE_GTK_DOC_TRUE@%.8: %.xml +@ENABLE_GTK_DOC_TRUE@%.1: %.xml common.ent +@ENABLE_GTK_DOC_TRUE@ $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +@ENABLE_GTK_DOC_TRUE@%.5: %.xml common.ent +@ENABLE_GTK_DOC_TRUE@ $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +@ENABLE_GTK_DOC_TRUE@%.7: %.xml common.ent @ENABLE_GTK_DOC_TRUE@ $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< -@ENABLE_GTK_DOC_TRUE@%.5: %.xml +@ENABLE_GTK_DOC_TRUE@%.8: %.xml common.ent @ENABLE_GTK_DOC_TRUE@ $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in $(AM_V_GEN) sed \ @@ -835,35 +877,33 @@ NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in $< >$@ @BUILD_SETTING_DOCS_TRUE@nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml -@BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc \ -@BUILD_SETTING_DOCS_TRUE@ --output $@ \ -@BUILD_SETTING_DOCS_TRUE@ --stringparam version $(NM_VERSION) \ -@BUILD_SETTING_DOCS_TRUE@ --stringparam date "`date +'%d %B %Y'`" \ -@BUILD_SETTING_DOCS_TRUE@ $^ +@BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc --output $@ $^ @BUILD_SETTING_DOCS_TRUE@nm-settings-keyfile.xml: nm-settings-keyfile.xsl $(top_builddir)/libnm/nm-keyfile-docs.xml -@BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc \ -@BUILD_SETTING_DOCS_TRUE@ --output $@ \ -@BUILD_SETTING_DOCS_TRUE@ --stringparam version $(NM_VERSION) \ -@BUILD_SETTING_DOCS_TRUE@ --stringparam date "`date +'%d %B %Y'`" \ -@BUILD_SETTING_DOCS_TRUE@ $^ +@BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc --output $@ $^ @BUILD_SETTING_DOCS_TRUE@nm-settings-ifcfg-rh.xml: nm-settings-ifcfg-rh.xsl $(top_builddir)/libnm/nm-ifcfg-rh-docs.xml -@BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc \ -@BUILD_SETTING_DOCS_TRUE@ --output $@ \ -@BUILD_SETTING_DOCS_TRUE@ --stringparam version $(NM_VERSION) \ -@BUILD_SETTING_DOCS_TRUE@ --stringparam date "`date +'%d %B %Y'`" \ -@BUILD_SETTING_DOCS_TRUE@ $^ +@BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc --output $@ $^ install-data-hook: - for link in $(links); do \ - ln -f $(DESTDIR)$(mandir)/man1/nmtui.1 $(DESTDIR)$(mandir)/man1/$$link.1; \ - done + if test -n "$(install_manpages)"; then \ + for link in $(nmtui_links); do \ + ln -f $(DESTDIR)$(mandir)/man1/nmtui.1 $(DESTDIR)$(mandir)/man1/$$link.1; \ + done; \ + for link in $(NetworkManager_conf_links); do \ + ln -f $(DESTDIR)$(mandir)/man5/NetworkManager.conf.5 $(DESTDIR)$(mandir)/man5/$$link.5; \ + done; \ + fi uninstall-hook: - for link in $(links); do \ - rm -f $(DESTDIR)$(mandir)/man1/$$link.1; \ - done + if test -n "$(install_manpages)"; then \ + for link in $(nmtui_links); do \ + rm -f $(DESTDIR)$(mandir)/man1/$$link.1; \ + done; \ + for link in $(NetworkManager_conf_links); do \ + rm -f $(DESTDIR)$(mandir)/man5/$$link.5; \ + done; \ + fi # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index 42768d74..35594cfe 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 03/29/2016 +.\" Date: 04/05/2016 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.2 +.\" Source: NetworkManager 1.1.93 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.2" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.1\&.93" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -301,7 +301,7 @@ to enable debug logging inside NetworkManager itself\&. .PP \fBNetworkManager.conf\fR(5), \fBnmcli\fR(1), -\fBnmcli-examples\fR(5), +\fBnmcli-examples\fR(7), \fBnm-online\fR(1), \fBnm-settings\fR(5), \fBnm-applet\fR(1), diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index d0f9acbb..72fbf38f 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,7 +2,7 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 03/29/2016 +.\" Date: 04/05/2016 .\" Manual: Configuration .\" Source: NetworkManager 1.2 .\" Language: English @@ -109,7 +109,7 @@ keyfile\&. .PP \fImonitor\-connection\-files\fR .RS 4 -Whether the configured settings plugin(s) should set up file monitors and immediately pick up changes made to connection files while NetworkManager is running\&. This is disabled by default; NetworkManager will only read the connection files at startup, and when explicitly requested via the ReloadConnections D\-Bus call\&. If this key is set to \*(Aqtrue\*(Aq, then NetworkManager will reload connection files any time they changed\&. +Whether the configured settings plugin(s) should set up file monitors and immediately pick up changes made to connection files while NetworkManager is running\&. This is disabled by default; NetworkManager will only read the connection files at startup, and when explicitly requested via the ReloadConnections D\-Bus call\&. If this key is set to \*(Aqtrue\*(Aq, then NetworkManager will reload connection files any time they changed\&. Automatic reloading is not advised because there are race conditions involved and it depends on the way how the editor updates the file\&. In some situations, NetworkManager might first delete and add the connection anew, instead of updating the existing one\&. Also, NetworkManager might pick up incomplete settings while the user is still editing the files\&. .RE .PP \fIauth\-polkit\fR @@ -898,7 +898,7 @@ interface\-name:vboxnet*,except:interface\-name:vboxnet2 .PP \fBNetworkManager\fR(8), \fBnmcli\fR(1), -\fBnmcli-examples\fR(5), +\fBnmcli-examples\fR(7), \fBnm-online\fR(1), \fBnm-settings\fR(5), \fBnm-applet\fR(1), diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 597f373f..3427cd64 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -138,7 +138,13 @@ plugins-=remove-me the connection files at startup, and when explicitly requested via the ReloadConnections D-Bus call. If this key is set to 'true', then NetworkManager will reload - connection files any time they changed. + connection files any time they changed. + Automatic reloading is not advised because there are race conditions + involved and it depends on the way how the editor updates the file. + In some situations, NetworkManager might first delete and add the + connection anew, instead of updating the existing one. Also, NetworkManager + might pick up incomplete settings while the user is still editing the files. + auth-polkit @@ -1004,7 +1010,7 @@ interface-name:vboxnet*,except:interface-name:vboxnet2 NetworkManager8, nmcli1, - nmcli-examples5, + nmcli-examples7, nm-online1, nm-settings5, nm-applet1, diff --git a/man/NetworkManager.conf.xml.in b/man/NetworkManager.conf.xml.in index 2a847f8f..2736065e 100644 --- a/man/NetworkManager.conf.xml.in +++ b/man/NetworkManager.conf.xml.in @@ -138,7 +138,13 @@ plugins-=remove-me the connection files at startup, and when explicitly requested via the ReloadConnections D-Bus call. If this key is set to 'true', then NetworkManager will reload - connection files any time they changed. + connection files any time they changed. + Automatic reloading is not advised because there are race conditions + involved and it depends on the way how the editor updates the file. + In some situations, NetworkManager might first delete and add the + connection anew, instead of updating the existing one. Also, NetworkManager + might pick up incomplete settings while the user is still editing the files. + auth-polkit @@ -1004,7 +1010,7 @@ interface-name:vboxnet*,except:interface-name:vboxnet2 NetworkManager8, nmcli1, - nmcli-examples5, + nmcli-examples7, nm-online1, nm-settings5, nm-applet1, diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index 39dfe484..3c4b733e 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -1,7 +1,10 @@ - + +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +%entities; +]> + + + + + nm-online + NetworkManager developers + + + + nm-online + 1 + NetworkManager + General Commands Manual + &NM_VERSION; + + + + nm-online + ask NetworkManager whether the network is connected + + + + + nm-online + OPTIONS + + + + Description + nm-online is a utility to find out whether we are + online. It is done by asking NetworkManager about its status. When run, + nm-online waits until NetworkManager reports an active + connection, or specified timeout expires. On exit, the returned status code + should be checked (see the return codes below). + + By default NetworkManager waits for IPv4 dynamic addressing to complete + but does not wait for the auto IPv6 dynamic addressing. To + wait for IPv6 addressing to complete, either (1) change the network + connection's IPv6 may-fail setting to no, + and/or (2) change the IPv6 addressing method to manual or + dhcp, to indicate that IPv6 connectivity is expected. + + + Options + + + + + + + + seconds + + + + Time to wait for a connection, in seconds. If the option is not provided, + the default timeout is 30 seconds. + + + + + + + + + + + + Exit immediately if NetworkManager is not running or connecting. + + + + + + + + + + + Don't print anything. + + + + + + + + + + + Wait for NetworkManager startup to complete, rather than waiting for + network connectivity specifically. Startup is considered complete once + NetworkManager has activated (or attempted to activate) every auto-activate + connection which is available given the current network state. (This is + generally only useful at boot time; after startup has completed, + nm-online -s will just return immediately, regardless of the + current network state.) + + + + + + + Exit Status + + nm-online exits with status 0 if it succeeds, a value + greater than 0 is returned if an error occurs. + + + + 0 + + Success – already online or connection established within given timeout. + + + + + 1 + + Offline or not online within given timeout. + + + + + 2 + + Unknown or unspecified error. + + + + + + + See Also + nmcli1, + NetworkManager8. + + + diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 7b848128..6eef8eb8 100644 --- a/man/nm-settings-ifcfg-rh.5 +++ b/man/nm-settings-ifcfg-rh.5 @@ -1,13 +1,13 @@ '\" t .\" Title: nm-settings-ifcfg-rh -.\" Author: [see the "AUTHOR" section] +.\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 29 March 2016 +.\" Date: 04/05/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.1.92 +.\" Source: NetworkManager 1.1.93 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.1\&.92" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.1\&.93" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -312,7 +312,7 @@ is used, NetworkManager assigns the interface 10\&.42\&.0\&.1, or it uses the fi .PP See the next section for detailed mapping of NetworkManager properties and \fIifcfg\-rh\fR -variables\&. Variable names, format and usage differences in NetworkManager and initscripts are documented in the tables bellow\&. +variables\&. Variable names, format and usage differences in NetworkManager and initscripts are documented in the tables below\&. .SH "DETAILS" .PP \fIifcfg\-rh\fR @@ -2581,9 +2581,6 @@ ask unused \- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. .RE -.SH "AUTHOR" -.PP -NetworkManager developers .SH "FILES" .PP /etc/sysconfig/network\-scripts/ifcfg\-* @@ -2597,6 +2594,9 @@ NetworkManager developers /usr/share/doc/initscripts/sysconfig\&.txt .SH "SEE ALSO" .PP -https://developer\&.gnome\&.org/NetworkManager/unstable/ref\-settings\&.html -.PP -nm\-settings(5), nm\-settings\-keyfile(5), NetworkManager(8), NetworkManager\&.conf(5), nmcli(1), nmcli\-examples(5) +\fBnm-settings\fR(5), +\fBnm-settings-keyfile\fR(5), +\fBNetworkManager\fR(8), +\fBNetworkManager.conf\fR(5), +\fBnmcli\fR(1), +\fBnmcli-examples\fR(7) diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index ef8e1df9..02b6bb14 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,6 +1,6 @@ -29 March 2016nm-settings-ifcfg-rh5NetworkManagerConfiguration1.1.92nm-settings-ifcfg-rhDescription of ifcfg-rh settings pluginDESCRIPTION +nm-settings-ifcfg-rhNetworkManager developersnm-settings-ifcfg-rh5NetworkManagerConfiguration1.1.93nm-settings-ifcfg-rhDescription of ifcfg-rh settings pluginDescription NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings5 for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -19,7 +19,7 @@ The main reason for using ifcfg-rh plugin is the compatibility with legacy configurations for ifup and ifdown (initscripts). - File Format + File Format The ifcfg-rh config format is a simple text file containing VARIABLE="value" lines. The format is described in sysconfig.txt of initscripts package. Note that the configuration files @@ -131,7 +131,7 @@ DEVICETYPE=TeamPort The UUID values in the config files must be unique. You can use uuidgen command line tool to generate such values. Alternatively, you can leave out UUID entirely. In that case NetworkManager will generate a UUID based on the file name. - Differences against initscripts + Differences against initscripts The main differences of NetworkManager ifcfg-rh plugin and traditional initscripts are: NM_CONTROLLED=yes|no @@ -164,8 +164,8 @@ DEVICETYPE=TeamPort if configured. See the next section for detailed mapping of NetworkManager properties and ifcfg-rh variables. Variable names, format and usage - differences in NetworkManager and initscripts are documented in the tables bellow. - DETAILSifcfg-rh plugin variables marked with (+) + differences in NetworkManager and initscripts are documented in the tables below. + Detailsifcfg-rh plugin variables marked with (+) are NetworkManager specific extensions not understood by traditional initscripts. 802-1x settingPropertyIfcfg-rh VariableDefaultDescriptioneapIEEE_8021X_EAP_METHODS(+)EAP method for 802.1X authentication. @@ -367,4 +367,9 @@ Allowed values: default, never, alwaysask - the associated password is not saved but it will be requested from the user each time it is required.unused - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required and should - not be requested from the user.AUTHORNetworkManager developersFILES/etc/sysconfig/network-scripts/ifcfg-*/etc/sysconfig/network-scripts/keys-*/etc/sysconfig/network-scripts/route-*/etc/sysconfig/network-scripts/route6-*/usr/share/doc/initscripts/sysconfig.txtSEE ALSOhttps://developer.gnome.org/NetworkManager/unstable/ref-settings.htmlnm-settings(5), nm-settings-keyfile(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5) + not be requested from the user.Files/etc/sysconfig/network-scripts/ifcfg-*/etc/sysconfig/network-scripts/keys-*/etc/sysconfig/network-scripts/route-*/etc/sysconfig/network-scripts/route6-*/usr/share/doc/initscripts/sysconfig.txtSee Alsonm-settings5, + nm-settings-keyfile5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index c648e65f..5a9f8d6a 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -1,4 +1,8 @@ + +%entities; +]> @@ -12,28 +16,25 @@ doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" /> - - - - + nm-settings-ifcfg-rh + NetworkManager developers nm-settings-ifcfg-rh 5 NetworkManager Configuration - + &NM_VERSION; nm-settings-ifcfg-rh Description of ifcfg-rh settings plugin - - DESCRIPTION + Description NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings @@ -58,8 +59,7 @@ (initscripts). - - File Format + File Format The ifcfg-rh config format is a simple text file containing VARIABLE="value" lines. The format is described in sysconfig.txt @@ -205,8 +205,7 @@ DEVICETYPE=TeamPort - - Differences against initscripts + Differences against initscripts The main differences of NetworkManager ifcfg-rh plugin and traditional initscripts are: @@ -266,12 +265,11 @@ DEVICETYPE=TeamPort See the next section for detailed mapping of NetworkManager properties and ifcfg-rh variables. Variable names, format and usage - differences in NetworkManager and initscripts are documented in the tables bellow. + differences in NetworkManager and initscripts are documented in the tables below. - - DETAILS + Details ifcfg-rh plugin variables marked with (+) are NetworkManager specific extensions not understood by traditional initscripts. @@ -305,26 +303,20 @@ DEVICETYPE=TeamPort - - AUTHOR - - - NetworkManager developers - - - - - FILES + Files /etc/sysconfig/network-scripts/ifcfg-* /etc/sysconfig/network-scripts/keys-* /etc/sysconfig/network-scripts/route-* /etc/sysconfig/network-scripts/route6-* /usr/share/doc/initscripts/sysconfig.txt - - SEE ALSO - https://developer.gnome.org/NetworkManager/unstable/ref-settings.html - nm-settings(5), nm-settings-keyfile(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5) + See Also + nm-settings5, + nm-settings-keyfile5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index ef5069ff..aa258355 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -1,13 +1,13 @@ '\" t .\" Title: nm-settings-keyfile -.\" Author: [see the "AUTHOR" section] +.\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 29 March 2016 +.\" Date: 04/05/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.1.92 +.\" Source: NetworkManager 1.1.93 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.1\&.92" "Configuration" +.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.1\&.93" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ The \fIkeyfile\fR config format is a simple \&.ini\-style format\&. It consists of sections (groups) of key\-value pairs\&. Each section corresponds to a setting name as described in the settings specification (\fBnm-settings\fR(5))\&. Each configuration key/value pair in the section is one of the properties listed in the settings specification\&. The majority of properties of the specification is written in the same format into the \fIkeyfile\fR -too\&. However some values are inconvenient for people to use\&. These are stored in the files in more readable ways\&. These properties are described bellow\&. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1\&.2\&.3\&.4/12 1\&.2\&.3\&.254"\&. More information of the generic key file format can be found at +too\&. However some values are inconvenient for people to use\&. These are stored in the files in more readable ways\&. These properties are described below\&. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1\&.2\&.3\&.4/12 1\&.2\&.3\&.254"\&. More information of the generic key file format can be found at \m[blue]\fBGLib key file format\fR\m[]\&\s-2\u[1]\d\s+2 (Lines beginning with a \*(Aq#\*(Aq are comments, lists are separated by character ; @@ -207,7 +207,7 @@ id=4 \fIkeyfile\fR plugin variables for the majority of NetworkManager properties have one\-to\-one mapping\&. It means a NetworkManager property is stored in the keyfile as a variable of the same name and in the same format\&. There are several exceptions to this rule, mainly for making keyfile syntax easier for humans\&. The exceptions handled specially by \fIkeyfile\fR -plugin are listed bellow\&. Refer to +plugin are listed below\&. Refer to \fBnm-settings\fR(5) for all available settings and properties and their description\&. .PP @@ -251,7 +251,7 @@ mac\-address T}:T{ mac\-address T}:T{ -ususal hex\-digits\-and\-colons notation +usual hex\-digits\-and\-colons notation T}:T{ MAC address in traditional hex\-digits\-and\-colons notation, or semicolon separated list of 6 decimal bytes (obsolete)\fB @@ -284,7 +284,7 @@ mac\-address T}:T{ mac\-address T}:T{ -ususal hex\-digits\-and\-colons notation +usual hex\-digits\-and\-colons notation T}:T{ MAC address in traditional hex\-digits\-and\-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete)\fB @@ -535,7 +535,7 @@ mac\-address T}:T{ mac\-address T}:T{ -ususal hex\-digits\-and\-colons notation +usual hex\-digits\-and\-colons notation T}:T{ MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162) T} @@ -544,7 +544,7 @@ cloned\-mac\-address T}:T{ cloned\-mac\-address T}:T{ -ususal hex\-digits\-and\-colons notation +usual hex\-digits\-and\-colons notation T}:T{ Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. T} @@ -600,7 +600,7 @@ mac\-address T}:T{ mac\-address T}:T{ -ususal hex\-digits\-and\-colons notation +usual hex\-digits\-and\-colons notation T}:T{ MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162)\&. T} @@ -609,7 +609,7 @@ cloned\-mac\-address T}:T{ cloned\-mac\-address T}:T{ -ususal hex\-digits\-and\-colons notation +usual hex\-digits\-and\-colons notation T}:T{ Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. T} @@ -679,17 +679,17 @@ variable is a decimal number (0 \- 7) defined as a sum of the following values: .\} 4 \- (not\-required) \- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. .RE -.SH "AUTHOR" -.PP -NetworkManager developers .SH "FILES" .PP /etc/NetworkManager/system\-connections/* .SH "SEE ALSO" .PP -https://developer\&.gnome\&.org/NetworkManager/unstable/ref\-settings\&.html -.PP -nm\-settings(5), nm\-settings\-ifcfg\-rh(5), NetworkManager(8), NetworkManager\&.conf(5), nmcli(1), nmcli\-examples(5) +\fBnm-settings\fR(5), +\fBnm-settings-ifcfg-rh\fR(5), +\fBNetworkManager\fR(8), +\fBNetworkManager.conf\fR(5), +\fBnmcli\fR(1), +\fBnmcli-examples\fR(7) .SH "NOTES" .IP " 1." 4 GLib key file format diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index d8cdfe21..fe3c4423 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ -29 March 2016nm-settings-keyfile5NetworkManagerConfiguration1.1.92nm-settings-keyfileDescription of keyfile settings pluginDESCRIPTION +nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.1.93nm-settings-keyfileDescription of keyfile settings pluginDescription NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings5 for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -14,7 +14,7 @@ For security, it will ignore files that are readable or writable by any user or group other than 'root' since private keys and passphrases may be stored in plaintext inside the file. - File Format + File Format The keyfile config format is a simple .ini-style format. It consists of sections (groups) of key-value pairs. Each section corresponds to a setting name as described in the settings specification @@ -23,7 +23,7 @@ specification. The majority of properties of the specification is written in the same format into the keyfile too. However some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties are described bellow. + files in more readable ways. These properties are described below. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1.2.3.4/12 1.2.3.254". More information of the generic key file format can be found at @@ -122,12 +122,12 @@ type=vlan interface-name=VLAN-4A parent=eth0 id=4 - DETAILSkeyfile plugin variables for the majority of NetworkManager + Detailskeyfile plugin variables for the majority of NetworkManager properties have one-to-one mapping. It means a NetworkManager property is stored in the keyfile as a variable of the same name and in the same format. There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by keyfile - plugin are listed bellow. Refer to + plugin are listed below. Refer to nm-settings5 for all available settings and properties and their description. Name aliases @@ -140,7 +140,7 @@ id=4
bridge setting (section)PropertyKeyfile VariableFormatDescription -mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete) +mac-addressmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete) Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;
@@ -150,7 +150,7 @@ Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;16 infiniband setting (section)PropertyKeyfile VariableFormatDescription -mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete) +mac-addressmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete) Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
@@ -208,8 +208,8 @@ Example: password=Popocatepetl 802-3-ethernet setting (section)PropertyKeyfile VariableFormatDescription -mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162) -cloned-mac-addresscloned-mac-addressususal hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178). +mac-addressmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162) +cloned-mac-addresscloned-mac-addressusual hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).mac-address-blacklistmac-address-blacklistlist of MACs (separated with semicolons)MAC address blacklist. Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 @@ -219,8 +219,8 @@ Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78ssidssidstring (or decimal-byte list - obsolete)SSID of Wi-Fi network. Example: ssid=Quick Net -mac-addressmac-addressususal hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162). -cloned-mac-addresscloned-mac-addressususal hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178). +mac-addressmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162). +cloned-mac-addresscloned-mac-addressusual hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).mac-address-blacklistmac-address-blacklistlist of MACs (separated with semicolons)MAC address blacklist. Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 @@ -234,4 +234,9 @@ Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:782 - (not-saved) - this secret should not be saved but should be requested from the user each time it is required.4 - (not-required) - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required - and should not be requested from the user.AUTHORNetworkManager developersFILES/etc/NetworkManager/system-connections/*SEE ALSOhttps://developer.gnome.org/NetworkManager/unstable/ref-settings.htmlnm-settings(5), nm-settings-ifcfg-rh(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5) + and should not be requested from the user.Files/etc/NetworkManager/system-connections/*See Alsonm-settings5, + nm-settings-ifcfg-rh5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index 980a573c..41e7dcdb 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -1,4 +1,8 @@ + +%entities; +]> @@ -8,27 +12,24 @@ doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" /> - - - - + nm-settings-keyfile + NetworkManager developers nm-settings-keyfile 5 NetworkManager Configuration - + &NM_VERSION; nm-settings-keyfile Description of keyfile settings plugin - - DESCRIPTION + Description NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings @@ -48,8 +49,7 @@ in plaintext inside the file. - - File Format + File Format The keyfile config format is a simple .ini-style format. It consists of sections (groups) of key-value pairs. Each section @@ -60,7 +60,7 @@ specification. The majority of properties of the specification is written in the same format into the keyfile too. However some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties are described bellow. + files in more readable ways. These properties are described below. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1.2.3.4/12 1.2.3.254". More information of the generic key file format can be found at @@ -187,15 +187,14 @@ id=4 - - DETAILS + Details keyfile plugin variables for the majority of NetworkManager properties have one-to-one mapping. It means a NetworkManager property is stored in the keyfile as a variable of the same name and in the same format. There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by keyfile - plugin are listed bellow. Refer to + plugin are listed below. Refer to nm-settings5 for all available settings and properties and their description. @@ -242,22 +241,17 @@ id=4 - - AUTHOR - - - NetworkManager developers - - - - - FILES + Files /etc/NetworkManager/system-connections/* - - SEE ALSO - https://developer.gnome.org/NetworkManager/unstable/ref-settings.html - nm-settings(5), nm-settings-ifcfg-rh(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5) + + See Also + nm-settings5, + nm-settings-ifcfg-rh5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings.5 b/man/nm-settings.5 index d24d2fbe..d1c61ade 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -1,13 +1,13 @@ '\" t .\" Title: nm-settings -.\" Author: [see the "AUTHOR" section] +.\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 29 March 2016 +.\" Date: 04/05/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.1.92 +.\" Source: NetworkManager 1.1.93 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.1\&.92" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.1\&.93" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -3849,16 +3849,13 @@ property is a bitfield that contains zero or more of the following values logica .\} 0x4 (not\-required) \- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. .RE -.SH "AUTHOR" -.PP -NetworkManager developers .SH "FILES" .PP /etc/NetworkManager/system\-connections -.PP or distro plugin\-specific location .SH "SEE ALSO" .PP -https://wiki\&.gnome\&.org/Projects/NetworkManager/ConfigurationSpecification -.PP -NetworkManager(8), nmcli(1), nmcli\-examples(5), NetworkManager\&.conf(5) +\fBNetworkManager\fR(8), +\fBnmcli\fR(1), +\fBnmcli-examples\fR(7), +\fBNetworkManager.conf\fR(5) diff --git a/man/nm-settings.xml b/man/nm-settings.xml index 9b709621..b1ee7208 100644 --- a/man/nm-settings.xml +++ b/man/nm-settings.xml @@ -1,6 +1,6 @@ -29 March 2016nm-settings5NetworkManagerConfiguration1.1.92nm-settingsDescription of settings and properties of NetworkManager connection profilesDESCRIPTION +nm-settingsNetworkManager developersnm-settings5NetworkManagerConfiguration1.1.93nm-settingsDescription of settings and properties of NetworkManager connection profilesDescription NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -412,4 +412,7 @@ this secret; when it is required, agents will be asked to provide it.0x2 (not-saved) - this secret should not be saved but should be requested from the user each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, or if the user simply does not want to save the secret.0x4 (not-required) - in some situations it cannot be automatically determined that a secret - is required or not. This flag hints that the secret is not required and should not be requested from the user.AUTHORNetworkManager developersFILES/etc/NetworkManager/system-connectionsor distro plugin-specific locationSEE ALSOhttps://wiki.gnome.org/Projects/NetworkManager/ConfigurationSpecificationNetworkManager(8), nmcli(1), nmcli-examples(5), NetworkManager.conf(5) + is required or not. This flag hints that the secret is not required and should not be requested from the user.Files/etc/NetworkManager/system-connections or distro plugin-specific locationSee AlsoNetworkManager8, + nmcli1, + nmcli-examples7, + NetworkManager.conf5 diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl index b6f564c7..0fe4cabe 100644 --- a/man/nm-settings.xsl +++ b/man/nm-settings.xsl @@ -1,4 +1,8 @@ + +%entities; +]> @@ -8,27 +12,25 @@ doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" /> - - - - + nm-settings + NetworkManager developers nm-settings 5 NetworkManager Configuration - + &NM_VERSION; nm-settings Description of settings and properties of NetworkManager connection profiles - - DESCRIPTION + + Description NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When @@ -109,23 +111,16 @@ - - AUTHOR - - - NetworkManager developers - - - - - FILES - /etc/NetworkManager/system-connections - or distro plugin-specific location + + Files + /etc/NetworkManager/system-connections or distro plugin-specific location - - SEE ALSO - https://wiki.gnome.org/Projects/NetworkManager/ConfigurationSpecification - NetworkManager(8), nmcli(1), nmcli-examples(5), NetworkManager.conf(5) + + See Also + NetworkManager8, + nmcli1, + nmcli-examples7, + NetworkManager.conf5 diff --git a/man/nm-system-settings.conf.5.in b/man/nm-system-settings.conf.5.in deleted file mode 100644 index 172db112..00000000 --- a/man/nm-system-settings.conf.5.in +++ /dev/null @@ -1,25 +0,0 @@ -.\" nm-system-settings.conf(5) manual page -.\" -.\" Copyright (C) 2010 Red Hat, Inc. -.\" -.TH "nm-system-settings.conf" "5" "1 February 2010" "" -.SH NAME -nm\-system\-settings.conf \- Deprecated NetworkManager configuration file -.SH SYNOPSIS -/etc/NetworkManager/nm\-system\-settings.conf -.br -or -.br -\fI\fP/NetworkManager/nm\-system\-settings.conf -.br -where depends on your distribution or build. -.SH DESCRIPTION -.P -.I nm\-system\-settings.conf -is a deprecated configuration file for \fBNetworkManager\fP (5). While this -file can still be used, NetworkManager now defaults to reading the config -file \fP/NetworkManager/NetworkManager.conf\fP instead, falling back -to nm\-system\-settings.conf if NetworkManager.conf does not exist. -.SH "SEE ALSO" -.BR NetworkManager (8), -.BR NetworkManager.conf (5). diff --git a/man/nmcli-examples.5 b/man/nmcli-examples.5 deleted file mode 100644 index e25f8717..00000000 --- a/man/nmcli-examples.5 +++ /dev/null @@ -1,693 +0,0 @@ -'\" t -.\" Title: nmcli-examples -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 19 November 2014 -.\" Manual: Examples -.\" Source: NetworkManager 1.2 -.\" Language: English -.\" -.TH "NMCLI\-EXAMPLES" "5" "" "NetworkManager 1\&.2" "Examples" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nmcli-examples \- usage examples of nmcli -.SH "SYNOPSIS" -.HP \w'\fBnmcli\ \fR\fB[OPTIONS...]\fR\ 'u -\fBnmcli \fR\fB[OPTIONS...]\fR -.SH "DESCRIPTION" -.PP -\fInmcli\fR -is a command\-line client for NetworkManager\&. It allows controlling NetworkManager and reporting its status\&. For more information please refer to -\fBnmcli\fR(1) -manual page\&. -.PP -The purpose of this manual page is to provide you with various examples and usage scenarios of -\fInmcli\fR\&. -.PP -Note: this page has "work\-in\-progress" status\&. -.SH "EXAMPLES" -.PP -\fBExample\ \&1.\ \&Listing available Wi-Fi APs\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ nmcli device wifi list - \fR -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -* SSID MODE CHAN RATE SIGNAL BARS SECURITY - netdatacomm_local Infra 6 54 Mbit/s 37 ā–‚ā–„__ WEP -* F1 Infra 11 54 Mbit/s 98 ā–‚ā–„ā–†ā–ˆ WPA1 - LoremCorp Infra 1 54 Mbit/s 62 ā–‚ā–„ā–†_ WPA2 802\&.1X - Internet Infra 6 54 Mbit/s 29 ā–‚___ WPA1 - HPB110a\&.F2672A Ad\-Hoc 6 54 Mbit/s 22 ā–‚___ \-\- - Jozinet Infra 1 54 Mbit/s 19 ā–‚___ WEP - VOIP Infra 1 54 Mbit/s 20 ā–‚___ WEP - MARTINA Infra 4 54 Mbit/s 32 ā–‚ā–„__ WPA2 - N24PU1 Infra 7 11 Mbit/s 22 ā–‚___ \-\- - alfa Infra 1 54 Mbit/s 67 ā–‚ā–„ā–†_ WPA2 - bertnet Infra 5 54 Mbit/s 20 ā–‚___ WPA1 WPA2 - -.fi -.if n \{\ -.RE -.\} -.PP -This command shows how to list available Wi\-Fi networks (APs)\&. You can also use -\fI\-\-fields\fR -option for displaying different columns\&. -\fBnmcli \-f all dev wifi list\fR -will show all of them\&. -.PP -\fBExample\ \&2.\ \&Showing general information and properties for a Wi-Fi interface\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ nmcli \-p \-f general,wifi\-properties device show wlan0 - \fR -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -=============================================================================== - Device details (wlan0) -=============================================================================== -GENERAL\&.DEVICE: wlan0 -GENERAL\&.TYPE: wifi -GENERAL\&.VENDOR: Intel Corporation -GENERAL\&.PRODUCT: PRO/Wireless 5100 AGN [Shiloh] Network Connection -GENERAL\&.DRIVER: iwlwifi -GENERAL\&.DRIVER\-VERSION: 3\&.8\&.13\-100\&.fc17\&.x86_64 -GENERAL\&.FIRMWARE\-VERSION: 8\&.83\&.5\&.1 build 33692 -GENERAL\&.HWADDR: 00:1E:65:37:A1:D3 -GENERAL\&.MTU: 1500 -GENERAL\&.STATE: 100 (connected) -GENERAL\&.REASON: 0 (No reason given) -GENERAL\&.UDI: /sys/devices/pci0000:00/0000:00:1c\&.1/0000:03:00\&.0/net/wlan0 -GENERAL\&.IP\-IFACE: wlan0 -GENERAL\&.IS\-SOFTWARE: no -GENERAL\&.NM\-MANAGED: yes -GENERAL\&.AUTOCONNECT: yes -GENERAL\&.FIRMWARE\-MISSING: no -GENERAL\&.CONNECTION: My Alfa WiFi -GENERAL\&.CON\-UUID: 85194f4c\-d496\-4eec\-bae0\-d880b4cbcf26 -GENERAL\&.CON\-PATH: /org/freedesktop/NetworkManager/ActiveConnection/10 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -WIFI\-PROPERTIES\&.WEP: yes -WIFI\-PROPERTIES\&.WPA: yes -WIFI\-PROPERTIES\&.WPA2: yes -WIFI\-PROPERTIES\&.TKIP: yes -WIFI\-PROPERTIES\&.CCMP: yes -WIFI\-PROPERTIES\&.AP: no -WIFI\-PROPERTIES\&.ADHOC: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -.fi -.if n \{\ -.RE -.\} -.PP -This command shows information about a Wi\-Fi device\&. -.PP -\fBExample\ \&3.\ \&Listing NetworkManager polkit permissions\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ nmcli general permissions - \fR -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -PERMISSION VALUE -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-network yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wifi yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wwan yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wimax yes -org\&.freedesktop\&.NetworkManager\&.sleep\-wake no -org\&.freedesktop\&.NetworkManager\&.network\-control yes -org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.protected yes -org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.open yes -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.system yes -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.own yes -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.hostname auth - -.fi -.if n \{\ -.RE -.\} -.PP -This command shows configured polkit permissions for various NetworkManager operations\&. These permissions or actions (using polkit language) are configured by a system administrator and are not meant to be changed by users\&. The usual place for the polkit configuration is /usr/share/polkit\-1/actions/org\&.freedesktop\&.NetworkManager\&.policy\&. -\fIpkaction\fR -command can display description for polkit actions\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -pkaction \-\-action\-id org\&.freedesktop\&.NetworkManager\&.network\-control \-\-verbose - \fR -.fi -.if n \{\ -.RE -.\} -.sp -More information about polkit can be found at http://www\&.freedesktop\&.org/wiki/Software/polkit\&. -.PP -\fBExample\ \&4.\ \&Listing NetworkManager log level and domains\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ nmcli general logging - \fR -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -LEVEL DOMAINS -INFO PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,AUTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC,WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DCB,DISPATCH - -.fi -.if n \{\ -.RE -.\} -.PP -This command shows current NetworkManager logging status\&. -.PP -\fBExample\ \&5.\ \&Changing NetworkManager logging\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ nmcli g log level DEBUG domains CORE,ETHER,IP -$ nmcli g log level INFO domains DEFAULT - \fR -.fi -.if n \{\ -.RE -.\} -.PP -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 -\fBNetworkManager.conf\fR(5) -manual page for available logging levels and domains\&. -.PP -\fBExample\ \&6.\ \&Adding a bonding master and two slave connection profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ 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 - \fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a bond master connection and two slaves\&. The first command adds a master bond connection, naming the bonding interface -\fImybond0\fR -and using -\fIactive\-backup\fR -mode\&. The next two commands add slaves connections, both enslaved to -\fImybond0\fR\&. The first slave will be bound to -\fIeth1\fR -interface, the second to -\fIeth2\fR\&. -.PP -\fBExample\ \&7.\ \&Adding a team master and two slave connection profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ 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 - \fR -.fi -.if n \{\ -.RE -.\} -.PP -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 the team interface and the profile -\fITeam1\fR\&. The team configuration for the master is read from -\fIteam1\-master\-json\&.conf\fR -file\&. Later, you can change the configuration with -\fImodify\fR -command (\fBnmcli con modify Team1 team\&.config team1\-master\-another\-json\&.conf\fR)\&. The last two commands add slaves profiles, both enslaved to -\fITeam1\fR\&. The first slave will be bound to -\fIem1\fR -interface, the second to -\fIem2\fR\&. The slaves don\*(Aqt specify -\fIconfig\fR -and thus -\fIteamd\fR -will use its default configuration\&. You will activate the whole setup by activating both slaves: -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ nmcli con up Team1\-slave1 -$ nmcli con up Team1\-slave2 - \fR -.fi -.if n \{\ -.RE -.\} -.sp -By default, the created profiles are marked for auto\-activation\&. But if another connection has been activated on the device, the new profile won\*(Aqt activate automatically and you need to activate it manually\&. -.PP -\fBExample\ \&8.\ \&Adding a bridge and two slave profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB -$ 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 - \fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a bridge master connection and two slaves\&. The first command adds a master bridge connection, naming the bridge interface and the profile as -\fITowerBridge\fR\&. The next two commands add slaves profiles, both will be enslaved to -\fITowerBridge\fR\&. The first slave will be tied to -\fIens3\fR -interface, the second to -\fIens4\fR\&. The last command will disable 802\&.1D STP for the TowerBridge profile\&. -.PP -\fBExample\ \&9.\ \&Adding an ethernet connection profile with manual IP configuration\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf - \fB -$ 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 - \fR - -.fi -.if n \{\ -.RE -.\} -.PP -The first command adds an Ethernet connection profile named -\fImy\-con\-em1\fR -that is bound to interface name -\fIem1\fR\&. The profile is configured with static IP addresses\&. Three addresses are added, two IPv4 addresses and one IPv6\&. The first IP 192\&.168\&.100\&.100 has a prefix of 24 (netmask equivalent of 255\&.255\&.255\&.0)\&. Gateway entry will become the default route if this profile is activated on em1 interface (and there is no connection with higher priority)\&. The next two addresses do not specify a prefix, so a default prefix will be used, i\&.e\&. 32 for IPv4 and 128 for IPv6\&. The second, third and fourth commands modify DNS parameters of the new connection profile\&. The last -\fIcon show\fR -command displays the profile so that all parameters can be reviewed\&. -.PP -\fBExample\ \&10.\ \&Escaping colon characters in tabular mode\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf - \fB -$ nmcli \-t \-f general \-e yes \-m tab dev show eth0 - \fR - -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection:e1000e:2\&.1\&.4\-k:1\&.8\-3:00\e:22\e:68\e:15\e:29\e:21:1500:100 (connected):0 (No reason given):/sys/devices/pci0000\e:00/0000\e:00\e:19\&.0/net/eth0:eth0:yes:yes:no:ethernet\-13:89cbcbc6\-dc85\-456c\-9c8b\-bd828fee3917:/org/freedesktop/NetworkManager/ActiveConnection/9 - -.fi -.if n \{\ -.RE -.\} -.PP -This example shows escaping colon characters in tabular mode\&. It may be useful for script processing, because \*(Aq:\*(Aq is used as a field separator\&. -.PP -\fBExample\ \&11.\ \&nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -#!/bin/bash -export LC_ALL=C - -enable_disable_wifi () -{ - result=$(nmcli dev | grep "ethernet" | grep \-w "connected") - if [ \-n "$result" ]; then - nmcli radio wifi off - else - nmcli radio wifi on - fi -} - -if [ "$2" = "up" ]; then - enable_disable_wifi -fi - -if [ "$2" = "down" ]; then - enable_disable_wifi -fi - -.fi -.if n \{\ -.RE -.\} -.PP -This dispatcher script makes Wi\-Fi mutually exclusive with wired networking\&. When a wired interface is connected, Wi\-Fi will be set to airplane mode (rfkilled)\&. When the wired interface is disconnected, Wi\-Fi will be turned back on\&. Name this script e\&.g\&. 70\-wifi\-wired\-exclusive\&.sh and put it into /etc/NetworkManager/dispatcher\&.d/ directory\&. See -\fBNetworkManager\fR(8) -manual page for more information about NetworkManager dispatcher scripts\&. -.PP -\fBExample sessions of interactive connection editor\fR -.PP -\fBExample\ \&12.\ \&Adding an ethernet connection profile in interactive editor (a)\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf - \fB -$ nmcli connection edit type ethernet - \fR - -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf - -===| nmcli interactive connection editor |=== - -Adding a new \*(Aq802\-3\-ethernet\*(Aq connection - -Type \*(Aqhelp\*(Aq or \*(Aq?\*(Aq for available commands\&. -Type \*(Aqdescribe [\&.]\*(Aq for detailed property description\&. - -You may edit the following settings: connection, 802\-3\-ethernet (ethernet), 802\-1x, ipv4, ipv6, dcb -nmcli> print -=============================================================================== - Connection details -=============================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.master: \-\- -connection\&.slave\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: auto -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: auto -ipv4\&.dns: -ipv4\&.dns\-search: -ipv4\&.addresses: -ipv4\&.gateway: \-\- -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.gateway: \-\- -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> goto ethernet -You may edit the following properties: port, speed, duplex, auto\-negotiate, mac\-address, cloned\-mac\-address, mac\-address\-blacklist, mtu, s390\-subchannels, s390\-nettype, s390\-options -nmcli 802\-3\-ethernet> set mtu 1492 -nmcli 802\-3\-ethernet> b -nmcli> goto ipv4\&.addresses -nmcli ipv4\&.addresses> desc - -=== [addresses] === -[NM property description] -Array of IP addresses\&. - -[nmcli specific description] -Enter a list of IPv4 addresses formatted as: - ip[/prefix], ip[/prefix],\&.\&.\&. -Missing prefix is regarded as prefix of 32\&. - -Example: 192\&.168\&.1\&.5/24, 10\&.0\&.0\&.11/24 - -nmcli ipv4\&.addresses> set 192\&.168\&.1\&.100/24 -Do you also want to set \*(Aqipv4\&.method\*(Aq to \*(Aqmanual\*(Aq? [yes]: yes -nmcli ipv4\&.addresses> -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 -Verify connection: OK -nmcli> print -=============================================================================== - Connection details -=============================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.master: \-\- -connection\&.slave\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: 1492 -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: manual -ipv4\&.dns: -ipv4\&.dns\-search: -ipv4\&.addresses: 192\&.168\&.1\&.100/24 -ipv4\&.gateway: 192\&.168\&.1\&.1 -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -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 -=============================================================================== - Connection details -=============================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.master: \-\- -connection\&.slave\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: 1492 -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: manual -ipv4\&.dns: 8\&.8\&.8\&.8,8\&.8\&.4\&.4 -ipv4\&.dns\-search: -ipv4\&.addresses: 192\&.168\&.1\&.100/24 -ipv4\&.gateway: 192\&.168\&.1\&.1 -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.gateway: \-\- -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> verify -Verify connection: OK -nmcli> save -Connection \*(Aqethernet\-4\*(Aq (de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4) successfully saved\&. -nmcli> quit - -.fi -.if n \{\ -.RE -.\} -.PP -Example session in the nmcli interactive connection editor\&. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS)\&. -.SH "SEE ALSO" -.PP -\fBnmcli\fR(1), -\fBNetworkManager\fR(8), -\fBNetworkManager.conf\fR(5), -\fBnm-settings\fR(5), -\fBnm-online\fR(1), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1) diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 new file mode 100644 index 00000000..2bb5bb77 --- /dev/null +++ b/man/nmcli-examples.7 @@ -0,0 +1,619 @@ +'\" t +.\" Title: nmcli-examples +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 04/05/2016 +.\" Manual: Examples +.\" Source: NetworkManager 1.1.93 +.\" Language: English +.\" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.1\&.93" "Examples" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nmcli-examples \- usage examples of nmcli +.SH "SYNOPSIS" +.HP \w'\fBnmcli\ \fR\fB[OPTIONS...]\fR\ 'u +\fBnmcli \fR\fB[OPTIONS...]\fR +.SH "DESCRIPTION" +.PP +\fInmcli\fR +is a command\-line client for NetworkManager\&. It allows controlling NetworkManager and reporting its status\&. For more information please refer to +\fBnmcli\fR(1) +manual page\&. +.PP +The purpose of this manual page is to provide you with various examples and usage scenarios of +\fInmcli\fR\&. +.PP +Note: this page has "work\-in\-progress" status\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Listing available Wi-Fi APs\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli device wifi list\fR +* SSID MODE CHAN RATE SIGNAL BARS SECURITY + netdatacomm_local Infra 6 54 Mbit/s 37 ā–‚ā–„__ WEP +* F1 Infra 11 54 Mbit/s 98 ā–‚ā–„ā–†ā–ˆ WPA1 + LoremCorp Infra 1 54 Mbit/s 62 ā–‚ā–„ā–†_ WPA2 802\&.1X + Internet Infra 6 54 Mbit/s 29 ā–‚___ WPA1 + HPB110a\&.F2672A Ad\-Hoc 6 54 Mbit/s 22 ā–‚___ \-\- + Jozinet Infra 1 54 Mbit/s 19 ā–‚___ WEP + VOIP Infra 1 54 Mbit/s 20 ā–‚___ WEP + MARTINA Infra 4 54 Mbit/s 32 ā–‚ā–„__ WPA2 + N24PU1 Infra 7 11 Mbit/s 22 ā–‚___ \-\- + alfa Infra 1 54 Mbit/s 67 ā–‚ā–„ā–†_ WPA2 + bertnet Infra 5 54 Mbit/s 20 ā–‚___ WPA1 WPA2 +.fi +.if n \{\ +.RE +.\} +.PP +This command shows how to list available Wi\-Fi networks (APs)\&. You can also use +\fI\-\-fields\fR +option for displaying different columns\&. +\fBnmcli \-f all dev wifi list\fR +will show all of them\&. +.PP +\fBExample\ \&2.\ \&Showing general information and properties for a Wi-Fi interface\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli \-p \-f general,wifi\-properties device show wlan0\fR +=========================================================================== + Device details (wlan0) +=========================================================================== +GENERAL\&.DEVICE: wlan0 +GENERAL\&.TYPE: wifi +GENERAL\&.VENDOR: Intel Corporation +GENERAL\&.PRODUCT: PRO/Wireless 5100 AGN [Shiloh] Network Connection +GENERAL\&.DRIVER: iwlwifi +GENERAL\&.DRIVER\-VERSION: 3\&.8\&.13\-100\&.fc17\&.x86_64 +GENERAL\&.FIRMWARE\-VERSION: 8\&.83\&.5\&.1 build 33692 +GENERAL\&.HWADDR: 00:1E:65:37:A1:D3 +GENERAL\&.MTU: 1500 +GENERAL\&.STATE: 100 (connected) +GENERAL\&.REASON: 0 (No reason given) +GENERAL\&.UDI: /sys/devices/pci0000:00/0000:00:1c\&.1/net/wlan0 +GENERAL\&.IP\-IFACE: wlan0 +GENERAL\&.IS\-SOFTWARE: no +GENERAL\&.NM\-MANAGED: yes +GENERAL\&.AUTOCONNECT: yes +GENERAL\&.FIRMWARE\-MISSING: no +GENERAL\&.CONNECTION: My Alfa WiFi +GENERAL\&.CON\-UUID: 85194f4c\-d496\-4eec\-bae0\-d880b4cbcf26 +GENERAL\&.CON\-PATH: /org/freedesktop/NetworkManager/ActiveConnection/ +10 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +WIFI\-PROPERTIES\&.WEP: yes +WIFI\-PROPERTIES\&.WPA: yes +WIFI\-PROPERTIES\&.WPA2: yes +WIFI\-PROPERTIES\&.TKIP: yes +WIFI\-PROPERTIES\&.CCMP: yes +WIFI\-PROPERTIES\&.AP: no +WIFI\-PROPERTIES\&.ADHOC: yes +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.fi +.if n \{\ +.RE +.\} +.PP +This command shows information about a Wi\-Fi device\&. +.PP +\fBExample\ \&3.\ \&Listing NetworkManager polkit permissions\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli general permissions\fR +PERMISSION VALUE +org\&.freedesktop\&.NetworkManager\&.enable\-disable\-network yes +org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wifi yes +org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wwan yes +org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wimax yes +org\&.freedesktop\&.NetworkManager\&.sleep\-wake no +org\&.freedesktop\&.NetworkManager\&.network\-control yes +org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.protected yes +org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.open yes +org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.system yes +org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.own yes +org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.hostname auth +.fi +.if n \{\ +.RE +.\} +.PP +This command shows configured polkit permissions for various NetworkManager operations\&. These permissions or actions (using polkit language) are configured by a system administrator and are not meant to be changed by users\&. The usual place for the polkit configuration is /usr/share/polkit\-1/actions/org\&.freedesktop\&.NetworkManager\&.policy\&. +\fIpkaction\fR +command can display description for polkit actions\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB + pkaction \-\-action\-id org\&.freedesktop\&.NetworkManager\&.network\-control \-\-verbose + \fR +.fi +.if n \{\ +.RE +.\} +.sp +More information about polkit can be found at http://www\&.freedesktop\&.org/wiki/Software/polkit\&. +.PP +\fBExample\ \&4.\ \&Listing NetworkManager log level and domains\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli general logging\fR +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, +WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DC +B,DISPATCH +.fi +.if n \{\ +.RE +.\} +.PP +This command shows current NetworkManager logging status\&. +.PP +\fBExample\ \&5.\ \&Changing NetworkManager logging\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli g log level DEBUG domains CORE,ETHER,IP\fR +\fB$ nmcli g log level INFO domains DEFAULT\fR +.fi +.if n \{\ +.RE +.\} +.PP +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 +\fBNetworkManager.conf\fR(5) +manual page for available logging levels and domains\&. +.PP +\fBExample\ \&6.\ \&Adding a bonding master and two slave connection profiles\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli con add type bond ifname mybond0 mode active\-backup\fR +\fB$ nmcli con add type ethernet ifname eth1 master mybond0\fR +\fB$ nmcli con add type ethernet ifname eth2 master mybond0\fR +.fi +.if n \{\ +.RE +.\} +.PP +This example demonstrates adding a bond master connection and two slaves\&. The first command adds a master bond connection, naming the bonding interface +\fImybond0\fR +and using +\fIactive\-backup\fR +mode\&. The next two commands add slaves connections, both enslaved to +\fImybond0\fR\&. The first slave will be bound to +\fIeth1\fR +interface, the second to +\fIeth2\fR\&. +.PP +\fBExample\ \&7.\ \&Adding a team master and two slave connection profiles\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli con add type team con\-name Team1 ifname Team1 config team1\-master\-json\&.conf\fR +\fB$ nmcli con add type ethernet con\-name Team1\-slave1 ifname em1 master Team1\fR +\fB$ nmcli con add type ethernet con\-name Team1\-slave2 ifname em2 master Team1\fR +.fi +.if n \{\ +.RE +.\} +.PP +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 the team interface and the profile +\fITeam1\fR\&. The team configuration for the master is read from +\fIteam1\-master\-json\&.conf\fR +file\&. Later, you can change the configuration with +\fImodify\fR +command (\fBnmcli con modify Team1 team\&.config team1\-master\-another\-json\&.conf\fR)\&. The last two commands add slaves profiles, both enslaved to +\fITeam1\fR\&. The first slave will be bound to +\fIem1\fR +interface, the second to +\fIem2\fR\&. The slaves don\*(Aqt specify +\fIconfig\fR +and thus +\fIteamd\fR +will use its default configuration\&. You will activate the whole setup by activating both slaves: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fB$ nmcli con up Team1\-slave1\fR + \fB$ nmcli con up Team1\-slave2\fR +.fi +.if n \{\ +.RE +.\} +.sp +By default, the created profiles are marked for auto\-activation\&. But if another connection has been activated on the device, the new profile won\*(Aqt activate automatically and you need to activate it manually\&. +.PP +\fBExample\ \&8.\ \&Adding a bridge and two slave profiles\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli con add type bridge con\-name TowerBridge ifname TowerBridge\fR +\fB$ nmcli con add type ethernet con\-name br\-slave\-1 ifname ens3 master TowerBridge\fR +\fB$ nmcli con add type ethernet con\-name br\-slave\-2 ifname ens4 master TowerBridge\fR +\fB$ nmcli con modify TowerBridge bridge\&.stp no\fR +.fi +.if n \{\ +.RE +.\} +.PP +This example demonstrates adding a bridge master connection and two slaves\&. The first command adds a master bridge connection, naming the bridge interface and the profile as +\fITowerBridge\fR\&. The next two commands add slaves profiles, both will be enslaved to +\fITowerBridge\fR\&. The first slave will be tied to +\fIens3\fR +interface, the second to +\fIens4\fR\&. The last command will disable 802\&.1D STP for the TowerBridge profile\&. +.PP +\fBExample\ \&9.\ \&Adding an ethernet connection profile with manual IP configuration\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli con add con\-name my\-con\-em1 ifname em1 type ethernet \e + ip4 192\&.168\&.100\&.100/24 gw4 192\&.168\&.100\&.1 ip4 1\&.2\&.3\&.4 ip6 abbe::cafe\fR +\fB$ nmcli con mod my\-con\-em1 ipv4\&.dns "8\&.8\&.8\&.8 8\&.8\&.4\&.4"\fR +\fB$ nmcli con mod my\-con\-em1 +ipv4\&.dns 1\&.2\&.3\&.4\fR +\fB$ nmcli con mod my\-con\-em1 ipv6\&.dns "2001:4860:4860::8888 2001:4860:4860::8844"\fR +\fB$ nmcli \-p con show my\-con\-em1\fR +.fi +.if n \{\ +.RE +.\} +.PP +The first command adds an Ethernet connection profile named +\fImy\-con\-em1\fR +that is bound to interface name +\fIem1\fR\&. The profile is configured with static IP addresses\&. Three addresses are added, two IPv4 addresses and one IPv6\&. The first IP 192\&.168\&.100\&.100 has a prefix of 24 (netmask equivalent of 255\&.255\&.255\&.0)\&. Gateway entry will become the default route if this profile is activated on em1 interface (and there is no connection with higher priority)\&. The next two addresses do not specify a prefix, so a default prefix will be used, i\&.e\&. 32 for IPv4 and 128 for IPv6\&. The second, third and fourth commands modify DNS parameters of the new connection profile\&. The last +\fIcon show\fR +command displays the profile so that all parameters can be reviewed\&. +.PP +\fBExample\ \&10.\ \&Escaping colon characters in tabular mode\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli \-t \-f general \-e yes \-m tab dev show eth0\fR +GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: +e1000e:2\&.1\&.4\-k:1\&.8\-3:00\e:22\e:68\e:15\e:29\e:21:1500:100 (connected):0 (No reas +on given):/sys/devices/pci0000\e:00/0000\e:00\e:19\&.0/net/eth0:eth0:yes:yes:no: +ethernet\-13:89cbcbc6\-dc85\-456c\-9c8b\-bd828fee3917:/org/freedesktop/NetworkMa +nager/ActiveConnection/9 +.fi +.if n \{\ +.RE +.\} +.PP +This example shows escaping colon characters in tabular mode\&. It may be useful for script processing, because \*(Aq:\*(Aq is used as a field separator\&. +.PP +\fBExample\ \&11.\ \&nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +#!/bin/bash +export LC_ALL=C + +enable_disable_wifi () +{ + result=$(nmcli dev | grep "ethernet" | grep \-w "connected") + if [ \-n "$result" ]; then + nmcli radio wifi off + else + nmcli radio wifi on + fi +} + +if [ "$2" = "up" ]; then + enable_disable_wifi +fi + +if [ "$2" = "down" ]; then + enable_disable_wifi +fi + +.fi +.if n \{\ +.RE +.\} +.PP +This dispatcher script makes Wi\-Fi mutually exclusive with wired networking\&. When a wired interface is connected, Wi\-Fi will be set to airplane mode (rfkilled)\&. When the wired interface is disconnected, Wi\-Fi will be turned back on\&. Name this script e\&.g\&. 70\-wifi\-wired\-exclusive\&.sh and put it into /etc/NetworkManager/dispatcher\&.d/ directory\&. See +\fBNetworkManager\fR(8) +manual page for more information about NetworkManager dispatcher scripts\&. +.PP +\fBExample sessions of interactive connection editor\fR +.PP +\fBExample\ \&12.\ \&Adding an ethernet connection profile in interactive editor (a)\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ nmcli connection edit type ethernet\fR + +===| nmcli interactive connection editor |=== + +Adding a new \*(Aq802\-3\-ethernet\*(Aq connection + +Type \*(Aqhelp\*(Aq or \*(Aq?\*(Aq for available commands\&. +Type \*(Aqdescribe [\&.]\*(Aq for detailed property description\&. + +You may edit the following settings: connection, 802\-3\-ethernet (ethernet), +802\-1x, ipv4, ipv6, dcb +nmcli> \fBprint\fR +=========================================================================== + Connection details +=========================================================================== +connection\&.id: ethernet\-4 +connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 +connection\&.interface\-name: \-\- +connection\&.type: 802\-3\-ethernet +connection\&.autoconnect: yes +connection\&.autoconnect\-priority: 0 +connection\&.timestamp: 0 +connection\&.read\-only: no +connection\&.permissions: +connection\&.zone: \-\- +connection\&.master: \-\- +connection\&.slave\-type: \-\- +connection\&.secondaries: +connection\&.gateway\-ping\-timeout: 0 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +802\-3\-ethernet\&.port: \-\- +802\-3\-ethernet\&.speed: 0 +802\-3\-ethernet\&.duplex: \-\- +802\-3\-ethernet\&.auto\-negotiate: yes +802\-3\-ethernet\&.mac\-address: \-\- +802\-3\-ethernet\&.cloned\-mac\-address: \-\- +802\-3\-ethernet\&.mac\-address\-blacklist: +802\-3\-ethernet\&.mtu: auto +802\-3\-ethernet\&.s390\-subchannels: +802\-3\-ethernet\&.s390\-nettype: \-\- +802\-3\-ethernet\&.s390\-options: +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +ipv4\&.method: auto +ipv4\&.dns: +ipv4\&.dns\-search: +ipv4\&.addresses: +ipv4\&.gateway: \-\- +ipv4\&.routes: +ipv4\&.route\-metric: \-1 +ipv4\&.ignore\-auto\-routes: no +ipv4\&.ignore\-auto\-dns: no +ipv4\&.dhcp\-client\-id: \-\- +ipv4\&.dhcp\-send\-hostname: yes +ipv4\&.dhcp\-hostname: \-\- +ipv4\&.never\-default: no +ipv4\&.may\-fail: yes +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +ipv6\&.method: auto +ipv6\&.dns: +ipv6\&.dns\-search: +ipv6\&.addresses: +ipv6\&.gateway: \-\- +ipv6\&.routes: +ipv6\&.route\-metric: \-1 +ipv6\&.ignore\-auto\-routes: no +ipv6\&.ignore\-auto\-dns: no +ipv6\&.never\-default: no +ipv6\&.may\-fail: yes +ipv6\&.ip6\-privacy: \-1 (unknown) +ipv6\&.dhcp\-hostname: \-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +nmcli> \fBgoto ethernet\fR +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> \fBgoto ipv4\&.addresses\fR +nmcli ipv4\&.addresses> desc + +=== [addresses] === +[NM property description] +Array of IP addresses\&. + +[nmcli specific description] +Enter a list of IPv4 addresses formatted as: + ip[/prefix], ip[/prefix],\&.\&.\&. +Missing prefix is regarded as prefix of 32\&. + +Example: 192\&.168\&.1\&.5/24, 10\&.0\&.0\&.11/24 + +nmcli ipv4\&.addresses> set 192\&.168\&.1\&.100/24 +Do you also want to set \*(Aqipv4\&.method\*(Aq to \*(Aqmanual\*(Aq? [yes]: yes +nmcli ipv4\&.addresses> +nmcli ipv4\&.addresses> print +addresses: 192\&.168\&.1\&.100/24 +nmcli ipv4\&.addresses> back +nmcli ipv4> b +nmcli> \fBset ipv4\&.gateway 192\&.168\&.1\&.1\fR +nmcli> \fBverify\fR +Verify connection: OK +nmcli> \fBprint\fR +=========================================================================== + Connection details +=========================================================================== +connection\&.id: ethernet\-4 +connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 +connection\&.interface\-name: \-\- +connection\&.type: 802\-3\-ethernet +connection\&.autoconnect: yes +connection\&.autoconnect\-priority: 0 +connection\&.timestamp: 0 +connection\&.read\-only: no +connection\&.permissions: +connection\&.zone: \-\- +connection\&.master: \-\- +connection\&.slave\-type: \-\- +connection\&.secondaries: +connection\&.gateway\-ping\-timeout: 0 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +802\-3\-ethernet\&.port: \-\- +802\-3\-ethernet\&.speed: 0 +802\-3\-ethernet\&.duplex: \-\- +802\-3\-ethernet\&.auto\-negotiate: yes +802\-3\-ethernet\&.mac\-address: \-\- +802\-3\-ethernet\&.cloned\-mac\-address: \-\- +802\-3\-ethernet\&.mac\-address\-blacklist: +802\-3\-ethernet\&.mtu: 1492 +802\-3\-ethernet\&.s390\-subchannels: +802\-3\-ethernet\&.s390\-nettype: \-\- +802\-3\-ethernet\&.s390\-options: +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +ipv4\&.method: manual +ipv4\&.dns: +ipv4\&.dns\-search: +ipv4\&.addresses: 192\&.168\&.1\&.100/24 +ipv4\&.gateway: 192\&.168\&.1\&.1 +ipv4\&.routes: +ipv4\&.route\-metric: \-1 +ipv4\&.ignore\-auto\-routes: no +ipv4\&.ignore\-auto\-dns: no +ipv4\&.dhcp\-client\-id: \-\- +ipv4\&.dhcp\-send\-hostname: yes +ipv4\&.dhcp\-hostname: \-\- +ipv4\&.never\-default: no +ipv4\&.may\-fail: yes +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +ipv6\&.method: auto +ipv6\&.dns: +ipv6\&.dns\-search: +ipv6\&.addresses: +ipv6\&.routes: +ipv6\&.route\-metric: \-1 +ipv6\&.ignore\-auto\-routes: no +ipv6\&.ignore\-auto\-dns: no +ipv6\&.never\-default: no +ipv6\&.may\-fail: yes +ipv6\&.ip6\-privacy: \-1 (unknown) +ipv6\&.dhcp\-hostname: \-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +nmcli> \fBset ipv4\&.dns 8\&.8\&.8\&.8 8\&.8\&.4\&.4\fR +nmcli> \fBprint\fR +=========================================================================== + Connection details +=========================================================================== +connection\&.id: ethernet\-4 +connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 +connection\&.interface\-name: \-\- +connection\&.type: 802\-3\-ethernet +connection\&.autoconnect: yes +connection\&.autoconnect\-priority: 0 +connection\&.timestamp: 0 +connection\&.read\-only: no +connection\&.permissions: +connection\&.zone: \-\- +connection\&.master: \-\- +connection\&.slave\-type: \-\- +connection\&.secondaries: +connection\&.gateway\-ping\-timeout: 0 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +802\-3\-ethernet\&.port: \-\- +802\-3\-ethernet\&.speed: 0 +802\-3\-ethernet\&.duplex: \-\- +802\-3\-ethernet\&.auto\-negotiate: yes +802\-3\-ethernet\&.mac\-address: \-\- +802\-3\-ethernet\&.cloned\-mac\-address: \-\- +802\-3\-ethernet\&.mac\-address\-blacklist: +802\-3\-ethernet\&.mtu: 1492 +802\-3\-ethernet\&.s390\-subchannels: +802\-3\-ethernet\&.s390\-nettype: \-\- +802\-3\-ethernet\&.s390\-options: +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +ipv4\&.method: manual +ipv4\&.dns: 8\&.8\&.8\&.8,8\&.8\&.4\&.4 +ipv4\&.dns\-search: +ipv4\&.addresses: 192\&.168\&.1\&.100/24 +ipv4\&.gateway: 192\&.168\&.1\&.1 +ipv4\&.routes: +ipv4\&.route\-metric: \-1 +ipv4\&.ignore\-auto\-routes: no +ipv4\&.ignore\-auto\-dns: no +ipv4\&.dhcp\-client\-id: \-\- +ipv4\&.dhcp\-send\-hostname: yes +ipv4\&.dhcp\-hostname: \-\- +ipv4\&.never\-default: no +ipv4\&.may\-fail: yes +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +ipv6\&.method: auto +ipv6\&.dns: +ipv6\&.dns\-search: +ipv6\&.addresses: +ipv6\&.gateway: \-\- +ipv6\&.routes: +ipv6\&.route\-metric: \-1 +ipv6\&.ignore\-auto\-routes: no +ipv6\&.ignore\-auto\-dns: no +ipv6\&.never\-default: no +ipv6\&.may\-fail: yes +ipv6\&.ip6\-privacy: \-1 (unknown) +ipv6\&.dhcp\-hostname: \-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +nmcli> \fBverify\fR +Verify connection: OK +nmcli> \fBsave\fR +Connection \*(Aqethernet\-4\*(Aq (de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4) successfully + saved\&. +nmcli> \fBquit\fR +.fi +.if n \{\ +.RE +.\} +.PP +Example session in the nmcli interactive connection editor\&. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS)\&. +.SH "SEE ALSO" +.PP +\fBnmcli\fR(1), +\fBNetworkManager\fR(8), +\fBNetworkManager.conf\fR(5), +\fBnm-settings\fR(5), +\fBnm-online\fR(1), +\fBnm-applet\fR(1), +\fBnm-connection-editor\fR(1) diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 0ce7dc72..9c28e15f 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -1,6 +1,10 @@ - - + + + +%entities; +]> + + + + + nmcli + NetworkManager developers + + + + nmcli + 1 + NetworkManager + General Commands Manual + &NM_VERSION; + + + + nmcli + command-line tool for controlling NetworkManager + + + + + nmcli + OPTIONS + + + + + + + + + + + COMMAND + ARGUMENTS + + + + Description + nmcli is a command-line tool for controlling + NetworkManager and reporting network status. It can be utilized as a + replacement for nm-applet or other graphical clients. + nmcli is used to create, display, edit, delete, activate, + and deactivate network connections, as well as control and display network + device status. + + Typical uses include: + + + Scripts: Utilize NetworkManager via nmcli instead of + managing network connections manually. nmcli supports a + terse output format which is better suited for script processing. Note that + NetworkManager can also execute scripts, called "dispatcher scripts", in + response to network events. See + NetworkManager8 + for details about these dispatcher scripts. + + + + Servers, headless machines, and terminals: nmcli can + be used to control NetworkManager without a GUI, including creating, editing, + starting and stopping network connections and viewing network status. + + + + + Options + + + + + + + + + + Output is terse. This mode is designed and suitable for computer (script) + processing. + + + + + + + + + + + Output is pretty. This causes nmcli to produce easily + readable outputs for humans, i.e. values are aligned, headers are printed, + etc. + + + + + + + + + tabular + multiline + + + + + Switch between tabular and multiline output: + + + + tabular + + Output is a table where each line describes a single entry. + Columns define particular properties of the entry. + + + + + multiline + + Each entry comprises multiple lines, each property on its + own line. The values are prefixed with the property name. + + + + + If omitted, default is tabular for most commands. + For the commands producing more structured information, that cannot be + displayed on a single line, default is multiline. + Currently, they are: + + + + nmcli connection show ID + + + + nmcli device show + + + + + + + + + + + + yes + no + auto + + + + + This option controls color output (using terminal escape sequences). + yes enables colors, no disables them, + auto only produces colors when standard output is directed + to a terminal. The default value is auto. + + + + + + + + + field + all + common + + + + + This option is used to specify what fields (column names) should be + printed. Valid field names differ for specific commands. List available fields + by providing an invalid value to the option. + all is used to print all valid field values of the + command. common is used to print common field values of + the command. + + If omitted, default is common. The option is + mandatory when is used. In this case, generic values + all and common cannot be used. This + is to maintain compatibility when new fields are added in the future. + + + + + + + + + yes + no + + + + + Whether to escape : and \ characters in terse tabular mode. The + escape character is \. + + If omitted, default is yes. + + + + + + + + + + + This option can be used to force nmcli to skip + checking nmcli and NetworkManager + version compatibility. Use it with care, because using incompatible versions + may produce incorrect results. + + + + + + + + + + + When using this option nmcli will stop and ask for any + missing required arguments, so do not use this option for non-interactive + purposes like scripts. This option controls, for example, whether you will be + prompted for a password if it is required for connecting to a network. + + + + + + + + + + + When using this option nmcli will display passwords + and secrets that might be present in an output of an operation. This option + also influences echoing passwords typed by user as an input. + + + + + + + + + + seconds + + + + This option sets a timeout period for which nmcli will + wait for NetworkManager to finish operations. It is + especially useful for commands that may take a longer time to complete, e.g. + connection activation. + + Specifying a value of 0 instructs + nmcli not to wait but to exit immediately with a status of + success. The default value depends on the executed command. + + + + + + + + + + + Show nmcli version. + + + + + + + + + + + Print help information. + + + + + + + General Commands + + + nmcli general + + status + hostname + permissions + logging + + ARGUMENTS + + + Use this command to show NetworkManager status and permissions. You can also get + and change system hostname, as well as NetworkManager logging level and domains. + + + + + status + + + Show overall status of NetworkManager. This is the default action, when + no additional command is provided for nmcli general. + + + + + + hostname + hostname + + + + Get and change system hostname. With no arguments, this prints currently + configured hostname. When you pass a hostname, it will be handed over to + NetworkManager to be set as a new system hostname. + + Note that the term "system" hostname may also be referred to as + "persistent" or "static" by other programs or tools. The hostname is stored + in /etc/hostname file in most distributions. For example, + systemd-hostnamed service uses the term "static" hostname and it only reads + the /etc/hostname file when it starts. + + + + + permissions + + + Show the permissions a caller has for various authenticated operations + that NetworkManager provides, like enable and disable networking, changing + Wi-Fi and WWAN state, modifying connections, etc. + + + + + + logging + level + domains + + + + Get and change NetworkManager logging level and + domains. Without any argument current logging level and domains are shown. In + order to change logging state, provide and, or, + parameters. See + NetworkManager.conf5 + for available level and domain values. + + + + + + Networking Control Commands + + + nmcli networking + + on + off + connectivity + + ARGUMENTS + + + Query NetworkManager networking status, enable and disable networking. + + + + + + on + off + + + Enable enable or disable networking control by NetworkManager. + All interfaces managed by NetworkManager are deactivated when networking + is disabled. + + + + + + connectivity + check + + + + Get network connectivity state. The optional + argument tells NetworkManager to re-check the connectivity, else the most + recent known connectivity state is displayed without re-checking. + + Possible states are: + + + + none + + the host is not connected to any network. + + + + portal + + the host is behind a captive portal and cannot reach the full Internet. + + + + limited + + the host is connected to a network, but it has no access to the Internet. + + + + full + + the host is connected to a network and has full access to the Internet. + + + + unknown + + the connectivity status cannot be found out. + + + + + + + + + + Radio Transmission Control Commands + + + nmcli radio + + all + wifi + wwan + + ARGUMENTS + + + Show radio switches status, or enable and disable the switches. + + + + + + wifi + + on + off + + + + + Show or set status of Wi-Fi in NetworkManager. If no arguments are + supplied, Wi-Fi status is printed; enables Wi-Fi; + disables Wi-Fi. + + + + + + wwan + + on + off + + + + + Show or set status of WWAN (mobile broadband) in NetworkManager. If no + arguments are supplied, mobile broadband status is printed; + enables mobile broadband, + disables it. + + + + + + all + + on + off + + + + + Show or set all previously mentioned radio switches at the same time. + + + + + + Activity Monitor + + + nmcli monitor + + + Observe NetworkManager activity. Watches for changes + in connectivity state, devices or connection profiles. + + See also nmcli connection monitor + and nmcli device monitor to watch + for changes in certain devices or connections. + + + Connection Management Commands + + + nmcli connection + + show + up + down + add + edit + modify + delete + monitor + reload + load + + ARGUMENTS + + + NetworkManager stores all network configuration as "connections", + which are collections of data (Layer2 details, IP addressing, etc.) that + describe how to create or connect to a network. A connection is "active" + when a device uses that connection's configuration to create or connect to + a network. There may be multiple connections that apply to a device, but only + one of them can be active on that device at any given time. The additional + connections can be used to allow quick switching between different networks + and configurations. + + Consider a machine which is usually connected to a DHCP-enabled network, + but sometimes connected to a testing network which uses static IP addressing. + Instead of manually reconfiguring eth0 each time the network is changed, the + settings can be saved as two connections which both apply to eth0, one for DHCP + (called default) and one with the static addressing details (called + testing). When connected to the DHCP-enabled network the user would run + nmcli con up default , and when connected to the static network the user + would run nmcli con up testing. + + + + + + show + + + + [+-]category: + + + + + List in-memory and on-disk connection profiles, some of which may also be + active if a device is using that connection profile. Without a parameter, all + profiles are listed. When option is specified, only + the active profiles are shown. + + The option can be used to get custom + ordering of connections. The connections can be ordered by active status + (active), name (name), type + (type) or D-Bus path (path). If + connections are equal according to a sort order category, an additional + category can be specified. The default sorting order is equivalent to + --order active:name:path. + or no + prefix means sorting in ascending order (alphabetically or in numbers), + - means reverse (descending) order. The category names + can be abbreviated (e.g. --order -a:na). + + + + + + show + + + + + + + + ID + + + + Show details for specified connections. By default, both static + configuration and active connection data are displayed. When + option is specified, only the active profiles are + taken into account. Use global option to + display secrets associated with the profile. + + , , + and keywords can be used + if ID is ambiguous. Optional + ID-specifying keywords are: + + + + + + the ID denotes a connection name. + + + + + + the ID denotes a connection UUID. + + + + + + the ID denotes a D-Bus + static connection path in the format of + /org/freedesktop/NetworkManager/Settings/num + or just num. + + + + + + the ID denotes a D-Bus active connection path in the format of + /org/freedesktop/NetworkManager/ActiveConnection/num or just + num. + + + + + It is possible to filter the output using the global + option. Use the following values: + + + + + + only shows static profile configuration. + + + + + + only shows active connection data (when the profile is active). + + + + + You can also specify particular fields. For static configuration, use + setting and property names as described in + nm-settings5 + manual page. For active data use GENERAL, IP4, DHCP4, IP6, + DHCP6, VPN. + + When no command is given to the nmcli connection, + the default action is nmcli connection show. + + + + + + + up + + + + + + ID + ifname + BSSID + file + + + + Activate a connection. The connection is identified by its name, UUID or + D-Bus path. If ID is ambiguous, a keyword , + or can be used. When + requiring a particular device to activate the connection on, the + option with interface name should be given. If the + ID is not given an is required, and + NetworkManager will activate the best available connection for the given + . In case of a VPN connection, the + option specifies the device of the base connection. + The option specify what particular AP should be used in + case of a Wi-Fi connection. + + If option is not specified, the default timeout will be 90 + seconds. + + See connection show above for the description of the + ID-specifying keywords. + + Available options are: + + + + + + interface that will be used for activation. + + + + + + BSSID of the AP which the command should connect to (for Wi-Fi connections). + + + + + + some networks may require credentials during activation. You can give + these credentials using this option. Each line of the file should contain one + password in the form: + + setting_name.property_name:the password + + For example, for WPA Wi-Fi with PSK, the line would be + + 802-11-wireless-security.psk:secret12345 + + For 802.1X password, the line would be + + 802-1x.password:my 1X password + + nmcli also accepts wifi-sec and wifi strings instead of + 802-11-wireless-security. When NetworkManager requires a password and it is + not given, nmcli will ask for it when run with . + If was not passed, NetworkManager can ask another secret + agent that may be running (typically a GUI secret agent, such as nm-applet or + gnome-shell). + + + + + + + + + + down + + + + + + + ID + + + + Deactivate a connection from a device without preventing the device from + further auto-activation. Multiple connections can be passed to the + command. + + Be aware that this command deactivates the specified active connection, + but the device on which the connection was active, is still ready to connect + and will perform auto-activation by looking for a suitable connection that has + the 'autoconnect' flag set. This includes the just deactivated connection. So + if the connection is set to auto-connect, it will be automatically started on + the disconnected device again. + + In most cases you may want to use device disconnect + command instead. + + The connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword , + , or + can be used. + + See connection show above for the description of + the ID-specifying keywords. + + If option is not specified, the default timeout + will be 10 seconds. + + + + + + add + ifname + con-name name + + + + yes + no + + + + + + yes + no + + + master master + slave-type type + type type + ARGUMENTS + ip4 addr + gw4 addr + ip6 addr + gw6 addr + + + + [+|-]setting.property + value + + + + + + Add a connection for NetworkManager. Arguments differ according to connection types, see below. + + + + + + + interface to bind the connection to. The connection will only be + applicable to this interface name. A special value of * + can be used for interface-independent connections. The + argument is mandatory for all connection types + except bond, team, bridge and vlan. Note: use quotes around + * to suppress shell expansion. + + + + + + + connection name (when not provided a default name is generated: + <type>[-<ifname>][-<num>]). + + + + + + + whether the connection profile can be automatically activated (default: + yes). + + + + + + + whether the connection should be persistent, i.e. NetworkManager should + store it on disk (default: yes). + + + + + + + master interface name, or connection UUID or ID of master connection + profile. The value can be prefixed with ifname/, + uuid/ or id/ to disambiguate it. + + + + + + + type of master connection. Only required when it can not be inferred + (i.e. the master connection does + not exist yet). + + + + + + + connection type; see below for allowed values. Note that types + , and + create connection + profiles. Their use is discouraged in favor of using a specific type with + option. + + + + + + + addr + addr + mtu + + + + + + + MAC address of the device this connection is locked to. + + + + + + + cloned MAC. + + + + + + + MTU. + + + + + + + + + + SSID + addr + addr + + + + infrastructure + ap + adhoc + + + mtu + + + + + + + SSID. + + + + + + + MAC address of the device this connection is locked to. + + + + + + + cloned MAC. + + + + + + + Wi-Fi network mode. If blank, infrastructure + is assumed. + + + + + + + MTU. + + + + + + + + + + addr + nsp + + + + + + + MAC address of the device this connection is locked to. + + + + + + + Network Service Provider name. + + + + + + + + + + user + passwd + name + mtu + addr + + + + + + + PPPoE username. + + + + + + + Password for the PPPoE username. + + + + + + + PPPoE service name (if required by concentrator). + + + + + + + MTU. + + + + + + + MAC address of the device this connection is locked to. + + + + + + + + + + APN + user + passwd + + + + + + + APN - GSM Access Point Name. + + + + + + + user name. + + + + + + + password. + + + + + + + + + + user + passwd + + + + + + + user name. + + + + + + + password. + + + + + + + + + + addr + mtu + + + + datagram + connected + + + device + key + + + + + + + MAC address of the device this connection is locked to + (InfiniBand MAC is 20 bytes). + + + + + + + MTU. + + + + + + + InfiniBand transport mode. + + + + + + + the interface name of the parent device (if any). + + + + + + + the InfiniBand P_Key (16-bit unsigned integer). + + + + + + + + + + addr + + + + panu + dun-gsm + dun-cdma + + + + + + + + + Bluetooth device address (MAC). + + + + + + + Bluetooth connection type. + + + + + + + + + + device + id + flags + mapping + mapping + mtu + + + + + + + parent device this VLAN is on. + + + + + + + VLAN ID in range 0-4095. + + + + + + + flags. + + + + + + + VLAN ingress priority mapping. + + + + + + + VLAN egress priority mapping. + + + + + + + MTU. + + + + + + + + + + + + + active-backup + balance-xor + broadcast + 802.3ad + balance-tlb + balance-alb + num + + + ifname + num + num + num + num + num + + + + + + + + bonding mode (default: balance-rr). + + + + + + + primary interface name (for active-backup mode). + + + + + + + miimon (default: 100). + + + + + + + downdelay (default: 0). + + + + + + + updelay (default: 0). + + + + + + + ARP interval (default: 0). + + + + + + + ARP IP target. + + + + + + + + + + master + + + + + + + master bond interface name, or connection UUID or + ID of bond master connection profile. The value can be + prefixed with ifname/, + uuid/ or id/ to + disambiguate it. + + + + + + + + + + + + + file + JSON + + + + + + + + + + JSON configuration for team. + + + + + + + + + + + + + + + + + + + + master team interface name, or connection UUID or + ID of team master connection profile. The value can be + prefixed with ifname/, + uuid/ or id/to + disambiguate it. + + + + + + + JSON configuration for team. + + + + + + + + + + + + + yes + no + + + num + 2-30 + 1-10 + 6-42 + 0-1000000 + + + + yes + no + + + addr + + + + + + + controls whether Spanning Tree Protocol (STP) is enabled for this bridge + (default: yes). + + + + + + + sets STP priority (default: 128). + + + + + + + STP forwarding delay, in seconds (default: 15). + + + + + + + STP hello time, in seconds (default: 2). + + + + + + + STP maximum message age, in seconds (default: 20). + + + + + + + the Ethernet MAC address aging time, in seconds (default: 300). + + + + + + + controls whether IGMP snooping is enabled (default: yes). + + + + + + + MAC address of the bridge (note: this requires a recent kernel feature, + originally introduced in 3.15 upstream kernel). + + + + + + + + + + master + num + 1-65535 + + + + yes + no + + + + + + + + + master bridge interface name, or connection UUID + or ID of bridge master connection profile. The value + can be prefixed with ifname/, + uuid/ or id/ + to disambiguate it. + + + + + + + STP priority of this slave (default: 32). + + + + + + + STP port cost for destinations via this slave (default: 100). + + + + + + + 'hairpin mode' for the slave, which allows frames to be sent back out + through the slave the frame was received on (default: yes). + + + + + + + + + + type + username + + + + + + + VPN type. + + + + + + + VPN username. + + + + + + + + + + SSID + 1-13 + MAC + + + + + + + SSID. + + + + + + + channel to use for the network. + + + + + + + anycast DHCP MAC address used when requesting an IP address via DHCP. + + + + + + + + + + username + + + + pppoa + pppoe + ipoatm + + + passwd + + + + vcmux + llc + + + + + + + + + ADSL user name. + + + + + + + ADSL protocol. + + + + + + + ADSL password. + + + + + + + ADSL encapsulation. + + + + + + + + + + + + + tun + tap + + + UID + GID + + + + yes + no + + + + + + yes + no + + + + + + yes + no + + + + + + + + + Mode for the device. + + + + + + + UID of the owner. + + + + + + + GID of the group. + + + + + + + include packet information (~IFF_NO_PI flag). + + + + + + + send and receive large (i.e. GSO) packets and packets with partial + checksums (IFF_VNET_HDR flag). + + + + + + + multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag). + + + + + + + + + + + + + ipip + gre + sit + isatap + vti + ip6ip6 + ipip6 + ip6gre + vti6 + tun + + + addr + addr + device + + + + + + + tunnel mode. + + + + + + + IPv4 or IPv6 address of the remote tunnel endpoint. + + + + + + + IPv4 or IPv6 address of the local tunnel endpoint. + + + + + + + device to use for tunnel endpoint communication. + + + + + + + + + + device + + + + vepa + bridge + private + passthru + source + + + + + + yes + no + + + + + + + + + parent device this MACVLAN is on. + + + + + + + MACVLAN mode, which specifies the communication mechanism between + multiple MACVLANs on the same lower device. + + + + + + + controls the device type. If set to 'yes' a MACVTAP will be created + (default: no). + + + + + + + + + + id + addr + parent device (ifname or connection UUID) + addr + 0-65535 + 0-65535 + 0-65535 + + + + + + + VXLAN Network Identifer to use. + + + + + + + unicast destination IP address or multicast IP address to join. + + + + + + + device to use for tunnel endpoint communication. + + + + + + + source IP address. + + + + + + + minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. + + + + + + + maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. + + + + + + + UDP destination port to communicate to the remote VXLAN tunnel endpoint. + + + + + + + + + + + IPv4 addresses. + + + + + + + + IPv6 addresses. + + + + + + + If a argument is encountered, the rest of command + line is interpreted as property list in the same format as connection + modify command accepts. This makes it possible to adjust the + connection properties before it's added. + + + + + + + + + edit + + + + + + + + ID + + + type + name + + + + + + Edit an existing connection or add a new one, using an interactive editor. + + The existing connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword , + , or can be used. See + connection show above for the description of the + ID-specifying keywords. Not providing an + ID means that a new connection will be added. + + The interactive editor will guide you through the connection editing and + allow you to change connection parameters according to your needs by means of + a simple menu-driven interface. The editor indicates what settings and + properties can be modified and provides in-line help. + + Available options: + + + + + + type of the new connection; valid types are the same as for + connection add command. + + + + + + name for the new connection. It can be changed later in the editor. + + + + + See also + nm-settings5 + for all NetworkManager settings and property names, and their + descriptions; and + nmcli-examples7 + for sample editor sessions. + + + + + + modify + + + + + + + ID + + [+|-]setting.property + value + + + + + Modify one or more properties in the connection profile. + + The connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword , + or can be used. See + nm-settings5 + for setting and property names, their descriptions and default + values. This command supports abbreviations for setting + and property provided they are unique. Empty + value ("") removes the property value (sets + the property to the default value). The provided value overwrites the existing + property value. + + If you want to append an item to the existing value, use + + prefix for the property name. If you want to remove just + one item from container-type property, use - prefix for + the property name and specify a value or an zero-based index of the item to + remove (or option name for properties with named options) as + value. Of course, + and + - only have a real effect for multi-value (container) + properties like ipv4.dns, ipv4.addresses, + bond.options, etc. + + + + + + clone + + + + + + + ID + name + + + + Clone a connection. The connection to be cloned is identified by its + name, UUID or D-Bus path. If ID is ambiguous, a keyword + , or + can be used. See connection show above for the description + of the ID-specifying keywords. name is + the name of the new cloned connection. The new connection will be the exact + copy except the connection.id (name) and + connection.uuid (generated) properties. + + The new connection profile will be saved as persistent unless + option is specified, in which case the new profile + won't exist after NetworkManager restart. + + + + + + delete + + + + + + ID + + + + Delete a configured connection. The connection to be deleted is + identified by its name, UUID or D-Bus path. If ID is ambiguous, a + keyword , or can be used. + See connection show above for the description of + the ID-specifying keywords. + + If option is not specified, the default timeout will be 10 + seconds. + + + + + + monitor + + + + + + ID + + + + Monitor connection profile activity. This command prints a line whenever + the specified connection changes. The connection to be monitored is identified + by its name, UUID or D-Bus path. If ID is ambiguous, a keyword + , or + can be used. See connection show above for the description of the + ID-specifying keywords. + + Monitors all connection profiles in case none is specified. The command + terminates when all monitored connections disappear. If you want to monitor + connection creation consider using the global monitor with nmcli + monitor command. + + + + + + reload + + + + Reload all connection files from disk. + NetworkManager does not monitor changes to connection + files by default. So you need to use this command in order to tell + NetworkManager to re-read the connection profiles from + disk when a change was made to them. However, the auto-loading feature can be + enabled and then NetworkManager will reload connection + files any time they change (monitor-connection-files=true in + NetworkManager.conf5). + + + + + + + load + filename + + + + Load/reload one or more connection files from disk. Use this after + manually editing a connection file to ensure that + NetworkManager is aware of its latest state. + + + + + + import + + type + file + + + + Import an external/foreign configuration as a NetworkManager connection + profile. The type of the input file is specified by + option. + + Only VPN configurations are supported at the moment. The configuration is + imported by NetworkManager VPN plugins. values are + the same as for option in nmcli + connection add. VPN configurations are imported by VPN plugins. + Therefore the proper VPN plugin has to be installed so that nmcli could import + the data. + + The imported connection profile will be saved as persistent unless + option is specified, in which case the new profile + won't exist after NetworkManager restart. + + + + + + export + + + + + + ID + file + + + + Export a connection. + + Only VPN connections are supported at the moment. A proper VPN plugin has + to be installed so that nmcli could export a connection. If no + file is provided, the VPN configuration + data will be printed to standard output. + + + + + + Device Management Commands + + + nmcli device + + status + show + set + connect + reapply + disconnect + delete + monitor + wifi + lldp + + ARGUMENTS + + + Show and manage network interfaces. + + + + + status + + + Print status of devices. + + This is the default action if no command is specified to + nmcli device. + + + + + + show + ifname + + + + Show detailed information about devices. Without an argument, all + devices are examined. To get information for a specific device, the interface + name has to be provided. + + + + + + set + ifname + ifname + + + + yes + no + + + + + + yes + no + + + + + + Set device properties. + + + + + + connect + ifname + + + + Connect the device. NetworkManager will try to find a suitable connection + that will be activated. It will also consider connections that are not set to + auto connect. + + If option is not specified, the default timeout will be 90 + seconds. + + + + + + reapply + ifname + + + + Attempt to update device with changes to the currently active connection + made since it was last applied. + + + + + + disconnect + ifname + + + + Disconnect a device and prevent the device from automatically activating + further connections without user/manual intervention. Note that disconnecting + software devices may mean that the devices will disappear. + + If option is not specified, the default timeout + will be 10 seconds. + + + + + + + delete + ifname + + + + Delete a device. The command removes the interface from the system. Note + that this only works for software devices like bonds, bridges, teams, etc. + Hardware devices (like Ethernet) cannot be deleted by the command. + + If option is not specified, the default timeout will be 10 + seconds. + + + + + + monitor + ifname + + + + Monitor device activity. This command prints a line whenever the + specified devices change state. + + Monitors all devices in case no interface is specified. The monitor + terminates when all specified devices disappear. If you want to monitor device + addition consider using the global monitor with nmcli + monitor command. + + + + + + wifi + + list + ifname + BSSID + + + + + List available Wi-Fi access points. The and + options can be used to list APs for a particular + interface or with a specific BSSID, respectively. + + + + + + wifi + connect + (B)SSID + password + + + + key + phrase + + + ifname + BSSID + name + + + + yes + no + + + + + + yes + no + + + + + + Connect to a Wi-Fi network specified by SSID or BSSID. The command + creates a new connection and then activates it on a device. This is a + command-line counterpart of clicking an SSID in a GUI client. The command + always creates a new connection and thus it is mainly useful for connecting to + new Wi-Fi networks. If a connection for the network already exists, it is + better to bring up (activate) the existing connection as follows: + nmcli con up id name. Note that + only open, WEP and WPA-PSK networks are supported at the moment. It is also + supposed that IP configuration is obtained via DHCP. + + If option is not specified, the default timeout will be 90 + seconds. + + Available options are: + + + + + + password for secured networks (WEP or WPA). + + + + + + type of WEP secret, either for ASCII/HEX key or + for passphrase. + + + + + + interface that will be used for activation. + + + + + + if specified, the created connection will be restricted just for the + BSSID. + + + + + + if specified, the connection will use the name (else NM creates a name + itself). + + + + + + if set to yes, the connection will only be visible + to the user who created it. Otherwise the connection is system-wide, which is + the default. + + + + + + set to yes when connecting for the first time to an + AP not broadcasting its SSID. Otherwise the SSID would not be found and the + connection attempt would fail. + + + + + + + + + wifi + hotspot + ifname + name + SSID + + + + a + bg + + + channel + password + + + + Create a Wi-Fi hotspot. The command creates a hotspot connection profile + according to Wi-Fi device capabilities and activates it on the device. The + hotspot is secured with WPA if device/driver supports that, otherwise WEP is + used. Use connection down or device + disconnect to stop the hotspot. + + Parameters of the hotspot can be influenced by the optional + parameters: + + + + + + what Wi-Fi device is used. + + + + + + name of the created hotspot connection profile. + + + + + + SSID of the hotspot. + + + + + + Wi-Fi band to use. + + + + + + Wi-Fi channel to use. + + + + + + password to use for the created hotspot. If not provided, nmcli will + generate a password. The password is either WPA pre-shared key or WEP + key. + + Note that global option can be used to + print the hotspot password. It is useful especially when the password was + generated. + + + + + + + + + wifi + rescan + ifname + SSID + + + + Request that NetworkManager immediately re-scan for + available access points. NetworkManager scans Wi-Fi networks periodically, but + in some cases it can be useful to start scanning manually (e.g. after resuming + the computer). By using , it is possible to scan for a + specific SSID, which is useful for APs with hidden SSIDs. You can provide + multiple parameters in order to scan more + SSIDs. + + This command does not show the APs, use nmcli device wifi list + for that. + + + + + + lldp + + list + ifname + + + + + Display information about neighboring devices learned through the Link + Layer Discovery Protocol (LLDP). The option can be + used to list neighbors only for a given interface. The protocol must be enabled + in the connection settings. + + + + + + Secret Agent + + + nmcli agent + + secret + polkit + all + + + + Run nmcli as a NetworkManager secret agent, or polkit agent. + + + + + secret + + + Register nmcli as a NetworkManager secret agent and listen for secret + requests. You do usually not need this command, because nmcli can handle + secrets when connecting to networks. However, you may find the command useful + when you use another tool for activating connections and you do not have a + secret agent available (like nm-applet). + + + + + + polkit + + + + Register nmcli as a polkit agent for the user session and listen for + authorization requests. You do not usually need this command, because nmcli can + handle polkit actions related to NetworkManager operations (when run with + ). However, you may find the command useful when you want + to run a simple text based polkit agent and you do not have an agent of a desktop + environment. Note that running this command makes nmcli handle all polkit requests, + not only NetworkManager related ones, because only one polkit agent can run for the + session. + + + + + + all + + + + Runs nmcli as both NetworkManager secret and a polkit agent. + + + + + + + + Environment Variables + + nmcli's behavior is affected by the following + environment variables. + + + + LC_ALL + + If set to a non-empty string value, it overrides the values of all the + other internationalization variables. + + + + + LC_MESSAGES + + Determines the locale to be used for internationalized messages. + + + + + LANG + + Provides a default value for the internationalization variables that are + unset or null. + + + + + + + Internationalization notes + + Be aware that nmcli is localized and that is why the + output depends on your environment. This is important to realize especially + when you parse the output. + + Call nmcli as LC_ALL=C nmcli to + be sure the locale is set to C while executing in a script. + + LC_ALL, LC_MESSAGES, LANG + variables specify the LC_MESSAGES locale category (in that + order), which determines the language that nmcli uses for + messages. The C locale is used if none of these variables are set, and this + locale uses English messages. + + + + Exit Status + + nmcli exits with status 0 if it succeeds, a value + greater than 0 is returned if an error occurs. + + + + 0 + + Success – indicates the operation succeeded. + + + + + 1 + + Unknown or unspecified error. + + + + + 2 + + Invalid user input, wrong nmcli + invocation. + + + + + 3 + + Timeout expired (see option). + + + + + 4 + + Connection activation failed. + + + + + 5 + + Connection deactivation failed. + + + + + 6 + + Disconnecting device failed. + + + + + 7 + + Connection deletion failed. + + + + + 8 + + NetworkManager is not running. + + + + + 9 + + nmcli and NetworkManager + versions mismatch. + + + + + 10 + + Connection, device, or access point does not exist. + + + + + + Examples + + This section presents various examples of nmcli usage. If you want even + more, please refer to + nmcli-examples7 + manual page. + + + + nmcli -t -f RUNNING general + + tells you whether NetworkManager is running or not. + + + + + nmcli -t -f STATE general + + shows the overall status of NetworkManager. + + + + + nmcli radio wifi off + + switches Wi-Fi off. + + + + + nmcli connection show + + lists all connections NetworkManager has. + + + + + nmcli -p -m multiline -f all con show + + shows all configured connections in multi-line mode. + + + + + nmcli connection show --active + + lists all currently active connections. + + + + + nmcli -f name,autoconnect c s + + shows all connection profile names and their auto-connect property. + + + + + nmcli -p connection show "My default em1" + + shows details for "My default em1" connection profile. + + + + + nmcli --show-secrets connection show "My Home WiFi" + + shows details for "My Home WiFi" connection profile with all passwords. + Without option, secrets would not be + displayed. + + + + + nmcli -f active connection show "My default em1" + + shows details for "My default em1" active connection, like IP, DHCP + information, etc. + + + + + nmcli -f profile con s "My wired connection" + + shows static configuration details of the connection profile with "My + wired connection" name. + + + + + nmcli -p con up "My wired connection" ifname eth0 + + activates the connection profile with name "My wired connection" on + interface eth0. The -p option makes nmcli show progress of the + activation. + + + + + nmcli con up 6b028a27-6dc9-4411-9886-e9ad1dd43761 ap 00:3A:98:7C:42:D3 + + connects the Wi-Fi connection with UUID + 6b028a27-6dc9-4411-9886-e9ad1dd43761 to the AP with BSSID + 00:3A:98:7C:42:D3. + + + + + nmcli device status + + shows the status for all devices. + + + + + nmcli dev disconnect em2 + + disconnects a connection on interface em2 and marks the device as + unavailable for auto-connecting. As a result, no connection will automatically + be activated on the device until the device's 'autoconnect' is set to TRUE or + the user manually activates a connection. + + + + + nmcli -f GENERAL,WIFI-PROPERTIES dev show wlan0 + + shows details for wlan0 interface; only GENERAL and WIFI-PROPERTIES + sections will be shown. + + + + + nmcli -f CONNECTIONS device show wlp3s0 + + shows all available connection profiles for your Wi-Fi interface + wlp3s0. + + + + + nmcli dev wifi + + lists available Wi-Fi access points known to NetworkManager. + + + + + nmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe" + + creates a new connection named "My cafe" and then connects it to "Cafe + Hotspot 1" SSID using password "caffeine". This is mainly useful when + connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to + use nmcli con up id "My cafe" so that the + existing connection profile can be used and no additional is created. + + + + + nmcli -s dev wifi hotspot con-name QuickHotspot + + creates a hotspot profile and connects it. Prints the hotspot password + the user should use to connect to the hotspot from other devices. + + + + + nmcli connection add type ethernet autoconnect no ifname eth0 + + non-interactively adds an Ethernet connection tied to eth0 interface with + automatic IP configuration (DHCP), and disables the connection's autoconnect + flag. + + + + + nmcli c a ifname Maxipes-fik type vlan dev eth0 id 55 + + non-interactively adds a VLAN connection with ID 55. The connection will + use eth0 and the VLAN interface will be named Maxipes-fik. + + + + + nmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local + + non-interactively adds a connection that will use eth0 Ethernet interface + and only have an IPv6 link-local address configured. + + + + + nmcli connection edit ethernet-em1-2 + + edits existing "ethernet-em1-2" connection in the interactive + editor. + + + + + nmcli connection edit type ethernet con-name "yet another Ethernet connection" + + adds a new Ethernet connection in the interactive editor. + + + + + nmcli con mod ethernet-2 connection.autoconnect no + + modifies 'autoconnect' property in the 'connection' setting of + 'ethernet-2' connection. + + + + + nmcli con mod "Home Wi-Fi" wifi.mtu 1350 + + modifies 'mtu' property in the 'wifi' setting of 'Home Wi-Fi' + connection. + + + + + nmcli con mod em1-1 ipv4.method manual ipv4.addr "192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11" + + sets manual addressing and the addresses in em1-1 profile. + + + + + nmcli con modify ABC +ipv4.dns 8.8.8.8 + + appends a Google public DNS server to DNS servers in ABC profile. + + + + + nmcli con modify ABC -ipv4.addresses "192.168.100.25/24 192.168.1.1" + + removes the specified IP address from (static) profile ABC. + + + + + nmcli con import type openvpn file ~/Downloads/frootvpn.ovpn + + imports an OpenVPN configuration to NetworkManager. + + + + + nmcli con export corp-vpnc /home/joe/corpvpn.conf + + exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) + configuration. + + + + + + Notes + nmcli accepts abbreviations, as long as they are a unique prefix in the set + of possible options. As new options get added, these abbreviations are not guaranteed + to stay unique. For scripting and long term compatibility it is therefore strongly + advised to spell out the full option names. + + + Bugs + There are probably some bugs. If you find a bug, please report it to + https://bugzilla.gnome.org/ — product NetworkManager. + + + See Also + nmcli-examples7, + nm-online1, + NetworkManager8, + NetworkManager.conf5, + nm-settings5, + nm-applet1, + nm-connection-editor1. + + + diff --git a/man/nmtui.1 b/man/nmtui.1 new file mode 100644 index 00000000..832d65d3 --- /dev/null +++ b/man/nmtui.1 @@ -0,0 +1,76 @@ +'\" t +.\" Title: nmtui +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 04/05/2016 +.\" Manual: General Commands Manual +.\" Source: NetworkManager 1.1.93 +.\" Language: English +.\" +.TH "NMTUI" "1" "" "NetworkManager 1\&.1\&.93" "General Commands Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nmtui \- Text User Interface for controlling NetworkManager +.SH "SYNOPSIS" +.HP \w'\fBnmtui\-edit\ |\ nmtui\ edit\ \fR\ 'u +\fBnmtui\-edit | nmtui\ edit \fR {\fIname\fR\ |\ \fIid\fR} +.HP \w'\fBnmtui\-connect\ |\ nmtui\ connect\ \fR\ 'u +\fBnmtui\-connect | nmtui\ connect \fR {\fIname\fR\ |\ \fIuuid\fR\ |\ \fIdevice\fR\ |\ \fISSID\fR} +.HP \w'\fBnmtui\-hostname\ |\ nmtui\ hostname\ \fR\ 'u +\fBnmtui\-hostname | nmtui\ hostname \fR +.SH "DESCRIPTION" +.PP +\fBnmtui\fR +is a curses\(hybased TUI application for interacting with NetworkManager\&. When starting +\fBnmtui\fR, the user is prompted to choose the activity to perform unless it was specified as the first argument\&. +.PP +The supported activities are: +.PP +\fBedit\fR +.RS 4 +Show a connection editor that supports adding, modifying, viewing and deleting connections\&. It provides similar functionality as +\fBnm\-connection\-editor\fR\&. +.RE +.PP +\fBconnect\fR +.RS 4 +Show a list of available connections, with the option to activate or deactivate them\&. It provides similar functionality as +\fBnm\-applet\fR\&. +.RE +.PP +\fBhostname\fR +.RS 4 +Set the system hostname\&. +.RE +.PP +Corresponding to above activities, +\fBnmtui\fR +also comes with binaries named +\fBnmtui\-edit\fR, +\fBnmtui\-connect\fR, and +\fBnmtui\-hostname\fR +to skip the selection of the activities\&. +.SH "SEE ALSO" +.PP +\fBnmcli\fR(1), +\fBnm-applet\fR(1), +\fBnm-connection-editor\fR(1), +\fBNetworkManager\fR(8)\&. diff --git a/man/nmtui.1.in b/man/nmtui.1.in deleted file mode 100644 index 977339db..00000000 --- a/man/nmtui.1.in +++ /dev/null @@ -1,66 +0,0 @@ -.\" nmtui (1) manual page -.\" -.\" This is free documentation; you can redistribute it and/or -.\" modify it under the terms of the GNU General Public License as -.\" published by the Free Software Foundation; either version 2 of -.\" the License, or (at your option) any later version. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public Licence along -.\" with this manual; if not, write to the Free Software Foundation, Inc., -.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -.\" -.\" Copyright 2014 Red Hat, Inc. -.\" -.TH NMTUI "1" "2014-11-06" "NetworkManager 1.2" - -.SH NAME -nmtui \- Text User Interface for controlling NetworkManager -.SH SYNOPSIS -.B nmtui -.RI " [ " edit " | " connect " | " hostname " ] [ ... ] " -.P -.B nmtui\-edit -.RI " [ " connection-id " | " connection-name " ] " -.P -.B nmtui\-connect -.RI " [ " connection-name " | " connection-uuid " | " device-name " | " Wi-Fi-SSID " ] " -.P -.B nmtui\-hostname - -.SH DESCRIPTION -.B nmtui -is a curses\(hybased TUI application for interacting with \fINetworkManager\fP. -.P -When starting \fInmtui\fP, the user is prompted to choose the activity to perform -unless it was specified as the first argument. -.P -The supported activities are: -.IP \(em 4 -\fIedit\fP: show a connection editor that supports adding, modifying, viewing and deleting -connections. It provides similar functionality as \fInm\-connection\-editor\fP. -.IP \(em 4 -\fIconnect\fP: show a list of available connections, with the option to activate or deactivate -them. It provides similar functionality as \fInm\-applet\fP. -.IP \(em 4 -\fIhostname\fP: set the system hostname. - -.P -Corresponding to above activities, \fInmtui\fP also comes with binaries named -\fInmtui\-edit\fP, \fInmtui\-connect\fP, and \fInmtui-hostname\fP to skip the selection -of the activities. - -.SH SEE ALSO -.BR NetworkManager(8), -.BR nmcli(1). -.BR nm\-applet(1). -.BR nm\-connection\-editor(1). diff --git a/man/nmtui.xml b/man/nmtui.xml new file mode 100644 index 00000000..d92f525b --- /dev/null +++ b/man/nmtui.xml @@ -0,0 +1,137 @@ + + + +%entities; +]> + + + + + + + nmtui + NetworkManager developers + + + + nmtui + 1 + NetworkManager + General Commands Manual + &NM_VERSION; + + + + nmtui + Text User Interface for controlling NetworkManager + + + + + + nmtui-edit + nmtui edit + + + + name + id + + + + + + nmtui-connect + nmtui connect + + + + name + uuid + device + SSID + + + + + + nmtui-hostname + nmtui hostname + + + + + Description + nmtui is a cursesā€based TUI application for + interacting with NetworkManager. When starting nmtui, the + user is prompted to choose the activity to perform unless it was specified as + the first argument. + + The supported activities are: + + + + + + Show a connection editor that supports adding, modifying, viewing and + deleting connections. It provides similar functionality as + nm-connection-editor. + + + + + + + Show a list of available connections, with the option to activate or + deactivate them. It provides similar functionality as + nm-applet. + + + + + + + Set the system hostname. + + + + + Corresponding to above activities, nmtui also comes + with binaries named nmtui-edit, + nmtui-connect, and nmtui-hostname to skip + the selection of the activities. + + + See Also + nmcli1, + nm-applet1, + nm-connection-editor1, + NetworkManager8. + + + -- cgit 1.3.0-6-gf8a5