docs/manual/makeusers-syntax.txt

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