1
0
mirror of https://github.com/systemd/systemd.git synced 2024-12-22 17:35:35 +03:00
Commit Graph

330 Commits

Author SHA1 Message Date
Zbigniew Jędrzejewski-Szmek
4677c3da97 man: really fix conditional in homed.conf
Followup for f978844eb6.
2020-06-13 17:31:59 +02:00
Benjamin Berg
4540e698e8 man: Add systemd-xdg-autostart-generator man page 2020-05-27 09:02:10 +02:00
Zbigniew Jędrzejewski-Szmek
0406d1a843 man: add docs for the new functions 2020-05-25 11:09:21 +02:00
Lennart Poettering
feb86ca90c man: document homed.conf 2020-05-07 23:37:30 +02:00
Zbigniew Jędrzejewski-Szmek
c62e7d041f man: update rules
Forgotten in 4f07ddfa9b.
2020-05-07 14:05:17 +02:00
Zbigniew Jędrzejewski-Szmek
06689b8d11 meson: rename make-man-rules.py to update-man-rules.py
The name of the helper didn't match the name of the meson target, which was
always confusing me. With this change, we consistenly use "update" to
re-generate things which we otherwise keep in vc, and "make" for things
which are generated during each build.
2020-05-07 14:01:09 +02:00
Zbigniew Jędrzejewski-Szmek
b856b346c1 man: add stub for home1(5) 2020-05-06 09:13:42 +02:00
Zbigniew Jędrzejewski-Szmek
1a0e562a5b man: add description of org.freedesktop.LogControl1
I'm not sure if the LogTarget property is sufficiently general to be made into
a property that can be generally implemented. It is very closely tied to the internal
systemd logic. The other two seem fine thoough.
2020-05-05 22:41:23 +02:00
Kumar Kartikeya Dwivedi
4f07ddfa9b
Introduce sd_notify_barrier
This adds the sd_notify_barrier function, to allow users to synchronize against
the reception of sd_notify(3) status messages. It acts as a synchronization
point, and a successful return gurantees that all previous messages have been
consumed by the manager. This can be used to eliminate race conditions where
the sending process exits too early for systemd to associate its PID to a
cgroup and attribute the status message to a unit correctly.

systemd-notify now uses this function for proper notification delivery and be
useful for NotifyAccess=all units again in user mode, or in cases where it
doesn't have a control process as parent.

Fixes: #2739
2020-05-01 03:22:47 +05:30
Daan De Meyer
bac1b83217 sd-bus: Add sd_bus_query_sender_creds/privilege docs 2020-04-28 19:38:04 +02:00
Daan De Meyer
8653422b6a sd-bus: Add sd_bus_get_creds_mask docs 2020-04-28 19:30:49 +02:00
Zbigniew Jędrzejewski-Szmek
c13f4643f4 Merge pull request #15579 from DaanDeMeyer/sd-bus-get-name/owner-creds-docs 2020-04-24 08:29:41 +02:00
Daan De Meyer
425d5cecbe sd-bus: Add sd_bus_get_name/owner_creds docs 2020-04-24 08:15:05 +02:00
Daan De Meyer
68b5003bc1 sd-bus: Add sd_bus_message_get_creds docs 2020-04-23 22:56:10 +02:00
Daan De Meyer
0e4305eeea sd-bus: Add sd_bus_get_name_machine_id docs 2020-04-23 22:40:20 +02:00
Daan De Meyer
d7fbc6804e sd-bus: Add sd_bus_send_to docs 2020-04-23 22:38:44 +02:00
Zbigniew Jędrzejewski-Szmek
927cffd57f Merge pull request #15569 from DaanDeMeyer/sd-bus-message-peek-type-docs 2020-04-23 20:11:14 +02:00
Daan De Meyer
3df22bb5c8 sd-bus: Add sd_bus_message_peek_type docs 2020-04-23 19:37:21 +02:00
Daan De Meyer
7cd40caa66 sd-bus: Add sd_bus_message_open/close/enter/exit_container docs 2020-04-23 18:30:40 +02:00
Daan De Meyer
0076098b0a sd-bus: Add sd_bus_message_get_error/errno docs 2020-04-23 08:57:39 +02:00
Daan De Meyer
570f92c691 sd-bus: Add sd_bus_get/set_allow_interactive_authorization docs 2020-04-23 08:53:27 +02:00
Daan De Meyer
e8c47f7370 sd-bus: Add sd_bus_message_at_end docs 2020-04-22 23:42:03 +02:00
Zbigniew Jędrzejewski-Szmek
bbdeb2b5e9
Merge pull request #15517 from DaanDeMeyer/sd-bus-monitor-docs
sd-bus: Add sd_bus_set/is_monitor docs
2020-04-22 23:38:37 +02:00
Daan De Meyer
e5f1a3faab sd-bus: Add sd_bus_message_read_strv docs 2020-04-22 08:42:29 +02:00
Daan De Meyer
f74067dfbd sd-bus: Add sd_bus_list_names docs 2020-04-21 22:20:54 +02:00
Daan De Meyer
0eb5b641c5 sd-bus: Add sd_bus_set/is_monitor docs 2020-04-21 19:33:25 +02:00
Lennart Poettering
ede32a7cff
Merge pull request #15505 from keszybz/man-sd-hwdb-sd-journal
Document remaining sd-journal and sd-hwdb functions
2020-04-21 13:37:55 +02:00
Zbigniew Jędrzejewski-Szmek
32c4d2ba62 man: add SD_HWDB_FOREACH_PROPERTY with an example 2020-04-21 11:44:49 +02:00
Zbigniew Jędrzejewski-Szmek
ec7ea47dae man: add description of all the sd-hwdb funtions 2020-04-21 11:37:30 +02:00
Zbigniew Jędrzejewski-Szmek
55c0fbde8f
Merge pull request #15502 from DaanDeMeyer/sd-bus-exit-on-disconnect-docs
sd-bus: Add sd_bus_get/set_exit_on_disconnect docs
2020-04-21 09:23:16 +02:00
Zbigniew Jędrzejewski-Szmek
21dc5e82ad man: add sd_j_open_namespace as refname
This was forgotten in 241c8f67f6.
2020-04-21 09:08:14 +02:00
Zbigniew Jędrzejewski-Szmek
c11edfee98 man: document sd_journal_*_with_location 2020-04-21 09:08:14 +02:00
Daan De Meyer
4eaf8bc69e sd-bus: Add sd_bus_get_scope/tid/unique_name docs 2020-04-21 08:44:32 +02:00
Daan De Meyer
c72d0fb154 sd-bus: Add sd_bus_get/set_exit_on_disconnect docs 2020-04-20 20:03:41 +02:00
Daan De Meyer
842a362c3a sd-bus: Add sd_bus_is_server + sd_bus_set/is_bus_client docs 2020-04-20 19:12:36 +02:00
Zbigniew Jędrzejewski-Szmek
f294b60204
Merge pull request #15480 from DaanDeMeyer/sd-bus-add-node-enumerator-docs
sd-bus: Add sd_bus_add_node_enumerator docs
2020-04-20 08:44:26 +02:00
Daan De Meyer
db5328e931 sd-bus: Add sd_bus_get_current_* docs 2020-04-20 08:42:04 +02:00
Daan De Meyer
ad30002885 sd-bus: Add sd_bus_emit_* docs 2020-04-20 08:40:24 +02:00
Daan De Meyer
a3c0b9df9a sd-bus: Add sd_bus_add_node_enumerator docs 2020-04-20 08:22:50 +02:00
Daan De Meyer
c40bd28419 sd-bus: Add sd_bus_set_server, sd_bus_get_bus_id docs 2020-04-19 21:41:03 +02:00
Daan De Meyer
e762fa0392 sd-bus: Add sd_bus_add_object_manager docs 2020-04-19 19:02:11 +02:00
Daan De Meyer
3841fa7916 sd-bus: Add sd_bus_add_filter docs 2020-04-19 19:00:22 +02:00
Lennart Poettering
09f8722801
Merge pull request #15396 from keszybz/dbus-api-docs
D-bus API docs
2020-04-17 23:40:50 +02:00
Zbigniew Jędrzejewski-Szmek
8f8cc84ba4 sd-login: get rid of seat_can_multi_session()
Follow-up for fa2cf64a91.
Backwards-compat is retained. A short note is added in docs, in case
people see sd_seat_can_multi_session() mentioned somewhere and wonder what
happened to it.

