man-nixos-rebuild.xml: Improve layout

+40
+40
nixos/doc/manual/man-nixos-rebuild.xml
··· 7 <refmiscinfo class="source">NixOS</refmiscinfo> 8 <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> 9 </refmeta> 10 <refnamediv> 11 <refname><command>nixos-rebuild</command> 12 </refname><refpurpose>reconfigure a NixOS machine</refpurpose> 13 </refnamediv> 14 <refsynopsisdiv> 15 <cmdsynopsis> 16 <command>nixos-rebuild</command><group choice='req'> ··· 74 <arg> 75 <option>--builders</option> <replaceable>builder-spec</replaceable> 76 </arg> 77 <sbr /> 78 <arg> 79 <group choice='req'> ··· 121 </arg> 122 </cmdsynopsis> 123 </refsynopsisdiv> 124 <refsection> 125 <title>Description</title> 126 <para> 127 This command updates the system so that it corresponds to the configuration 128 specified in <filename>/etc/nixos/configuration.nix</filename>. Thus, every ··· 133 (re)starts any system services if needed. Please note that user services need 134 to be started manually as they aren't detected by the activation script at the moment. 135 </para> 136 <para> 137 This command has one required argument, which specifies the desired 138 operation. It must be one of the following: 139 <variablelist> 140 <varlistentry> 141 <term> ··· 152 </para> 153 </listitem> 154 </varlistentry> 155 <varlistentry> 156 <term> 157 <option>boot</option> ··· 165 </para> 166 </listitem> 167 </varlistentry> 168 <varlistentry> 169 <term> 170 <option>test</option> ··· 179 </para> 180 </listitem> 181 </varlistentry> 182 <varlistentry> 183 <term> 184 <option>build</option> ··· 197 </para> 198 </listitem> 199 </varlistentry> 200 <varlistentry> 201 <term> 202 <option>dry-build</option> ··· 208 </para> 209 </listitem> 210 </varlistentry> 211 <varlistentry> 212 <term> 213 <option>dry-activate</option> ··· 222 </para> 223 </listitem> 224 </varlistentry> 225 <varlistentry> 226 <term> 227 <option>edit</option> ··· 232 </para> 233 </listitem> 234 </varlistentry> 235 <varlistentry> 236 <term> 237 <option>build-vm</option> ··· 249 <prompt>$ </prompt>./result/bin/run-*-vm 250 </screen> 251 </para> 252 <para> 253 The VM is implemented using the <literal>qemu</literal> package. For 254 best performance, you should load the <literal>kvm-intel</literal> or 255 <literal>kvm-amd</literal> kernel modules to get hardware 256 virtualisation. 257 </para> 258 <para> 259 The VM mounts the Nix store of the host through the 9P file system. The 260 host Nix store is read-only, so Nix commands that modify the Nix store ··· 262 <command>nixos-rebuild</command>; to change the VM’s configuration, 263 you must halt the VM and re-run the commands above. 264 </para> 265 <para> 266 The VM has its own <literal>ext3</literal> root file system, which is 267 automatically created when the VM is first started, and is persistent ··· 272 </para> 273 </listitem> 274 </varlistentry> 275 <varlistentry> 276 <term> 277 <option>build-vm-with-bootloader</option> ··· 294 </variablelist> 295 </para> 296 </refsection> 297 <refsection> 298 <title>Options</title> 299 <para> 300 This command accepts the following options: 301 </para> 302 <variablelist> 303 <varlistentry> 304 <term> ··· 310 </para> 311 </listitem> 312 </varlistentry> 313 <varlistentry> 314 <term> 315 <option>--install-bootloader</option> ··· 321 </para> 322 </listitem> 323 </varlistentry> 324 <varlistentry> 325 <term> 326 <option>--no-build-nix</option> ··· 336 </para> 337 </listitem> 338 </varlistentry> 339 <varlistentry> 340 <term> 341 <option>--fast</option> ··· 349 </para> 350 </listitem> 351 </varlistentry> 352 <varlistentry> 353 <term> 354 <option>--rollback</option> ··· 363 </para> 364 </listitem> 365 </varlistentry> 366 <varlistentry> 367 <term> 368 <option>--builders</option> <replaceable>builder-spec</replaceable> ··· 382 </para> 383 </listitem> 384 </varlistentry> 385 <varlistentry> 386 <term> 387 <option>--profile-name</option> ··· 412 </para> 413 </listitem> 414 </varlistentry> 415 <varlistentry> 416 <term> 417 <option>--build-host</option> ··· 437 </para> 438 </listitem> 439 </varlistentry> 440 <varlistentry> 441 <term> 442 <option>--target-host</option> ··· 449 be accessible over ssh, and for the commands <option>switch</option>, 450 <option>boot</option> and <option>test</option> you need root access. 451 </para> 452 <para> 453 If <option>--build-host</option> is not explicitly specified, 454 <option>--build-host</option> will implicitly be set to the same value as ··· 457 place remotely (and no build artifacts will be copied to the local 458 machine). 459 </para> 460 <para> 461 You can include a remote user name in the host name 462 (<replaceable>user@host</replaceable>). You can also set ssh options by ··· 465 </listitem> 466 </varlistentry> 467 </variablelist> 468 <para> 469 In addition, <command>nixos-rebuild</command> accepts various Nix-related 470 flags, including <option>--max-jobs</option> / <option>-j</option>, ··· 473 <option>-v</option>. See the Nix manual for details. 474 </para> 475 </refsection> 476 <refsection> 477 <title>Environment</title> 478 <variablelist> 479 <varlistentry> 480 <term> ··· 487 </para> 488 </listitem> 489 </varlistentry> 490 <varlistentry> 491 <term> 492 <envar>NIX_SSHOPTS</envar> ··· 500 </varlistentry> 501 </variablelist> 502 </refsection> 503 <refsection> 504 <title>Files</title> 505 <variablelist> 506 <varlistentry> 507 <term> 508 <filename>/run/current-system</filename> ··· 513 </para> 514 </listitem> 515 </varlistentry> 516 <varlistentry> 517 <term> 518 <filename>/nix/var/nix/profiles/system</filename> ··· 524 </para> 525 </listitem> 526 </varlistentry> 527 </variablelist> 528 </refsection> 529 <refsection> 530 <title>Bugs</title> 531 <para>
··· 7 <refmiscinfo class="source">NixOS</refmiscinfo> 8 <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> 9 </refmeta> 10 + 11 <refnamediv> 12 <refname><command>nixos-rebuild</command> 13 </refname><refpurpose>reconfigure a NixOS machine</refpurpose> 14 </refnamediv> 15 + 16 <refsynopsisdiv> 17 <cmdsynopsis> 18 <command>nixos-rebuild</command><group choice='req'> ··· 76 <arg> 77 <option>--builders</option> <replaceable>builder-spec</replaceable> 78 </arg> 79 + 80 <sbr /> 81 <arg> 82 <group choice='req'> ··· 124 </arg> 125 </cmdsynopsis> 126 </refsynopsisdiv> 127 + 128 <refsection> 129 <title>Description</title> 130 + 131 <para> 132 This command updates the system so that it corresponds to the configuration 133 specified in <filename>/etc/nixos/configuration.nix</filename>. Thus, every ··· 138 (re)starts any system services if needed. Please note that user services need 139 to be started manually as they aren't detected by the activation script at the moment. 140 </para> 141 + 142 <para> 143 This command has one required argument, which specifies the desired 144 operation. It must be one of the following: 145 + 146 <variablelist> 147 <varlistentry> 148 <term> ··· 159 </para> 160 </listitem> 161 </varlistentry> 162 + 163 <varlistentry> 164 <term> 165 <option>boot</option> ··· 173 </para> 174 </listitem> 175 </varlistentry> 176 + 177 <varlistentry> 178 <term> 179 <option>test</option> ··· 188 </para> 189 </listitem> 190 </varlistentry> 191 + 192 <varlistentry> 193 <term> 194 <option>build</option> ··· 207 </para> 208 </listitem> 209 </varlistentry> 210 + 211 <varlistentry> 212 <term> 213 <option>dry-build</option> ··· 219 </para> 220 </listitem> 221 </varlistentry> 222 + 223 <varlistentry> 224 <term> 225 <option>dry-activate</option> ··· 234 </para> 235 </listitem> 236 </varlistentry> 237 + 238 <varlistentry> 239 <term> 240 <option>edit</option> ··· 245 </para> 246 </listitem> 247 </varlistentry> 248 + 249 <varlistentry> 250 <term> 251 <option>build-vm</option> ··· 263 <prompt>$ </prompt>./result/bin/run-*-vm 264 </screen> 265 </para> 266 + 267 <para> 268 The VM is implemented using the <literal>qemu</literal> package. For 269 best performance, you should load the <literal>kvm-intel</literal> or 270 <literal>kvm-amd</literal> kernel modules to get hardware 271 virtualisation. 272 </para> 273 + 274 <para> 275 The VM mounts the Nix store of the host through the 9P file system. The 276 host Nix store is read-only, so Nix commands that modify the Nix store ··· 278 <command>nixos-rebuild</command>; to change the VM’s configuration, 279 you must halt the VM and re-run the commands above. 280 </para> 281 + 282 <para> 283 The VM has its own <literal>ext3</literal> root file system, which is 284 automatically created when the VM is first started, and is persistent ··· 289 </para> 290 </listitem> 291 </varlistentry> 292 + 293 <varlistentry> 294 <term> 295 <option>build-vm-with-bootloader</option> ··· 312 </variablelist> 313 </para> 314 </refsection> 315 + 316 <refsection> 317 <title>Options</title> 318 <para> 319 This command accepts the following options: 320 </para> 321 + 322 <variablelist> 323 <varlistentry> 324 <term> ··· 330 </para> 331 </listitem> 332 </varlistentry> 333 + 334 <varlistentry> 335 <term> 336 <option>--install-bootloader</option> ··· 342 </para> 343 </listitem> 344 </varlistentry> 345 + 346 <varlistentry> 347 <term> 348 <option>--no-build-nix</option> ··· 358 </para> 359 </listitem> 360 </varlistentry> 361 + 362 <varlistentry> 363 <term> 364 <option>--fast</option> ··· 372 </para> 373 </listitem> 374 </varlistentry> 375 + 376 <varlistentry> 377 <term> 378 <option>--rollback</option> ··· 387 </para> 388 </listitem> 389 </varlistentry> 390 + 391 <varlistentry> 392 <term> 393 <option>--builders</option> <replaceable>builder-spec</replaceable> ··· 407 </para> 408 </listitem> 409 </varlistentry> 410 + 411 <varlistentry> 412 <term> 413 <option>--profile-name</option> ··· 438 </para> 439 </listitem> 440 </varlistentry> 441 + 442 <varlistentry> 443 <term> 444 <option>--build-host</option> ··· 464 </para> 465 </listitem> 466 </varlistentry> 467 + 468 <varlistentry> 469 <term> 470 <option>--target-host</option> ··· 477 be accessible over ssh, and for the commands <option>switch</option>, 478 <option>boot</option> and <option>test</option> you need root access. 479 </para> 480 + 481 <para> 482 If <option>--build-host</option> is not explicitly specified, 483 <option>--build-host</option> will implicitly be set to the same value as ··· 486 place remotely (and no build artifacts will be copied to the local 487 machine). 488 </para> 489 + 490 <para> 491 You can include a remote user name in the host name 492 (<replaceable>user@host</replaceable>). You can also set ssh options by ··· 495 </listitem> 496 </varlistentry> 497 </variablelist> 498 + 499 <para> 500 In addition, <command>nixos-rebuild</command> accepts various Nix-related 501 flags, including <option>--max-jobs</option> / <option>-j</option>, ··· 504 <option>-v</option>. See the Nix manual for details. 505 </para> 506 </refsection> 507 + 508 <refsection> 509 <title>Environment</title> 510 + 511 <variablelist> 512 <varlistentry> 513 <term> ··· 520 </para> 521 </listitem> 522 </varlistentry> 523 + 524 <varlistentry> 525 <term> 526 <envar>NIX_SSHOPTS</envar> ··· 534 </varlistentry> 535 </variablelist> 536 </refsection> 537 + 538 <refsection> 539 <title>Files</title> 540 + 541 <variablelist> 542 + 543 <varlistentry> 544 <term> 545 <filename>/run/current-system</filename> ··· 550 </para> 551 </listitem> 552 </varlistentry> 553 + 554 <varlistentry> 555 <term> 556 <filename>/nix/var/nix/profiles/system</filename> ··· 562 </para> 563 </listitem> 564 </varlistentry> 565 + 566 </variablelist> 567 </refsection> 568 + 569 <refsection> 570 <title>Bugs</title> 571 <para>