Commit graph

45 commits

Author SHA1 Message Date
Beniamino Galvani 7a07a0b92d man: replace license blurb with SPDX tag 2023-10-06 13:27:59 +02:00
Fernando Fernandez Mancera a44f20c985 man: adjust references of nm-settings to nm-settings-nmcli
nm-settings was renamed to nm-settings-nmcli therefore we should rename
all the references to nm-settings-nmcli.
2023-08-01 14:21:23 +02:00
Lubomir Rintel 1c17e55627 nmcli/devices: add "checkpoint" command
This is an interface to the Checkpoint/Restore functionality that's
available for quite some time. It runs a command with a checkpoint taken
and rolls back unless success is confirmed before the checkpoint times
out:

  $ nmcli dev checkpoint eth0 -- nmcli dev dis eth0
  Device 'eth0' successfully disconnected.
  Type "Yes" to commit the changes: No
  Checkpoint was removed.

The details about how it's used are documented in nmcli(1) and
nmcli-examples(7).
2022-06-15 12:26:08 +02:00
Lubomir Rintel 6fa1323ce5 nmcli: add --offline option for "add" and "modify"
This adds a global "--offline" option and allows its use with "add" and
"modify" commands. The "add" looks like this:

  $ nmcli --offline conn add type ethernet ens3 ipv4.dns 192.168.1.1 \
      >output.nmconnection

The "modify" is essentially implementing what's been suggested by
Beniamino in bugzilla ticked (referred to below):

  $ nmcli --offline connection modify ens3 ipv4.dns 192.168.1.1 \
      <input.nmconnection >output.nmconnection

Other commands don't support the argument at the moment:

  $ nmcli --offline c up ens3
  Error: 'up' command doesn't support --offline mode.

https://bugzilla.redhat.com/show_bug.cgi?id=1361145
2022-04-19 14:12:42 +02:00
Sayed Shah 7337ab8959
all: fix typo in man pages
There should be a comma after 'Otherwise' and 'Currently'.

https://bugzilla.redhat.com/show_bug.cgi?id=1852452

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/560
2020-07-03 10:48:04 +02:00
Thomas Haller a8442c8243 man: show example for nmcli --ask device wifi connect in nmcli-example manual 2020-03-06 09:48:58 +01:00
Auke Kok 425293b13c man: show example for nmcli device wifi connect in nmcli-example manual
Add the only important example that this file should have

All other examples are nice. But when you install a console-only
machine and read the NM man pages, you are none the wiser, because
something as simple like this isn't covered in the man pages.

I've seen other users complain about it, and I've torn my hair out
over this several times.

[thaller@redhat.com: changed subject line of patch]
2020-03-06 09:48:58 +01:00
Thomas Haller a5bc4cb785 man: add examples how to configure bluetooth devices to man nmcli-examples. 2019-09-22 16:05:50 +02:00
Beniamino Galvani f606124b62 man: add SR-IOV nmcli example
Add an example on how to configure SR-IOV to the nmcli examples man
page.

https://bugzilla.redhat.com/show_bug.cgi?id=1651979
2018-12-12 14:38:18 +01:00
Francesco Giudici e3ea7245c3 man: add OTP-based VPN activation example 2018-11-14 17:15:50 +01:00
Francesco Giudici f4d0417c8d nmcli: add -g[et-values] option as a '-m tab -t -f <arg>' shortcut
Quick and easy way to get clean and parsable field values.
2017-03-28 10:55:00 +02:00
Lubomir Rintel 057d477b2a man: turn the manual page cross-references into links
This improves the HTML rendering.

But it also causes a lot of non-resolvable linkends warning when rendering a
separate manual pages into roff/mman. The messages are harmless, but still
a bit ugly.
2016-06-21 18:40:13 +02:00
Thomas Haller d91f3b35d7 auth: fix get_permissions() D-Bus call for settings-modify-global-dns 2016-06-01 22:04:37 +02:00
Thomas Haller 1d0e0eeffd manager: add Reload() D-Bus command
Add new Reload D-Bus command to reload NetworkManager configuration.

For now, this is like sending SIGHUP to the process. There are several
advantages here:

  - it is guarded via PolicyKit authentication while signals
    can only be sent by root.

  - the user can wait for the reload to be complete instead of sending
    an asynchronous signal. For now, we operation completes after
    nm_config_reload() returns, but later we could delay the response
    further until specific parts are fully reloaded.

  - SIGHUP reloads everything including re-reading configuration from
    disk while SIGUSR1 reloads just certain parts such as writing out DNS
    configuration anew.
    Now, the Reload command has a flags argument which is more granular
    in selecting parts which are to be reloaded. For example, via
    signals the user can:

      1) send SIGUSR1: this writes out the DNS configuration to
         resolv.conf and possibly reloads other parts without
         re-reading configuration and without restarting the DNS plugin.
      2) send SIGHUP: this reloads configuration from disk,
         writes out resolv.conf and restarts the DNS plugin.

    There is no way, to only restart the DNS plugin without also reloading
    everything else.
2016-06-01 19:06:34 +02:00
Lubomir Rintel b349603959 man: clarify the license of the manuals
It's included from GFDL 1.1+ document; it should be GFDL too.
2016-04-08 13:10:47 +02:00
Lubomir Rintel 22fb039435 man: remove work-in-progress warning 2016-04-08 13:10:47 +02:00
Lubomir Rintel f73649db5c man: fix prompt and user input formatting 2016-04-08 13:10:47 +02:00
Lubomir Rintel 37271b6827 man: fix nmcli-examples synopsis formatting 2016-04-08 13:10:47 +02:00
Lubomir Rintel 0fc0cc68fc man: move nmcli-examples to section 7
It really is not a configuration file and doesn't belong to section 5.
2016-04-05 14:37:51 +02:00
Lubomir Rintel 60582bf443 man: include version from a XML entity
This way it's consistently used across all manual page without a need
for XSL templating.