Also see https://github.com/systemd/systemd/pull/15337#issuecomment-610369404.
2020-04-17 16:15:30 +02:00
Zbigniew Jędrzejewski-Szmek
3031660c21 man: import org.freedesktop.systemd1(3) from the wiki
As usual, the formatting was fixed and various obvious updates
were done, but nothing major.

I removed documentation of snapshots and related methods though.
2020-04-16 19:46:40 +02:00
Zbigniew Jędrzejewski-Szmek
ffd10e5a24 man: import org.freedesktop.resolve1(3) from the wiki 2020-04-16 19:46:40 +02:00
Zbigniew Jędrzejewski-Szmek
91c7ac94ba man: import org.freedesktop.locale1(3) from the wiki 2020-04-12 19:48:01 +02:00
Zbigniew Jędrzejewski-Szmek
9c970e5f55 man: import org.freedesktop.timedate1(3) from the wiki 2020-04-12 19:48:01 +02:00
Zbigniew Jędrzejewski-Szmek
e09a36bd46 man: import org.freedesktop.hostname1(3) from the wiki 2020-04-12 19:48:01 +02:00
Zbigniew Jędrzejewski-Szmek
2fe60ff1d0 man: import org.freedesktop.import1(3) from the wiki 2020-04-12 19:48:01 +02:00
Zbigniew Jędrzejewski-Szmek
de2efb75f7 man: import org.freedesktop.machine1(3) from the wiki
The wiki was primarily describing the D-Bus API, but it also had a large
introduction to the daemon functionality. I moved that latter part into
the page that describes the daemon, and the API description into the new
page.

This is mostly a straighforward import. Apart from some required formatting
changes, I removed obvious repetitions, and made tiny grammar and typo fixes
where I noticed them. The goal is not to have a perfect text immediately.

