Skip to content

Commit dd33654

Browse files
authored
Merge pull request #269 from muesli/readme-update
README: list all packages and fix ordering
2 parents d7b55e1 + 760cf2d commit dd33654

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66
Go bindings to systemd. The project has several packages:
77

88
- `activation` - for writing and using socket activation from Go
9+
- `daemon` - for notifying systemd of service status changes
910
- `dbus` - for starting/stopping/inspecting running services and units
1011
- `journal` - for writing to systemd's logging service, journald
1112
- `sdjournal` - for reading from journald by wrapping its C API
13+
- `login1` - for integration with the systemd logind API
1214
- `machine1` - for registering machines/containers with systemd
1315
- `unit` - for (de)serialization and comparison of unit files
1416

@@ -18,10 +20,9 @@ An example HTTP server using socket activation can be quickly set up by followin
1820

1921
https://github.com/coreos/go-systemd/tree/master/examples/activation/httpserver
2022

21-
## Journal
23+
## systemd Service Notification
2224

23-
Using the pure-Go `journal` package you can submit journal entries directly to systemd's journal, taking advantage of features like indexed key/value pairs for each log entry.
24-
The `sdjournal` package provides read access to the journal by wrapping around journald's native C API; consequently it requires cgo and the journal headers to be available.
25+
The `daemon` package is an implementation of the [sd_notify protocol](https://www.freedesktop.org/software/systemd/man/sd_notify.html#Description). It can be used to inform systemd of service start-up completion, watchdog events, and other status changes.
2526

2627
## D-Bus
2728

@@ -45,6 +46,20 @@ Create `/etc/dbus-1/system-local.conf` that looks like this:
4546
</busconfig>
4647
```
4748

49+
## Journal
50+
51+
### Writing to the Journal
52+
53+
Using the pure-Go `journal` package you can submit journal entries directly to systemd's journal, taking advantage of features like indexed key/value pairs for each log entry.
54+
55+
### Reading from the Journal
56+
57+
The `sdjournal` package provides read access to the journal by wrapping around journald's native C API; consequently it requires cgo and the journal headers to be available.
58+
59+
## logind
60+
61+
The `login1` package provides functions to integrate with the [systemd logind API](http://www.freedesktop.org/wiki/Software/systemd/logind/).
62+
4863
## machined
4964

5065
The `machine1` package allows interaction with the [systemd machined D-Bus API](http://www.freedesktop.org/wiki/Software/systemd/machined/).

0 commit comments

Comments
 (0)