summaryrefslogtreecommitdiff
path: root/src/nm-online/README.md
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2021-08-19 15:26:16 +0200
committerThomas Haller <thaller@redhat.com>2021-08-19 17:51:11 +0200
commitea49b50651c882e856185edd9c0e9e1322e39049 (patch)
tree4c641a82a7c6779a3a16d00da04aad55b106317f /src/nm-online/README.md
parent2f3c2647d2263bf565fd21d14a3db56f6a063b91 (diff)
downloadNetworkManager-ea49b50651c882e856185edd9c0e9e1322e39049.tar.gz
all: add some README.md files describing the purpose of our sources
Diffstat (limited to 'src/nm-online/README.md')
-rw-r--r--src/nm-online/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/nm-online/README.md b/src/nm-online/README.md
new file mode 100644
index 0000000000..eaa909f717
--- /dev/null
+++ b/src/nm-online/README.md
@@ -0,0 +1,14 @@
+nm-online
+=========
+
+A small NetworkManager client that blocks until
+NetworkManager is done configuring the interfaces.
+
+This is not very useful to the end user. It is used
+by `NetworkManager-wait-online.service` to determine
+when NetworkManager is done with startup.
+
+See:
+
+- `man 1 nm-online` ([[www]](https://networkmanager.dev/docs/api/latest/nm-online.html))
+- `systemctl cat NetworkManager-wait-online.service`