From 7d2e1d26cbf10f342b8078040234f2ac354ec320 Mon Sep 17 00:00:00 2001 From: Eric Hameleers Date: Tue, 26 Oct 2021 13:06:01 +0200 Subject: Update the documentation and grub/syslinux help texts --- EFI/BOOT/help.txt | 24 +++++++++++++++++++++--- README.txt | 7 +++++++ syslinux/f2.txt | 4 ++++ syslinux/f3.txt | 25 ++++++++++++++++++------- syslinux/f4.txt | 2 ++ 5 files changed, 52 insertions(+), 10 deletions(-) diff --git a/EFI/BOOT/help.txt b/EFI/BOOT/help.txt index cb35533..8d7310e 100644 --- a/EFI/BOOT/help.txt +++ b/EFI/BOOT/help.txt @@ -10,11 +10,15 @@ To boot with default values just press ENTER. kbd=fr xkb=ch,fr => Example of custom X keyboard layout. livepw="somestring" => Change the password for user "live". + The password is passed as a cleartext string. + You can pass an empty string (livepw=) to remove the password. locale=nl_NL kbd=nl tz=Europe/Amsterdam => Example of language, keyboard and/or timezone customization. rootpw="somestring" => Change the password for user "root". + The password is passed as a cleartext string. + You can pass an empty string (rootpw=) to remove the password. === Custom software === @@ -52,8 +56,10 @@ localhd => initialize RAID/LVM on local hard drives. tweaks=tweak1[,tweak2,[,...]] => Implemented tweaks: nga - no glamor 2D acceleration, avoids error "EGL_MESA_drm_image required". + nsh - no sub-pixel hinting in freetype. tpb - enable TrackPoint scrolling while holding down middle mouse button. syn - start the syndaemon for better support of Synaptics touchpads. + ssh - start SSH daemon (disabled by default). nomodeset => Boot without kernel mode setting, needed with some machines. @@ -83,7 +89,8 @@ livemedia=/dev/sdX => Tell the init script which partition become necessary if you have another copy of Slackware Live installed in another partition. -livemedia=/dev/sdX:/path/to/live.iso => Use this if you want to +livemedia=/dev/sdX:/path/to/live.iso +livemedia=scandev:/path/to/live.iso => Use this if you want to load the live OS from an ISO file on a local harddisk partition. livemain=directoryname => Use this if you copied the content @@ -94,13 +101,24 @@ luksvol=file1[:/mountpoint1][,file1[:/mountpoint2],...] => Multiple files should be separated with comma. Specify "luksvol=" to *prevent* mounting any LUKS container. -nop => No persistence, i.e. boot the virgin installation in - case your "persistence" directory got corrupted. +nop => No persistence, i.e. boot the virgin installation in + case your "persistence" directory got corrupted. + If you want to ignore any persistent data during boot, + including LUKS data, specify "nop luksvol=" . + +nop=wipe => Wipe all data from persistence directory or container. + Useful in cases where your persistent data got corrupted. persistence=directoryname => Use this if you want to use a different directory than "persistence" for storing persistent data. +persistence=/dev/sdX:/path/to/mypersistence +persistence=scandev:/path/to/mypersistence => Use this if + the persistence directory or container is not located on the USB stick, + but on a local hard disk partition. Useful for network (PXE) boot + where you still want to offer users persistence. + toram => copy the OS from the media to to RAM before running it. You can remove the boot media after booting. diff --git a/README.txt b/README.txt index 90c6146..f0cf0bf 100644 --- a/README.txt +++ b/README.txt @@ -120,6 +120,7 @@ This script, called 'iso2usb.sh', accepts the following parameters: -i|--infile Full path to the ISO image file. -o|--outdev The device name of your USB drive. -p|--persistence Custom name of the 'persistence' directory/file. + If it does not exist yet, create it manually. -r|--refresh Refresh the USB stick with the ISO content. No formatting, do not touch user content. -s|--scan Scan for insertion of new USB device instead of @@ -391,6 +392,12 @@ nop=wipe => Wipe all data from persistence directory or container. persistence=name => Use this if you are using a different directory/file than "persistence" for storing persistent data. +persistence=/dev/sdX:/path/to/mypersistence +persistence=scandev:/path/to/mypersistence => Use this if + the persistence directory or container is not located on the USB stick, + but on a local hard disk partition. Useful for network (PXE) boot + where you still want to offer users persistence. + toram => copy the OS from the media to to RAM before running it. You can remove the boot media after booting. diff --git a/syslinux/f2.txt b/syslinux/f2.txt index 2451b39..1a41e5c 100644 --- a/syslinux/f2.txt +++ b/syslinux/f2.txt @@ -8,11 +8,15 @@ kbd=fr xkb=ch,fr => Example of custom X keyboard layout. livepw="somestring" => Change the password for user "live". + The password is passed as a cleartext string. + You can pass an empty string (livepw=) to remove the password. locale=nl_NL kbd=nl tz=Europe/Amsterdam => Example of language, keyboard and/or timezone customization. rootpw="somestring" => Change the password for user "root". + The password is passed as a cleartext string. + You can pass an empty string (rootpw=) to remove the password. === Custom software === diff --git a/syslinux/f3.txt b/syslinux/f3.txt index 7d14801..a311cb5 100644 --- a/syslinux/f3.txt +++ b/syslinux/f3.txt @@ -21,18 +21,29 @@ livemedia=/dev/sdX => Tell the init script which partition become necessary if you have another copy of Slackware Live installed in another partition. Also accepted: UUID or LABEL. -livemedia=/dev/sdX:/path/to/live.iso => Use this if you want to +livemedia=/dev/sdX:/path/to/live.iso +livemedia=scandev:/path/to/live.iso => Use this if you want to load the live OS from an ISO file on a local harddisk partition. livemain=directoryname => Use this if you copied the content of the ISO to a different directory than "liveslak". -nop => No persistence, i.e. boot the virgin installation in - case your "persistence" directory got corrupted. - -persistence=directoryname => Use this if you want to use - a different directory than "persistence" for storing - persistent data. +nop => No persistence, i.e. boot the virgin installation in + case your "persistence" directory got corrupted. + If you want to ignore any persistent data during boot, + including LUKS data, specify "nop luksvol=" . + +nop=wipe => Wipe all data from persistence directory or container. + Useful in cases where your persistent data got corrupted. + +persistence=name => Use this if you are using a different + directory/file than "persistence" for storing persistent data. + +persistence=/dev/sdX:/path/to/mypersistence +persistence=scandev:/path/to/mypersistence => Use this if + the persistence directory or container is not located on the USB stick, + but on a local hard disk partition. Useful for network (PXE) boot + where you still want to offer users persistence. toram => copy the OS from the media to to RAM before running it. You can remove the boot media after booting. diff --git a/syslinux/f4.txt b/syslinux/f4.txt index c890348..80ca985 100644 --- a/syslinux/f4.txt +++ b/syslinux/f4.txt @@ -6,8 +6,10 @@ localhd => initialize RAID/LVM on local hard drives. tweaks=tweak1[,tweak2,[,...]] => Implemented tweaks: nga - no glamor 2D acceleration, avoids error "EGL_MESA_drm_image required". + nsh - no sub-pixel hinting in freetype. tpb - enable TrackPoint scrolling while holding down middle mouse button. syn - start the syndaemon for better support of Synaptics touchpads. + ssh - start SSH daemon (disabled by default). nomodeset => Boot without kernel mode setting, needed with some machines. -- cgit v1.2.3