From 5f8d14546b6a5a5df8a4768833497a674083dd8e Mon Sep 17 00:00:00 2001 From: Wilhelm Schuster Date: Wed, 1 Jun 2016 16:23:32 +0200 Subject: Manual: Explicitly mark commands that require to be run as root (#15589) * manual: Mark commands that require root Mark every command that requires to be run as root by prefixing them with '#' instead of '$'. * manual: Add note about commands that require root --- nixos/doc/manual/configuration/adding-custom-packages.xml | 2 +- nixos/doc/manual/configuration/linux-kernel.xml | 2 +- nixos/doc/manual/configuration/luks-file-systems.xml | 6 +++--- nixos/doc/manual/configuration/user-mgmt.xml | 8 ++++---- nixos/doc/manual/configuration/wireless.xml | 4 ++-- nixos/doc/manual/configuration/x-windows.xml | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) (limited to 'nixos/doc/manual/configuration') diff --git a/nixos/doc/manual/configuration/adding-custom-packages.xml b/nixos/doc/manual/configuration/adding-custom-packages.xml index c1789fcbc041..ab3665bae504 100644 --- a/nixos/doc/manual/configuration/adding-custom-packages.xml +++ b/nixos/doc/manual/configuration/adding-custom-packages.xml @@ -31,7 +31,7 @@ and you run nixos-rebuild, specifying your own Nixpkgs tree: -$ nixos-rebuild switch -I nixpkgs=/path/to/my/nixpkgs +# nixos-rebuild switch -I nixpkgs=/path/to/my/nixpkgs diff --git a/nixos/doc/manual/configuration/linux-kernel.xml b/nixos/doc/manual/configuration/linux-kernel.xml index b008baaa66c9..52be26d6024a 100644 --- a/nixos/doc/manual/configuration/linux-kernel.xml +++ b/nixos/doc/manual/configuration/linux-kernel.xml @@ -82,7 +82,7 @@ $ nix-shell '' -A linuxPackages.kernel $ unpackPhase $ cd linux-* $ make -C $dev/lib/modules/*/build M=$(pwd)/drivers/net/ethernet/mellanox modules -$ sudo insmod ./drivers/net/ethernet/mellanox/mlx5/core/mlx5_core.ko +# insmod ./drivers/net/ethernet/mellanox/mlx5/core/mlx5_core.ko ]]> diff --git a/nixos/doc/manual/configuration/luks-file-systems.xml b/nixos/doc/manual/configuration/luks-file-systems.xml index 88b506d5323d..2062456703f7 100644 --- a/nixos/doc/manual/configuration/luks-file-systems.xml +++ b/nixos/doc/manual/configuration/luks-file-systems.xml @@ -12,7 +12,7 @@ here is how you create an encrypted Ext4 file system on the device /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: -$ cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d +# cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d WARNING! ======== @@ -22,10 +22,10 @@ Are you sure? (Type uppercase yes): YES Enter LUKS passphrase: *** Verify passphrase: *** -$ cryptsetup luksOpen /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d crypted +# cryptsetup luksOpen /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d crypted Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: *** -$ mkfs.ext4 /dev/mapper/crypted +# mkfs.ext4 /dev/mapper/crypted To ensure that this file system is automatically mounted at boot time diff --git a/nixos/doc/manual/configuration/user-mgmt.xml b/nixos/doc/manual/configuration/user-mgmt.xml index 631742059278..829e5b9ea842 100644 --- a/nixos/doc/manual/configuration/user-mgmt.xml +++ b/nixos/doc/manual/configuration/user-mgmt.xml @@ -63,14 +63,14 @@ commands such as useradd, account named alice: -$ useradd -m alice +# useradd -m alice To make all nix tools available to this new user use `su - USER` which opens a login shell (==shell that loads the profile) for given user. This will create the ~/.nix-defexpr symlink. So run: -$ su - alice -c "true" +# su - alice -c "true" The flag causes the creation of a home directory @@ -79,7 +79,7 @@ have an initial password and therefore cannot log in. A password can be set using the passwd utility: -$ passwd alice +# passwd alice Enter new UNIX password: *** Retype new UNIX password: *** @@ -87,7 +87,7 @@ Retype new UNIX password: *** A user can be deleted using userdel: -$ userdel -r alice +# userdel -r alice The flag deletes the user’s home directory. Accounts can be modified using usermod. Unix diff --git a/nixos/doc/manual/configuration/wireless.xml b/nixos/doc/manual/configuration/wireless.xml index e4560f2da36b..1868380dcbfa 100644 --- a/nixos/doc/manual/configuration/wireless.xml +++ b/nixos/doc/manual/configuration/wireless.xml @@ -41,13 +41,13 @@ If you are using WPA2 the wpa_passphrase tool might be useful to generate the wpa_supplicant.conf. -$ wpa_passphrase ESSID PSK > /etc/wpa_supplicant.conf +# wpa_passphrase ESSID PSK > /etc/wpa_supplicant.conf After you have edited the wpa_supplicant.conf, you need to restart the wpa_supplicant service. -$ systemctl restart wpa_supplicant.service +# systemctl restart wpa_supplicant.service diff --git a/nixos/doc/manual/configuration/x-windows.xml b/nixos/doc/manual/configuration/x-windows.xml index 7f43acab2c38..0405146ab0fa 100644 --- a/nixos/doc/manual/configuration/x-windows.xml +++ b/nixos/doc/manual/configuration/x-windows.xml @@ -5,7 +5,7 @@ xml:id="sec-x11"> X Window System - + The X Window System (X11) provides the basis of NixOS’ graphical user interface. It can be enabled as follows: @@ -48,7 +48,7 @@ services.xserver.autorun = false; The X server can then be started manually: -$ systemctl start display-manager.service +# systemctl start display-manager.service -- cgit 1.4.1