makeusers-syntax.txt 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. // -*- mode:doc -*- ;
  2. // vim: set syntax=asciidoc:
  3. [[makeuser-syntax]]
  4. == Makeusers syntax documentation
  5. The syntax to create users is inspired by the makedev syntax, above, but
  6. is specific to Buildroot.
  7. The syntax for adding a user is a space-separated list of fields, one
  8. user per line; the fields are:
  9. |=================================================================
  10. |username |uid |group |gid |password |home |shell |groups |comment
  11. |=================================================================
  12. Where:
  13. - +username+ is the desired user name (aka login name) for the user.
  14. It can not be +root+, and must be unique. If set to +-+, then just a
  15. group will be created.
  16. - +uid+ is the desired UID for the user. It must be unique, and not
  17. +0+. If set to +-1+, then a unique UID will be computed by Buildroot
  18. in the range [1000...1999]
  19. - +group+ is the desired name for the user's main group. It can not
  20. be +root+. If the group does not exist, it will be created.
  21. - +gid+ is the desired GID for the user's main group. It must be unique,
  22. and not +0+. If set to +-1+, and the group does not already exist, then
  23. a unique GID will be computed by Buildroot in the range [1000..1999]
  24. - +password+ is the crypt(3)-encoded password. If prefixed with +!+,
  25. then login is disabled. If prefixed with +=+, then it is interpreted
  26. as clear-text, and will be crypt-encoded (using MD5). If prefixed with
  27. +!=+, then the password will be crypt-encoded (using MD5) and login
  28. will be disabled. If set to +*+, then login is not allowed. If set to
  29. +-+, then no password value will be set.
  30. - +home+ is the desired home directory for the user. If set to '-', no
  31. home directory will be created, and the user's home will be +/+.
  32. Explicitly setting +home+ to +/+ is not allowed.
  33. - +shell+ is the desired shell for the user. If set to +-+, then
  34. +/bin/false+ is set as the user's shell.
  35. - +groups+ is the comma-separated list of additional groups the user
  36. should be part of. If set to +-+, then the user will be a member of
  37. no additional group. Missing groups will be created with an arbitrary
  38. +gid+.
  39. - +comment+ (aka https://en.wikipedia.org/wiki/Gecos_field[GECOS]
  40. field) is an almost-free-form text.
  41. There are a few restrictions on the content of each field:
  42. * except for +comment+, all fields are mandatory.
  43. * except for +comment+, fields may not contain spaces.
  44. * no field may contain a colon (+:+).
  45. If +home+ is not +-+, then the home directory, and all files below,
  46. will belong to the user and its main group.
  47. Examples:
  48. ----
  49. foo -1 bar -1 !=blabla /home/foo /bin/sh alpha,bravo Foo user
  50. ----
  51. This will create this user:
  52. - +username+ (aka login name) is: +foo+
  53. - +uid+ is computed by Buildroot
  54. - main +group+ is: +bar+
  55. - main group +gid+ is computed by Buildroot
  56. - clear-text +password+ is: +blabla+, will be crypt(3)-encoded, and login is disabled.
  57. - +home+ is: +/home/foo+
  58. - +shell+ is: +/bin/sh+
  59. - +foo+ is also a member of +groups+: +alpha+ and +bravo+
  60. - +comment+ is: +Foo user+
  61. ----
  62. test 8000 wheel -1 = - /bin/sh - Test user
  63. ----
  64. This will create this user:
  65. - +username+ (aka login name) is: +test+
  66. - +uid+ is : +8000+
  67. - main +group+ is: +wheel+
  68. - main group +gid+ is computed by Buildroot, and will use the value defined in the rootfs skeleton
  69. - +password+ is empty (aka no password).
  70. - +home+ is +/+ but will not belong to +test+
  71. - +shell+ is: +/bin/sh+
  72. - +test+ is not a member of any additional +groups+
  73. - +comment+ is: +Test user+