<interfacename>org.foo.bar</interface> is used for interface names,
<function>function()</function> for methods, and <function>signal</function>
(no parentheses) for signal names. In D-Bus, signals are similar to methods,
and docbook doesn't have a nice tag for them.
2020-04-12 19:48:01 +02:00
Zbigniew Jędrzejewski-Szmek
44fd44f1cf man: import org.freedesktop.login1(3) from the wiki 2020-04-12 19:48:01 +02:00
Zbigniew Jędrzejewski-Szmek
92cad3f82d
Merge pull request #15406 from DaanDeMeyer/sd-bus-set-exec-docs
Add sd_bus_set_exec docs
2020-04-12 18:38:49 +02:00
Daan De Meyer
3415b0cc8a sd-bus: Add sd_bus_set_exec docs 2020-04-12 17:24:01 +02:00
Zbigniew Jędrzejewski-Szmek
b15b4376af
Merge pull request #15405 from DaanDeMeyer/sd-bus-can-send-docs
Add sd_bus_can_send docs
2020-04-12 17:05:05 +02:00
Daan De Meyer
3258aa750e sd-bus: Add sd_bus_can_send docs 2020-04-11 21:25:39 +02:00
Daan De Meyer
4b7f8d78de sd-bus: Add sd_bus_get/set_property docs 2020-04-11 19:10:54 +02:00
Zbigniew Jędrzejewski-Szmek
9aa822179b man: update rules
Apparently this step was forgotten in 935052a8aa.
2020-04-06 20:47:14 +02:00
Daan De Meyer
11a177d9de sd-bus: Deprecate priority functions 2020-04-02 21:36:59 +02:00
Zbigniew Jędrzejewski-Szmek
6829d8ce69
Merge pull request #15253 from DaanDeMeyer/object-vtable-error-docs
sd-bus: Add error handling info to sd_bus_add_object_vtable docs
2020-04-01 12:25:34 +02:00
Daan De Meyer
e3e5a6eebd sd-bus: Add sd_bus_get/set_priority docs + fixes 2020-04-01 00:11:33 +02:00
Daan De Meyer
9b62e232ea sd-bus: Add note about sd_bus_reply_method_return to SD_BUS_METHOD docs 2020-03-31 20:38:54 +02:00
Daan De Meyer
fc91667d77 sd-bus: Add sd_bus_add_object and callback docs 2020-03-31 20:16:30 +02:00
Zbigniew Jędrzejewski-Szmek
4a874560c5
Merge pull request #15217 from keszybz/beef-up-sd-path
Export sd-path functions and beef up systemd-path to show more items
2020-03-29 22:57:53 +02:00
Daan De Meyer
45069c67ce sd-bus: Add sd_bus_slot_get_current_* docs 2020-03-29 21:36:55 +02:00
Zbigniew Jędrzejewski-Szmek
b35ed5530b man: add sd_path_lookup(3) 2020-03-27 20:12:44 +01:00
Daan De Meyer
b0f4c02e2d sd-bus: Add sd_bus_send docs + cleanups. 2020-03-22 20:21:11 +01:00
Daan De Meyer
60ef094297 sd-bus: Add sd_bus_reply_method_return docs + cleanups 2020-03-19 20:51:17 +01:00
Daan De Meyer
4bd859be95 sd-bus: add sd_bus_message_seal docs + cleanups 2020-03-19 14:27:56 +01:00
Zbigniew Jędrzejewski-Szmek
677ceb0c2f
Merge pull request #15153 from keszybz/man-bus-address
Add two man pages for sd-bus
2020-03-19 09:11:14 +01:00
Daan De Meyer
cc46b9d913 sd-bus: sd_bus_set/get_method_call_timeout docs + cleanups. 2020-03-18 20:07:45 +01:00
Zbigniew Jędrzejewski-Szmek
92b6df1d68 man: mention sd_bus_is_anonymous() and sd_bus_is_trusted() 2020-03-18 19:57:44 +01:00
Zbigniew Jędrzejewski-Szmek
9783b59bf6 man: describe sd_bus_default_flush_close() 2020-03-18 19:57:43 +01:00
Zbigniew Jędrzejewski-Szmek
3f549982a5 man: add sd_bus_set_address(3) 2020-03-18 19:57:43 +01:00
Zbigniew Jędrzejewski-Szmek
27622235c4 man: add sd_bus_start(3) 2020-03-18 19:57:43 +01:00
Daan De Meyer
953ee402cb sd-bus: sd_bus_call/sd_bus_call_async_docs + cleanups. 2020-03-18 10:45:14 +01:00
Daan De Meyer
9735c644be sd-bus: Add sd_bus_method_call/sd_bus_method_call_async docs + cleanups. 2020-03-17 17:12:58 +09:00
Zbigniew Jędrzejewski-Szmek
4a29c185b7 man: add systemd-network-generator.service(8)
It's a bit bare-bones, but it should be enough to point the reader in the right
direction.
2020-03-05 08:20:06 +01:00
Zbigniew Jędrzejewski-Szmek
aa07dc7093 man: add .service suffix to systemd-pstore(8)
That is the pattern that we always use with executables not in
$PATH.
2020-02-29 09:57:06 +01:00
Zbigniew Jędrzejewski-Szmek
ebb7a2fcb9 man: add missing refnames for two binary names
We generally want the man page to also be available under the
binary name, but the <refname> tags were missing in two cases.
2020-02-28 17:02:23 +01:00
Lennart Poettering
5c11632735 man: document the new sd_bus_enqueue_for_read() API call 2020-02-04 18:47:32 +01:00
Lennart Poettering
d58f31793a
Merge pull request #14645 from keszybz/sd-bus-message-dump
sd_bus_message_dump
2020-02-02 17:27:50 +01:00
Yu Watanabe
af06ddf51a meson, man: do not install pam_systemd_home(8) when pam or homed is disabled
Fixes #14725.
2020-02-01 12:13:45 +01:00
Lennart Poettering
241c8f67f6 man: document the new sd_journal_open_namespace() API 2020-01-31 15:10:40 +01:00
Lennart Poettering
6bc4361997 man: document journald@NAMESPACE.conf 2020-01-31 15:10:40 +01:00
Lennart Poettering
efcbcd0d04 man: document journald namespaces 2020-01-31 15:10:40 +01:00
Yu Watanabe
2d37ea5ca9 man: do not install man pages for systemd-repart if it is disabled
Closes #14716.
2020-01-31 18:06:09 +09:00
Zbigniew Jędrzejewski-Szmek
f770b7e084 man: document man/sd_bus_message_dump.xml 2020-01-30 14:33:05 +01:00
Lennart Poettering
28e208a7d8 man: document pam_systemd_home 2020-01-28 22:37:49 +01:00
Lennart Poettering
38e7b808eb man: add systemd-homed man page 2020-01-28 22:37:25 +01:00
Lennart Poettering
ea7a19e95d man: add homectl(1) man page 2020-01-28 22:37:00 +01:00
Lennart Poettering
917cc8082b man: document systemd-repart 2020-01-20 17:42:03 +01:00
Lennart Poettering
7d9ad0e5e5 man: document systemd-userdbd.service 2020-01-15 15:30:40 +01:00
Lennart Poettering
3b2db6f110 man: document userdbctl(1) 2020-01-15 15:30:20 +01:00
Lennart Poettering
ac6431dad9 man: add man page for sd_bus_message_sensitive() 2019-12-18 09:10:34 +01:00
Lennart Poettering
8089643328 man: document the new sd-event pidfd magic 2019-12-04 10:36:10 +01:00
Lennart Poettering
0bca283127 man: document sd_event_source_set_floating()
Let's make sure we get back to 100% man page documentation coverage of
our sd-event APIs. We are bad enough at the others, let's get these ones
right at least.
2019-11-29 02:48:41 +09:00
Jan Tojnar
88eb051972 man: use mkswap@ instead of makeswap@
That is what is linked from systemd.swap(5) and also what the systemd.generator produces.
2019-11-28 15:46:21 +01:00
Lennart Poettering
20bae8b94d meson: correct man page deps 2019-10-31 09:04:19 +09:00
Lennart Poettering
39867bb9fb man: document the systemd-random-seed rework 2019-07-25 18:31:20 +02:00
Eric DeVolder
9b4abc69b2 pstore: Tool to archive contents of pstore
This patch introduces the systemd pstore service which will archive the
contents of the Linux persistent storage filesystem, pstore, to other storage,
thus preserving the existing information contained in the pstore, and clearing
pstore storage for future error events.

