lol

nixos/users-groups: convert remaining descriptions to MD

manpage is unchanged, html change is only in whitespace

authored by

pennae and committed by
pennae
7f6d0d16 a2ceee8f

+35 -35
+35 -35
nixos/modules/config/users-groups.nix
··· 17 17 ]); 18 18 19 19 passwordDescription = '' 20 - The options <option>hashedPassword</option>, 21 - <option>password</option> and <option>passwordFile</option> 20 + The options {option}`hashedPassword`, 21 + {option}`password` and {option}`passwordFile` 22 22 controls what password is set for the user. 23 - <option>hashedPassword</option> overrides both 24 - <option>password</option> and <option>passwordFile</option>. 25 - <option>password</option> overrides <option>passwordFile</option>. 23 + {option}`hashedPassword` overrides both 24 + {option}`password` and {option}`passwordFile`. 25 + {option}`password` overrides {option}`passwordFile`. 26 26 If none of these three options are set, no password is assigned to 27 27 the user, and the user will not be able to do password logins. 28 - If the option <option>users.mutableUsers</option> is true, the 28 + If the option {option}`users.mutableUsers` is true, the 29 29 password defined in one of the three options will only be set when 30 30 the user is created for the first time. After that, you are free to 31 31 change the password with the ordinary user management commands. If 32 - <option>users.mutableUsers</option> is false, you cannot change 32 + {option}`users.mutableUsers` is false, you cannot change 33 33 user passwords, they will always be set according to the password 34 34 options. 35 35 ''; 36 36 37 37 hashedPasswordDescription = '' 38 - To generate a hashed password run <literal>mkpasswd -m sha-512</literal>. 38 + To generate a hashed password run `mkpasswd -m sha-512`. 39 39 40 - If set to an empty string (<literal>""</literal>), this user will 40 + If set to an empty string (`""`), this user will 41 41 be able to log in without being asked for a password (but not via remote 42 - services such as SSH, or indirectly via <command>su</command> or 43 - <command>sudo</command>). This should only be used for e.g. bootable 42 + services such as SSH, or indirectly via {command}`su` or 43 + {command}`sudo`). This should only be used for e.g. bootable 44 44 live systems. Note: this is different from setting an empty password, 45 - which can be achieved using <option>users.users.&lt;name?&gt;.password</option>. 45 + which can be achieved using {option}`users.users.<name?>.password`. 46 46 47 - If set to <literal>null</literal> (default) this user will not 48 - be able to log in using a password (i.e. via <command>login</command> 47 + If set to `null` (default) this user will not 48 + be able to log in using a password (i.e. via {command}`login` 49 49 command). 50 50 ''; 51 51 ··· 234 234 hashedPassword = mkOption { 235 235 type = with types; nullOr (passwdEntry str); 236 236 default = null; 237 - description = '' 237 + description = lib.mdDoc '' 238 238 Specifies the hashed password for the user. 239 239 ${passwordDescription} 240 240 ${hashedPasswordDescription} ··· 244 244 password = mkOption { 245 245 type = with types; nullOr str; 246 246 default = null; 247 - description = '' 247 + description = lib.mdDoc '' 248 248 Specifies the (clear text) password for the user. 249 249 Warning: do not set confidential information here 250 250 because it is world-readable in the Nix store. This option ··· 256 256 passwordFile = mkOption { 257 257 type = with types; nullOr str; 258 258 default = null; 259 - description = '' 259 + description = lib.mdDoc '' 260 260 The full path to a file that contains the user's password. The password 261 261 file is read on each system activation. The file should contain 262 262 exactly one line, which should be the password in an encrypted form 263 - that is suitable for the <literal>chpasswd -e</literal> command. 263 + that is suitable for the `chpasswd -e` command. 264 264 ${passwordDescription} 265 265 ''; 266 266 }; ··· 268 268 initialHashedPassword = mkOption { 269 269 type = with types; nullOr (passwdEntry str); 270 270 default = null; 271 - description = '' 271 + description = lib.mdDoc '' 272 272 Specifies the initial hashed password for the user, i.e. the 273 273 hashed password assigned if the user does not already 274 - exist. If <option>users.mutableUsers</option> is true, the 274 + exist. If {option}`users.mutableUsers` is true, the 275 275 password can be changed subsequently using the 276 - <command>passwd</command> command. Otherwise, it's 277 - equivalent to setting the <option>hashedPassword</option> option. 276 + {command}`passwd` command. Otherwise, it's 277 + equivalent to setting the {option}`hashedPassword` option. 278 278 279 279 ${hashedPasswordDescription} 280 280 ''; ··· 458 458 users.mutableUsers = mkOption { 459 459 type = types.bool; 460 460 default = true; 461 - description = '' 462 - If set to <literal>true</literal>, you are free to add new users and groups to the system 463 - with the ordinary <literal>useradd</literal> and 464 - <literal>groupadd</literal> commands. On system activation, the 465 - existing contents of the <literal>/etc/passwd</literal> and 466 - <literal>/etc/group</literal> files will be merged with the 467 - contents generated from the <literal>users.users</literal> and 468 - <literal>users.groups</literal> options. 461 + description = lib.mdDoc '' 462 + If set to `true`, you are free to add new users and groups to the system 463 + with the ordinary `useradd` and 464 + `groupadd` commands. On system activation, the 465 + existing contents of the `/etc/passwd` and 466 + `/etc/group` files will be merged with the 467 + contents generated from the `users.users` and 468 + `users.groups` options. 469 469 The initial password for a user will be set 470 - according to <literal>users.users</literal>, but existing passwords 470 + according to `users.users`, but existing passwords 471 471 will not be changed. 472 472 473 - <warning><para> 474 - If set to <literal>false</literal>, the contents of the user and 473 + ::: {.warning} 474 + If set to `false`, the contents of the user and 475 475 group files will simply be replaced on system activation. This also 476 476 holds for the user passwords; all changed 477 477 passwords will be reset according to the 478 - <literal>users.users</literal> configuration on activation. 479 - </para></warning> 478 + `users.users` configuration on activation. 479 + ::: 480 480 ''; 481 481 }; 482 482