summaryrefslogtreecommitdiff
path: root/man
Commit message (Collapse)AuthorAge
* Export sd_bus_message_append_ap. It is renamed to sd_bus_message_appendv to ↵Federico2017-07-25
| | | | | | | follow elogind naming conventions. (#5753) Moreover, man page for sd_bus_message_append is updated with reference to new exposed function. Makefile-man is updated too, to reflect new alias.
* Fix typo in function name (#5565)Michal Sekletar2017-07-25
|
* Prep v233.3: Add missing documentation for API functions exported by ↵Sven Eden2017-07-20
| | | | elogind. (unreviewed)
* Prep v233.3: Unmask various functions for future coverage tests.Sven Eden2017-07-19
| | | | | These functions, although not used by elogind itself, are mostly tiny and crucial for important tests to work.
* Prep v233: Update root build files to upstream versionSven Eden2017-07-17
|
* man: update pam_elogind and elogind-logind man pages a bitLennart Poettering2017-07-17
| | | | | | | This builds on @utezduyar's #4640, but extends on it. Fixes: #4550 Replaces: #4640
* man: document that sd_notify() is racy in some casesLennart Poettering2017-07-17
|
* man: use unicode ellipsis in more placesZbigniew Jędrzejewski-Szmek2017-07-17
| | | | | | | | | | | | | | As requested in https://github.com/elogind/elogind/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
* man: Document return value of event source prepare callback (#4834)Martin Ejdestig2017-07-17
|
* sd-id128: add new sd_id128_get_machine_app_specific() APILennart Poettering2017-07-17
| | | | | | | | | | | | This adds an API for retrieving an app-specific machine ID to sd-id128. Internally it calculates HMAC-SHA256 with an 128bit app-specific ID as payload and the machine ID as key. (An alternative would have been to use siphash for this, which is also cryptographically strong. However, as it only generates 64bit hashes it's not an obvious choice for generating 128bit IDs.) Fixes: #4667
* man/sd_watchdog_enabled: correct minor typos (#4632)Jonathan Boulle2017-07-17
|
* Prep v232: Apply missing updates from upstreamSven Eden2017-07-05
|
* man: Fix event source priority enum names in synopsis (#4478)Martin Ejdestig2017-07-05
|
* man: add a note that FDSTORE=1 requires epoll-compatible fdsZbigniew Jędrzejewski-Szmek2017-07-05
| | | | Let's say that this was not obvious from our man page.
* man: typo fixesThomas Hindoe Paaboel Andersen2017-07-05
| | | | A mix of fixes for typos and UK english
* man: expand the documentation of $SYSTEMD_PAGER and related environment ↵Lennart Poettering2017-07-05
| | | | | | | | variables Document the default pagers used, as well as $SYSTEMD_LESSCHARSET. Fixes: #4143
* core: add "invocation ID" concept to service managerLennart Poettering2017-07-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds a new invocation ID concept to the service manager. The invocation ID identifies each runtime cycle of a unit uniquely. A new randomized 128bit ID is generated each time a unit moves from and inactive to an activating or active state. The primary usecase for this concept is to connect the runtime data PID 1 maintains about a service with the offline data the journal stores about it. Previously we'd use the unit name plus start/stop times, which however is highly racy since the journal will generally process log data after the service already ended. The "invocation ID" kinda matches the "boot ID" concept of the Linux kernel, except that it applies to an individual unit instead of the whole system. The invocation ID is passed to the activated processes as environment variable. It is additionally stored as extended attribute on the cgroup of the unit. The latter is used by journald to automatically retrieve it for each log logged message and attach it to the log entry. The environment variable is very easily accessible, even for unprivileged services. OTOH the extended attribute is only accessible to privileged processes (this is because cgroupfs only supports the "trusted." xattr namespace, not "user."). The environment variable may be altered by services, the extended attribute may not be, hence is the better choice for the journal. Note that reading the invocation ID off the extended attribute from journald is racy, similar to the way reading the unit name for a logging process is. This patch adds APIs to read the invocation ID to sd-id128: sd_id128_get_invocation() may be used in a similar fashion to sd_id128_get_boot(). PID1's own logging is updated to always include the invocation ID when it logs information about a unit. A new bus call GetUnitByInvocationID() is added that allows retrieving a bus path to a unit by its invocation ID. The bus path is built using the invocation ID, thus providing a path for referring to a unit that is valid only for the current runtime cycleof it. Outlook for the future: should the kernel eventually allow passing of cgroup information along AF_UNIX/SOCK_DGRAM messages via a unique cgroup id, then we can alter the invocation ID to be generated as hash from that rather than entirely randomly. This way we can derive the invocation race-freely from the messages.
* add a new tool for creating transient mount and automount unitsLennart Poettering2017-07-05
| | | | | | | | | | | | | | | | | | | | | | | This adds "elogind-mount" which is for transient mount and automount units what "elogind-run" is for transient service, scope and timer units. The tool allows establishing mounts and automounts during runtime. It is very similar to the usual /bin/mount commands, but can pull in additional dependenices on access (for example, it pulls in fsck automatically), an take benefit of the automount logic. This tool is particularly useful for mount removable file systems (such as USB sticks), as the automount logic (together with automatic unmount-on-idle), as well as automatic fsck on first access ensure that the removable file system has a high chance to remain in a fully clean state even when it is unplugged abruptly, and returns to a clean state on the next re-plug. This is a follow-up for #2471, as it adds a simple client-side for the transient automount logic added in that PR. In later work it might make sense to invoke this tool automatically from udev rules in order to implement a simpler and safer version of removable media management á la udisks.
* Prep v231.2: Apply some minor style fixesSven Eden2017-06-19
|
* man: explain that *KeyIgnoreInhibited only apply to a subset of locksZbigniew Jędrzejewski-Szmek2017-06-19
| | | | | | Follow-up for #3924. (cherry picked from commit 05b2a8fd7a0533758d2f532df798cabc3c442683)
* Prep v231: Update man pages to include upstream changesSven Eden2017-06-16
|
* sd-id128: handle NULL return parameter in sd_id128_from_string() nicerLennart Poettering2017-06-16
| | | | | If the return parameter is NULL, simply validate the string, and return no error.
* tree-wide: use mdash instead of a two minusesZbigniew Jędrzejewski-Szmek2017-06-16
|
* loginctl: add --value optionZbigniew Jędrzejewski-Szmek2017-06-16
|
* Prep v229: Update man pages (fix most inappropriate stuff. Still lots to do...)Sven Eden2017-05-23
|
* sd-journal: add an API to enumerate known field names of the journalLennart Poettering2017-05-17
| | | | | | This adds two new calls to get the list of all journal fields names currently in use. This is the low-level support to implement the feature requested in #2176 in a more optimized way.
* man: document that logind's RemoveIPC= option excepts all system usersLennart Poettering2017-05-17
| | | | Fixes #2324.
* sd-event: check clock argument to sd_event_now()Zbigniew Jędrzejewski-Szmek2017-05-17
| | | | | | | | sd_event_now() is a public function, so we must check all arguments for validity. Update man page and add tests. Sample debug message: Assertion 'IN_SET(clock, CLOCK_REALTIME, CLOCK_REALTIME_ALARM, CLOCK_MONOTONIC, CLOCK_BOOTTIME, CLOCK_BOOTTIME_ALARM)' failed at src/libelogind/sd-event/sd-event.c:2719, function sd_event_now(). Ignoring.
* man: fix typosJakub Wilk2017-05-17
|
* tree-wide: expose "p"-suffix unref calls in public APIs to make gcc cleanup easyLennart Poettering2017-05-17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | GLIB has recently started to officially support the gcc cleanup attribute in its public API, hence let's do the same for our APIs. With this patch we'll define an xyz_unrefp() call for each public xyz_unref() call, to make it easy to use inside a __attribute__((cleanup())) expression. Then, all code is ported over to make use of this. The new calls are also documented in the man pages, with examples how to use them (well, I only added docs where the _unref() call itself already had docs, and the examples, only cover sd_bus_unrefp() and sd_event_unrefp()). This also renames sd_lldp_free() to sd_lldp_unref(), since that's how we tend to call our destructors these days. Note that this defines no public macro that wraps gcc's attribute and makes it easier to use. While I think it's our duty in the library to make our stuff easy to use, I figure it's not our duty to make gcc's own features easy to use on its own. Most likely, client code which wants to make use of this should define its own: #define _cleanup_(function) __attribute__((cleanup(function))) Or similar, to make the gcc feature easier to use. Making this logic public has the benefit that we can remove three header files whose only purpose was to define these functions internally. See #2008.
* man: include the target name when linking to man pages in html outputZbigniew Jędrzejewski-Szmek2017-05-17
| | | | | | | | | | | | | | | | | | | | | Links like http://www.freedesktop.org/software/elogind/man/elogind.socket.html are changed to http://www.freedesktop.org/software/elogind/man/elogind.socket.html#Accept=. This implementation is quick & dirty, and misses various corner cases. A fairly important one is that when a few directives share the same anchor (which happens when multiple directives are described in the same paragraph), generated links for everything except the first one link to an invalid anchor. Another shortcoming is that the formatting does not use the proper generateID machinery, so the anchor name could be wrong in some cases. But it seems to work for a large percentage of links, so seems to be an improvement in usability. When the anchor is missing, we land at the top of the page, which is the same as before. If the anchor were to point to different spot, this would be more confusing... Not sure if that ever happens. Anyway, the user should be able to recover from landing on the wrong place in the page. (Mostly) fixes https://github.com/elogind/elogind/issues/1956.
* man: fully document sd-event interfacesLennart Poettering2017-05-17
| | | | | | | | | This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
* gitignore: only ignore .html files in man/Martin Pitt2017-05-17
| | | | | src/journal-remote/browse.html is git-tracked source and should not be ignored. Avoid accidentally ignoring similar ones in the future.
* man: Drop "internally," which is misleadingDavid Strauss2017-04-26
| | | | The existing text misleads readers into thinking how the notify socket protocol is "internals" and that they can only use the functions. However, the socket is part of the Interface Stability Promise. So, we should drop "internally" from the description so the man page both indicates both how the functions work and how one would talk to the socket directly.
* Prep v227: Fix man page index building.Sven Eden2017-04-12
|
* Major cleanup of all leftovers after rebasing on master.Sven Eden2017-03-14
| | | | | | | | The patching of elogind in several steps with only partly rebasing on a common commit with upstream, left the tree in a state, that was unmergeable with master. By rebasing on master and manually cleaning up all commits, this merge is now possible. However, this process left some orphans, that are cleanup now.
* Updated man pages.Sven Eden2017-03-14
|
* Remove support for auto-spawning VTsSven Eden2017-03-14
| | | | | Auto-spawning VTs requires systemd in practice. If you're using systemd you can just use its logind :)
* Remove sd_is_mqSven Eden2017-03-14
| | | | | | | * src/systemd/sd-daemon.h: * src/libelogind/sd-daemon/sd-daemon.c (sd_is_mq): Remove unused function that depended on librt. Ultimately we should remove this header at some point.
* Fix man page building to be less systemd and more elogind.Sven Eden2017-03-14
|
* Remove man/sd[-_]bus[-_]error*.xml files, as elogind does not provide a ↵Sven Eden2017-03-14
| | | | systemd dbus interface to control.
* Change systemd occurences in factory/etc/pam.d to elogind.Sven Eden2017-03-14
|
* Remove APPARMOR, BLKID and SECCOMP checks and feature.Sven Eden2017-03-14
| | | | | Remove logind check, it is always built as elogind anyway. Remove ENABLE_LOGIND conditional from man pages.
* sd-login: rework error handlingLennart Poettering2017-03-14
| | | | | | Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
* Prep v222: Update build system:Sven Eden2017-03-14
| | | | | | | | - The content of the man pages directory has been overhauled - Makefile-man.am was regenerated - Makefile.am and configure.ac needed a few addtitions and fixes - Some masked functions had to be unmasked - Now superfluous files have been removed
* Prep v221: Update and clean up build system to sync with upstreamSven Eden2017-03-14
| | | | | | | | | | | | | | This commit replays the moving around of source files that have been done between systemd-219 and systemd-221. Further the Makefile.am is synchronized with the upstream version and then "re-cleaned". A lot of functions, that are not used anywhere in elogind have been coated into #if 0/#endif directives to further shorten the list of dependencies. All unneeded files have been removed.
* man: typo fixesThomas Hindoe Paaboel Andersen2017-03-14
|
* doc: configure docbook stylesheet to generate reproducible IDsJohan Ouwerkerk2017-03-14
| | | | This makes auto generated anchor tags in HTML output reproducible.
* Use a top-to-bottom numbering scheme for generating ids of subheadings and ↵Johan Ouwerkerk2017-03-14
| | | | | | | | | terms. This scheme fixes permalinks to distinguish between items that would previously have the same ID attribute. Where possible the generated ID values are the same as those generated with the previous versions of the stylesheet to retain backwards compatibility with published links. As a side effect of the changes xsltproc should no longer complain about duplicate IDs during build.
* man: fully document sd-bus' error APIsLennart Poettering2017-03-14
| | | | | [@zonque: Some minor nits fixed as pointed out by @ronnychevalier, dropped class='sd-bus-errors' to fix python logic]