Linux provides a persistent storage file system, pstore[1], that can store
error records when the kernel dies (or reboots or powers-off). These records in
turn can be referenced to debug kernel problems (currently the kernel stuffs
the tail of the dmesg, which also contains a stack backtrace, into pstore).

The pstore file system supports a variety of backends that map onto persistent
storage, such as the ACPI ERST[2, Section 18.5 Error Serialization] and UEFI
variables[3 Appendix N Common Platform Error Record]. The pstore backends
typically offer a relatively small amount of persistent storage, e.g. 64KiB,
which can quickly fill up and thus prevent subsequent kernel crashes from
recording errors. Thus there is a need to monitor and extract the pstore
contents so that future kernel problems can also record information in the
pstore.

The pstore service is independent of the kdump service. In cloud environments
specifically, host and guest filesystems are on remote filesystems (eg. iSCSI
or NFS), thus kdump relies [implicitly and/or explicitly] upon proper operation
of networking software *and* hardware *and* infrastructure.  Thus it may not be
possible to capture a kernel coredump to a file since writes over the network
may not be possible.

The pstore backend, on the other hand, is completely local and provides a path
to store error records which will survive a reboot and aid in post-mortem
debugging.

Usage Notes:
This tool moves files from /sys/fs/pstore into /var/lib/systemd/pstore.

To enable kernel recording of error records into pstore, one must either pass
crash_kexec_post_notifiers[4] to the kernel command line or enable via 'echo Y
 > /sys/module/kernel/parameters/crash_kexec_post_notifiers'. This option
invokes the recording of errors into pstore *before* an attempt to kexec/kdump
on a kernel crash.

Optionally, to record reboots and shutdowns in the pstore, one can either pass
the printk.always_kmsg_dump[4] to the kernel command line or enable via 'echo Y >
/sys/module/printk/parameters/always_kmsg_dump'. This option enables code on the
shutdown path to record information via pstore.

This pstore service is a oneshot service. When run, the service invokes
systemd-pstore which is a tool that performs the following:
 - reads the pstore.conf configuration file
 - collects the lists of files in the pstore (eg. /sys/fs/pstore)
 - for certain file types (eg. dmesg) a handler is invoked
 - for all other files, the file is moved from pstore

 - In the case of dmesg handler, final processing occurs as such:
   - files processed in reverse lexigraphical order to faciliate
     reconstruction of original dmesg
   - the filename is examined to determine which dmesg it is a part
   - the file is appended to the reconstructed dmesg

For example, the following pstore contents:

 root@vm356:~# ls -al /sys/fs/pstore
 total 0
 drwxr-x--- 2 root root    0 May  9 09:50 .
 drwxr-xr-x 7 root root    0 May  9 09:50 ..
 -r--r--r-- 1 root root 1610 May  9 09:49 dmesg-efi-155741337601001
 -r--r--r-- 1 root root 1778 May  9 09:49 dmesg-efi-155741337602001
 -r--r--r-- 1 root root 1726 May  9 09:49 dmesg-efi-155741337603001
 -r--r--r-- 1 root root 1746 May  9 09:49 dmesg-efi-155741337604001
 -r--r--r-- 1 root root 1686 May  9 09:49 dmesg-efi-155741337605001
 -r--r--r-- 1 root root 1690 May  9 09:49 dmesg-efi-155741337606001
 -r--r--r-- 1 root root 1775 May  9 09:49 dmesg-efi-155741337607001
 -r--r--r-- 1 root root 1811 May  9 09:49 dmesg-efi-155741337608001
 -r--r--r-- 1 root root 1817 May  9 09:49 dmesg-efi-155741337609001
 -r--r--r-- 1 root root 1795 May  9 09:49 dmesg-efi-155741337710001
 -r--r--r-- 1 root root 1770 May  9 09:49 dmesg-efi-155741337711001
 -r--r--r-- 1 root root 1796 May  9 09:49 dmesg-efi-155741337712001
 -r--r--r-- 1 root root 1787 May  9 09:49 dmesg-efi-155741337713001
 -r--r--r-- 1 root root 1808 May  9 09:49 dmesg-efi-155741337714001
 -r--r--r-- 1 root root 1754 May  9 09:49 dmesg-efi-155741337715001

