From 2736c25ce27fd3911604108b141c452aec069fe7 Mon Sep 17 00:00:00 2001 From: Daan De Meyer Date: Sun, 19 Apr 2020 13:05:44 +0200 Subject: [PATCH] D-Bus docs: systemd1 fixes --- man/org.freedesktop.systemd1.xml | 284 ++++++++++++++++--------------- 1 file changed, 143 insertions(+), 141 deletions(-) diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 09b1a9e78bf..2d0063b07fc 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -364,8 +364,8 @@ node /org/freedesktop/systemd1 { invoked this method. Unsubscribe() reverts the signal subscription that Subscribe() implements. It is not necessary to invoke Unsubscribe() as clients are tracked. Signals are no longer sent out as soon as - all clients which previously asked for Subscribe() either closed the bus - connection or invoked Unsubscribe(). + all clients which previously asked for Subscribe() either closed their connection + to the bus or invoked Unsubscribe(). Reload() may be invoked to reload all unit files. @@ -376,57 +376,57 @@ node /org/freedesktop/systemd1 { Exit() may be invoked to ask the manager to exit. This is not available for the system manager and is useful only for user session managers. - Reboot(), PowerOff(), Halt(), + Reboot(), PowerOff(), Halt(), or KExec() may be used to ask for immediate reboot, powering down, halt or kexec based reboot of the system. Note that this does not shut down any services and immediately transitions - into the reboot process. These functions are normally only called as last step of shutdown, and should - not be called directly. To shut down the machine it is a much better choice generally to invoke - Reboot() and PoweOff() on the + into the reboot process. These functions are normally only called as the last step of shutdown and should + not be called directly. To shut down the machine, it is generally a better idea to invoke + Reboot() or PowerOff() on the systemd-logind manager object; see org.freedesktop.login15 for more information. SwitchRoot() may be used to transition to a new root directory. This is - intended to be used by initial RAM disks. The call takes two arguments: the new root directory (which - needs to be specified), plus an init binary path (which may be left empty, in which case it is + intended to be used by initial RAM disks. The method takes two arguments: the new root directory (which + needs to be specified) and an init binary path (which may be left empty, in which case it is automatically searched for). The state of the system manager will be serialized before the - transition. After the transition the manager binary on the main system is invoked and replaces the old + transition. After the transition, the manager binary on the main system is invoked and replaces the old PID 1. All state will then be deserialized. SetEnvironment() may be used to alter the environment block that is passed - to all spawned processes. Takes a string array with environment variable assignments. Settings passed - will override previously set variables. + to all spawned processes. It takes a string array of environment variable assignments. Any previously set + environment variables will be overridden. - UnsetEnvironment() may be used to unset environment variables. Takes a - string array with environment variable names. All variables specified will be unset (if they have been - set previously) and no longer be passed to all spawned processes. This call has no effect for variables + UnsetEnvironment() may be used to unset environment variables. It takes a + string array of environment variable names. All variables specified will be unset (if they have been + set previously) and no longer be passed to all spawned processes. This method has no effect for variables that were previously not set, but will not fail in that case. UnsetAndSetEnvironment() is a combination of UnsetEnvironment() and SetEnvironment(). It takes two - lists. The first one is a list of variables to unset, the second one of assignments to set. If a - variable is listed in both, the variable is set after this call, i.e. the set list overrides the unset - list. + lists. The first list contains variables to unset, the second one contains assignments to set. If a + variable is listed in both, the variable is set after this method returns, i.e. the set list overrides the + unset list. - ListUnitFiles() returns an array of unit names plus their enablement + ListUnitFiles() returns an array of unit names and their enablement status. Note that ListUnit() returns a list of units currently loaded into memory, - while ListUnitFiles() returns a list of unit files that could - be found on disk. Note that while most units are read directly from a unit file with the same name some - units are not backed by files, and some files (templates) cannot directly be loaded as units but need - to be instantiated. + while ListUnitFiles() returns a list of unit files that were + found on disk. Note that while most units are read directly from a unit file with the same name, some + units are not backed by files and some files (templates) cannot directly be loaded as units but need + to be instantiated instead. - GetUnitFileState() returns the current enablement status of specific unit + GetUnitFileState() returns the current enablement status of a specific unit file. EnableUnitFiles() may be used to enable one or more units in the system (by creating symlinks to them in /etc or /run). It takes a list of unit files to enable (either just file names or full absolute paths if the unit files are residing - outside the usual unit search paths), and two booleans: the first controls whether the unit shall be + outside the usual unit search paths) and two booleans: the first controls whether the unit shall be enabled for runtime only (true, /run), or persistently (false, /etc). The second one controls whether symlinks pointing to other units shall be - replaced if necessary. This call returns one boolean and an array with the changes made. The boolean + replaced if necessary. This method returns one boolean and an array of the changes made. The boolean signals whether the unit files contained any enablement information (i.e. an [Install]) section. The - changes list consists of structures with three strings: the type of the change (one of + changes array consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink. Note that most of the following calls return a changes list in the same format. @@ -441,40 +441,40 @@ node /org/freedesktop/systemd1 { Similarly, LinkUnitFiles() links unit files (that are located outside of the usual unit search paths) into the unit search path. - Similarly, PresetUnitFiles() enables/disables one or more units file + Similarly, PresetUnitFiles() enables/disables one or more unit files according to the preset policy. See systemd.preset7 for more information. - Similarly, MaskUnitFiles() masks unit files, and + Similarly, MaskUnitFiles() masks unit files and UnmaskUnitFiles() unmasks them again. SetDefaultTarget() changes the default.target link. See bootup7 for more - information + information. GetDefaultTarget() retrieves the name of the unit to which - default.target is aliased + default.target is aliased. SetUnitProperties() may be used to modify certain unit properties at runtime. Not all properties may be changed at runtime, but many resource management settings (primarily those listed in systemd.cgroup5) - may. The changes are applied instantly, and stored on disk for future boots, unless + may. The changes are applied instantly and stored on disk for future boots, unless runtime is true, in which case the settings only apply until the next reboot. name is the name of the unit to modify. properties are the settings to set, encoded as an array of property name and value pairs. Note that this is not a - dictionary! Note that when setting array properties with this call this usually results in appending to - the pre-configured array. To reset the configured arrays set the property to an empty array first, then - append to it. + dictionary! Also note that when setting array properties with this method usually results in appending to + the pre-configured array. To reset the configured arrays, set the property to an empty array first and + then append to it. - StartTransientUnit() may be used to create and start a transient unit, which + StartTransientUnit() may be used to create and start a transient unit which will be released as soon as it is not running or referenced anymore or the system is - rebooted. name is the unit name including suffix, and must be + rebooted. name is the unit name including its suffix and must be unique. mode is the same as in StartUnit(), properties contains properties of the unit, specified like in SetUnitProperties(). aux is currently unused and should be - passed as empty array. See the New Control Group Interface for more information how to make use of this functionality for resource control purposes. @@ -484,7 +484,7 @@ node /org/freedesktop/systemd1 { Signals Note that most signals are sent out only after Subscribe() has been invoked - by at least one client. Make sure to invoke this call when subscribing to these signals! + by at least one client. Make sure to invoke this method when subscribing to these signals! UnitNew() and UnitRemoved() are sent out each time a new unit is loaded or unloaded. Note that this has little to do with whether a unit is available on @@ -493,24 +493,24 @@ node /org/freedesktop/systemd1 { JobNew() and JobRemoved() are sent out each time a new job is queued or dequeued. Both signals take the numeric job ID, the bus path and the primary unit name - for this job as argument. JobRemoved() also includes a result string, being one of - done, canceled, timeout, - failed, dependency, + for this job as arguments. JobRemoved() also includes a result string which is one + of done, canceled, timeout, + failed, dependency, or skipped. done indicates successful execution of a job. canceled indicates that a job has been canceled (via CancelJob() above) before it finished execution (this doesn't necessarily mean though that the job operation is actually cancelled too, see above). timeout indicates that the job timeout was reached. failed indicates that the job - failed. dependency indicates that a job this job has been depending on failed and - the job hence has been removed too. skipped indicates that a job was skipped because - it didn't apply to the units current state. + failed. dependency indicates that a job this job depended on failed and the job hence + was removed as well. skipped indicates that a job was skipped because + it didn't apply to the unit's current state. - StartupFinished() is sent out when startup finished. It carries six - microsecond timespan values each indicating how much boot time has been spent in the firmware (if + StartupFinished() is sent out when startup finishes. It carries six + microsecond timespan values, each indicating how much boot time has been spent in the firmware (if known), in the boot loader (if known), in the kernel initialization phase, in the initrd (if known), in userspace and in total. These values may also be calculated from the FirmwareTimestampMonotonic, LoaderTimestampMonotonic, - InitRDTimestampMonotonic, UserspaceTimestampMonotonic, + InitRDTimestampMonotonic, UserspaceTimestampMonotonic, and FinishTimestampMonotonic properties (see below). UnitFilesChanged() is sent out each time the list of enabled or masked unit @@ -518,7 +518,7 @@ node /org/freedesktop/systemd1 { Reloading() is sent out immediately before a daemon reload is done (with the boolean parameter set to True) and after a daemon reload is completed (with the boolean parameter set - to False). This may be used by UIs to optimize UI updates + to False). This may be used by UIs to optimize UI updates. @@ -530,15 +530,15 @@ node /org/freedesktop/systemd1 { The others: Version encodes the version string of the running systemd instance. Note that - the version string is purely informational, it should not be parsed, one may not assume the version to + the version string is purely informational. It should not be parsed and one may not assume the version to be formatted in any particular way. We take the liberty to change the versioning scheme at any time and - it is not part of the API. + it is not part of the public API. Features encodes the features that have been enabled and disabled for this build. Enabled options are prefixed with +, disabled options with -. - Tainted encodes a couple of taint flags, as a colon-separated list. When - systemd detects it is run on a system with certain problems it will set an appropriate taint + Tainted encodes a couple of taint flags as a colon-separated list. When + systemd detects it is running on a system with certain problems, it will set an appropriate taint flag. Taints may be used to lower the chance of bogus bug reports. The following taints are currently known: split-usr, mtab-not-symlink, cgroups-missing, local-hwclock. split-usr is @@ -556,26 +556,27 @@ node /org/freedesktop/systemd1 { KernelTimestamp, KernelTimestampMonotonic, InitRDTimestamp, InitRDTimestampMonotonic, UserspaceTimestamp, UserspaceTimestampMonotonic, - FinishTimestamp, FinishTimestampMonotonic encode + FinishTimestamp, and FinishTimestampMonotonic encode CLOCK_REALTIME and CLOCK_MONOTONIC microsecond timestamps taken when the firmware first began execution, when the boot loader first began execution, when the kernel first began execution, when the initrd first began execution, when the main systemd instance began execution and finally, when all queued startup jobs finished execution. These values are useful - for determining boot-time performance. Note that as monotonic time begins with the kernel startup the - KernelTimestampMonotonic timestamp will always be 0, and FirmwareTimestampMonotonic and - LoaderTimestampMonotonic are to be read as negative values. Also, not all fields are available, - depending on the used firmware, boot loader or initrd implementation. In these cases the respective - pairs of timestamps are both 0, indicating that no data is available. + for determining boot-time performance. Note that as monotonic time begins with the kernel startup, the + KernelTimestampMonotonic timestamp will always be 0 and + FirmwareTimestampMonotonic and LoaderTimestampMonotonic are to + be read as negative values. Also, not all fields are always available, depending on the used firmware, + boot loader or initrd implementation. In these cases the respective pairs of timestamps are both 0, + indicating that no data is available. Similarly, the SecurityStartTimestamp, - GeneratorsStartTimestamp and LoadUnitTimestamp (plus their + GeneratorsStartTimestamp and LoadUnitTimestamp (as well as their monotonic and stop counterparts) expose performance data for uploading the security policies to the kernel (such as the SELinux, IMA, or SMACK policies), for running the generator tools and for loading - the unit files + the unit files. NNames encodes how many unit names are currently known. This only includes - names of units that are currently loaded and can be more than actually loaded units since units may - have more than one name. + names of units that are currently loaded and can be more than the amount of actually loaded units since + units may have more than one name. NJobs encodes how many jobs are currently queued. @@ -583,20 +584,21 @@ node /org/freedesktop/systemd1 { NFailedJobs encodes how many jobs have ever failed in total. - Progress encodes boot progress as floating point value between 0.0 and + Progress encodes boot progress as a floating point value between 0.0 and 1.0. This value begins at 0.0 at early-boot and ends at 1.0 when boot is finished and is based on the - number of executed and queued jobs. After startup this field is always 1.0 indicating a finished + number of executed and queued jobs. After startup, this field is always 1.0 indicating a finished boot. Environment encodes the environment block passed to all executed services. It may be altered with bus calls such as SetEnvironment() (see above). UnitPath encodes the currently active unit file search path. It is an array of - strings, each being one file system path + file system paths encoded as strings. Virtualization contains a short ID string describing the virtualization - technology the system runs in. On bare-metal hardware this is the empty string, otherwise an identifier - such as kvm, vmware and so on. For a full list of IDs see + technology the system runs in. On bare-metal hardware this is the empty string. Otherwise, it contains + an identifier such as kvm, vmware and so on. For a full list of + IDs see systemd-detect-virt1. Note that only the "innermost" virtualization technology is exported here. This detects both full-machine virtualizations (VMs) and shared-kernel virtualization (containers). @@ -606,9 +608,9 @@ node /org/freedesktop/systemd1 { ConditionArchitectures=. ControlGroup contains the root control group path of this system manager. Note - that the root path is encoded as empty string here (not as /!), so that it can be + that the root path is encoded as the empty string here (not as /!), so that it can be appended to /sys/fs/cgroup/systemd easily. This value will be set to the empty - string for the host instance, and some other string for container instances + string for the host instance and some other string for container instances. @@ -623,9 +625,9 @@ node /org/freedesktop/systemd1 { ReenableUnitFiles(), LinkUnitFiles(), PresetUnitFiles, MaskUnitFiles, and similar) require org.freedesktop.systemd1.manage-unit-files). Operations which modify the - exported environment ( SetEnvironment(), UnsetEnvironment(), + exported environment (SetEnvironment(), UnsetEnvironment(), UnsetAndSetEnvironment()) require - org.freedesktop.systemd1.set-environment. Reload() + org.freedesktop.systemd1.set-environment. Reload() and Reexecute() require org.freedesktop.systemd1.reload-daemon. @@ -749,11 +751,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { Restart(), TryRestart(), ReloadOrRestart(), ReloadOrTryRestart(), Kill(), ResetFailed(), and - SetProperties() implement the same operation as the respective method calls on the - Manager object (see above), however operate on the unit object and hence - do not take a unit name parameter. Invoking the methods directly on the Manager object has the - advantage of not requiring a GetUnit() call to get the unit object for a specific - unit name. Calling the methods on the Manager object is hence a round trip optimization. + SetProperties() implement the same operation as the respective methods on the + Manager object (see above). However, these methods operate on the unit + object and hence do not take a unit name parameter. Invoking the methods directly on the Manager + object has the advantage of not requiring a GetUnit() call to get the unit object + for a specific unit name. Calling the methods on the Manager object is hence a round trip + optimization. @@ -774,9 +777,9 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { WantedBy, BoundBy, Conflicts, ConflictedBy, Before, After, OnFailure, Triggers, TriggeredBy, - PropagatesReloadTo, RequiresMountsFor contain arrays which encode - the dependencies and their inverse dependencies (where this applies), as configured in the unit file or - determined automatically. + PropagatesReloadTo, and RequiresMountsFor contain arrays which encode + the dependencies and their inverse dependencies (where this applies) as configured in the unit file or + determined automatically. Description contains the human readable description string for the unit. @@ -784,16 +787,16 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { SourcePath contains the path to a configuration file this unit is automatically generated from in case it is not a native unit (in which case it contains the empty string). For example, all mount units generated from /etc/fstab have this field - set to this value. + set to /etc/fstab. Documentation contains a string array with URLs of documentation for this unit. LoadState contains a state value that reflects whether the configuration file of this unit has been loaded. The following states are currently defined: loaded, - error, masked. loaded indicates that the + error, and masked. loaded indicates that the configuration was successfully loaded. error indicates that the configuration failed - to load, the LoadError field (see below) contains information about the cause of + to load. The LoadError field (see below) contains information about the cause of this failure. masked indicates that the unit is currently masked out (i.e. symlinked to /dev/null or empty). Note that the LoadState is fully orthogonal to the ActiveState (see below) as units without valid loaded @@ -803,7 +806,7 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { ActiveState contains a state value that reflects whether the unit is currently active or not. The following states are currently defined: active, reloading, inactive, failed, - activating, deactivating. active indicates + activating, and deactivating. active indicates that unit is active (obviously...). reloading indicates that the unit is active and currently reloading its configuration. inactive indicates that it is inactive and the previous run was successful or no previous run has taken place yet. failed @@ -824,47 +827,46 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { later on than the common high-level states explained above. FragmentPath contains the unit file path this unit was read from, if there is - any (if not this contains the empty string). + one (if not, it contains the empty string). UnitFileState encodes the install state of the unit file of FragmentPath. It currently knows the following states: enabled, enabled-runtime, linked, linked-runtime, masked, masked-runtime, static, - disabled, invalid. enabled indicates that a + disabled, and invalid. enabled indicates that a unit file is permanently enabled. enable-runtime indicates the unit file is only - temporarily enabled, and will no longer be enabled after a reboot (that means, it is enabled via + temporarily enabled and will no longer be enabled after a reboot (that means, it is enabled via /run symlinks, rather than /etc). linked - indicates that a unit is linked into /etc permanently, linked + indicates that a unit is linked into /etc permanently. linked-runtime indicates that a unit is linked into /run temporarily (until the next - reboot). masked indicates that the unit file is masked permanently, - masked-runtime indicates that it is only temporarily masked in - /run, until the next reboot. static indicates that the unit is - statically enabled, i.e. always enabled and doesn't need to be enabled - explicitly. invalid indicates that it could not be determined whether the unit file - is enabled. + reboot). masked indicates that the unit file is masked permanently. + masked-runtime indicates that it is masked in /run temporarily + (until the next reboot). static indicates that the unit is statically enabled, i.e. + always enabled and doesn't need to be enabled explicitly. invalid indicates that it + could not be determined whether the unit file is enabled. InactiveExitTimestamp, InactiveExitTimestampMonotonic, ActiveEnterTimestamp, ActiveEnterTimestampMonotonic, ActiveExitTimestamp, ActiveExitTimestampMonotonic, - InactiveEnterTimestamp, InactiveEnterTimestampMonotonic contain - CLOCK_REALTIME and CLOCK_MONOTONIC 64-bit microsecond + InactiveEnterTimestamp, and InactiveEnterTimestampMonotonic + contain CLOCK_REALTIME and CLOCK_MONOTONIC 64-bit microsecond timestamps of the last time a unit left the inactive state, entered the active state, exited the active state, or entered an inactive state. These are the points in time where the unit transitioned inactive/failed → activating, activating → active, active → deactivating, and finally deactivating → inactive/failed. The fields are 0 in case such a transition has - not been recording on this boot yet. + not yet been recorded on this boot. - CanStart, CanStop, CanReload encodes as - booleans whether the unit supports the start, stop or reload operations. Even if a unit supports such - an operation the client might not necessary have the right privileges to execute them. + CanStart, CanStop, and CanReload encode + as booleans whether the unit supports the start, stop or reload operations. Even if a unit supports + such an operation, the client might not necessary have the necessary privileges to execute them. - CanIsolate encodes as boolean whether the unit may be started in isolation + CanIsolate encodes as a boolean whether the unit may be started in isolation mode. Job encodes the job ID and job object path of the job currently scheduled or - executed for this unit, if there is any. If no job is scheduled or executed the job id field will be + executed for this unit, if there is any. If no job is scheduled or executed, the job id field will be 0. StopWhenUnneeded, RefuseManualStart, @@ -887,28 +889,28 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { ConditionTimestamp and ConditionTimestampMonotonic contain the CLOCK_REALTIME/CLOCK_MONOTONIC microsecond timestamps of - the last time the configured conditions of the unit have been checked, or 0 if they have never been + the last time the configured conditions of the unit have been checked or 0 if they have never been checked. Conditions are checked when a unit is requested to start. ConditionResult contains the condition result of the last time the configured conditions of this unit were checked. - Conditions contains all configured conditions of the unit. For each condition + Conditions contains all configured conditions of the unit. For each condition, five fields are given: condition type (e.g. ConditionPathExists), whether the condition is a trigger condition, whether the condition is reversed, the right hand side of the condition (e.g. the path in case of ConditionPathExists), and the status. The status can be 0, in which case the condition hasn't been checked yet, a positive value, in which case the condition passed, or a negative value, in which case the condition failed. Currently only 0, +1, and -1 are used, but additional values may be used in the future, retaining the meaning of - zero/positive/negative values + zero/positive/negative values. LoadError contains a pair of strings. If the unit failed to load (as encoded in LoadState, see above), then this will include a D-Bus error pair consisting of - the error ID and an explanatory human readable string of what happened. If it succeeded to load this + the error ID and an explanatory human readable string of what happened. If it loaded successfully, this will be a pair of empty strings. - Transient contains a boolean that indicates whether the unit was created as - transient unit (i.e. via CreateTransientUnit() on the manager object) + Transient contains a boolean that indicates whether the unit was created as a + transient unit (i.e. via CreateTransientUnit() on the manager object). @@ -1073,10 +1075,10 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ last watchdog ping received from the service, or 0 if none was ever received. ExecStartPre, ExecStart, ExecStartPost, - ExecReload, ExecStop, ExecStop each are arrays - of structures each containing: the binary path to execute; an array with all arguments to pass to the - executed command, starting with argument 0; a boolean whether it should be considered a failure if the - process exits uncleanly; two pairs of + ExecReload, ExecStop, and ExecStop are arrays + of structures where each struct contains: the binary path to execute; an array with all arguments to + pass to the executed command, starting with argument 0; a boolean whether it should be considered a + failure if the process exits uncleanly; two pairs of CLOCK_REALTIME/CLOCK_MONOTONIC microsecond timestamps when the process began and finished running the last time, or 0 if it never ran or never finished running; the PID of the process, or 0 if it has not run yet; the exit code and status of the last run. This @@ -1084,16 +1086,17 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ with runtime data. LimitCPU (and related properties) map more or less directly to the - corresponding settings in the service unit files, however are set to 18446744073709551615 (i.e. -1) if - they aren't set. + corresponding settings in the service unit files except that if they aren't set, their value is + 18446744073709551615 (i.e. -1). Capabilities contains the configured capabilities, as formatted with cap_to_text3. SecureBits, CapabilityBoundingSet, - MountFlags also correspond to the configured settings of the unit files, but are - encoded as the actual binary flag fields they are, rather than formatted as string. + MountFlags also correspond to the configured settings of the unit files, but + instead of being formatted as strings, they are encoded as the actual binary flags they are. + ExecMainStartTimestamp, ExecMainStartTimestampMonotonic, ExecMainExitTimestamp, ExecMainExitTimestampMonotonic, @@ -1119,17 +1122,17 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ explanatory string. Result encodes the execution result of the last run of the service. It is - useful to determine the reason a service failed if it is in failed state (see + useful to determine the reason a service failed if it is in the failed state (see ActiveState above). The following values are currently known: success is set if the unit didn't fail. resources indicates that - not enough resources have been available to fork off and execute the service + not enough resources were available to fork off and execute the service processes. timeout indicates that a time-out occurred while executing a service operation. exit-code indicates that a service process exited with an unclean exit code. signal indicates that a service process exited with an uncaught signal. core-dump indicates that a service process exited uncleanly and dumped core. watchdog indicates that a service did not send out watchdog ping messages often enough. start-limit indicates that a service has been started too frequently - in a time frame (as configured in StartLimitInterval, + in a specific time frame (as configured in StartLimitInterval, StartLimitBurst). ControlGroup indicates the control group path the processes of this service @@ -1292,15 +1295,15 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { i.e. those where systemd is responsible for accepted connections. Similarly NConnections contains the number of currently open connections on - this socket, and also applies only to socket with Accept set to + this socket. It only applies only to socket units with Accept set to true. - Result encodes the reason why a socket unit failed if it is in + Result encodes the reason why a socket unit failed if it is in the failed state (see ActiveState above). The values success, resources, timeout, exit-code, signal and core-dump have the same - meaning as they have for the corresponding field of service units (see above). In addition to that the - value service-failed-permanent indicates that the service of this socket failed + meaning as they have for the corresponding field of service units (see above). In addition to that, + the value service-failed-permanent indicates that the service of this socket failed continuously. @@ -1379,13 +1382,12 @@ node /org/freedesktop/systemd1/unit/dev_2d_foo_2edevice { - Mount Unit Objects All mount unit objects implement the org.freedesktop.systemd1.Mount interface (described here) in addition to the generic - org.freedesktop.systemd1.Unit interface (see above) + org.freedesktop.systemd1.Unit interface (see above). $ gdbus introspect --system --dest org.freedesktop.systemd1 \ @@ -1503,7 +1505,7 @@ node /org/freedesktop/systemd1/unit/home_2emount { Properties Most of the properties map directly to the corresponding settings in mount unit files. As mount - units invoke the /usr/bin/mount command their bus objects include implicit + units invoke the /usr/bin/mount command, their bus objects include implicit ExecMount (and similar) fields which contain information about processes to execute. They also share most of the fields related to the execution context that Service objects expose (see above). In addition to these properties there are the following: @@ -1514,7 +1516,7 @@ node /org/freedesktop/systemd1/unit/home_2emount { Result contains a value explaining why a mount unit failed if it failed. It can take the values success, resources, - timeout, exit-code, signal, + timeout, exit-code, signal, or core-dump which have the identical meaning as the corresponding values of the corresponding field of service unit objects (see above). @@ -1562,7 +1564,7 @@ node /org/freedesktop/systemd1/unit/proc_2dsys_2dfs_2dbinfmt_5fmisc_2eautomount files. Result knows the values success and - resources, at this time. They have the same meanings as the corresponding values of + resources at this time. They have the same meanings as the corresponding values of the corresponding field of the Service object. @@ -1611,10 +1613,10 @@ node /org/freedesktop/systemd1/unit/systemd_2dtmpfiles_2dclean_2etimer { TimersMonotonic contains an array of structs that contain information about all monotonic timers of this timer unit. The structs contain a string identifying the timer base, which is one of OnActiveUSec, OnBootUSec, - OnStartupUSec, OnUnitActiveUSec, - OnUnitInactiveUSec, which correspond to the settings of the same names in the timer + OnStartupUSec, OnUnitActiveUSec, or + OnUnitInactiveUSec which correspond to the settings of the same names in the timer unit files; the microsecond offset from this timer base in monotonic time; the next elapsation point on - the CLOCK_MONOTONIC clock, relative its epoch. + the CLOCK_MONOTONIC clock, relative to its epoch. TimersCalendar contains an array of structs that contain information about all realtime/calendar timers of this timer unit. The structs contain a string identifying the timer base, @@ -1757,7 +1759,7 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { Most of the properties map directly to the corresponding settings in swap unit files. As mount units invoke the - swapon8 command + swapon8 command, their bus objects include implicit ExecActivate (and similar) fields which contain information about processes to execute. They also share most of the fields related to the execution context that Service objects expose (see above). In addition to these properties there are the @@ -1770,7 +1772,7 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { Result contains a value explaining why a mount unit failed if it failed. It can take the values success, resources, - timeout, exit-code, signal, + timeout, exit-code, signal, or core-dump which have the identical meanings as the corresponding values of the corresponding field of service unit objects (see above). @@ -1819,12 +1821,12 @@ node /org/freedesktop/systemd1/unit/cups_2epath { Paths contains an array of structs. Each struct contains the condition to watch, which can be one of PathExists, PathExistsGlob, - PathChanged, PathModified, DirectoryNotEmpty + PathChanged, PathModified, or DirectoryNotEmpty which correspond directly to the matching settings in the path unit files; and the path to watch, possibly including glob expressions. Result contains a result value which can be success or - resources, which have the same meaning as the corresponding field of the service + resources which have the same meaning as the corresponding field of the Service interface. @@ -1942,7 +1944,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { Abandon() may be used to place a scope unit in the "abandoned" state. This may be used to inform the system manager that the manager that created the scope lost interest in the - scope (for example, because it is terminating), without wanting to shut down the scope entirely + scope (for example, because it is terminating), without wanting to shut down the scope entirely. @@ -1950,18 +1952,18 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { RequestStop is sent to the peer that is configured in the Controller property when systemd is requested to terminate the scope unit. A program - registering a scope can use this to cleanly shut down the processes it added to the scope, instead of + registering a scope can use this to cleanly shut down the processes it added to the scope instead of letting systemd do it with the usual SIGTERM logic. Properties - All properties correspond directly with the matching properties of service units + All properties correspond directly with the matching properties of service units. Controller contains the bus name (unique or well-known) that is notified when the scope unit is to be shut down via a RequestStop signal (see below). This is - set when the scope is created. If not set the scope's processes will terminated with + set when the scope is created. If not set, the scope's processes will terminated with SIGTERM directly. @@ -2015,17 +2017,17 @@ node /org/freedesktop/systemd1/job/1292 { Id is the numeric Id of the job. During the runtime of a systemd instance each numeric ID is only assigned once. - Unit refers to the unit this job belongs two. It is a structure consisting of + Unit refers to the unit this job belongs to. It is a structure consisting of the name of the unit and a bus path to the unit's object. JobType refers to the job's type and is one of start, verify-active, stop, reload, - restart, try-restart, reload-or-start. Note + restart, try-restart, or reload-or-start. Note that later versions might define additional values. State refers to the job's state and is one of waiting and running. The former indicates that a job is currently queued but has not begun to - execute yet, the latter indicates that a job is currently being executed. + execute yet. The latter indicates that a job is currently being executed.