Also, the entities file could in future possibly be used to template the
build-time configurables such as filesystem paths or bug tracker URL.
2016-04-05 14:37:51 +02:00
Lubomir Rintel 8035b5b03b man: drop dates
It's injected from the makefile, but not even used consistently or included in
the resulting render of manual page. Which is good, otherwise we'd have a
non-reproducible build with possible multilib conflicts if rendered around
midnight.
2016-04-05 14:37:50 +02:00
Lubomir Rintel 1ab89ecf85 man/nmcli-examples: specify a language for the listing 2016-04-01 12:29:42 +02:00
Lubomir Rintel 159c95cbe2 man/nmcli-examples: no extra breaks around listings
Looks bad in HTML.
2016-04-01 12:29:20 +02:00
Lubomir Rintel f446afbfad man/nmcli-examples: mark user input in editor
For the extra viewing pleasure.
2016-04-01 12:13:52 +02:00
Lubomir Rintel 529f744ec9 man/nmcli-examples: wrap screen output at column 75
This ensures it doesn't generate excessively long lines and roughly corresponds to what actually be on a screen.
Or a teletype typewriter. In 1969.
2016-04-01 12:13:52 +02:00
Lubomir Rintel 14421ac4aa man/nmcli-examples: structure the screen examples better
The synopsis tag is not appropriate and doesn't look well in HTML and
inserts unnecessary line breaks in roff.

The <userinput> in <screen> suits this perfectly on the other hand.
2016-04-01 12:13:52 +02:00
Beniamino Galvani f67bf52046 man: use replace <programlisting> with <synopsis>
It makes more sense and actually looks good in rendered HTML.

[lkundrak@v3.sk: wrote the commit message]
2016-03-26 11:28:19 +01:00
Beniamino Galvani c885fd55e8 man: update version number and dates in manual pages
Bump NM version number to 1.2 and add the project name to non-XML
pages. Also, update the dates to the date of the last non-trivial
change and update their format to YYYY-MM-DD, as specified by 'man
man-pages'.
2016-03-09 10:11:27 +01:00
Thomas Haller b51da9b030 man: replace tabs by eight spaces in xml manual pages 2016-01-27 13:12:49 +01:00
Lubomir Rintel 1375d9c13a cli: add master option to "nmcli c add" 2015-07-12 15:46:37 +02:00
Jiří Klimeš 3c8dfb91f6 man: update version reference to 1.0 in manual pages 2014-11-19 16:53:30 +01:00
Jiří Klimeš 3889ff864c man: update nmcli-examples manual page 2014-11-19 15:21:34 +01:00
Jiří Klimeš 1553607223 man: clarify an nmcli example for adding static addresses in nmcli-examples 2014-06-16 12:48:04 +02:00
Thomas Haller b5ffcf46f1 doc: update documentation to show all logging domains
Also, mention the deprecated alias HW in man/NetworkManager.conf

Signed-off-by: Thomas Haller <thaller@redhat.com>
2014-05-12 19:12:28 +02:00
Thomas Haller 9305c5bbf7 man/cli: add missing log domains to manual page and nmcli bash completion
Signed-off-by: Thomas Haller <thaller@redhat.com>
2014-04-24 17:27:47 +02:00
Jiří Klimeš b3cbb260ef man: use correct Mbit/s for maximum bitrate in nmcli-examples 2014-04-01 15:15:18 +02:00
Jiří Klimeš 223962f4ad man: add a simple bridge example to nmcli-examples manual page 2014-02-28 13:37:02 +01:00
Jiří Klimeš 9433ea502b man: fix typo in commands in Team example 2014-01-24 11:13:31 +01:00
Jiří Klimeš 26f8889286 cli: consolidate active and configured connections (rh #997999)
Handle connection profiles in a single 'show' command instead of 'show active'
and 'show configured'.

nmcli con show [--active] [[id|uuid|path|apath] <bla>]

nmcli con show           : display all connection profiles
nmcli con show --active  : only display active connection profiles
                           (filters out inactive profiles)

nmcli con show myeth     : display details of "myeth" profile, and also active
                           connection info (if the profile is active)
nmcli -f profile con show myeth : only display "myeth"'s static configuration
nmcli -f active  con show myeth : only display active details of "myeth"
nmcli -f connection.id,ipv4,general con show myeth
                                          : display "connection.id"a property
                                            "ipv4" setting and "GENERAL" group
                                            of active data

https://bugzilla.redhat.com/show_bug.cgi?id=997999
2014-01-23 13:45:46 +01:00
Jiří Klimeš 0ff286adcf man: add a Team example to nmcli-examples manual page 2014-01-22 17:53:28 +01:00
Jiří Klimeš 080b3a43b5 man: update nmcli-examples manual page 2014-01-15 17:40:02 +01:00
Stephen Wadeley 52ad4ec577 man: some improvements to language and style in nmcli-examples manual page
Signed-off-by: Stephen Wadeley <swadeley@redhat.com>
2013-10-31 13:24:22 +01:00
Yuri Chornoivan 61de24ba35 Fix typos
https://bugzilla.gnome.org/show_bug.cgi?id=710505
2013-10-19 11:49:18 -04:00
Jiří Klimeš 625f2e3814 man: fix a typo in nmcli-examples manual page (rh #1004117)
https://bugzilla.redhat.com/show_bug.cgi?id=1004117
2013-09-10 16:46:08 +02:00
Jiří Klimeš 6993b5b2a1 man: add 'nmcli-examples' manual page with examples of nmcli usage
(and add a reference to 'nmcli-examples' to other man pages)
2013-07-22 13:43:54 +02:00