results in the following:

 root@vm356:~# ls -al /var/lib/systemd/pstore/155741337/
 total 92
 drwxr-xr-x 2 root root  4096 May  9 09:50 .
 drwxr-xr-x 4 root root    40 May  9 09:50 ..
 -rw-r--r-- 1 root root  1610 May  9 09:50 dmesg-efi-155741337601001
 -rw-r--r-- 1 root root  1778 May  9 09:50 dmesg-efi-155741337602001
 -rw-r--r-- 1 root root  1726 May  9 09:50 dmesg-efi-155741337603001
 -rw-r--r-- 1 root root  1746 May  9 09:50 dmesg-efi-155741337604001
 -rw-r--r-- 1 root root  1686 May  9 09:50 dmesg-efi-155741337605001
 -rw-r--r-- 1 root root  1690 May  9 09:50 dmesg-efi-155741337606001
 -rw-r--r-- 1 root root  1775 May  9 09:50 dmesg-efi-155741337607001
 -rw-r--r-- 1 root root  1811 May  9 09:50 dmesg-efi-155741337608001
 -rw-r--r-- 1 root root  1817 May  9 09:50 dmesg-efi-155741337609001
 -rw-r--r-- 1 root root  1795 May  9 09:50 dmesg-efi-155741337710001
 -rw-r--r-- 1 root root  1770 May  9 09:50 dmesg-efi-155741337711001
 -rw-r--r-- 1 root root  1796 May  9 09:50 dmesg-efi-155741337712001
 -rw-r--r-- 1 root root  1787 May  9 09:50 dmesg-efi-155741337713001
 -rw-r--r-- 1 root root  1808 May  9 09:50 dmesg-efi-155741337714001
 -rw-r--r-- 1 root root  1754 May  9 09:50 dmesg-efi-155741337715001
 -rw-r--r-- 1 root root 26754 May  9 09:50 dmesg.txt

where dmesg.txt is reconstructed from the group of related
dmesg-efi-155741337* files.

Configuration file:
The pstore.conf configuration file has four settings, described below.
 - Storage : one of "none", "external", or "journal". With "none", this
   tool leaves the contents of pstore untouched. With "external", the
   contents of the pstore are moved into the /var/lib/systemd/pstore,
   as well as logged into the journal.  With "journal", the contents of
   the pstore are recorded only in the systemd journal. The default is
   "external".
 - Unlink : is a boolean. When "true", the default, then files in the
   pstore are removed once processed. When "false", processing of the
   pstore occurs normally, but the pstore files remain.

References:
[1] "Persistent storage for a kernel's dying breath",
    March 23, 2011.
    https://lwn.net/Articles/434821/

[2] "Advanced Configuration and Power Interface Specification",
    version 6.2, May 2017.
    https://www.uefi.org/sites/default/files/resources/ACPI_6_2.pdf

[3] "Unified Extensible Firmware Interface Specification",
    version 2.8, March 2019.
    https://uefi.org/sites/default/files/resources/UEFI_Spec_2_8_final.pdf

[4] "The kernel’s command-line parameters",
    https://static.lwn.net/kerneldoc/admin-guide/kernel-parameters.html
2019-07-19 21:46:07 +02:00
Zbigniew Jędrzejewski-Szmek
34d2f9204c meson: update hint in man/rules/ 2019-07-19 07:09:34 +09:00
Lennart Poettering
cb367b1785
Merge pull request #12518 from keszybz/naming-scheme
Document our naming schemes properly
2019-05-10 15:14:59 -04:00
Zbigniew Jędrzejewski-Szmek
aa7585fd8e sd-event: add sd_event_source_disable_unrefp() too
I do not have any immediate use for it, but let's add it for completeness.
2019-05-10 16:55:37 +02:00
Zbigniew Jędrzejewski-Szmek
afd15bbb4b sd-event: add sd_event_source_disable_unref() helper 2019-05-10 16:55:35 +02:00
Zbigniew Jędrzejewski-Szmek
0b1e5b6ed8 man: describe naming schemes in a new man page
I decided to make this a separate man page because it is freakin' long.
This content could equally well go in systemd-udevd.service(8), systemd.link(5),
or a new man page for the net_id builtin.

v2:
- rename to systemd.net-naming-scheme
- add udevadm test-builtin net_id example
2019-05-10 10:24:03 +02:00
Zbigniew Jędrzejewski-Szmek
afb9c0c958 man: document sd_bus_add_{object,fallback}_vtable
The interface provided by those two functions is huge, so this text could
probably be made two or three times as long if all details were described.
But I think it's a good start.
2019-04-23 22:58:51 +02:00
Lennart Poettering
03abeb0baf
Merge pull request #12267 from keszybz/udev-settle-warning
Udev settle warning
2019-04-11 19:01:03 +02:00
Zbigniew Jędrzejewski-Szmek
18a3882250 man: add a page for systemd-udev-settle.service 2019-04-10 10:12:43 +02:00
Zbigniew Jędrzejewski-Szmek
38df8d3f52 sd-id128: expose ID128_UUID_FORMAT_STR
It is generally useful, and can be made public in the same manner that
SD_ID128_FORMAT_STR is.
2019-04-05 13:47:54 +02:00
Zbigniew Jędrzejewski-Szmek
2dfdf9c4b2 man: create .so links for sd_bus_close_{unref,unrefp}
Follow-up for bd62b74486.
2019-02-28 13:10:08 +01:00
Lennart Poettering
ffd1a3f688 man: substantially update the docs regarding hooking sd-bus objects up with external event loops
Prompted by https://lists.freedesktop.org/archives/systemd-devel/2018-December/041817.html

