From: Daan De Meyer Date: Tue, 14 Apr 2020 11:43:11 +0000 (+0200) Subject: man: fixes from online review X-Git-Tag: v246-rc1~567^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ca264f7d96df3c33ad808b5ca4c4fc8acadc0067;p=thirdparty%2Fsystemd.git man: fixes from online review Also includes the issues pointed out by @boucman. --- diff --git a/man/org.freedesktop.locale1.xml b/man/org.freedesktop.locale1.xml index 94c96456f97..12a82c1db52 100644 --- a/man/org.freedesktop.locale1.xml +++ b/man/org.freedesktop.locale1.xml @@ -72,24 +72,24 @@ node /org/freedesktop/locale1 { Methods - If you set a new system locale all old system locale settings will be dropped, and the new - settings will be saved to disk. It will also be passed to the system manager, and subsequently started + If you set a new system locale all old system locale settings will be dropped and the new + settings will be saved to disk. The locale will also be passed to the system manager, and subsequently started daemons will inherit the new system locale. Note that already running daemons will not learn about the new value. - The SetVConsoleKeyboard() call may be used to set the key mapping on the + The SetVConsoleKeyboard() call may be used to set the key mapping for the virtual console. Similarly, SetX11Keyboard() may be used to set the default key - mapping of the X11 servers. + mapping of any X11 servers. - Note that SetVConsoleKeyboard() instantly applies the new keymapping to the + Note that SetVConsoleKeyboard() instantly applies the new key mapping to the console, while SetX11Keyboard() simply sets a default that may be used by later sessions. The boolean argument convert may be set to optionally convert the console keyboard configuration to X11 keyboard mappings and vice versa. If true and - SetVConsoleKeyboard() is used the nearest X11 keyboard setting for the chosen + SetVConsoleKeyboard() is used, the nearest X11 keyboard setting for the chosen console setting is set. If true and SetX11Keyboard() is used, the nearest console - keyboard setting for the chosen X11 setting is set. Usually it is hence sufficient to call one of the + keyboard setting for the chosen X11 setting is set. Hence, it is usually sufficient to call only one of the two functions. For graphical UIs that need to set the system keyboard mapping simply invoke @@ -99,7 +99,7 @@ node /org/freedesktop/locale1 { Use the empty string for the keymap parameters you wish not to set. The interactive boolean parameters can be used to control whether PolicyKit - should interactively ask the user for authentication credentials if it needs to. + should interactively ask the user for authentication credentials if required. @@ -124,7 +124,7 @@ node /org/freedesktop/locale1 { X11Options properties show values configurable with SetX11Keyboard() described above (or SetVConsoleKeyboard() with convert=true). The VConsoleKeymap and - VConsoleKeymapToggle propries sohw values configurable with + VConsoleKeymapToggle properties show values configurable with SetVConsoleKeyboard() (or SetX11Keyboard() with convert=true). diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index ff944b2d1c4..84dded38491 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -24,11 +24,11 @@ Introduction systemd-logind.service8 - is a system service that keeps track of user logins and seats in various ways. + is a system service that keeps track of user logins and seats. The daemon provides both a C library interface as well as a D-Bus interface. The library interface may be used to introspect and watch the state of user logins and seats. The bus interface provides the - same, but in addition may also be used to make changes to system state. For more information please + same functionality but in addition may also be used to make changes to the system state. For more information please consult sd-login3. @@ -244,19 +244,19 @@ node /org/freedesktop/login1 { GetUserByPID() get the session/user object the specified PID belongs to if there is any. - ListSessions() returns an array with all current sessions. The structures in + ListSessions() returns an array of all current sessions. The structures in the array consist of the following fields: session id, user id, user name, seat id, session object - path. If a session does not have a seat attached the seat id field will be an empty string. + path. If a session does not have a seat attached, the seat id field will be an empty string. - ListUsers() returns an array with all currently logged in users. The + ListUsers() returns an array of all currently logged in users. The structures in the array consist of the following fields: user id, user name, user object path. - ListSeats() returns an array with all currently available seats. The + ListSeats() returns an array of all currently available seats. The structure in the array consists of the following fields: seat id, seat object path. - ListInhibitors() lists all currently active inhibitors. Returns an array of + ListInhibitors() lists all currently active inhibitors. It returns an array of structures consisting of what, who, why, - mode, user ID uid, and process ID pid. + mode, uid (user ID), and pid (process ID). CreateSession() and ReleaseSession() may be used to open or close login sessions. These calls should never be invoked directly by @@ -273,8 +273,8 @@ node /org/freedesktop/login1 { screen lock, if there is any. This is implemented by sending out the Lock() and Unlock() signals from the respective session object which session managers are supposed to listen on. - LockSessions() asks all sessions to activate the screen locks. This may be - used to lock any access to the machine in one action. Similarly, UnlockSessions() + LockSessions() asks all sessions to activate their screen locks. This may be + used to lock access to the entire machine in one action. Similarly, UnlockSessions() asks all sessions to deactivate their screen locks. KillSession() may be used to send a Unix signal to one or all processes of a @@ -284,45 +284,46 @@ node /org/freedesktop/login1 { are killed. KillUser() may be used to send a Unix signal to all processes of a user. As - argument it takes the user id and a signal number. + arguments it takes the user id and a signal number. TerminateSession(), TerminateUser(), TerminateSeat() may be used to forcibly terminate one specific session, all processes of a user, and all sessions attached to a specific seat, respectively. The session, user, and seat are identified by their respective IDs. - SetUserLinger() enables or disables user lingering. If enabled the runtime + SetUserLinger() enables or disables user lingering. If enabled, the runtime directory of a user is kept around and he may continue to run processes while he is logged out. If - disabled the runtime directory goes away as soon as he logs out. Expects three arguments: the UID, a - boolean whether to enable/disable and a boolean controlling the PolicyKit authorization interactivity - (see above). Note that the user linger state is persistently stored on disk. + disabled, the runtime directory goes away as soon as they log out. SetUserLinger() + expects three arguments: the UID, a boolean whether to enable/disable and a boolean controlling the + PolicyKit authorization interactivity (see below). Note that the user linger state is persistently + stored on disk. AttachDevice() may be used to assign a specific device to a specific - seat. The device is identified by its /sys path, and must be eligible for seat assignments. Takes three + seat. The device is identified by its /sys path and must be eligible for seat assignments. AttachDevice() takes three arguments: the seat id, the sysfs path, and a boolean for controlling PolicyKit interactivity (see - above). Device assignments are persistently stored to disk. To create a new seat, simply specify a + below). Device assignments are persistently stored on disk. To create a new seat, simply specify a previously unused seat id. For more information about the seat assignment logic see Multi-Seat for Linux. FlushDevices() removes all explicit seat assignments for devices, resetting - all assignments to the automatic defaults. The only argument this takes is the PolicyKit interactivity - boolean (see above). + all assignments to the automatic defaults. The only argument it takes is the PolicyKit interactivity + boolean (see below). PowerOff(), Reboot(), Halt(), - Suspend(), Hibernate() result in the system being powered - off, rebooted, halted (shut down without turning off power), suspended (the store of the system is - saved to RAM and the CPU is turned off), or hibernated (the store of the system is saved to disk and + Suspend(), and Hibernate() result in the system being powered + off, rebooted, halted (shut down without turning off power), suspended (the system state is + saved to RAM and the CPU is turned off), or hibernated (the system state is saved to disk and the machine is powered down). HybridSleep() results in the system entering a hybrid-sleep mode, i.e. the system is both hibernated and suspended. SuspendThenHibernate() results in the system being suspended, then later woken - using an RTC timer, and hibernated. The only argument is the PolicyKit interactivity boolean - interactive (see above). The main purpose of these calls is that they enforce + using an RTC timer and hibernated. The only argument is the PolicyKit interactivity boolean + interactive (see below). The main purpose of these calls is that they enforce PolicyKit policy and hence allow powering off/rebooting/suspending/hibernating even by unprivileged - users. They also enforce inhibition locks. UIs should expose these calls as primary mechanism to + users. They also enforce inhibition locks. UIs should expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine. - SetRebootParameter() sets the parameter for the subsequent reboot operation. + SetRebootParameter() sets a parameter for a subsequent reboot operation. See the description of reboot in systemctl1 and reboot2 @@ -331,23 +332,23 @@ node /org/freedesktop/login1 { SetRebootToFirmwareSetup(), SetRebootToBootLoaderMenu(), and SetRebootToBootLoaderEntry() configure the action to be taken from the boot loader after a reboot: respectively entering firmware - setup mode, or the boot loader menu, or a specific boot loader entry. See + setup mode, the boot loader menu, or a specific boot loader entry. See systemctl1 for the - command line interface. + corresponding command line interface. CanPowerOff(), CanReboot(), CanHalt(), CanSuspend(), CanHibernate(), CanHybridSleep(), CanSuspendThenHibernate(), CanRebootParameter(), CanRebootToFirmwareSetup(), CanRebootToBootLoaderMenu(), and - CanRebootToBootLoaderEntry(), test whether the system supports the respective - operation and whether the calling user is allowed to request it. Returns one of na, + CanRebootToBootLoaderEntry() test whether the system supports the respective + operation and whether the calling user is allowed to execute it. Returns one of na, yes, no, and challenge. If na is returned, the operation is not available because hardware, kernel, or drivers do not support it. If yes is returned, the operation is supported and the user may - execute the operation without further authentication. If no is returned the + execute the operation without further authentication. If no is returned, the operation is available but the user is not allowed to execute the operation. If - challenge is returned the operation is available, but only after + challenge is returned, the operation is available but only after authorization. ScheduleShutdown() schedules a shutdown operation type at @@ -359,7 +360,7 @@ node /org/freedesktop/login1 { cancelled is true if a shutdown operation was scheduled. SetWallMessage() sets the wall message (the message that will be sent out to - all terminals and stored in an + all terminals and stored in a utmp5 record) for a subsequent scheduled shutdown operation. The parameter wall_message specifies the shutdown reason (and may be empty) which will be included in the shutdown message. The parameter @@ -377,7 +378,7 @@ node /org/freedesktop/login1 { mode is either block or delay which encodes whether the inhibit shall be consider mandatory or whether it should just delay the operation to a certain maximum time. The call returns a file descriptor. The lock is released the moment this file - descriptor (and all its duplicates) are closed. For more information on the inhibition logic see + descriptor and all its duplicates are closed. For more information on the inhibition logic see Inhibitor Locks. @@ -385,21 +386,21 @@ node /org/freedesktop/login1 { Signals - Whenever the inhibition state or idle hint changes daemon PropertyChanged + Whenever the inhibition state or idle hint changes, PropertyChanged signals are sent out to which clients can subscribe. The SessionNew, SessionRemoved, - UserNew, UserRemoved, SeatNew, + UserNew, UserRemoved, SeatNew, and SeatRemoved signals are sent each time a session is created or removed, a user logs in or out, or a seat is added or removed. They each contain the ID of the object plus the object path. The PrepareForShutdown() and PrepareForSleep() signals - are sent right before (with the argument true) and after (with the argument + are sent right before (with the argument true) or after (with the argument false) the system goes down for reboot/poweroff and suspend/hibernate, - respetively. This may be used by applications to save data on disk, release memory, or do other jobs - that shall be done shortly before shutdown/sleep, in conjunction with delay inhibitor locks. After - completion of this work they should release their inhibition locks in order not to delay the operation + respectively. This may be used by applications to save data on disk, release memory, or do other jobs + that should be done shortly before shutdown/sleep, in conjunction with delay inhibitor locks. After + completion of this work they should release their inhibition locks in order to not delay the operation any further. For more information see Inhibitor Locks. @@ -424,7 +425,7 @@ node /org/freedesktop/login1 { The IdleHint property reflects the idle hint state of the system. If the - system is idle it might get into automatic suspend or shutdown, depending on configuration. + system is idle it might get into automatic suspend or shutdown depending on the configuration. IdleSinceHint and IdleSinceHintMonotonic encode the timestamps of the last change of the idle hint boolean, in CLOCK_REALTIME and @@ -432,26 +433,26 @@ node /org/freedesktop/login1 { The BlockInhibited and DelayInhibited properties encode the currently active locks of the respective modes. They are colon separated lists of - shutdown, sleep, idle (see above). + shutdown, sleep, and idle (see above). NCurrentSessions and NCurrentInhibitors contain the number of currently registered sessions and inhibitors. The BootLoaderEntries property contains a list of boot loader entries. - This includes boot loader entries defined in configuration, and any additional loader entries + This includes boot loader entries defined in configuration and any additional loader entries reported by the boot loader. See systemd-boot7 for more information. The PreparingForShutdown and PreparingForSleep boolean - properties are true between the time when the two PrepareForShutdown and - PrepareForSleep signals are sent, respectively. Note that these properties do not + properties are true during the interval between the two PrepareForShutdown and + PrepareForSleep signals respectively. Note that these properties do not send out PropertyChanged signals. - The RebootParameter property shows the value set with + The RebootParameter property shows the value set with the SetRebootParameter() method described above. - The ScheduledShutdown shows the value pair set with + ScheduledShutdown shows the value pair set with the ScheduleShutdown() method described above. RebootToFirmwareSetup, RebootToBootLoaderMenu, and @@ -460,11 +461,11 @@ node /org/freedesktop/login1 { SetRebootToBootLoaderMenu, or SetRebootToBootLoaderEntry. - WallMessage and EnableWallMessages properties reflect the - shutdown reasoson and wall message enablement switch which can be set with - SetWallMessage() method described above. + The WallMessage and EnableWallMessages properties reflect the + shutdown reason and wall message enablement switch which can be set with the + SetWallMessage() method described above. - Docked is true if the machine is connected to dock. + Docked is true if the machine is connected to a dock. LidClosed is true when the lid (of a laptop) is closed. OnExternalPower is true when the machine is connected to an external power supply. @@ -478,7 +479,7 @@ node /org/freedesktop/login1 { org.freedesktop.login1.set-user-linger privilege. AttachDevice() requires org.freedesktop.login1.attach-device and - FlushDevices() + FlushDevices() requires org.freedesktop.login1.flush-devices. PowerOff(), Reboot(), Halt(), Suspend(), Hibernate() require @@ -497,7 +498,7 @@ node /org/freedesktop/login1 { org.freedesktop.login1.hibernate, org.freedesktop.login1.hibernate-multiple-sessions, org.freedesktop.login1.hibernate-ignore-inhibit, - respectively, depending on whether there are other sessions around or active inhibits. + respectively depending on whether there are other sessions around or active inhibits are present. HybridSleep() and SuspendThenHibernate() use the same privileges as Hibernate(). SetRebootParameter() requires @@ -514,7 +515,7 @@ node /org/freedesktop/login1 { ScheduleShutdown and CancelScheduledShutdown require the same privileges (listed above) as the immediate poweroff/reboot/halt operations. - Inhibit() is protected via either one of + Inhibit() is protected via one of org.freedesktop.login1.inhibit-block-shutdown, org.freedesktop.login1.inhibit-delay-shutdown, org.freedesktop.login1.inhibit-block-sleep, @@ -527,7 +528,7 @@ node /org/freedesktop/login1 { type and mode taken. The interactive boolean parameters can be used to control whether PolicyKit - should interactively ask the user for authentication credentials if it needs to. + should interactively ask the user for authentication credentials if required. @@ -585,7 +586,7 @@ node /org/freedesktop/login1/seat/seat0 { Whenever ActiveSession, Sessions, CanGraphical, CanMultiSession and CanTTY - or the idle state changes PropertyChanged signals are sent out to which clients + or the idle state changes, PropertyChanged signals are sent out to which clients can subscribe. @@ -595,7 +596,7 @@ node /org/freedesktop/login1/seat/seat0 { The Id property encodes the ID of the seat. ActiveSession encodes the currently active session if there is one. It is a - structure consisting of session id and object path. + structure consisting of the session id and the object path. CanMultiSession encodes whether the session is multi-session capable, CanTTY whether it is suitable for text logins, CanGraphical @@ -604,7 +605,7 @@ node /org/freedesktop/login1/seat/seat0 { The Sessions property is an array of all current sessions of this seat, each encoded in a structure consisting of the ID and the object path. - The IdleHint, IdleSinceHint, + The IdleHint, IdleSinceHint, and IdleSinceHint properties encode the idle state, similar to the one exposed on the Manager object, but specific for this seat. @@ -660,14 +661,14 @@ node /org/freedesktop/login1/user/_1000 { Methods Terminate() and Kill() work similar to the - TerminateUser() and KillUser() calls on the manager + TerminateUser() and KillUser() methods on the manager object. Signals - Whenever Sessions or the idle state changes + Whenever Sessions or the idle state changes, PropertyChanged signals are sent out to which clients can subscribe. @@ -680,39 +681,39 @@ node /org/freedesktop/login1/user/_1000 { The Name property encodes the user name. Timestamp and TimestampMonotonic encode the login time of - the user in usec since the epoch, in the CLOCK_REALTIME and + the user in microseconds since the epoch, in the CLOCK_REALTIME and CLOCK_MONOTONIC clocks, respectively. RuntimePath encodes the runtime path of the user, - i.e. $XDG_RUNTIME_DIR, for details see the + i.e. $XDG_RUNTIME_DIR. For details see the XDG Basedir Specification . - Service contains the name of the user systemd service unit name of this - user. Each logged in user gets a user service unit assigned that runs a user systemd instance. This is + Service contains the unit name of the user systemd service of this + user. Each logged in user is assigned a user service that runs a user systemd instance. This is usually an instance of user@.service. - Slice contains the name of the user systemd slice unit name of this user. Each + Slice contains the unit name of the user systemd slice of this user. Each logged in user gets a private slice. - Display encodes which graphical session should be used as primary UI display - for the use. It is a structure encoding session ID and object path of the session to use. + Display encodes which graphical session should be used as the primary UI display + for the user. It is a structure encoding the session ID and the object path of the session to use. - State encodes the user state, one of offline, - lingering, online, active, + State encodes the user state and is one of offline, + lingering, online, active, or closing. See sd_uid_get_state3 for more information about the states. Sessions is an array of structures encoding all current sessions of the - user. Each structure consists of ID and object path. + user. Each structure consists of the ID and object path. - The IdleHint, IdleSinceHint, + The IdleHint, IdleSinceHint, and IdleSinceHintMonotonic properties encode the idle hint state of the user, similar to the Manager's properties, but specific for this user. - The Linger property shows whether lingering is enabled for the user. + The Linger property shows whether lingering is enabled for this user. @@ -812,41 +813,41 @@ node /org/freedesktop/login1/session/45 { Methods Terminate(), Activate(), Lock(), - Unlock(), Kill() work similarly to the respective calls on + Unlock(), and Kill() work similarly to the respective calls on the Manager object. - SetIdleHint() shall be called by the session object to update the idle state - of the session, whenever it changes. + SetIdleHint() is called by the session object to update the idle state + of the session whenever it changes. TakeControl() allows a process to take exclusive managed device - access-control for that session. Only one dbus-connection can be a controller for a given session at a - time. If the force argument is set (root only), an existing controller is kicked - out and replaced. Otherwise, this call fails if there is already a controller. Note that this call is - limited to dbus-users with the effective UID set to the User of the Session or root. - - ReleaseControl() drops control of a given session again. Closing the - dbus-connection implicitly releases control, too. See TakeControl() for more. This - also releases all devices for the controller that were requested via TakeDevice(). + access-control for that session. Only one D-Bus connection can be a controller for a given session at any + time. If the force argument is set (root only), an existing controller is kicked + out and replaced. Otherwise, this call fails if there is already a controller. Note that this call is + limited to D-Bus users with the effective UID set to the user of the session or root. + + ReleaseControl() drops control of a given session. Closing the + D-Bus connection implicitly releases control as well. See TakeControl() for more information. This + method also releases all devices for which the controller requested ownership via TakeDevice(). - TakeDevice() allows a session-controller to get a file-descriptor for a - specific device. Pass in the major and minor numbers of the character-device and - systemd-logind will return a file-descriptor for the device. Only a limited set of + TakeDevice() allows a session controller to get a file descriptor for a + specific device. Pass in the major and minor numbers of the character device and + systemd-logind will return a file descriptor for the device. Only a limited set of device-types is currently supported (but may be extended). systemd-logind - automatically mutes the file-descriptor if the session is inactive and resumes it once the session gets - active again. This guarantees that a session can only access session-devices if the session is + automatically mutes the file descriptor if the session is inactive and resumes it once the session is + activated again. This guarantees that a session can only access session devices if the session is active. Note that this revoke/resume mechanism is asynchronous and may happen at any given time. This only works on devices that are attached to the seat of the given session. A process is not required to - have direct access to the device-node. systemd-logind only requires you to be the + have direct access to the device node. systemd-logind only requires you to be the active session controller (see TakeControl()). Also note that any device can only be requested once. As long as you don't release it, further TakeDevice() calls will fail. ReleaseDevice() releases a device again (see TakeDevice()). This is also implicitly done by - ReleaseControl() or when closing the dbus-connection. + ReleaseControl() or when closing the D-Bus connection. - PauseDeviceComplete() allows a session-controller to synchronously pause a + PauseDeviceComplete() allows a session controller to synchronously pause a device after receiving a PauseDevice(pause) signal. Forced signals (or after an internal timeout) are automatically completed by systemd-logind asynchronously. @@ -857,7 +858,7 @@ node /org/freedesktop/login1/session/45 { unlocked. SetBrightness() may be used to set the display brightness. This is intended - to be used by the desktop environment, and allows unprivileged programs to access hardware settings in + to be used by the desktop environment and allows unprivileged programs to access hardware settings in a controlled way. The subsystem parameter specifies a kernel subsystem, either backlight or leds. The name parameter specifies a device name under the specified subsystem. The brightness parameter @@ -869,34 +870,33 @@ node /org/freedesktop/login1/session/45 { Signals - The active session-controller exclusively gets PauseDevice and + The active session controller exclusively gets PauseDevice and ResumeDevice events for any device it requested via TakeDevice(). They notify the controller whenever a device is paused or resumed. A - device is never resumed if a session is inactive. Also note that PauseDevice + device is never resumed if its session is inactive. Also note that PauseDevice signals are sent before the PropertyChanged signal for the Active state. The inverse is true for ResumeDevice. A device may remain paused for unknown reasons even though the Session is active. - A PauseDevice signal carries the major and minor and a string describing the - type as arguments. force means the device got paused by - systemd-logind already and this is only an asynchronous - notification. pause means systemd-logind tries to pause the - device and grants you limited amount of time to pause it. You must respond to this via - PauseDeviceComplete(). This synchronous pausing-mechanism is used for + A PauseDevice signal carries the major and minor numbers and a string describing the + type as arguments. force means the device was already paused by + systemd-logind and the signal is only an asynchronous + notification. pause means systemd-logind grants you a limited amount of time to pause the device. You must respond to this via + PauseDeviceComplete(). This synchronous pausing mechanism is used for backwards-compatibility to VTs and systemd-logind is free to not make use of it. It is also free to send a forced PauseDevice if you don't respond in a timely manner (or for any other reason). gone means the device was unplugged from the - system and you will no longer get any notifications about it. There is no reason to call + system and you will no longer get any notifications about it. There is no need to call ReleaseDevice(). You may call TakeDevice() again if a new - device gets the major+minor combination assigned. + device is assigned the major+minor combination. ResumeDevice is sent whenever a session is active and a device is - resumed. It carries the major/minor as arguments and provides a new open file-descriptor. You should + resumed. It carries the major/minor numbers as arguments and provides a new open file descriptor. You should switch to the new descriptor and close the old one. They are not guaranteed to have the same underlying - open-file-descriptor in the kernel (except for a limited set of device types). + open file descriptor in the kernel (except for a limited set of device types). - Whenever Active or the idle state changes + Whenever Active or the idle state changes, PropertyChanged signals are sent out to which clients can subscribe. Lock/Unlock is sent when the session is asked to be @@ -911,18 +911,18 @@ node /org/freedesktop/login1/session/45 { Id encodes the session ID. User encodes the user ID of the user this session belongs to. This is a - structure encoding the Unix UID and the object path. + structure consisting of the Unix UID and the object path. Name encodes the user name. - Timestamp and TimestampMonotonic encode the usec timestamp + Timestamp and TimestampMonotonic encode the microseconds since the epoch when the session was created, in CLOCK_REALTIME or CLOCK_MONOTONIC, respectively. VTNr encodes the virtual terminal number of the session if there is any, 0 otherwise. - Seat encodes the seat this session belongs to, if there is any. This is a + Seat encodes the seat this session belongs to if there is any. This is a structure consisting of the ID and the seat object path. TTY encodes the kernel TTY path of the session if this is a text login. If not @@ -945,7 +945,7 @@ node /org/freedesktop/login1/session/45 { Leader encodes the PID of the process that registered the session. - Audit encodes the Kernel Audit session ID of the session, if auditing is + Audit encodes the Kernel Audit session ID of the session if auditing is available. Type encodes the session type. It's one of unspecified (for @@ -953,23 +953,23 @@ node /org/freedesktop/login1/session/45 { x11/mir/wayland (for graphical logins). Class encodes the session class. It's one of user (for - normal user sessions), greeter (for display manager pseudo-sessions), + normal user sessions), greeter (for display manager pseudo-sessions), or lock-screen (for display lock screens). Active is a boolean that is true if the session is active, i.e. currently in the - foreground. This field is semi-redundant due to State. + foreground. This field is semi-redundant due to State. State encodes the session state and one of online, - active, closing. See + active, or closing. See sd_session_get_state3 for more information about the states. - IdleHint, IdleSinceHint, + IdleHint, IdleSinceHint, and IdleSinceHintMonotonic encapsulate the idle hint state of this session, similarly to how the respective properties on the manager object do it for the whole system. - LockedHint shows the locked hint state of this session, as set by - SetLockedHint() described above. + LockedHint shows the locked hint state of this session, as set by the + SetLockedHint() method described above. diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index 1c9c41f04c1..0b35ab43131 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -177,27 +177,27 @@ node /org/freedesktop/machine1 { Methods GetMachine() may be used to get the machine object path for the machine with - the specified name. Similarly, GetMachineByPID() get the machine object the + the specified name. Similarly, GetMachineByPID() gets the machine object the specified PID belongs to if there is any. - GetImage() may be used to the the image object path for the image with the + GetImage() may be used to get the image object path of the image with the specified name. - ListMachines() returns an array with all currently registered machines. The + ListMachines() returns an array of all currently registered machines. The structures in the array consist of the following fields: machine name, machine class, an identifier for the service that registered the machine and the machine object path. - ListImages() returns an array with all currently known images. The + ListImages() returns an array of all currently known images. The structures in the array consist of the following fields: image name, type, read-only flag, creation - time, modification time, current disk space, image object path. + time, modification time, current disk space, and image object path. CreateMachine() may be used to register a new virtual machine or container - with systemd-machined, creating a scope unit for it. This takes as arguments: a - machine name chosen by the registrar, an optional UUID as 32 byte array, a string that identifies the + with systemd-machined, creating a scope unit for it. It accepts the following arguments: a + machine name chosen by the registrar, an optional UUID as a 32 byte array, a string that identifies the service that registers the machine, a class string, the PID of the leader process of the machine, an optional root directory of the container, and an array of additional properties to use for the scope - registration. The virtual machine name must be suitable as hostname, and hence should follow the usual - DNS hostname rules, as well as Linux hostname restrictions. Specifically: only 7 Bit ASCII is + registration. The virtual machine name must be suitable as a hostname, and hence should follow the usual + DNS hostname rules, as well as the Linux hostname restrictions. Specifically, only 7 bit ASCII is permitted, a maximum length of 64 characters is enforced, only characters from the set a-zA-Z0-9-_. are allowed, the name may not begin with a dot, and it may not contain two dots immediately following each other. Container and VM managers should ideally use the hostname @@ -206,51 +206,51 @@ node /org/freedesktop/machine1 { nss-mymachines8. If a container manager needs to embed characters outside of the indicated range, escaping is required, possibly using _ as the escape character. Another (somewhat natural) option would be - to utilize Internet IDNA encoding. The UUID is passed as 32 byte array, or if no suitable UUID is - available an empty array (zero length) or zeroed out array shall be passed. The UUID should identify - the virtual machine/container uniquely, and should ideally be the same one as + to utilize Internet IDNA encoding. The UUID is passed as a 32 byte array or, if no suitable UUID is + available, an empty array (zero length) or zeroed out array shall be passed. The UUID should identify + the virtual machine/container uniquely and should ideally be the same UUID that /etc/machine-id in the VM/container is initialized from. The service string can be free-form, but it is recommended to pass a short lowercase identifier like systemd-nspawn, libvirt-lxc or similar. The class string should be either container or vm indicating whether the machine to register is of the respective class. The leader PID should be the host PID of the init process of the - container, or the encapsulating process of the VM. If the root directory of the container is known and - available in the host's hierarchy, it should be passed, otherwise use the empty string. Finally, the + container or the encapsulating process of the VM. If the root directory of the container is known and + available in the host's hierarchy, it should be passed. Otherwise, pass the empty string instead. Finally, the scope properties are passed as array in the same way as to PID1's - StartTransientUnit(). This method call will internally register a transient scope - unit for the calling client (utilizing the passed scope_properties), and move the leader PID into - it. The call returns an object path for the registered machine object, implementing the + StartTransientUnit() method. Calling this method will internally register a transient scope + unit for the calling client (utilizing the passed scope_properties) and move the leader PID into + it. The call returns an object path for the registered machine object that implements the org.freedesktop.machine1.Machine interface (see below). Also see the New Control Group - Interfaces for details about scope units, and how to alter resource control settings on the + Interfaces for details about scope units and how to alter resource control settings on the created machine at runtime. - RegisterMachine() is similar to CreateMachine(), - however only registers a machine, but does not create a scope unit for it. The caller's unit will be - registered instead. This call is only recommended to be used for container or VM managers that are run + RegisterMachine() is similar to CreateMachine(). + However, it only registers a machine and does not create a scope unit for it. Instead, the caller's unit is + registered. We recommend to only use this method for container or VM managers that are run multiple times, one instance for each container/VM they manage, and are invoked as system services. CreateMachineWithNetwork() and RegisterMachineWithNetwork() are similar to CreateMachine() and RegisterMachine() but take an extra argument: an array of network interface - indexes that point towards the virtual machine or container. The interface indexes should reference one - or more network interfaces on the host that can be used to communicate with the guest. Commonly the - passed interface index refers to the host side of a "veth" link (in case of containers), or a - "tun"/"tap" link (in case of VMs) or the host side of a bridge interface that bridges access to the + indices that point towards the virtual machine or container. The interface indices should reference one + or more network interfaces on the host that can be used to communicate with the guest. Commonly, the + passed interface index refers to the host side of a "veth" link (in case of containers), a + "tun"/"tap" link (in case of VMs), or the host side of a bridge interface that bridges access to the VM/container interfaces. Specifying this information is useful to enable support for link-local IPv6 - communication to the machines, since the scope field of sockaddr_in6 can be initialized by the + communication to the machines since the scope field of sockaddr_in6 can be initialized by the specified ifindex. nss-mymachines8 makes use of this information. - KillMachine() sends a UNIX signal to the machine's processes. It takes a + KillMachine() sends a UNIX signal to the machine's processes. As its arguments, it takes a machine name (as originally passed to CreateMachine() or returned by - ListMachines()). An identifier what precisely to send the signal to being either - leader or all, plus a numeric UNIX signal integer. + ListMachines()), an identifier that specifies what precisely to send the signal to (either + leader or all), and a numeric UNIX signal integer. TerminateMachine() terminates a virtual machine, killing its processes. It - takes a machine name as argument. + takes a machine name as its only argument. GetMachineAddresses() retrieves the IP addresses of a container. This call returns an array of pairs consisting of an address family specifier (AF_INET or @@ -258,41 +258,41 @@ node /org/freedesktop/machine1 { containers that make use of network namespacing. GetMachineOSRelease() retrieves the OS release information of a - container. This call returns an array of key value pairs read from the + container. This method returns an array of key value pairs read from the os-release5 file in - the container, and is useful to identify the operating system used in a container. + the container and is useful to identify the operating system used in a container. OpenMachinePTY() allocates a pseudo TTY in the container and returns a file descriptor and its path. This is equivalent to transitioning into the container and invoking posix_openpt3. OpenMachineLogin() allocates a pseudo TTY in the container and ensures that - a getty loging prompt of the container is running on the other end. It returns the file descriptor of - the PTY plus the PTY path. This is useful for acquiring a pty with a login prompt from the + a getty login prompt of the container is running on the other end. It returns the file descriptor of + the PTY and the PTY path. This is useful for acquiring a pty with a login prompt from the container. OpenMachineShell() allocates a pseudo TTY in the container, as the specified - user, and invokes an executable of the specified path, with a list of arguments (starting from - argv[0]), and an environment block. It then returns the file descriptor of the PTY plus the PTY + user, and invokes the executable at the specified path with a list of arguments (starting from + argv[0]) and an environment block. It then returns the file descriptor of the PTY and the PTY path. BindMountMachine() bind mounts a file or directory from the host into the - container. Takes a machine name, the source directory on the host, and the destination directory in the - container as argument. Also takes two booleans, one indicating whether the bind mount shall be + container. Its arguments consist of a machine name, the source directory on the host, the destination directory in the + container, and two booleans, one indicating whether the bind mount shall be read-only, the other indicating whether the destination mount point shall be created first, if it is missing. CopyFromMachine() copies files or directories from a container into the - host. Takes a container name, a source directory in the container and a destination directory on the - host as argument. CopyToMachine() does the opposite and copies files from a source + host. It takes a container name, a source directory in the container and a destination directory on the + host as arguments. CopyToMachine() does the opposite and copies files from a source directory on the host into a destination directory in the container. - RemoveImage() removes the image by the specified name. + RemoveImage() removes the image with the specified name. - RenameImage() renames the specified image to a new name. + RenameImage() renames the specified image. - CloneImage() clones the specified image under a new name. Also takes a - boolean argument indicating whether the resuling image shall be read-only or not. + CloneImage() clones the specified image under a new name. It also takes a + boolean argument indicating whether the resulting image shall be read-only or not. MarkImageReadOnly() toggles the read-only flag of an image. @@ -301,15 +301,15 @@ node /org/freedesktop/machine1 { SetImageLimit() sets a per-image quota limit. MapFromMachineUser(), MapToMachineUser(), - MapFromMachineGroup(), MapToMachineGroup() may be used to map - UIDs/GIDs from the host user namespace to a container namespace or back. + MapFromMachineGroup(), and MapToMachineGroup() may be used to map + UIDs/GIDs from the host user namespace to a container user namespace or vice versa. Signals MachineNew and MachineRemoved are sent whenever a new - machine is registered or removed. These signals carry the machine name plus the object path to the + machine is registered or removed. These signals carry the machine name and the object path to the corresponding org.freedesktop.machine1.Machine interface (see below). @@ -393,47 +393,47 @@ node /org/freedesktop/machine1/machine/rawhide { Methods - Terminate() and Kill() terminate/kill the machine, and + Terminate() and Kill() terminate/kill the machine. These methods take the same arguments as TerminateMachine() and - KillMachine() on the Manager interface. + KillMachine() on the Manager interface, respectively. - GetAddresses() and GetOSRelease() get IP address and OS - release information from the machine, and take the same arguments as + GetAddresses() and GetOSRelease() get the IP address and OS + release information from the machine. These methods take the same arguments as GetMachineAddresses() and GetMachineOSRelease() of the - Manager interface, described above. + Manager interface, respectively. Properties - Name is the machine name, as it was passed in during registration with + Name is the machine name as it was passed in during registration with CreateMachine() on the manager object. Id is the machine UUID. Timestamp and TimestampMonotonic are the realtime and - monotonic timestamps when the virtual machines where created. + monotonic timestamps when the virtual machines where created in microseconds since the epoch. - Service contains a short string identifying the registering service, as passed + Service contains a short string identifying the registering service as passed in during registration of the machine. Unit is the systemd scope or service unit name for the machine. Leader is the PID of the leader process of the machine. - Class is the class of the machine and either the string "vm" (for real VMs + Class is the class of the machine and is either the string "vm" (for real VMs based on virtualized hardware) or "container" (for light-weight userspace virtualization sharing the same kernel as the host). - RootDirectory is the root directory of the container if that is known and - applicable, or the empty string. + RootDirectory is the root directory of the container if it is known and + applicable or the empty string. - NetworkInterfaces contains an array of network interface indexes that point - towards the container or VM or the host. For details about this information see the description of + NetworkInterfaces contains an array of network interface indices that point + towards the container, the VM or the host. For details about this information see the description of CreateMachineWithNetwork() above. - State is the state of the machine, and one of opening, - running, closing. Note that the state machine is not considered + State is the state of the machine and is one of opening, + running, or closing. Note that the state machine is not considered part of the API and states might be removed or added without this being considered API breakage. diff --git a/man/org.freedesktop.resolve1.xml b/man/org.freedesktop.resolve1.xml index d150ee2a5f9..83ab0ed3d95 100644 --- a/man/org.freedesktop.resolve1.xml +++ b/man/org.freedesktop.resolve1.xml @@ -29,14 +29,13 @@ systemd-resolved.service8 - is a system service that provides host name resolution and caching using DNS, LLMNR, and mDNS. It also + is a system service that provides hostname resolution and caching using DNS, LLMNR, and mDNS. It also does DNSSEC validation. This page describes the resolve semantics and the D-Bus interface. This page contains an API reference only. If you are looking for a longer explanation how to use this API, please consult - Writing Network Configuration Managers - and + Writing Network Configuration Managers and Writing Resolver Clients. @@ -184,37 +183,35 @@ node /org/freedesktop/resolve1 { Methods - ResolveHostname() takes a hostname and acquires one or more IP addresses for - it. As parameters it takes the Linux network interface index to execute the query on, or 0 if it may be + ResolveHostname() takes a hostname and resolves it to one or more IP addresses. + As parameters it takes the Linux network interface index to execute the query on, or 0 if it may be done on any suitable interface. The name parameter specifies the hostname to - resolve. Note that IDNA conversion is applied to this name when necessary, and when it is resolved via - Unicast DNS, but not for resolution via LLMNR or MulticastDNS. The family parameter - specifies the address family of the IP address to retrieve. It may be AF_INET, - AF_INET6 or AF_UNSPEC, to request addresses of a specific - family. If AF_UNSPEC is specified (recommended), both kinds are retrieved, subject + resolve. Note that if required, IDNA conversion is applied to this name unless it is resolved via LLMNR or MulticastDNS. The family parameter + limits the results to a specific address family. It may be AF_INET, + AF_INET6 or AF_UNSPEC. If AF_UNSPEC is specified (recommended), both kinds are retrieved, subject to local network configuration (i.e. if no local, routable IPv6 address is found, no IPv6 address is - retrieved; and similarly for IPv4). A 64-bit flags field may be used to alter + retrieved; and similarly for IPv4). A 64-bit flags field may be used to alter the behaviour of the resolver operation (see below). The method returns an array of address records. Each - address record consists of an interface index the address belongs to, an address family as well as a + address record consists of the interface index the address belongs to, an address family as well as a byte array with the actual IP address data (which either has 4 or 16 elements, depending on the address family). The returned address family will be one of AF_INET or AF_INET6. For IPv6, the returned address interface index should be used to - initialize the .sin6_scope_id field of a struct sockaddr_in6, to permit + initialize the .sin6_scope_id field of a struct sockaddr_in6 instance to permit support for resolution to link-local IP addresses. The address array is followed by the canonical name - of the host, which may or may not be identical to the name looked up. Finally, a 64-bit - flags field is returned, that is defined similarly to the flags + of the host, which may or may not be identical to the resolved hostname. Finally, a 64-bit + flags field is returned that is defined similarly to the flags field that was passed in, but contains information about the resolved data (see below). If the hostname - passed in is an IPv4 or IPv6 address formatted as string, it is parsed, and the result returned. In - this case no network communication is done. + passed in is an IPv4 or IPv6 address formatted as string, it is parsed, and the result is returned. In + this case, no network communication is done. ResolveAddress() executes the reverse operation: it takes an IP address and acquires one or more hostnames for it. As parameters it takes the interface index to execute the query on, or 0 if all suitable interfaces are OK. The family - parameter indicates the address family of the IP address to resolve, it may be either + parameter indicates the address family of the IP address to resolve. It may be either AF_INET or AF_INET6. The address parameter - takes the raw IP address data (as either 4 or 16 byte array). The flags input - parameter may be used to alter the resolver operation (see below). The call returns an array of name - records, consisting of an interface index plus the name each. The flags output + takes the raw IP address data (as either a 4 or 16 byte array). The flags input + parameter may be used to alter the resolver operation (see below). The method returns an array of name + records, each consisting of an interface index and a hostname. The flags output field contains additional information about the resolver operation (see below). ResolveRecord() takes a DNS resource record (RR) type, class and name, and @@ -223,7 +220,7 @@ node /org/freedesktop/resolve1 { any suitable interface. The name parameter specifies the RR domain name to look up (no IDNA conversion is applied), followed by the 16-bit class and type fields (which may be ANY). Finally, a flags field may be passed in to alter behaviour of the look-up (see - below). On return an array of RR items is returned. Each array entry consists of the network interface + below). On completion, an array of RR items is returned. Each array entry consists of the network interface index the RR was discovered on, the type and class field of the RR found, and a byte array of the raw RR discovered. The raw RR data starts with the RR's domain name, in the original casing, followed by the RR type, class, TTL and RDATA, in the binary format documented in @@ -231,91 +228,91 @@ node /org/freedesktop/resolve1 { compression in the payload (such as MX or PTR), the compression is expanded in the returned data. - Note that the class field has to be specified as IN or ANY currently, and specifying a different + Note that currently, the class field has to be specified as IN or ANY. Specifying a different class will return an error indicating that look-ups of this kind are unsupported. Similarly, some - special types are not supported either (AXFR, OPT, …). While systmed-resolved parses and validates resource - record of many types, it is crucial that clients using this API understand that the RR data originates + special types are not supported either (AXFR, OPT, …). While systemd-resolved parses and validates resource + records of many types, it is crucial that clients using this API understand that the RR data originates from the network and should be thoroughly validated before use. - ResolveService() may be used to resolve a DNS SRV service record, as the + ResolveService() may be used to resolve a DNS SRV service record, as well as the hostnames referenced in it, and possibly an accompanying DNS-SD TXT record containing additional - service metadata. The primary benefit of using this call over ResolveRecord() + service metadata. The primary benefit of using this method over ResolveRecord() specifying the SRV type is that it will resolve the SRV and TXT RRs as well as the hostnames referenced in the SRV in a single operation. As parameters it takes a Linux network interface index, a service - name, a service type and a service domain. The call may be invoked in three different modes: + name, a service type and a service domain. This method may be invoked in three different modes: To resolve a DNS-SD service, specify the service name (e.g. Lennart's Files), the service type (e.g. _webdav._tcp) and the domain to search in - (e.g. local) in the three service parameters. The service name must be in UTF-8 + (e.g. local) as the three service parameters. The service name must be in UTF-8 format, and no IDNA conversion is applied to it in this mode (as mandated by the DNS-SD - specifications). However, if necessary IDNA conversion is applied to the domain parameter. + specifications). However, if necessary, IDNA conversion is applied to the domain parameter. - To resolve a plain SRV record, set the service name parameter to the empty string, + To resolve a plain SRV record, set the service name parameter to the empty string and set the service type and domain properly. (IDNA conversion is applied to the domain, if necessary.) - Alternatively, leave both the service name and type empty, and specify the full + Alternatively, leave both the service name and type empty and specify the full domain name of the SRV record (i.e. prefixed with the service type) in the domain parameter. (No IDNA coversion is applied in this mode.) - The family parameter of the ResolveService() call encodes + The family parameter of the ResolveService() method encodes the desired family of the addresses to resolve (use AF_INET, - AF_INET6, AF_UNSPEC), if this is enabled (Use the + AF_INET6, or AF_UNSPEC). If this is enabled (Use the NO_ADDRESS flag to turn address resolution off, see below). The flags parameter takes a couple of flags that may be used to alter the resolver operation. - On return, ResolveService() returns an array of SRV record structures. Each - item consists of the priority, weight and port fields and the hostname to contact, as encoded in the SRV - record. Immediately following is an array with the addresses of this hostname, with each item consisting + On completion, ResolveService() returns an array of SRV record structures. Each + items consisting of the priority, weight and port fields as well as the hostname to contact, as encoded in the SRV + record. Immediately following is an array of the addresses of this hostname, with each item consisting of the interface index, the address family and the address data in a byte array. This address array is - followed with the canonicalized hostname. After this array of SRV record structures an array of byte - arrays follows, that encodes the TXT RR strings, in case DNS-SD look-ups are enabled. The next parameters + followed by the canonicalized hostname. After this array of SRV record structures an array of byte + arrays follows that encodes the TXT RR strings, in case DNS-SD look-ups are enabled. The next parameters are the canonical service name, type and domain. This may or may not be identical to the parameters passed in. Finally, a flags field is returned that contains information about the resolver operation performed. - The ResetStatistics() method resets to zero the various statistics counters - systmed-resolved maintains. (For details, see the statistics properties below.) + The ResetStatistics() method resets the various statistics counters that + systemd-resolved maintains to zero. (For details, see the statistics properties below.) The GetLink() method takes a network interface index and returns the object path to the org.freedesktop.resolve1.Link object corresponding to it. The SetLinkDNS() method sets the DNS servers to use on a specific - interface. This call (and the following ones) may be used by network management software to configure + interface. This method (and the following ones) may be used by network management software to configure per-interface DNS settings. It takes a network interface index as well as an array of DNS server IP address records. Each array item consists of an address family (either AF_INET or AF_INET6), followed by a 4-byte or 16-byte array with the raw address data. This - call is a one-call shortcut for retrieving the Link object for a network interface using - GetLink() (see above) and then invoking the SetDNS() call + method is a one-step shortcut for retrieving the Link object for a network interface using + GetLink() (see above) and then invoking the SetDNS() method (see below) on it. - Network management software integrating with systmed-resolved is recommended - to invoke this method (and the five below) after the interface appeared in the kernel (and thus after a - network interface index has been assigned), but before the network interfaces is activated (set - IFF_UP on) so that all settings take effect during the full time the network - interface is up. It is safe to alter settings while the interface is up, however. Use the + Network management software integrating with systemd-resolved should + call this method (and the five below) after the interface appeared in the kernel (and thus after a + network interface index has been assigned), but before the network interfaces is activated + (IFF_UP set) so that all settings take effect during the full time the network + interface is up. It is safe to alter settings while the interface is up, however. Use RevertLink() (described below) to reset all per-interface settings. The SetLinkDomains() method sets the search and routing domains to use on a - specific network interface for DNS look-ups. It take a network interface index plus an array of domains, - each with a boolean parameter indicating whether the specified domain shall be used as search domain - (false), or just as routing domain (true). Search domains are used for qualifying single-label names into + specific network interface for DNS look-ups. It takes a network interface index and an array of domains, + each with a boolean parameter indicating whether the specified domain shall be used as a search domain + (false), or just as a routing domain (true). Search domains are used for qualifying single-label names into FQDN when looking up hostnames, as well as for making routing decisions on which interface to send - queries ending in the domain to. Routing domains are not used for single-label name qualification, and - are only used for routing decisions. Pass the search domains in the order they shall be used. + queries ending in the domain to. Routing domains are only used for routing decisions and not used for single-label + name qualification. Pass the search domains in the order they should be used. The SetLinkLLMNR() method enables or disables LLMNR support on a specific - network interface. It takes a network interface index as well as a string that either may be empty, + network interface. It takes a network interface index as well as a string that may either be empty or one of yes, no or resolve. If empty, the systemd-wide - default LLMNR setting is used. If yes LLMNR is used for resolution of single-label - names, and the local hostname is registered on all local LANs for LLMNR resolution by peers. If - no LLMNR is turned off fully on this interface. If resolve LLMNR + default LLMNR setting is used. If yes, LLMNR is used for resolution of single-label + names and the local hostname is registered on all local LANs for LLMNR resolution by peers. If + no, LLMNR is turned off fully on this interface. If resolve, LLMNR is only enabled for resolving names, but the local host name is not registered for other peers to use. @@ -324,26 +321,26 @@ node /org/freedesktop/resolve1 { described above. The SetLinkDNSSEC() method enables or disables DNSSEC validation on a - specific network interface. It takes a network interface index as well as a string that either may be - empty, yes, no or allow-downgrade. If empty, - the system-wide default DNSSEC setting is used. If yes full DNSSEC validation is - done for all look-ups. If the selected DNS server does not support DNSSEC, look-ups will fail if this - mode is used. If no DNSSEC validation is fully disabled. If - allow-downgrade DNSSEC validation is enabled, but is turned off automatically if the + specific network interface. It takes a network interface index as well as a string that may either be + empty or one of yes, no, or allow-downgrade. When + empty, the system-wide default DNSSEC setting is used. If yes, full DNSSEC validation + is done for all look-ups. If the selected DNS server does not support DNSSEC, look-ups will fail if this + mode is used. If no, DNSSEC validation is fully disabled. If + allow-downgrade, DNSSEC validation is enabled, but is turned off automatically if the selected server does not support it (thus opening up behaviour to downgrade attacks). Note that DNSSEC only applies to traditional DNS, not to LLMNR or MulticastDNS. The SetLinkDNSSECNegativeTrustAnchors() method may be used to configure DNSSEC Negative Trust Anchors (NTAs) for a specific network interface. It takes a network interface index and a - list of domains as parameters. + list of domains as arguments. The RevertLink() method may be used to revert all per-link settings done with - the six calls described above to the defaults again. + the six methods described above to the defaults again. The Flags Parameter - The four calls above accept and return a 64-bit flags value. In most cases passing 0 is sufficient + The four methods above accept and return a 64-bit flags value. In most cases passing 0 is sufficient and recommended. However, the following flags are defined to alter the look-up: @@ -363,33 +360,33 @@ node /org/freedesktop/resolve1 { classic unicast DNS, LLMNR via IPv4/UDP and IPv6/UDP respectively, as well as MulticastDNS via IPv4/UDP and IPv6/UDP. If all of these five bits are off on input (which is strongly recommended) the look-up will be done via all suitable protocols for the specific look-up. Note that these flags - operate as filter only, but cannot force a look-up to be done via a protocol. Specifically, systmed-resolved + operate as filter only, but cannot force a look-up to be done via a protocol. Specifically, systemd-resolved will only route look-ups within the .local TLD to MulticastDNS (plus some reverse look-up address domains), and single-label names to LLMNR (plus some reverse address lookup domains). It will route neither of these to Unicast DNS servers. Also, it will do LLMNR and Multicast DNS only on interfaces - suitable for multicasting. + suitable for multicast. - On output these five flags indicate which protocol was used to execute the operation, and hence + On output, these five flags indicate which protocol was used to execute the operation, and hence where the data was found. - The primary use case for these five flags are follow-up look-ups based on DNS data retrieved + The primary use cases for these five flags are follow-up look-ups based on DNS data retrieved earlier. In this case it is often a good idea to limit the follow-up look-up to the protocol that was - used to discover the first DNS data look-up. + used to discover the first DNS result. The NO_CNAME flag controls whether CNAME/DNAME resource records shall be followed during the look-up. This flag is only available at input, none of the functions will return it on output. If a - CNAME/DNAME RR is discovered while resolving a hostname an error is returned instead. By default, + CNAME/DNAME RR is discovered while resolving a hostname, an error is returned instead. By default, when the flag is off, CNAME/DNAME RRs are followed. - The NO_TXT and NO_ADDRESS flags influence operation of the - ResolveService() call only. They are only defined for input, not output. If - NO_TXT set, the DNS-SD TXT RR look-up is not done in the same operation. If NO_ADDRESS is specified + The NO_TXT and NO_ADDRESS flags only influence operation of the + ResolveService() method. They are only defined for input, not output. If + NO_TXT set, the DNS-SD TXT RR look-up is not done in the same operation. If NO_ADDRESS is specified, the hostnames discovered are not implicitly translated to their addresses. The NO_SEARCH flag turns off the search domain logic. It is only defined for input in ResolveHostname(). When specified, single-label hostnames are not qualified using defined search domains, if any are configured. Note that ResolveRecord() - will not qualify single-label domain names using search domains in any case. Also note that + will never qualify single-label domain names using search domains. Also note that multi-label hostnames are never subject to search list expansion. The AUTHENTICATED bit is defined only in the output flags of the four functions. If set, the @@ -398,7 +395,7 @@ node /org/freedesktop/resolve1 { synthesized data, such as localhost or data from /etc/hosts. Moreover, it is set for all LLMNR or mDNS RRs which originate from the local host. Applications that require authenticated RR data for operation should check this flag before - trusting the data. Not that systmed-resolved will not return invalidated data in any case, hence this flag + trusting the data. Note that systemd-resolved will never return invalidated data, hence this flag simply allows to discern the cases where data is known to be trustable, or where there is proof that the data is "rightfully" unauthenticated (which includes cases where the underlying protocol or server does not support authenticating data). @@ -414,8 +411,8 @@ node /org/freedesktop/resolve1 { gethostname3, but may differ if a conflict is detected on the network. - DNS contains an array containing all DNS servers currently used by - systmed-resolved. It contains similar information as the DNS server data written to + DNS contains an array of all DNS servers currently used by + systemd-resolved. It contains similar information as the DNS server data written to /run/systemd/resolve/resolv.conf. Each structure in the array consists of a numeric network interface index, an address family, and a byte array containing the DNS server address (either 4 bytes in length for IPv4 or 16 bytes in lengths for IPv6). The array contains DNS servers configured system-wide, @@ -424,26 +421,26 @@ node /org/freedesktop/resolve1 { per-interface DNS server information either retrieved from systemd-networkd8, or configured by external software via SetLinkDNS() (see above). The network - interface index will be 0 for the system-wide configured services, and non-zero for the per-link + interface index will be 0 for the system-wide configured services and non-zero for the per-link servers. - Similarly, the Domains property contains an array containing all search and - routing domains currently used by systmed-resolved. Each entry consists of a network interface index (again, 0 + Similarly, the Domains property contains an array of all search and + routing domains currently used by systemd-resolved. Each entry consists of a network interface index (again, 0 encodes system-wide entries), the actual domain name, and whether the entry is used only for routing - (true), or for both routing and searching (false). + (true) or for both routing and searching (false). The TransactionStatistics property contains information about the number of - transactions systmed-resolved has been processing. It contains a pair of unsigned 64-bit counters, the first + transactions systemd-resolved has processed. It contains a pair of unsigned 64-bit counters, the first containing the number of currently ongoing transactions, the second the number of total transactions - systmed-resolved is processing or has processed. The latter value may be reset using the - ResetStatistics() call described above. Note that the number of transaction does - not directly map to the number of resolver bus calls issued. While simple look-ups usually require a + systemd-resolved is processing or has processed. The latter value may be reset using the + ResetStatistics() method described above. Note that the number of transactions does + not directly map to the number of issued resolver bus method calls. While simple look-ups usually require a single transaction only, more complex look-ups might result in more, for example when CNAMEs or DNSSEC are in use. The CacheStatistics property contains information about the executed cache operations so far. It exposes three 64-bit counters: the first being the total number of current cache - entries (both positive and negative), the second number of cache hits, and the third the number of + entries (both positive and negative), the second the number of cache hits, and the third the number of cache misses. The latter counters may be reset using ResetStatistics() (see above). @@ -453,15 +450,15 @@ node /org/freedesktop/resolve1 { each non-existance proof. The secure counter is increased for each operation that successfully verified a signed reply, the insecure counter is increased for each operation that successfully verified that an unsigned reply is rightfully unsigned. The bogus counter is increased for each operation where the - validation did not check out, and the data is likely to have been tempered with. Finally the + validation did not check out and the data is likely to have been tempered with. Finally the indeterminate counter is increased for each operation which did not complete because the necessary keys could not be acquired or the cryptographic algorithms were unknown. The DNSSECSupported boolean property reports whether DNSSEC is enabled and the selected DNS servers support it. It combines information about system-wide and per-link DNS settings (see below), and only reports true if DNSSEC is enabled and supported on every interface for - which DNS is configured and for the system-wide settings if there are any. Note that systmed-resolved assumes - DNSSEC is supported by DNS servers until it verified that this is not the case. Thus, the reported + which DNS is configured and for the system-wide settings if there are any. Note that systemd-resolved assumes + DNSSEC is supported by DNS servers until it verifies that this is not the case. Thus, the reported value may initially be true, until the first transactions are executed. @@ -546,7 +543,7 @@ node /org/freedesktop/resolve1/link/_34 { - For each Linux network interface a "Link" object is created, which exposes per-link DNS + For each Linux network interface a "Link" object is created which exposes per-link DNS configuration and state. Use GetLink() on the Manager interface to retrieve the object path for a link object given the network interface index (see above). @@ -556,32 +553,32 @@ node /org/freedesktop/resolve1/link/_34 { The various methods exposed by the Link interface are equivalent to their similarly named counterparts on the Manager interface. e.g. SetDNS() on the Link object maps to SetLinkDNS() on the Manager object, the main difference being that the later - expects an interface index to be speicified. Invoking the calls on the Manager interface has the + expects an interface index to be specified. Invoking the methods on the Manager interface has the benefit of reducing roundtrips, as it is not necessary to first request the Link object path via - GetLink() before invoking the methods. For further details on these calls see the - Manager documentation above. + GetLink() before invoking the methods. For further details on these methods see + the Manager documentation above. Properties ScopesMask defines which resolver scopes are currently active on this - interface. This 64-bit unsigned integer field is a bit mask, consisting of a subset of the bits as the + interface. This 64-bit unsigned integer field is a bit mask consisting of a subset of the bits of the flags parameter describe above. Specifically, it may have the DNS, LLMNR and MDNS bits (the latter in IPv4 and IPv6 flavours) set. Each individual bit is set when the protocol applies to a specific interface and is enabled for it. It is unset otherwise. Specifically, a multicast-capable interface in - "UP" state with an IP address is suitable for LLMNR or MulticastDNS, and any interface that is UP and + the "UP" state with an IP address is suitable for LLMNR or MulticastDNS, and any interface that is UP and has an IP address is suitable for DNS. Note the relationship of the bits exposed here with the LLMNR and MulticastDNS properties also exposed on the Link interface. The latter expose what is *configured* to be used on the interface, the former expose what is actually used on the interface, taking into account the abilities of the interface. DNSSECSupported exposes a boolean field that indicates whether DNSSEC is - currently configured and in use on the interface. Note that if DNSSEC is enabled on an interface it is + currently configured and in use on the interface. Note that if DNSSEC is enabled on an interface, it is assumed available until it is detected that the configured server does not actually support it. Thus, this property may initially report that DNSSEC is supported on an interface. - The other properties reflect the state of the various configuration settings for the link, which + The other properties reflect the state of the various configuration settings for the link which may be set with the various methods calls such as SetDNS() or SetLLMNR(). @@ -589,17 +586,17 @@ node /org/freedesktop/resolve1/link/_34 { Common Errors - Many bus calls systmed-resolved exposes (in particular the resolver calls such - as ResolveHostname() on the Manager interface) return + Many bus methods systemd-resolved exposes (in particular the resolver methods such + as ResolveHostname() on the Manager interface) may return some of the following errors: org.freedesktop.resolve1.NoNameServers - No suitable DNS servers have been found to resolve a request. + No suitable DNS servers were found to resolve a request. org.freedesktop.resolve1.InvalidReply - A response from the selected DNS server could not be understood. + A response from the selected DNS server was not understood. org.freedesktop.resolve1.NoSuchRR @@ -611,7 +608,7 @@ node /org/freedesktop/resolve1/link/_34 { org.freedesktop.resolve1.Aborted - The look-up was aborted, because the selected protocol became unavailable while the + The look-up was aborted because the selected protocol became unavailable while the operation was ongoing. @@ -624,7 +621,7 @@ node /org/freedesktop/resolve1/link/_34 { org.freedesktop.resolve1.NoTrustAnchor - No chain of trust could be established for the response, to a configured DNSSEC trust + No chain of trust could be established for the response to a configured DNSSEC trust anchor. @@ -640,7 +637,7 @@ node /org/freedesktop/resolve1/link/_34 { org.freedesktop.resolve1.LinkBusy - The requested configuration change can not be made, because + The requested configuration change could not be made because systemd-networkd8, already took possession of the interface and supplied configuration data for it. diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index a3b86d3f1cb..09b1a9e78bf 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -16,7 +16,7 @@ org.freedesktop.systemd1 - The D-Bus interface of systemd-systemdd + The D-Bus interface of systemd @@ -24,27 +24,27 @@ systemd1 and its - auxiliary daemons expose a number of APIs over D-Bus. This page describes the various APIs exposed by the - system and service manager itself, and does not cover the auxiliary daemons. + auxiliary daemons expose a number of APIs over D-Bus. This page only describes the various APIs exposed by the + system and service manager itself. It does not cover the auxiliary daemons. The service manager exposes a number of objects on the bus: one - Manager object as central entry point for clients, and individual objects + Manager object as a central entry point for clients along with individual objects for each unit and for each queued job. The unit objects each implement a generic - Unit interface plus a type-specific interface. For example, service units - implement org.freedesktop.systemd1.Unit as well as - org.freedesktop.system1.Service. The manager object can be used to list - unit and job objects, or to directly convert a unit name or job id into a bus path of the corresponding + Unit interface as well as a type-specific interface. For example, service units + implement both org.freedesktop.systemd1.Unit and + org.freedesktop.system1.Service. The manager object can list + unit and job objects or directly convert a unit name or job id into a bus path of the corresponding D-Bus object. Properties exposing time values are usually encoded in microseconds (usec) on the bus, even if their corresponding settings in the unit files are in seconds. - In contrast to most of the other services of the systemd suite PID 1 does not use PolicyKit for + In contrast to most of the other services of the systemd suite, PID 1 does not use PolicyKit for controlling access to privileged operations, but relies exclusively on the low-level D-Bus policy language. (This is done in order to avoid a cyclic dependency between PolicyKit and systemd/PID 1.) This means that sensitive operations exposed by PID 1 on the bus are generally not available to unprivileged - processes directly. However some (such as shutdown/reboot/suspend) are made available through the D-Bus + processes directly. However, some operations (such as shutdown/reboot/suspend) are made available through the D-Bus API of logind, see org.freedesktop.login15. @@ -245,76 +245,75 @@ node /org/freedesktop/systemd1 { Methods - Note that many of the calls exist twice: once on the Manager - object, and once on the respective unit objects. This is to optimize access times so that methods that + Note that many of the methods exist twice: once on the Manager + object and once on the respective unit objects. This is to optimize access times so that methods that belong to unit objects do not have to be called with a resolved unit path, but can be called with only the unit id, too. GetUnit() may be used to get the unit object path for a unit name. It takes - the unit name and returns the object path. If a unit has not been loaded yet by this name this call + the unit name and returns the object path. If a unit has not been loaded yet by this name this method will fail. GetUnitByPID() may be used to get the unit object path of the unit a process - ID belongs to. Takes a UNIX PID and returns the object path. The PID must refer to an existing process - of the system. + ID belongs to. It takes a UNIX PID and returns the object path. The PID must refer to an existing system process. LoadUnit() is similar to GetUnit() but will load the unit from disk if possible. - StartUnit() enqeues a start job, and possibly depending jobs. Takes the unit - to activate, plus a mode string. The mode needs to be one of replace, - fail, isolate, ignore-dependencies, - ignore-requirements. If replace the call will start the unit and - its dependencies, possibly replacing already queued jobs that conflict with this. If - fail the call will start the unit and its dependencies, but will fail if this would - change an already queued job. If isolate the call will start the unit in question - and terminate all units that aren't dependencies of it. If ignore-dependencies it - will start a unit but ignore all its dependencies. If ignore-requirements it will + StartUnit() enqueues a start job and possibly depending jobs. It takes the unit + to activate and a mode string as arguments. The mode needs to be one of replace, + fail, isolate, ignore-dependencies, or + ignore-requirements. If replace, the method will start the unit and + its dependencies, possibly replacing already queued jobs that conflict with it. If + fail, the method will start the unit and its dependencies, but will fail if this would + change an already queued job. If isolate, the method will start the unit in question + and terminate all units that aren't dependencies of it. If ignore-dependencies, it + will start a unit but ignore all its dependencies. If ignore-requirements, it will start a unit but only ignore the requirement dependencies. It is not recommended to make use of the - latter two options. Returns the newly created job object. + latter two options. On completion, this method returns the newly created job object. StartUnitReplace() is similar to StartUnit() but - replaces a job that is queued for one unit by a job for another. + replaces a job that is queued for one unit by a job for another unit. StopUnit() is similar to StartUnit() but stops the - specified unit rather than starting it. Note that isolate mode is invalid for this - call. + specified unit rather than starting it. Note that the isolate mode is invalid for this + method. ReloadUnit(), RestartUnit(), - TryRestartUnit(), ReloadOrRestartUnit(), - ReloadOrTryRestartUnit() may be used to restart and/or reload a unit, and takes + TryRestartUnit(), ReloadOrRestartUnit(), or + ReloadOrTryRestartUnit() may be used to restart and/or reload a unit. These methods take similar arguments as StartUnit(). Reloading is done only if the unit is already - running and fails otherwise. If a service is restarted that isn't running it will be started, unless + running and fails otherwise. If a service is restarted that isn't running, it will be started unless the "Try" flavor is used in which case a service that isn't running is not affected by the restart. The "ReloadOrRestart" flavors attempt a reload if the unit supports it and use a restart otherwise. KillUnit() may be used to kill (i.e. send a signal to) all processes of a - unit. Takes the unit name, an enum who and a UNIX + unit. It takes the unit name, an enum who and a UNIX signal number to send. The who enum is one of main, control or all. If - main, only the main process of a unit is killed. If control only - the control process of the unit is killed, if all all processes are killed. A + main, only the main process of the unit is killed. If control, only + the control process of the unit is killed. If all, all processes are killed. A control process is for example a process that is configured via - ExecStop= and is spawned in parallel to the main daemon process, in order to shut it + ExecStop= and is spawned in parallel to the main daemon process in order to shut it down. GetJob() returns the job object path for a specific job, identified by its id. - CancelJob() cancels a specific job identified by its numer ID. This - operation is also available in the Cancel() method of Job objects (see below), and + CancelJob() cancels a specific job identified by its numeric ID. This + operation is also available in the Cancel() method of Job objects (see below) and exists primarily to reduce the necessary round trips to execute this operation. Note that this will not have any effect on jobs whose execution has already begun. ClearJobs() flushes the job queue, removing all jobs that are still - queued. Note that this does not have any effect on jobs whose execution has already begun, it only + queued. Note that this does not have any effect on jobs whose execution has already begun. It only flushes jobs that are queued and have not yet begun execution. ResetFailedUnit() resets the "failed" state of a specific unit. ResetFailed() resets the "failed" state of all units. - ListUnits() returns an array with all currently loaded units. Note that + ListUnits() returns an array of all currently loaded units. Note that units may be known by multiple names at the same name, and hence there might be more unit names loaded than actual units behind them. The array consists of structures with the following elements: @@ -336,7 +335,7 @@ node /org/freedesktop/systemd1 { The unit object path - If there is a job queued for the job unit the numeric job id, 0 + If there is a job queued for the job unit, the numeric job id, 0 otherwise The job type as string @@ -361,8 +360,8 @@ node /org/freedesktop/systemd1 { Subscribe() enables most bus signals to be sent out. Clients which are - interested in signals need to call this function. Signals are only sent out if at least one client - invoked this function. Unsubscribe() undoes the signal subscription that + interested in signals need to call this method. Signals are only sent out if at least one client + 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 diff --git a/man/org.freedesktop.timedate1.xml b/man/org.freedesktop.timedate1.xml index 88525129069..089f6fbd374 100644 --- a/man/org.freedesktop.timedate1.xml +++ b/man/org.freedesktop.timedate1.xml @@ -25,7 +25,7 @@ systemd-timedated.service8 - is a system service that can be used to control the system time and related settings. This page + is a system service that can be used to control the system time and related settings. This page describes the D-Bus interface. @@ -93,8 +93,8 @@ node /org/freedesktop/timedate1 { Use SetTime() to change the system clock. Pass a value of microseconds since the UNIX epoch (1 Jan 1970 UTC). If relative is true, the passed usec value will be - added to the current system time, if it is false the current system time will be set to the passed usec - value. If the system time is set with this call the RTC will be updated as well. + added to the current system time. If it is false, the current system time will be set to the passed usec + value. If the system time is set with this method, the RTC will be updated as well. Use SetTimezone() to set the system timezone. Pass a value like Europe/Berlin to set the timezone. Valid timezones are listed in @@ -102,11 +102,11 @@ node /org/freedesktop/timedate1 { time, it will be updated accordingly. Use SetLocalRTC() to control whether the RTC is in local time or UTC. It is - strongly recommended to maintain the RTC in UTC. Some OSes (Windows) however maintain the RTC in local - time, which might make it necessary to enable this feature. However, this creates various problems as - daylight changes might be missed. If fix_system is passed true, - the time from the RTC is read again and the system clock adjusted according to the new setting. If - fix_system is passed false the system time is written to the RTC + strongly recommended to maintain the RTC in UTC. However, some OSes (Windows) maintain the RTC in local + time, which might make it necessary to enable this feature. Note that this might create various problems as + daylight changes could be missed. If fix_system is true, + the time from the RTC is read again and the system clock is adjusted according to the new setting. If + fix_system is false, the system time is written to the RTC taking the new setting into account. Use fix_system=true in installers and livecds where the RTC is probably more reliable than the system time. Use fix_system=false in configuration UIs that are run during normal operation and where the system clock is probably more @@ -116,7 +116,7 @@ node /org/freedesktop/timedate1 { network using systemd-timesyncd. This will enable and start or disable and stop the chosen time synchronization service. - Whenever the timezone and local_rtc settings are changed via the daemon + Whenever the timezone and local_rtc settings are changed via the daemon, PropertyChanged signals are sent out to which clients can subscribe. Changing the time settings using this interface is authenticated via PolicyKit. @@ -126,7 +126,7 @@ node /org/freedesktop/timedate1 { The user_interaction boolean parameters can be used to control whether - PolicyKit should interactively ask the user for authentication credentials if it needs to. + PolicyKit should interactively ask the user for authentication credentials if required. The PolicyKit action for SetTimezone() is org.freedesktop.timedate1.set-timezone. For diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index 185e0388093..699316a09a2 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -30,18 +30,18 @@ Description systemd-hostnamed.service is a system service that may be used to change the - system's hostname and related machine meta data from user programs. It is automatically activated on + system's hostname and related machine metadata from user programs. It is automatically activated on request and terminates itself when unused. It currently offers access to five variables: - The current host name (Example: dhcp-192-168-47-11) + The current hostname (Example: dhcp-192-168-47-11) - The static (configured) host name (Example: + The static (configured) hostname (Example: lennarts-computer) - The pretty host name (Example: Lennart's Computer) + The pretty hostname (Example: Lennart's Computer) A suitable icon name for the local host (Example: @@ -55,7 +55,7 @@ hostnamectl1 is a command line client to this service. - See the + See org.freedesktop.hostname11 for a description of the D-Bus API. diff --git a/man/systemd-localed.service.xml b/man/systemd-localed.service.xml index cd4359dc463..e5f6b78d218 100644 --- a/man/systemd-localed.service.xml +++ b/man/systemd-localed.service.xml @@ -40,7 +40,7 @@ localectl1 is a command line client to this service. - See the + See org.freedesktop.locale11 for a description of the D-Bus API. diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 87ee607c6c9..12f9f7a0f68 100644 --- a/man/systemd-logind.service.xml +++ b/man/systemd-logind.service.xml @@ -80,7 +80,7 @@ See org.freedesktop.login13 - for for information about the D-Bus APIs systemd-logind provides. + for information about the D-Bus APIs systemd-logind provides. For more information on the inhibition logic see the Inhibitor @@ -88,7 +88,7 @@ If you are interested in writing a display manager that makes use of logind, please have look at Writing Display - Manager. + Managers. If you are interested in writing a desktop environment that makes use of logind, please have look at Writing Desktop Environments. diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml index b5fad154e78..e15cc963b40 100644 --- a/man/systemd-machined.service.xml +++ b/man/systemd-machined.service.xml @@ -67,7 +67,7 @@ containers, connecting to the container's init system for that. systemctl's switch has the effect of not only showing the - locally running services, but recursively the services of all registered containers. + locally running services, but recursively showing the services of all registered containers. The machinectl command provides access to a number of useful operations on registered containers, such as introspecting them, rebooting, shutting them down, and