man-nixos-rebuild.xml: Improve layout

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