This also drops all references to select() from our manpages. It's 2018
after all, people should use poll(), or ppoll() or epoll().
2018-12-13 22:33:47 +01:00
Lennart Poettering
565f3d91a2 man: document systemd-run-generator 2018-11-27 09:44:40 +01:00
Zbigniew Jędrzejewski-Szmek
15e9a42074
Merge pull request #10306 from poettering/nspawn-ref-unref
nspawn scope lifecycle fixes
2018-11-09 20:49:31 +01:00
Lennart Poettering
48c3512269 man: document sd_bus_attach_event() 2018-11-09 17:09:52 +01:00
Lennart Poettering
eda0d9a13b man: document sd_bus_flush_close_unref() 2018-11-09 17:09:52 +01:00
Lennart Poettering
576af73f4a man: document sd_bus_close() + sd_bus_flush() 2018-11-09 17:09:52 +01:00
Lennart Poettering
c4e48030cf sd-bus: make "close+flush-on-exit" optional when using sd-event with sd-bus
This adds a new pair of API calls sd_bus_set_close_on_exit() and
sd_bus_get_close_on_exit(). They control whether an sd_bus object
attached to a an sd-event loop shall automatically be flushed/closed
when the event loop goes down. Usually that's a good thing, except for
very few cases where the bus connection is longer living than the event
loop it is attached on. Specifically, this is the case for nspawn, where
we run the event loop only while the container is up, but afterwards
still want to be able to use the bus connection.
2018-11-09 17:08:59 +01:00
Lennart Poettering
223ce56fa1 man: document systemd-bless-boot-generator 2018-10-19 22:34:50 +02:00
Lennart Poettering
04431cd1f8 man: document systemd-boot-check-no-failures.service 2018-10-19 22:34:50 +02:00
Lennart Poettering
ab3fc7b193 man: document systemd-bless-boot 2018-10-19 22:34:50 +02:00
Lennart Poettering
190128e407 sd-bus: add new API call sd_bus_error_move()
This new call move an sd_bus_error into another one.
2018-10-13 12:59:29 +02:00
Zbigniew Jędrzejewski-Szmek
adda90b03e man: add man page for systemd-id128 2018-10-02 15:15:10 +02:00
Zbigniew Jędrzejewski-Szmek
65d410c7ca sd-id128: add sd_id128_get_boot_app_specific() 2018-10-02 15:15:10 +02:00
Zbigniew Jędrzejewski-Szmek
d7338be4f0 man: add sd_bus_message_get_signature(3) 2018-08-23 16:57:55 +02:00
Zbigniew Jędrzejewski-Szmek
7f9f55e1b3 man: add sd_bus_message_read_array(3) 2018-08-11 12:25:54 +02:00
Zbigniew Jędrzejewski-Szmek
58df2afbbf man: add sd_bus_message_skip(3) 2018-08-11 12:25:54 +02:00
Zbigniew Jędrzejewski-Szmek
46fdbae32e man: add sd_bus_message_rewind(3) 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
e7015301fb man: document sd_bus_slot_get_bus in sd_bus_slot_ref(3)
Similar reasoning as for sd_bus_message_get_bus().
2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
dee0fccca3 man: add sd_bus_slot_set_description(3) 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
6d4a51820e man: add sd_bus_slot_set_userdata(3) 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
d65044e812 man: add sd_bus_message_set_expect_reply(3) 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
9905256523 man: document sd_bus_message_get_bus() in sd_bus_message_new(3)
It's not a particularly obvious place, but it's a trivial function that isn't
worth a man page of its own, and it doesn't fit anywhere else either.
2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
2c48865bd0 man: add sd_bus_message_verify_type(3) 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
9c9207912e man: add sd_bus_message_get_type(3)
sd_bus_message{get_type,is_signal,is_method_call,is_method_error} get one man
page.

sd_bus_message_{set,get}_{destination,path,interface,member,sender} are put in
the second one.
2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
f16a506418 man: add sd_bus_slot_ref(3) 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
7ddee21716 man: document sd_bus_message_new_method_return 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
f00ded93e0 man: document *_with_description functions 2018-08-02 15:49:45 +02:00
Zbigniew Jędrzejewski-Szmek
206ed9c1f6 man: add sd_bus_message_new(3) 2018-08-02 15:48:46 +02:00
Zbigniew Jędrzejewski-Szmek
cfe8ee463d man: add sd_bus_message_new_call(3) 2018-08-02 15:45:20 +02:00
Zbigniew Jędrzejewski-Szmek
e8b84fcca6 man: add sd_bus_message_new_signal(3) 2018-08-02 15:44:25 +02:00
Yu Watanabe
08540a9591 meson: allow building resolved and machined without nss modules
This adds -Dnss-resolve= and -Dnss-mymachines= meson options.
By using this option, e.g., resolved can be built without nss-resolve.
When no nss modules are built, then test-nss is neither built.

Also, This changes the option name -Dmyhostname= to -Dnss-myhostname=
for consistency to other nss related options.

