docs: document new description field
Also, explain GECOS syntax requirements.
This commit is contained in:
parent
0a388dfcc5
commit
072779f0bf
|
@ -22,6 +22,10 @@ UNIX/glibc NSS `struct group`, or the shadow structure `struct sgrp`'s
|
||||||
`realm` → The "realm" the group belongs to, conceptually identical to the same
|
`realm` → The "realm" the group belongs to, conceptually identical to the same
|
||||||
field of user records. A string in DNS domain name syntax.
|
field of user records. A string in DNS domain name syntax.
|
||||||
|
|
||||||
|
`description` → A descriptive string for the group. This is similar to the
|
||||||
|
`realName` field of user records, and accepts arbitrary strings, as long as
|
||||||
|
they follow the same GECOS syntax requirements as `realName`.
|
||||||
|
|
||||||
`disposition` → The disposition of the group, conceptually identical to the
|
`disposition` → The disposition of the group, conceptually identical to the
|
||||||
same field of user records. A string.
|
same field of user records. A string.
|
||||||
|
|
||||||
|
|
|
@ -221,12 +221,14 @@ optional, when unset the user should not be considered part of any realm. A
|
||||||
user record with a realm set is never compatible (for the purpose of updates,
|
user record with a realm set is never compatible (for the purpose of updates,
|
||||||
see above) with a user record without one set, even if the `userName` field matches.
|
see above) with a user record without one set, even if the `userName` field matches.
|
||||||
|
|
||||||
`realName` → The real name of the user, a string. This should contain the user's
|
`realName` → The real name of the user, a string. This should contain the
|
||||||
real ("human") name, and corresponds loosely to the GECOS field of classic UNIX
|
user's real ("human") name, and corresponds loosely to the GECOS field of
|
||||||
user records. When converting a `struct passwd` to a JSON user record this
|
classic UNIX user records. When converting a `struct passwd` to a JSON user
|
||||||
field is initialized from GECOS (i.e. the `pw_gecos` field), and vice versa
|
record this field is initialized from GECOS (i.e. the `pw_gecos` field), and
|
||||||
when converting back. That said, unlike GECOS this field is supposed to contain
|
vice versa when converting back. That said, unlike GECOS this field is supposed
|
||||||
only the real name and no other information.
|
to contain only the real name and no other information. This field must not
|
||||||
|
contain control characters (such as `\n`) or colons (`:`), since those are used
|
||||||
|
as record separators in classic `/etc/passwd` files and similar formats.
|
||||||
|
|
||||||
`emailAddress` → The email address of the user, formatted as
|
`emailAddress` → The email address of the user, formatted as
|
||||||
string. [`pam_systemd`](https://www.freedesktop.org/software/systemd/man/pam_systemd.html)
|
string. [`pam_systemd`](https://www.freedesktop.org/software/systemd/man/pam_systemd.html)
|
||||||
|
|
Loading…
Reference in New Issue