man/systemd-firstboot.1

   1 '\" t
   2 .TH "SYSTEMD\-FIRSTBOOT" "1" "" "systemd 217" "systemd-firstboot"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 systemd-firstboot, systemd-firstboot.service \- Initialize basic system settings on or before the first boot\-up of a system
  24 .SH "SYNOPSIS"
  25 .HP \w'\fBsystemd\-firstboot\fR\ 'u
  26 \fBsystemd\-firstboot\fR [OPTIONS...]
  27 .PP
  28 systemd\-firstboot\&.service
  29 .SH "DESCRIPTION"
  30 .PP
  31 \fBsystemd\-firstboot\fR
  32 initializes the most basic system settings interactively on the first boot, or optionally non\-interactively when a system image is created\&. The following settings may be set up:
  33 .sp
  34 .RS 4
  35 .ie n \{\
  36 \h'-04'\(bu\h'+03'\c
  37 .\}
  38 .el \{\
  39 .sp -1
  40 .IP \(bu 2.3
  41 .\}
  42 The system locale, more specifically the two locale variables
  43 \fILANG=\fR
  44 and
  45 \fILC_MESSAGES\fR
  46 .RE
  47 .sp
  48 .RS 4
  49 .ie n \{\
  50 \h'-04'\(bu\h'+03'\c
  51 .\}
  52 .el \{\
  53 .sp -1
  54 .IP \(bu 2.3
  55 .\}
  56 The system time zone
  57 .RE
  58 .sp
  59 .RS 4
  60 .ie n \{\
  61 \h'-04'\(bu\h'+03'\c
  62 .\}
  63 .el \{\
  64 .sp -1
  65 .IP \(bu 2.3
  66 .\}
  67 The system host name
  68 .RE
  69 .sp
  70 .RS 4
  71 .ie n \{\
  72 \h'-04'\(bu\h'+03'\c
  73 .\}
  74 .el \{\
  75 .sp -1
  76 .IP \(bu 2.3
  77 .\}
  78 The machine ID of the system
  79 .RE
  80 .sp
  81 .RS 4
  82 .ie n \{\
  83 \h'-04'\(bu\h'+03'\c
  84 .\}
  85 .el \{\
  86 .sp -1
  87 .IP \(bu 2.3
  88 .\}
  89 The root user\*(Aqs password
  90 .RE
  91 .PP
  92 Each of the fields may either be queried interactively from the users, set non\-interactively on the tool\*(Aqs command line, or be copied from a host system that is used to set up the system image\&.
  93 .PP
  94 If a setting is already initialized it will not be overwritten and the user will not be prompted for the setting\&.
  95 .PP
  96 Note that this tool operates directly on the file system and does not involve any running system services, unlike
  97 \fBlocalectl\fR(1),
  98 \fBtimedatectl\fR(1)
  99 or
 100 \fBhostnamectl\fR(1)\&. This allows
 101 \fBsystemd\-firstboot\fR
 102 to operate on mounted but not booted disk images and in early boot\&. It is not recommended to use
 103 \fBsystemd\-firstboot\fR
 104 on the running system while it is up\&.
 105 .SH "OPTIONS"
 106 .PP
 107 The following options are understood:
 108 .PP
 109 \fB\-\-root=\fR\fB\fIroot\fR\fR
 110 .RS 4
 111 Takes a directory path as an argument\&. All paths will be prefixed with the given alternate
 112 \fIroot\fR
 113 path, including config search paths\&. This is useful to operate on a system image mounted to the specified directory instead of the host system itself\&.
 114 .RE
 115 .PP
 116 \fB\-\-locale=\fR\fB\fILOCALE\fR\fR, \fB\-\-locale\-messages=\fR\fB\fILOCALE\fR\fR
 117 .RS 4
 118 Sets the system locale, more specifically the
 119 \fILANG=\fR
 120 and
 121 \fILC_MESSAGES\fR
 122 settings\&. The argument should be a valid locale identifier, such as
 123 "de_DE\&.UTF\-8"\&. This controls the
 124 \fBlocale.conf\fR(5)
 125 configuration file\&.
 126 .RE
 127 .PP
 128 \fB\-\-timezone=\fR\fB\fITIMEZONE\fR\fR
 129 .RS 4
 130 Sets the system time zone\&. The argument should be a valid time zone identifier, such as
 131 "Europe/Berlin"\&. This controls the
 132 \fBlocaltime\fR(5)
 133 symlink\&.
 134 .RE
 135 .PP
 136 \fB\-\-hostname=\fR\fB\fIHOSTNAME\fR\fR
 137 .RS 4
 138 Sets the system hostname\&. The argument should be a host name, compatible with DNS\&. This controls the
 139 \fBhostname\fR(5)
 140 configuration file\&.
 141 .RE
 142 .PP
 143 \fB\-\-machine\-id=\fR\fB\fIID\fR\fR
 144 .RS 4
 145 Sets the system\*(Aqs machine ID\&. This controls the
 146 \fBmachine-id\fR(5)
 147 file\&.
 148 .RE
 149 .PP
 150 \fB\-\-root\-password=\fR\fB\fIPASSWORD\fR\fR, \fB\-\-root\-password\-file=\fR\fB\fIPATH\fR\fR
 151 .RS 4
 152 Sets the password of the system\*(Aqs root user\&. This creates a
 153 \fBshadow\fR(5)
 154 file\&. This setting exists in two forms:
 155 \fB\-\-root\-password=\fR
 156 accepts the password to set directly on the command line,
 157 \fB\-\-root\-password\-file=\fR
 158 reads it from a file\&. Note that it is not recommended specifying passwords on the command line as other users might be able to see them simply by invoking
 159 \fBps\fR(1)\&.
 160 .RE
 161 .PP
 162 \fB\-\-prompt\-locale\fR, \fB\-\-prompt\-timezone\fR, \fB\-\-prompt\-hostname\fR, \fB\-\-prompt\-root\-password\fR
 163 .RS 4
 164 .PP
 165 Prompt the user interactively for a specific basic setting\&. Note that any explicit configuration settings specified on the command line take precedence, and the user is not prompted for it\&.
 166 .RE
 167 .PP
 168 \fB\-\-prompt\fR
 169 .RS 4
 170 .PP
 171 Query the user for locale, timezone, hostname and root password\&. This is equivalent to specifying
 172 \fB\-\-prompt\-locale\fR,
 173 \fB\-\-prompt\-timezone\fR,
 174 \fB\-\-prompt\-hostname\fR,
 175 \fB\-\-prompt\-root\-password\fR
 176 in combination\&.
 177 .RE
 178 .PP
 179 \fB\-\-copy\-locale\fR, \fB\-\-copy\-timezone\fR, \fB\-\-copy\-root\-password\fR
 180 .RS 4
 181 .PP
 182 Copy a specific basic setting from the host\&. This only works in combination with
 183 \fB\-\-root=\fR
 184 (see above)\&.
 185 .RE
 186 .PP
 187 \fB\-\-copy\fR
 188 .RS 4
 189 .PP
 190 Copy locale, time zone and root password from the host\&. This is equivalent to specifying
 191 \fB\-\-copy\-locale\fR,
 192 \fB\-\-copy\-timezone\fR,
 193 \fB\-\-copy\-root\-password\fR
 194 in combination\&.
 195 .RE
 196 .PP
 197 \fB\-\-setup\-machine\-id\fR
 198 .RS 4
 199 .PP
 200 Initialize the system\*(Aqs machine ID to a random ID\&. This only works in combination with
 201 \fB\-\-root=\fR\&.
 202 .RE
 203 .PP
 204 \fB\-h\fR, \fB\-\-help\fR
 205 .RS 4
 206 Print a short help text and exit\&.
 207 .RE
 208 .PP
 209 \fB\-\-version\fR
 210 .RS 4
 211 Print a short version string and exit\&.
 212 .RE
 213 .SH "EXIT STATUS"
 214 .PP
 215 On success, 0 is returned, a non\-zero failure code otherwise\&.
 216 .SH "SEE ALSO"
 217 .PP
 218 \fBsystemd\fR(1),
 219 \fBlocale.conf\fR(5),
 220 \fBlocaltime\fR(5),
 221 \fBhostname\fR(5),
 222 \fBmachine-id\fR(5),
 223 \fBshadow\fR(5),
 224 \fBsystemd-machine-id-setup\fR(1),
 225 \fBlocalectl\fR(1),
 226 \fBtimedatectl\fR(1),
 227 \fBhostnamectl\fR(1)