Closes #9596.
2018-07-23 14:03:05 +02:00
Zbigniew Jędrzejewski-Szmek
a99655b052 man: add a description of user@.service, user-runtime-dir@.service, user-*.slice
Fixes #9590.
2018-07-20 16:57:50 +02:00
Zbigniew Jędrzejewski-Szmek
3c775de6c5 man: add sd_bus_set_description(3) 2018-07-16 12:36:44 +02:00
Zbigniew Jędrzejewski-Szmek
629941003e man: add sd_bus_reply_method_error(3) 2018-07-16 12:25:16 +02:00
Zbigniew Jędrzejewski-Szmek
c5fd8c3995 man: add sd_bus_message_copy(3) 2018-07-16 12:25:16 +02:00
Zbigniew Jędrzejewski-Szmek
e50f471888 man: add sd_bus_message_new_error(3) 2018-07-16 12:25:14 +02:00
Zbigniew Jędrzejewski-Szmek
50972aac44 man: document sd_bus_read(), add more about sd_bus_read_basic() 2018-07-03 14:31:01 +02:00
Yu Watanabe
70c8db7555 man: use systemd-boot instead of sd-boot 2018-06-15 14:27:37 +09:00
Lennart Poettering
90b1fa59cf sd-event: document sd_event_source_set_io_fd_own()
With this we have 100% of the sd-event symbols documented again. Yay!
2018-06-07 13:10:56 +02:00
Lennart Poettering
15723a1db0 sd-event: add destroy callback logic to sd-event too
This adds what has been added to sd_bus_slot and sd_bus_track to
sd_event too.
2018-06-07 13:10:56 +02:00
Lennart Poettering
66223497d0 sd-bus: also add destroy callbacks to sd_bus_track objects
This augments previous work for this for sd_bus_slot objects, and adds
the same concept to sd_bus_track objects, too.
2018-06-07 13:10:56 +02:00
Zbigniew Jędrzejewski-Szmek
fa17b4e8d9 bus: optionally call a callbacks for cleanup
This adds a function sd_bus_slot_set_destroy_callback() to set a function
which can free userdata or perform other cleanups.

sd_bus_slot_get_destory_callback() queries the callback, and is included
for completeness.

