networkupstools / nut

The Network UPS Tools repository. UPS management protocol Informational RFC 9271 published by IETF at https://www.rfc-editor.org/info/rfc9271 Please star NUT on GitHub, this helps with sponsorships!
https://networkupstools.org/
Other
1.97k stars 348 forks source link

Please add Documentation= field in systemd .service files #722

Open bigon opened 5 years ago

bigon commented 5 years ago

Hi,

systemd .service files can add a reference to a man page with documentation about the daemon it starts (ie Documentation=man:upsd(8))

Would be nice if this was added

jimklimov commented 2 weeks ago

Per https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html

Documentation=

A space-separated list of URIs referencing documentation for this unit or its configuration. Accepted are only URIs of the types "http://", "https://", "file:", "info:", "man:". For more information about the syntax of these URIs, see uri(7). The URIs should be listed in order of relevance, starting with the most relevant. It is a good idea to first reference documentation that explains what the unit's purpose is, followed by how it is configured, followed by any other related documentation. This option may be specified more than once, in which case the specified list of URIs is merged. If the empty string is assigned to this option, the list is reset and all prior assignments will have no effect.

Added in version 201.