Without something like this, for floating asynchronous callbacks, which might
be called or not, depending on the sequence of events, it's hard to perform
resource cleanup. The alternative would be to always perform the cleanup from
the caller too, but that requires more coordination and keeping of some shared
state. It's nicer to keep the cleanup contained between the callback and the
function that requests the callback.
2018-06-06 23:01:57 +02:00
Lennart Poettering
1eb54dc645 man: document the new sd_event_add_inotify() call 2018-06-06 10:53:56 +02:00
Lennart Poettering
1004b2c7bc man: document the new sd_bus_slot_set_floating() call
Also extend the memory management description of sd-bus highlighting the
effect of "floating" slot objects a bit.
2018-05-30 17:34:34 +02:00
Lennart Poettering
a8c42bb8f3 man: add man pages for the portable service stuff 2018-05-24 17:01:57 +02:00
Yu Watanabe
1f416853b6 man: update references to systemd-journal-{remote,upload}
Fixes #8920 and #8921.
2018-05-08 10:14:06 +09:00
Yu Watanabe
1e4acc77b0 man: add explanations of show-timesync and timesync-status commands 2018-05-03 18:07:58 +09:00
Yu Watanabe
b69f810c8a man: create man page for resolvectl 2018-04-19 03:25:25 +09:00
Zbigniew Jędrzejewski-Szmek
0f943ae4ea man: add a new page with a general description of common syntax
We have a common parser, but for the user it might be
completely unobvious that the same general rules apply
to all those files. Let's add a page about the basic syntax
so that the more specific pages don't have to repeat those
details.
2018-04-18 09:11:01 +02:00
Zbigniew Jędrzejewski-Szmek
4298e26176 meson: fix indentation for systemd-time-sync-wait(5) entries
Those files should not be updated manually, because then automatic updates
contain spurious "changes".
2018-04-18 09:11:02 +02:00
Mario Limonciello
e68c79db91 Rename suspend-to-hibernate to suspend-then-hibernate
Per some discussion with Gnome folks, they would prefer this name
as it's more descriptive of what's happening.
2018-03-28 15:11:10 -05:00
Peter A. Bigot
5c3376efcd time-sync-wait: add service (#8494)
This one-shot service waits until the kernel time has been set to
synchronized.
2018-03-21 12:42:04 +01:00
Zbigniew Jędrzejewski-Szmek
99eae076eb
Merge pull request #8296 from poettering/resolvconf
resolvconf(8) compat interface
2018-03-12 17:27:39 +01:00
Zbigniew Jędrzejewski-Szmek
f37d383582 man: add some basic documentation for sd-boot (#8379)
I'm sure this can be improved in various ways, but I think
it's a good start.
2018-03-11 19:22:09 +09:00
Mario Limonciello
c58493c00a Introduce suspend-to-hibernate (#8274)
Suspend to Hibernate is a new sleep method that invokes suspend
for a predefined period of time before automatically waking up
and hibernating the system.

It's similar to HybridSleep however there isn't a performance
impact on every suspend cycle.

It's intended to use with systems that may have a higher power
drain in their supported suspend states to prevent battery and
data loss over an extended suspend cycle.

Signed-off-by: Mario Limonciello <mario.limonciello@dell.com>
2018-03-08 14:17:33 +01:00
Lennart Poettering
2eee2088d2 man: briefly document the resolvconf(8) compatibility interface 2018-03-02 15:48:46 +01:00
Lennart Poettering
2770da027a sd-bus: add APIs to query the current read and write queue size 2018-02-27 19:54:29 +01:00
Lennart Poettering
d97eac36d8 man: document all the new APIs we added 2018-01-05 13:58:33 +01:00
Lennart Poettering
245992a0c0 man: add a systemd-rc-local-generator(8) man page
Most importantly, let's highlight the differences to the rc-local
behaviour in SysV.

Fixes: #7703
2017-12-26 12:13:51 +01:00
Dmitry Rozhkov
6e73d91ec8 resolved: add man page for systemd.dnssd 2017-12-08 14:29:27 +02:00
Zbigniew Jędrzejewski-Szmek
58e0ac3349 man: add docs for systemd-growfs and systemd-makefs 2017-11-30 20:46:30 +01:00
Alan Jenkins
1c97e2ebf4 man: de-emphasize *_get_session()
Explanation:

"Please note the login session may be limited to a stub
 process or two.  User processes may instead be started from their
 systemd user manager, e.g. GUI applications started using DBus
 activation, as well as service processes which are shared between
 multiple logins of the same user."

The most glaring example being when you run commands from gnome-terminal,
or as you see nowadays, "gnome-terminal-server".

*_get_session() is still currently used (directly or indirectly) by Xorg,
Weston etc. running within the session scope.  That setup is perfectly
functional, although code will be more generally useful if it is able to
run outside the session scope.[1]

[1] https://wiki.archlinux.org/index.php/Systemd/User#Xorg_as_a_systemd_user_service

Re-order the man pages a bit at the same time.  This is to avoid having the
first and titular entry introduce the session concept, and then immediately
try and persuade you not to use it :).
2017-10-18 09:47:10 +01:00
Zbigniew Jędrzejewski-Szmek
1ec57f3394 build-sys: s/ENABLE_RESOLVED/ENABLE_RESOLVE/
The configuration option was called -Dresolve, but the internal define
was …RESOLVED. This options governs more than just resolved itself, so
let's settle on the version without "d".
2017-10-04 12:09:51 +02:00
Zbigniew Jędrzejewski-Szmek
08cf5b8dc3 build-sys: s/HAVE_MYHOSTNAME/ENABLE_MYHOSTNAME/
Same justification as for HAVE_UTMP. HAVE_MYHOSTNAME was used before mysthostname
was merged into systemd.
2017-10-04 12:09:51 +02:00
Zbigniew Jędrzejewski-Szmek
3211da4bcb build-sys: s/HAVE_UTMP/ENABLE_UTMP/
"Have" should be about the external environment and dependencies. Anything
which is a pure yes/no choice should be "enable".
2017-10-04 12:09:50 +02:00
Waldemar Brodkorb
e7e11bbf34 make nss-systemd support conditional (#6155)
This allows the nss-systemd module to be disabled on minimal installations.
2017-06-24 13:30:26 -04:00
userwithuid
232bd67797 build-sys: do not install manpages from disabled features (#5844)
A few of the manpages where missing the "conditional" attribute.
2017-04-28 08:22:17 -04:00
Zbigniew Jędrzejewski-Szmek
82b4969045 meson: add sd_bus_message_appendv alias to man list
As generated by "nj update-man-rules".
2017-04-25 14:20:55 -04:00
Zbigniew Jędrzejewski-Szmek
5c23128dab meson: build systemd using meson
It's crucial that we can build systemd using VS2010!

... er, wait, no, that's not the official reason. We need to shed old systems
by requring python 3! Oh, no, it's something else. Maybe we need to throw out
345 years of knowlege accumulated in autotools? Whatever, this new thing is
cool and shiny, let's use it.

This is not complete, I'm throwing it out here for your amusement and critique.

- rules for sd-boot are missing. Those might be quite complicated.

- rules for tests are missing too. Those are probably quite simple and
  repetitive, but there's lots of them.

- it's likely that I didn't get all the conditions right, I only tested "full"
  compilation where most deps are provided and nothing is disabled.

- busname.target and all .busname units are skipped on purpose.

  Otherwise, installation into $DESTDIR has the same list of files and the
  autoconf install, except for .la files.

It'd be great if people had a careful look at all the library linking options.
I added stuff until things compiled, and in the end there's much less linking
then in the old system. But it seems that there's still a lot of unnecessary
deps.

meson has a `shared_module` statement, which sounds like something appropriate
for our nss and pam modules. Unfortunately, I couldn't get it to work. For the
nss modules, we need an .so version of '2', but `shared_module` disallows the
version argument. For the pam module, it also didn't work, I forgot the reason.

The handling of .m4 and .in and .m4.in files is rather awkward. It's likely
that this could be simplified. If make support is ever dropped, I think it'd
make sense to switch to a different templating system so that two different
languages and not required, which would make everything simpler yet.

v2:
- use get_pkgconfig_variable
- use sh not bash
- use add_project_arguments

v3:
- drop required:true and fix progs/prog typo

v4:
- use find_library('bz2')
- add TTY_GID definition
- define __SANE_USERSPACE_TYPES__
- use join_paths(prefix, ...) is used on all paths to make them all absolute

v5:
- replace all declare_dependency's with []
- add more conf.get guards around optional components

v6:
- drop -pipe, -Wall which are the default in meson
- use compiler.has_function() and compiler.has_header_symbol instead of the
  hand-rolled checks.
- fix duplication in 'liblibsystemd' library name
- use the right .sym file for pam_systemd
- rename 'compiler' to 'cc': shorter, and more idiomatic.

v7:
- use ENABLE_ENVIRONMENT_D not HAVE_ENVIRONMENT_D
- rename prefix to prefixdir, rootprefix to rootprefixdir
  ("prefix" is too common of a name and too easy to overwrite by mistake)
- wrap more stuff with conf.get('ENABLE...') == 1
- use rootprefix=='/' and rootbindir as install_dir, to fix paths under
  split-usr==true.

v8:
- use .split() also for src/coredump. Now everything is consistent ;)
- add rootlibdir option and use it on the libraries that require it

v9:
- indentation

v10:
- fix check for qrencode and libaudit

v11:
- unify handling of executable paths, provide options for all progs

  This makes the meson build behave slightly differently than the
  autoconf-based one, because we always first try to find the executable in the
  filesystem, and fall back to the default. I think different handling of
  loadkeys, setfont, and telinit was just a historical accident.

  In addition to checking in $PATH, also check /usr/sbin/, /sbin for programs.
  In Fedora $PATH includes /usr/sbin, (and /sbin is is a symlink to /usr/sbin),
  but in Debian, those directories are not included in the path.

  C.f. https://github.com/mesonbuild/meson/issues/1576.

- call all the options 'xxx-path' for clarity.
- sort man/rules/meson.build properly so it's stable
2017-04-23 21:47:26 -04:00