diff options
Diffstat (limited to 'docs')
30 files changed, 235 insertions, 188 deletions
diff --git a/docs/bsd/freebsd.md b/docs/bsd/freebsd.md index 4ff29a47..2241c916 100644 --- a/docs/bsd/freebsd.md +++ b/docs/bsd/freebsd.md @@ -57,20 +57,20 @@ how to create the bootable FreeBSD USB drive: Connect the USB drive. Check dmesg: - $ dmesg | tail + \$ dmesg | tail Check to confirm which drive it is, for example, if you think its sd3: - $ disklabel sd3 + \$ disklabel sd3 Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ doas umount /dev/sd3i + \$ doas umount /dev/sd3i dmesg told you what device it is. Overwrite the drive, writing the FreeBSD installer to it with dd. For example: - $ doas dd if=freebsd.img of=/dev/rsdXc bs=1M; sync + \$ doas dd if=freebsd.img of=/dev/rsdXc bs=1M; sync You should now be able to boot the installer from your USB drive. Continue reading, for information about how to do that. @@ -83,21 +83,21 @@ the bootable FreeBSD USB drive: Connect the USB drive. Check dmesg: - $ dmesg + \$ dmesg Check lsblk to confirm which drive it is: - $ lsblk + \$ lsblk Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ sudo umount /dev/sdX* + \$ sudo umount /dev/sdX* # umount /dev/sdX* dmesg told you what device it is. Overwrite the drive, writing your distro ISO to it with dd. For example: - $ sudo dd if=freebsd.img of=/dev/sdX bs=8M; sync + \$ sudo dd if=freebsd.img of=/dev/sdX bs=8M; sync # dd if=freebsd.img of=/dev/sdX bs=8M; sync You should now be able to boot the installer from your USB drive. diff --git a/docs/bsd/netbsd.md b/docs/bsd/netbsd.md index 9d1dd517..2de937a1 100644 --- a/docs/bsd/netbsd.md +++ b/docs/bsd/netbsd.md @@ -53,20 +53,20 @@ to create the bootable NetBSD USB drive: Connect the USB drive. Check dmesg: - $ dmesg | tail + \$ dmesg | tail Check to confirm which drive it is, for example, if you think its sd3: - $ disklabel sd3 + \$ disklabel sd3 Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ doas umount /dev/sd3i + \$ doas umount /dev/sd3i dmesg told you what device it is. Overwrite the drive, writing the NetBSD installer to it with dd. For example: - $ doas netbsd.iso of=/dev/rsdXc bs=1M; sync + \$ doas netbsd.iso of=/dev/rsdXc bs=1M; sync You should now be able to boot the installer from your USB drive. Continue reading, for information about how to do that. @@ -79,21 +79,21 @@ the bootable NetBSD USB drive: Connect the USB drive. Check dmesg: - $ dmesg + \$ dmesg Check lsblk to confirm which drive it is: - $ lsblk + \$ lsblk Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ sudo umount /dev/sdX* + \$ sudo umount /dev/sdX* # umount /dev/sdX* dmesg told you what device it is. Overwrite the drive, writing your distro ISO to it with dd. For example: - $ sudo dd if=install60.fs of=/dev/sdX bs=8M; sync + \$ sudo dd if=install60.fs of=/dev/sdX bs=8M; sync # dd if=netbsd.iso of=/dev/sdX bs=8M; sync You should now be able to boot the installer from your USB drive. diff --git a/docs/bsd/openbsd.md b/docs/bsd/openbsd.md index 0bd07c2d..308a57f1 100644 --- a/docs/bsd/openbsd.md +++ b/docs/bsd/openbsd.md @@ -35,20 +35,20 @@ how to create the bootable LibertyBSD/OpenBSD USB drive: Connect the USB drive. Check dmesg: - $ dmesg | tail + \$ dmesg | tail Check to confirm which drive it is, for example, if you think its sd3: - $ disklabel sd3 + \$ disklabel sd3 Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ doas umount /dev/sd3i + \$ doas umount /dev/sd3i dmesg told you what device it is. Overwrite the drive, writing the OpenBSD installer to it with dd. For example: - $ doas dd if=install60.fs of=/dev/rsdXc bs=1M; sync + \$ doas dd if=install60.fs of=/dev/rsdXc bs=1M; sync You should now be able to boot the installer from your USB drive. Continue reading, for information about how to do that. @@ -78,21 +78,21 @@ the bootable OpenBSD USB drive: Connect the USB drive. Check dmesg: - $ dmesg + \$ dmesg Check lsblk to confirm which drive it is: - $ lsblk + \$ lsblk Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ sudo umount /dev/sdX* + \$ sudo umount /dev/sdX* # umount /dev/sdX* dmesg told you what device it is. Overwrite the drive, writing your distro ISO to it with dd. For example: - $ sudo dd if=install60.fs of=/dev/sdX bs=8M; sync + \$ sudo dd if=install60.fs of=/dev/sdX bs=8M; sync # dd if=install60.fs of=/dev/sdX bs=8M; sync You should now be able to boot the installer from your USB drive. diff --git a/docs/future/index.md b/docs/future/index.md index 082ea623..d7be7be3 100644 --- a/docs/future/index.md +++ b/docs/future/index.md @@ -330,12 +330,12 @@ getting this output. Get intelvbttool here: <http://review.coreboot.org/#/c/5842> (util/intelvbttool). -Now dump a copy of the running VGA BIOS: **$ sudo dd if=/dev/mem bs=64k +Now dump a copy of the running VGA BIOS: **\$ sudo dd if=/dev/mem bs=64k of=runningvga.bin skip=12 count=1** Then do (and record the output): - $ ./intelvbttool runningvga.bin > intelvbttool\_out + \$ ./intelvbttool runningvga.bin > intelvbttool\_out Backup both files (runningvga.bin and intelvbttool\_out), renaming them to match the system and LCD panel used. diff --git a/docs/git/index.md b/docs/git/index.md index 7f765d22..9fbfc15b 100644 --- a/docs/git/index.md +++ b/docs/git/index.md @@ -28,12 +28,12 @@ statically compiled executables for the utilities are included.** For Debian Stretch (may also work on Debian Jessie), you can run the following command: - $ sudo ./oldbuild dependencies debian + \$ sudo ./oldbuild dependencies debian (this will also work in Devuan) For Parabola, you can run the following command: - $ sudo ./oldbuild dependencies parabola + \$ sudo ./oldbuild dependencies parabola or: # **./oldbuild dependencies parabola** @@ -57,23 +57,23 @@ Since libreboot makes extensive use of git, you need to configure git properly. If you have not yet configured git, then the minimum requirement is: - $ git config \--global user.name "Your Name" - $ git config \--global user.email your@emailaddress.com + \$ git config \--global user.name "Your Name" + \$ git config \--global user.email your@emailaddress.com This is what will also appear in git logs if you ever commit your own changes to a given repository. For more information, see <http://git-scm.com/doc>. Another nice config for you (optional, but recommended): - $ git config \--global core.editor nano - $ git config \--global color.status auto - $ git config \--global color.branch auto - $ git config \--global color.interactive auto -$ **git config \--global color.diff auto** + \$ git config \--global core.editor nano + \$ git config \--global color.status auto + \$ git config \--global color.branch auto + \$ git config \--global color.interactive auto +\$ **git config \--global color.diff auto** After that, run the script: -$ **./download all** +\$ **./download all** What this did was download everything (grub, coreboot, memtest86+, bucts, flashrom) at the versions last tested for this release, and patch @@ -132,11 +132,11 @@ First, [install the build dependencies](#build_dependencies). To build bucts, do this in the main directory: -$ **./oldbuild module bucts** +\$ **./oldbuild module bucts** To statically compile it, do this: -$ **./oldbuild module bucts static** +\$ **./oldbuild module bucts static** The "builddeps" script in libreboot\_src also makes use of builddeps-bucts. @@ -164,11 +164,11 @@ First, [install the build dependencies](#build_dependencies). To build it, do the following in the main directory: -$ **./oldbuild module flashrom** +\$ **./oldbuild module flashrom** To statically compile it, do the following in the main directory: -$ **./oldbuild module flashrom static** +\$ **./oldbuild module flashrom static** After you've done that, under ./flashrom/ you will find the following executables: @@ -211,28 +211,28 @@ If you downloaded libreboot from git, refer to Build all of the components used in libreboot: -$ **./oldbuild module all** +\$ **./oldbuild module all** You can also build each modules separately, using *./oldbuild module modulename*. To see the possible values for *modulename*, use: -$ **./oldbuild module list** +\$ **./oldbuild module list** After that, build the ROM images (for all boards): - $ ./oldbuild roms withgrub + \$ ./oldbuild roms withgrub Alternatively, you can build for a specific board or set of boards. For example: - $ ./oldbuild roms withgrub x60 - $ ./oldbuild roms withgrub x200\_8mb - $ ./oldbuild roms withgrub x60 x200\_8mb + \$ ./oldbuild roms withgrub x60 + \$ ./oldbuild roms withgrub x200\_8mb + \$ ./oldbuild roms withgrub x60 x200\_8mb The list of board options can be found by looking at the directory names in **resources/libreboot/config/grub/**. To clean (reverse) everything, do the following: -$ **./oldbuild clean all** +\$ **./oldbuild clean all** The ROM images will be stored under **bin/*payload*/**, where *payload* could be *grub*, *seabios*, or whatever other payload those images were @@ -248,40 +248,40 @@ will also work in Devuan.** This is mainly intended for use with the git repository. These commands will work in the release archive (\_src), unless otherwise noted below. -The archives will appear under *release/oldbuildsystem/${version}/*; -${version} will either be set using *git describe* or, if a *version* +The archives will appear under *release/oldbuildsystem/\${version}/*; +\${version} will either be set using *git describe* or, if a *version* file already exists (\_src release archive), then it will simply re-use that. Tag the current commit, and that version will appear in both the -${version} string on the directory under *release/oldbuildsystem/*, and +\${version} string on the directory under *release/oldbuildsystem/*, and in the file names of the archives. Otherwise, whatever git uses for *git describe \--tags HEAD* will be used. Utilities (static executables): -$ **./oldbuild release util** +\$ **./oldbuild release util** Archive containing flashrom and bucts source code: -$ **./oldbuild release tobuild** +\$ **./oldbuild release tobuild** Documentation archive (**does not work on \_src release archive, only git**): -$ **./oldbuild release docs** +\$ **./oldbuild release docs** ROM image archives: -$ **./oldbuild release roms** +\$ **./oldbuild release roms** Source code archive: -$ **./oldbuild release src** +\$ **./oldbuild release src** SHA512 sums of all other release archives that have been generated: -$ **./oldbuild release sha512sums** +\$ **./oldbuild release sha512sums** If you are building on an i686 host, this will build statically linked 32-bit binaries in the binary release archive that you created, for: @@ -311,8 +311,8 @@ libreboot\_util, for: If you are building binaries on a live system or chroot (for flashrom/bucts), you can use the following to statically link them: - $ ./oldbuild module flashrom static -$ **./oldbuild module bucts static** + \$ ./oldbuild module flashrom static +\$ **./oldbuild module bucts static** The same conditions as above apply for ARM (except, building bucts on ARM is pointless, and for flashrom you only need the normal executable @@ -323,7 +323,7 @@ restrictions). The command that you used for generating the release archives will also run the following command: - $ ./oldbuild release tobuild + \$ ./oldbuild release tobuild The archive **tobuild.tar.xz** will have been created under **release/oldbuildsystem/**, containing bucts, flashrom and all other required resources for building them. diff --git a/docs/global.css b/docs/global.css new file mode 100644 index 00000000..0c14c721 --- /dev/null +++ b/docs/global.css @@ -0,0 +1,37 @@ +html { + background-color: #eee; +} + +body { + background-color: #fff; + margin: 0 auto; + max-width: 60em; + padding: 0.2em 1em; + box-shadow: 0 0 6px; +} + +body { + line-height: 1.4; + font-family: sans-serif; + font-size: 1em; + + color: #222; +} + +h1 { + font-size: 2.0em; +} + +#logo { + width: 25%; + float: right; +} + +a { + text-decoration: none; + color: #22D; +} + +a:hover { + color: #008; +} diff --git a/docs/gnulinux/configuring_parabola.md b/docs/gnulinux/configuring_parabola.md index ea06dec2..0612cd7d 100644 --- a/docs/gnulinux/configuring_parabola.md +++ b/docs/gnulinux/configuring_parabola.md @@ -611,7 +611,7 @@ I didn't want the following, so I removed them: I also lazily installed all fonts: -# **pacman -S $(pacman -Ssq ttf-)** +# **pacman -S \$(pacman -Ssq ttf-)** And a mail client: @@ -638,7 +638,7 @@ start lxde without lxdm. Read Open LXterminal: - $ cp /etc/skel/.xinitrc \~ + \$ cp /etc/skel/.xinitrc \~ Open .xinitrc and add the following plus a line break at the bottom of the file. @@ -656,7 +656,7 @@ exec startlxde * Now make sure that it is executable: -$ **chmod +x .xinitrc** +\$ **chmod +x .xinitrc** [Back to top of page.](#pagetop) diff --git a/docs/gnulinux/encrypted_debian.md b/docs/gnulinux/encrypted_debian.md index a6021852..b74af313 100644 --- a/docs/gnulinux/encrypted_debian.md +++ b/docs/gnulinux/encrypted_debian.md @@ -193,7 +193,7 @@ this section. Immediately after logging in, do that: -$ **sudo ecryptfs-unwrap-passphrase** +\$ **sudo ecryptfs-unwrap-passphrase** This will be needed in the future if you ever need to recover your home directory from another system, so write it down and keep the note diff --git a/docs/gnulinux/encrypted_parabola.md b/docs/gnulinux/encrypted_parabola.md index 34e850fd..005def8c 100644 --- a/docs/gnulinux/encrypted_parabola.md +++ b/docs/gnulinux/encrypted_parabola.md @@ -572,13 +572,13 @@ option at the end, with the name of your chosen chip is quotes. You can check if everything is in there (*grub.cfg* and *grubtest.cfg* would be really nice): - $ ./cbfstool libreboot.rom print + \$ ./cbfstool libreboot.rom print Extract grubtest.cfg: - $ ./cbfstool libreboot.rom extract -n grubtest.cfg -f grubtest.cfg + \$ ./cbfstool libreboot.rom extract -n grubtest.cfg -f grubtest.cfg And modify: -$ **vi grubtest.cfg** +\$ **vi grubtest.cfg** In grubtest.cfg, inside the 'Load Operating System' menu entry, change the contents to: @@ -608,10 +608,10 @@ hardening your GRUB configuration, for security purposes. Save your changes in grubtest.cfg, then delete the unmodified config from the ROM image: - $ ./cbfstool libreboot.rom remove -n grubtest.cfg + \$ ./cbfstool libreboot.rom remove -n grubtest.cfg and insert the modified grubtest.cfg: -$ **./cbfstool libreboot.rom add -n grubtest.cfg -f grubtest.cfg -t +\$ **./cbfstool libreboot.rom add -n grubtest.cfg -f grubtest.cfg -t raw** Now refer to <http://libreboot.org/docs/install/#flashrom>. Cd (up) to @@ -650,16 +650,16 @@ this guide again in the future (modifying the already modified config). Inside libreboot\_util/cbfstool/{armv7l i686 x86\_64}, we can do this with the following command: -$ **sed -e 's:(cbfsdisk)/grub.cfg:(cbfsdisk)/grubtest.cfg:g' -e +\$ **sed -e 's:(cbfsdisk)/grub.cfg:(cbfsdisk)/grubtest.cfg:g' -e 's:Switch to grub.cfg:Switch to grubtest.cfg:g' < grubtest.cfg > grub.cfg** Delete the grub.cfg that remained inside the ROM: - $ ./cbfstool libreboot.rom remove -n grub.cfg + \$ ./cbfstool libreboot.rom remove -n grub.cfg Add the modified version that you just made: - $ ./cbfstool libreboot.rom add -n grub.cfg -f grub.cfg -t raw + \$ ./cbfstool libreboot.rom add -n grub.cfg -f grub.cfg -t raw Now you have a modified ROM. Once more, refer to <http://libreboot.org/docs/install/#flashrom>. Cd to the libreboot\_util diff --git a/docs/gnulinux/grub_boot_installer.md b/docs/gnulinux/grub_boot_installer.md index 8821f1ef..edd25715 100644 --- a/docs/gnulinux/grub_boot_installer.md +++ b/docs/gnulinux/grub_boot_installer.md @@ -26,21 +26,21 @@ to create the bootable GNU+Linux USB drive: Connect the USB drive. Check dmesg: - $ dmesg + \$ dmesg Check lsblk to confirm which drive it is: - $ lsblk + \$ lsblk Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ sudo umount /dev/sdX* + \$ sudo umount /dev/sdX* # umount /dev/sdX* dmesg told you what device it is. Overwrite the drive, writing your distro ISO to it with dd. For example: - $ sudo dd if=gnulinux.iso of=/dev/sdX bs=8M; sync + \$ sudo dd if=gnulinux.iso of=/dev/sdX bs=8M; sync # dd if=gnulinux.iso of=/dev/sdX bs=8M; sync You should now be able to boot the installer from your USB drive. @@ -71,20 +71,20 @@ how to create the bootable GNU+Linux USB drive: Connect the USB drive. Check dmesg: - $ dmesg | tail + \$ dmesg | tail Check to confirm which drive it is, for example, if you think its sd3: - $ disklabel sd3 + \$ disklabel sd3 Check that it wasn't automatically mounted. If it was, unmount it. For example: - $ doas umount /dev/sd3i + \$ doas umount /dev/sd3i dmesg told you what device it is. Overwrite the drive, writing the OpenBSD installer to it with dd. For example: - $ doas dd if=gnulinux.iso of=/dev/rsdXc bs=1M; sync + \$ doas dd if=gnulinux.iso of=/dev/rsdXc bs=1M; sync You should now be able to boot the installer from your USB drive. Continue reading, for information about how to do that. diff --git a/docs/gnulinux/grub_cbfs.md b/docs/gnulinux/grub_cbfs.md index deb0a456..14f0ef5b 100644 --- a/docs/gnulinux/grub_cbfs.md +++ b/docs/gnulinux/grub_cbfs.md @@ -130,7 +130,7 @@ image file is named *libreboot.rom*, so please make sure to adapt. ROM images are included pre-compiled in libreboot. You can also dump your current firmware, using flashrom: - $ sudo flashrom -p internal -r libreboot.rom + \$ sudo flashrom -p internal -r libreboot.rom # flashrom -p internal -r libreboot.rom If you are told to specify the chip, add the option **-c {your chip}** to the command, for example: @@ -144,7 +144,7 @@ Extract grubtest.cfg from the ROM image {#extract_testconfig} You can check the contents of the ROM image, inside CBFS: - $ cd .../libreboot\_util/cbfstool** $ ./cbfstool libreboot.rom + \$ cd .../libreboot\_util/cbfstool** \$ ./cbfstool libreboot.rom print** The files *grub.cfg* and *grubtest.cfg* should be present. grub.cfg is @@ -154,7 +154,7 @@ reduce the possibility of bricking your device, so DO NOT SKIP THIS! Extract grubtest.cfg from the ROM image: - $ ./cbfstool libreboot.rom extract -n grubtest.cfg -f grubtest.cfg + \$ ./cbfstool libreboot.rom extract -n grubtest.cfg -f grubtest.cfg Modify the grubtest.cfg accordingly. @@ -166,11 +166,11 @@ Re-insert the modified grubtest.cfg into the ROM image {#reinsert_modified_testc Once your grubtest.cfg is modified and saved, delete the unmodified config from the ROM image: - $ ./cbfstool libreboot.rom remove -n grubtest.cfg + \$ ./cbfstool libreboot.rom remove -n grubtest.cfg Next, insert the modified version: -**$ ./cbfstool libreboot.rom add -n grubtest.cfg -f grubtest.cfg -t +**\$ ./cbfstool libreboot.rom add -n grubtest.cfg -f grubtest.cfg -t raw** [Back to top of page.](#pagetop) @@ -182,7 +182,7 @@ Testing [../install/#flashrom](../install/#flashrom) for information on how to flash it. - $ cd /libreboot\_util** # **./flash update libreboot.rom + \$ cd /libreboot\_util** # **./flash update libreboot.rom Ocassionally, coreboot changes the name of a given board. If flashrom complains about a board mismatch, but you are sure that you chose the correct ROM image, then run this alternative command: @@ -214,17 +214,17 @@ to grubtest.cfg, so that you don't have to manually switch to it, in case you ever want to follow this guide again in the future (modifying the already modified config). From /libreboot\_util/cbfstool, do: -$ **sed -e 's:(cbfsdisk)/grub.cfg:(cbfsdisk)/grubtest.cfg:g' -e +\$ **sed -e 's:(cbfsdisk)/grub.cfg:(cbfsdisk)/grubtest.cfg:g' -e 's:Switch to grub.cfg:Switch to grubtest.cfg:g' < grubtest.cfg > grub.cfg** Delete the grub.cfg that remained inside the ROM: - $ ./cbfstool libreboot.rom remove -n grub.cfg + \$ ./cbfstool libreboot.rom remove -n grub.cfg Add the modified version that you just made: - $ ./cbfstool libreboot.rom add -n grub.cfg -f grub.cfg -t raw + \$ ./cbfstool libreboot.rom add -n grub.cfg -f grub.cfg -t raw **Now you have a modified ROM. Again, refer back to [../install/#flashrom](../install/#flashrom) for information on how to diff --git a/docs/gnulinux/grub_hardening.md b/docs/gnulinux/grub_hardening.md index e982efca..f135b349 100644 --- a/docs/gnulinux/grub_hardening.md +++ b/docs/gnulinux/grub_hardening.md @@ -111,12 +111,12 @@ configurations, is to remove (or comment out) **unset superusers** in function try\_user\_config: function try_user_config { - set root="${1}" + set root="\${1}" for dir in boot grub grub2 boot/grub boot/grub2; do for name in '' autoboot_ libreboot_ coreboot_; do - if [ -f /"${dir}"/"${name}"grub.cfg ]; then + if [ -f /"\${dir}"/"\${name}"grub.cfg ]; then #unset superusers - configfile /"${dir}"/"${name}"grub.cfg + configfile /"\${dir}"/"\${name}"grub.cfg fi done done diff --git a/docs/grub/index.md b/docs/grub/index.md index f68980bd..48c8c0b7 100644 --- a/docs/grub/index.md +++ b/docs/grub/index.md @@ -41,17 +41,17 @@ one](http://sourceforge.net/projects/dejavu/files/dejavu/2.34/dejavu-fonts-ttf-2 This is a free font that is also contained in GNU+Linux distributions like Debian, Devuan or Parabola. - $ cd libreboot\_src/grub + \$ cd libreboot\_src/grub compile grub (the build scripts info on how to do this) come back out into libreboot\_src/resources/grub: - $ cd ../libreboot\_src/resources/grub/font + \$ cd ../libreboot\_src/resources/grub/font I took Dejavu Sans Mono from dejavu (included in this version of libreboot) and did: -**$ ../../../grub/grub-mkfont -o dejavusansmono.pf2 +**\$ ../../../grub/grub-mkfont -o dejavusansmono.pf2 dejavu-fonts-ttf-2.34/ttf/DejaVuSansMono.ttf** I then added the instructions to 'gen.sh' script in grub-assemble to @@ -73,7 +73,7 @@ Keymaps are stored in resources/utilities/grub-assemble/keymap/. Example (French Azerty): - $ ckbcomp fr > frazerty + \$ ckbcomp fr > frazerty Go in grub directory: @@ -98,7 +98,7 @@ ukdvorak had to be created manually, based on usdvorak. diff them (under resources/utilities/grub-assemble/keymap/original) to see how ukdvorak file was created - $ cat ukdvorak | ./grub/grub-mklayout -o ukdvorak.gkb + \$ cat ukdvorak | ./grub/grub-mklayout -o ukdvorak.gkb Copyright © 2014 Leah Rowe <info@minifree.org> diff --git a/docs/hardware/t60_security.md b/docs/hardware/t60_security.md index 8ed41ead..1ccfaa37 100644 --- a/docs/hardware/t60_security.md +++ b/docs/hardware/t60_security.md @@ -350,8 +350,8 @@ Explain that black hats, TAO, and so on might use a 0day to get in, and explain that in this case it mitigates what the attacker can do. Also the TAO do some evaluation before launching an attack: they take the probability of beeing caught into account, along with the kind of -target. A 0day costs a lot of money, I heard that it was from 100000$ -to 400000$, some other websites had prices 10 times lower but that but +target. A 0day costs a lot of money, I heard that it was from 100000\$ +to 400000\$, some other websites had prices 10 times lower but that but it was probably a typo. So if people increase their security it makes it more risky and more costly to attack people. diff --git a/docs/hardware/x60_security.md b/docs/hardware/x60_security.md index 965d6f1a..b393c232 100644 --- a/docs/hardware/x60_security.md +++ b/docs/hardware/x60_security.md @@ -242,8 +242,8 @@ Explain that black hats, TAO, and so on might use a 0day to get in, and explain that in this case it mitigates what the attacker can do. Also the TAO do some evaluation before launching an attack: they take the probability of beeing caught into account, along with the kind of -target. A 0day costs a lot of money, I heard that it was from 100000$ -to 400000$, some other websites had prices 10 times lower but that but +target. A 0day costs a lot of money, I heard that it was from 100000\$ +to 400000\$, some other websites had prices 10 times lower but that but it was probably a typo. So if people increase their security it makes it more risky and more costly to attack people. diff --git a/docs/hcl/gm45_remove_me.md b/docs/hcl/gm45_remove_me.md index ef386b62..46eef08e 100644 --- a/docs/hcl/gm45_remove_me.md +++ b/docs/hcl/gm45_remove_me.md @@ -38,12 +38,12 @@ ich9gen executables can be found under ./ich9deblob/ statically compiled in libreboot\_util. If you are using src or git, build ich9gen from source with: - $ ./oldbuild module ich9deblob + \$ ./oldbuild module ich9deblob The executable will appear under resources/utilities/ich9deblob/ Run: -$ **./ich9gen** +\$ **./ich9gen** Running ich9gen this way (without any arguments) generates a default descriptor+gbe image with a generic MAC address. You probably don't @@ -70,7 +70,7 @@ onboard ethernet chipset is flashed (inside the ROM image). You should generate a descriptor+gbe image with your own MAC address inside (with the Gbe checksum updated to match). Run: - $ ./ich9gen \--macaddress XX:XX:XX:XX:XX:XX + \$ ./ich9gen \--macaddress XX:XX:XX:XX:XX:XX (replace the XX chars with the hexadecimal chars in the MAC address that you want) @@ -89,17 +89,17 @@ descriptor+gbe file into the ROM image. For 16MiB flash chips: -$ **dd if=ich9fdgbe\_16m.bin of=libreboot.rom bs=1 count=12k +\$ **dd if=ich9fdgbe\_16m.bin of=libreboot.rom bs=1 count=12k conv=notrunc** For 8MiB flash chips: -$ **dd if=ich9fdgbe\_8m.bin of=libreboot.rom bs=1 count=12k +\$ **dd if=ich9fdgbe\_8m.bin of=libreboot.rom bs=1 count=12k conv=notrunc** For 4MiB flash chips: -$ **dd if=ich9fdgbe\_4m.bin of=libreboot.rom bs=1 count=12k +\$ **dd if=ich9fdgbe\_4m.bin of=libreboot.rom bs=1 count=12k conv=notrunc** Your libreboot.rom image is now ready to be flashed on the system. Refer @@ -170,7 +170,7 @@ under resources/utilities/ich9deblob/ and will already be compiled if you ran **./oldbuild module all** or **./oldbuild module ich9deblob** from the main directory (./), otherwise you can build it like so: - $ ./oldbuild module ich9deblob + \$ ./oldbuild module ich9deblob An executable file named **ich9deblob** will now appear under resources/utilities/ich9deblob/ @@ -183,7 +183,7 @@ external flashing guides for GM45 targets linked [../install/](../install/)) in the directory where you have your ich9deblob executable, then run the tool: -$ **./ich9deblob** +\$ **./ich9deblob** A 12kiB file named **deblobbed\_descriptor.bin** will now appear. **Keep this and the factory.rom stored in a safe location!** The first 4KiB @@ -201,11 +201,11 @@ Assuming that your libreboot image is named **libreboot.rom**, copy the **deblobbed\_descriptor.bin** file to where **libreboot.rom** is located and then run: -$ **dd if=deblobbed\_descriptor.bin of=libreboot.rom bs=1 count=12k +\$ **dd if=deblobbed\_descriptor.bin of=libreboot.rom bs=1 count=12k conv=notrunc** Alternatively, if you got a the **deblobbed\_4kdescriptor.bin** file (no -GbE defined), do this: $ **dd if=deblobbed\_4kdescriptor.bin +GbE defined), do this: \$ **dd if=deblobbed\_4kdescriptor.bin of=libreboot.rom bs=1 count=4k conv=notrunc** The utility will also generate 4 additional files: @@ -239,13 +239,13 @@ all of those restrictions. Simply run (with factory.rom in the same directory): -$ **./demefactory** +\$ **./demefactory** It will generate a 4KiB descriptor file (only the descriptor, no GbE). Insert that into a factory.rom image (NOTE: do this on a copy of it. Keep the original factory.rom stored safely somewhere): -$ **dd if=demefactory\_4kdescriptor.bin of=factory\_nome.rom bs=1 +\$ **dd if=demefactory\_4kdescriptor.bin of=factory\_nome.rom bs=1 count=4k conv=notrunc** TODO: test this. diff --git a/docs/hcl/index.md b/docs/hcl/index.md index 6943f795..a9e599d4 100644 --- a/docs/hcl/index.md +++ b/docs/hcl/index.md @@ -183,7 +183,7 @@ could get finger input working. They used linuxwacom at git tag # Now, for some reason (probably a bug in linuxwacom), # the 'Touch=on' directive gets reset to 'off'. # So you'll need to do - # $ xsetwacom --set WTouch Touch on + # \$ xsetwacom --set WTouch Touch on # # tested with linuxwacom git 42a42b2a8636abc9e105559e5dea467163499de7 @@ -407,8 +407,8 @@ for whatever reason, since they include a lot of useful information. Backups created using wget: - $ wget -m -p -E -k -K -np http://macbook.donderklumpen.de/ -**$ wget -m -p -E -k -K -np + \$ wget -m -p -E -k -K -np http://macbook.donderklumpen.de/ +**\$ wget -m -p -E -k -K -np http://macbook.donderklumpen.de/coreboot/** Use **-e robots=off** if using this trick for other sites and the site diff --git a/docs/hcl/t500.md b/docs/hcl/t500.md index 37740c25..3763cfe7 100644 --- a/docs/hcl/t500.md +++ b/docs/hcl/t500.md @@ -71,8 +71,8 @@ factory.rom image dumped from the T500 with a SOIC-8 4MiB flash chip. The patch re-creates the X200 descriptor/gbe source, so the commands were something like: - $ diff -u t500gbe x200gbe -$ **diff -u t500descriptor x200descriptor** + \$ diff -u t500gbe x200gbe +\$ **diff -u t500descriptor x200descriptor** ME VSCC table is in a different place and a different size on the T500. Libreboot disables and removes the ME anyway, so it doesn't matter. diff --git a/docs/hcl/x200.md b/docs/hcl/x200.md index e5e2ff77..fafe5f0b 100644 --- a/docs/hcl/x200.md +++ b/docs/hcl/x200.md @@ -233,8 +233,8 @@ different, so this page might be BS) pehjota started collecting some steppings for different CPUs on several X200 laptops. You can get the CPUID by running: -$ **dmesg | sed -n 's/\^.* microcode: CPU0 -sig=0x\\(\[\^,\]*\\),.*$/\\1/p'** +\$ **dmesg | sed -n 's/\^.* microcode: CPU0 +sig=0x\\(\[\^,\]*\\),.*\$/\\1/p'** What pehjota wrote: The laptops that have issues resuming from suspend, as well as a laptop that (as I mentioned earlier in #libreboot) won't diff --git a/docs/index.md b/docs/index.md index 590cde0b..40748008 100644 --- a/docs/index.md +++ b/docs/index.md @@ -177,7 +177,7 @@ If it exists, you can also extract this *lbversion* file by using the either dumped or haven't flashed yet. In your distribution, run cbfstool on your ROM image (*libreboot.rom*, in this example): - $ ./cbfstool libreboot.rom extract -n lbversion -f lbversion + \$ ./cbfstool libreboot.rom extract -n lbversion -f lbversion You will now have a file, named *lbversion*, which you can read in whatever program it is that you use for reading/writing text files. diff --git a/docs/install/bbb_setup.md b/docs/install/bbb_setup.md index 7f10fee2..4517eb6c 100644 --- a/docs/install/bbb_setup.md +++ b/docs/install/bbb_setup.md @@ -189,16 +189,16 @@ contents of this file with: #!/bin/sh -e ### BEGIN INIT INFO # Provides: led_aging.sh - # Required-Start: $local_fs - # Required-Stop: $local_fs + # Required-Start: \$local_fs + # Required-Stop: \$local_fs # Default-Start: 2 3 4 5 # Default-Stop: 0 1 6 # Short-Description: Start LED aging # Description: Starts LED aging (whatever that is) ### END INIT INFO - x=$(/bin/ps -ef | /bin/grep "[l]ed_acc") - if [ ! -n "$x" -a -x /usr/bin/led_acc ]; then + x=\$(/bin/ps -ef | /bin/grep "[l]ed_acc") + if [ ! -n "\$x" -a -x /usr/bin/led_acc ]; then /usr/bin/led_acc & fi diff --git a/docs/install/index.md b/docs/install/index.md index cc1e2952..947fbe8b 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -80,9 +80,9 @@ Libreboot comes with ROM images built for QEMU, by default: Examples of how to use libreboot ROM images in QEMU: -- $ **qemu-system-i386 -M q35 -m 512 -bios +- \$ **qemu-system-i386 -M q35 -m 512 -bios qemu\_q35\_ich9\_keymap\_mode.rom** -- $ **qemu-system-i386 -M pc -m 512 -bios +- \$ **qemu-system-i386 -M pc -m 512 -bios qemu\_i440fx\_piix4\_keymap\_mode.rom** You can optionally specify the **-serial stdio** argument, so that QEMU @@ -265,13 +265,13 @@ executables from the libreboot source code archives. How to update the flash chip contents: -$ **sudo ./flash update [yourrom.rom](#rom)** +\$ **sudo ./flash update [yourrom.rom](#rom)** Ocassionally, coreboot changes the name of a given board. If flashrom complains about a board mismatch, but you are sure that you chose the correct ROM image, then run this alternative command: -$ **sudo ./flash forceupdate [yourrom.rom](#rom)** +\$ **sudo ./flash forceupdate [yourrom.rom](#rom)** You should see **"Verifying flash... VERIFIED."** written at the end of the flashrom output. **Shut down** after you see this, and then boot @@ -302,7 +302,7 @@ https://notabug.org/vimuser/libreboot/raw/9d850543ad90b72e0e333c98075530b31e5d23 The first half of the procedure is as follows: -$ **sudo ./flash i945lenovo\_firstflash [yourrom.rom](#rom).** +\$ **sudo ./flash i945lenovo\_firstflash [yourrom.rom](#rom).** You should see within the output the following: @@ -325,11 +325,11 @@ and then boot; libreboot is running, but there is a 2nd procedure When you have booted up again, you must also do this: -$ **sudo ./flash i945lenovo\_secondflash [yourrom.rom](#rom)** +\$ **sudo ./flash i945lenovo\_secondflash [yourrom.rom](#rom)** If flashing fails at this stage, try the following: -$ **sudo ./flashrom/i686/flashrom -p +\$ **sudo ./flashrom/i686/flashrom -p internal:laptop=force\_I\_want\_a\_brick -w [yourrom.rom](#rom)** You should see within the output the following: @@ -368,7 +368,7 @@ with your device. Use this flashing script, to install libreboot: -$ **sudo ./flash i945apple\_firstflash [yourrom.rom](#rom)** +\$ **sudo ./flash i945apple\_firstflash [yourrom.rom](#rom)** You should also see within the output the following: diff --git a/docs/install/rpi_setup.md b/docs/install/rpi_setup.md index 764a472e..7eed9fd1 100644 --- a/docs/install/rpi_setup.md +++ b/docs/install/rpi_setup.md @@ -14,7 +14,7 @@ SOIC-16). [](#raspberry-pi-thinkpad-x60t60-and-macbook-21){#user-content-raspberry-pi-thinkpad-x60t60-and-macbook-21 .anchor}Raspberry Pi (ThinkPad X60/T60 and Macbook 2,1) ------------------------------------------------------------------------------------------------------------------------------------------------------------------ -The Raspberry Pi (a multipurpose $25 GNU+Linux computer) can be used as +The Raspberry Pi (a multipurpose \$25 GNU+Linux computer) can be used as a BIOS flashing tool, thanks to its GPIO pins and SPI support. > **Note:** The Raspberry Pi Model A is not supported, since it has no @@ -206,7 +206,7 @@ GPG signature as well. x86# gpg --keyserver prefered.keyserver.org --recv-keys 0x656F212E - x86# for signature in $(ls *.sig); do gpg --verify $signature; done + x86# for signature in \$(ls *.sig); do gpg --verify \$signature; done Extract NOOBS and libreboot. @@ -347,13 +347,13 @@ for great good! [](#raspberry-pi-c720-chromebook){#user-content-raspberry-pi-c720-chromebook .anchor}Raspberry Pi (C720 Chromebook) ------------------------------------------------------------------------------------------------------------------- -The Raspberry Pi (a multipurpose $25 GNU+Linux computer) can be used as +The Raspberry Pi (a multipurpose \$25 GNU+Linux computer) can be used as a BIOS flashing tool, thanks to its GPIO pins and SPI support. ### [](#what-you-need){#user-content-what-you-need .anchor}What you need -- $25 - Raspberry Pi Model B (Rev.2 or higher) -- $10-20 - SOIC-8 Pomona Clip +- \$25 - Raspberry Pi Model B (Rev.2 or higher) +- \$10-20 - SOIC-8 Pomona Clip - Usually comes bundled with nice, color-colored *female to female* wires diff --git a/docs/install/t60_unbrick.md b/docs/install/t60_unbrick.md index 123e4d60..1ce8d588 100644 --- a/docs/install/t60_unbrick.md +++ b/docs/install/t60_unbrick.md @@ -30,13 +30,13 @@ two: images (the ROM images in libreboot binary archives already have this applied!): -dd if=coreboot.rom of=top64k.bin bs=1 skip=$\[$(stat -c %s +dd if=coreboot.rom of=top64k.bin bs=1 skip=\$\[\$(stat -c %s coreboot.rom) - 0x10000\] count=64k -dd if=coreboot.rom bs=1 skip=$\[$(stat -c %s coreboot.rom) - 0x20000\] +dd if=coreboot.rom bs=1 skip=\$\[\$(stat -c %s coreboot.rom) - 0x20000\] count=64k | hexdump -dd if=top64k.bin of=coreboot.rom bs=1 seek=$\[$(stat -c %s +dd if=top64k.bin of=coreboot.rom bs=1 seek=\$\[\$(stat -c %s coreboot.rom) - 0x20000\] count=64k conv=notrunc (doing this makes the ROM suitable for use when flashing a system that diff --git a/docs/install/x60_unbrick.md b/docs/install/x60_unbrick.md index c0cd7777..a5bb9eef 100644 --- a/docs/install/x60_unbrick.md +++ b/docs/install/x60_unbrick.md @@ -30,13 +30,13 @@ two: images (the ROM images in libreboot binary archives already have this applied!): -dd if=coreboot.rom of=top64k.bin bs=1 skip=$\[$(stat -c %s +dd if=coreboot.rom of=top64k.bin bs=1 skip=\$\[\$(stat -c %s coreboot.rom) - 0x10000\] count=64k -dd if=coreboot.rom bs=1 skip=$\[$(stat -c %s coreboot.rom) - 0x20000\] +dd if=coreboot.rom bs=1 skip=\$\[\$(stat -c %s coreboot.rom) - 0x20000\] count=64k | hexdump -dd if=top64k.bin of=coreboot.rom bs=1 seek=$\[$(stat -c %s +dd if=top64k.bin of=coreboot.rom bs=1 seek=\$\[\$(stat -c %s coreboot.rom) - 0x20000\] count=64k conv=notrunc (doing this makes the ROM suitable for use when flashing a system that diff --git a/docs/install/x60tablet_unbrick.md b/docs/install/x60tablet_unbrick.md index 134d2d0c..c683e3ce 100644 --- a/docs/install/x60tablet_unbrick.md +++ b/docs/install/x60tablet_unbrick.md @@ -30,13 +30,13 @@ two: images (the ROM images in libreboot binary archives already have this applied!): -dd if=coreboot.rom of=top64k.bin bs=1 skip=$\[$(stat -c %s +dd if=coreboot.rom of=top64k.bin bs=1 skip=\$\[\$(stat -c %s coreboot.rom) - 0x10000\] count=64k -dd if=coreboot.rom bs=1 skip=$\[$(stat -c %s coreboot.rom) - 0x20000\] +dd if=coreboot.rom bs=1 skip=\$\[\$(stat -c %s coreboot.rom) - 0x20000\] count=64k | hexdump -dd if=top64k.bin of=coreboot.rom bs=1 seek=$\[$(stat -c %s +dd if=top64k.bin of=coreboot.rom bs=1 seek=\$\[\$(stat -c %s coreboot.rom) - 0x20000\] count=64k conv=notrunc (doing this makes the ROM suitable for use when flashing a system that diff --git a/docs/misc/bbb_ehci.md b/docs/misc/bbb_ehci.md index 3a48837f..5ff5f820 100644 --- a/docs/misc/bbb_ehci.md +++ b/docs/misc/bbb_ehci.md @@ -128,19 +128,19 @@ Make sure that you have cross compiling environment for arm-linux-gnueabihf setup on your *host*. - On BBB: uname -r - this will give you version number like - 3.8.13-bone70 (I will refer to this as: $mav.$miv-$lv: where + 3.8.13-bone70 (I will refer to this as: \$mav.\$miv-\$lv: where mav=3.8, miv=13, lv=bone70 - Get the BBB kernel ready on your host for cross-compiling: <!-- --> - $ cd $work_dir - $ git clone https://github.com/beagleboard/kernel.git - $ cd kernel - $ git checkout $mav (see above) - $ ./patch.sh - $ wget http://arago-project.org/git/projects/?p=am33x-cm3.git\;a=blob_plain\;f=bin/am335x-pm-firmware.bin\;hb=HEAD -O kernel/firmware/am335x-pm-firmware.bin - $ cp configs/beaglebone kernel/arch/arm/configs/beaglebone_defconfig + \$ cd \$work_dir + \$ git clone https://github.com/beagleboard/kernel.git + \$ cd kernel + \$ git checkout \$mav (see above) + \$ ./patch.sh + \$ wget http://arago-project.org/git/projects/?p=am33x-cm3.git\;a=blob_plain\;f=bin/am335x-pm-firmware.bin\;hb=HEAD -O kernel/firmware/am335x-pm-firmware.bin + \$ cp configs/beaglebone kernel/arch/arm/configs/beaglebone_defconfig - Download the patch from [here](http://www.coreboot.org/images/8/88/Ehci-debug-gadget-patches.tar.gz) @@ -150,7 +150,7 @@ arm-linux-gnueabihf setup on your *host*. the two different version of the kernel (3.8 and 3.10). I will use 3.8. (If using kernel 3.12 patch\_1 is not needed) - cd kernel (note that this is one more level: you should be in - $work\_dir/kernel/kernel) + \$work\_dir/kernel/kernel) - Apply the patches: <!-- --> @@ -166,12 +166,12 @@ arm-linux-gnueabihf setup on your *host*. see [scripts](http://www.fsfla.org/svn/fsfla/software/linux-libre/scripts/). - Get your current BBB kernel config (from: /boot/config-<ver>) - and copy it to your host as $work\_dir/kernel/kernel/.config + and copy it to your host as \$work\_dir/kernel/kernel/.config - Set proper version number: - - On your host, edit $work\_dir/kernel/kernel/.config (the one + - On your host, edit \$work\_dir/kernel/kernel/.config (the one you've just copied from BBB), find the line CONFIG\_LOCALVERSION="<something or empty>" and change - it to CONFIG\_LOCALVERSION="-$lv", so it will look something + it to CONFIG\_LOCALVERSION="-\$lv", so it will look something like: CONFIG\_LOCALVERSION="-bone70" - Also, make sure that: CONFIG\_USB\_G\_DBGP=m (If not, make menuconfig, and set @Device Drivers-> USB Support -> USB @@ -180,12 +180,12 @@ arm-linux-gnueabihf setup on your *host*. <!-- --> - $ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- -j4 (is it possoble to build only the gadget modules) - $ mkdir ../tmp && make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- INSTALL_MOD_PATH=../tmp modules_install + \$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- -j4 (is it possoble to build only the gadget modules) + \$ mkdir ../tmp && make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- INSTALL_MOD_PATH=../tmp modules_install - on BBB, backup /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget (i.e. mv /lib/modules/3.8.13-bone70/kernel/drivers/usb/gadget - $HOME) + \$HOME) - copy the freshly compiled usb/gadget dir to /lib/modules/3.8.13-bone70/kernel/drivers/usb - restart BBB @@ -200,14 +200,14 @@ push debug messages to the EHCI debug port. If you've downloaded the binary distribution, you can check if it is properly configured in the following way: -- Go to the libreboot dist root directory cd $libreboot\_bin -- Locate the rom image for your target (I will call it: $img\_path) +- Go to the libreboot dist root directory cd \$libreboot\_bin +- Locate the rom image for your target (I will call it: \$img\_path) - Running the following command will extract the config in a file ./my\_config: <!-- --> - ./cbfstool/i686/cbfstool $img_path extract -n config -f ./my_config + ./cbfstool/i686/cbfstool \$img_path extract -n config -f ./my_config - Make sure that the following params in the config are set as following: diff --git a/docs/misc/index.md b/docs/misc/index.md index 6f217d80..096842df 100644 --- a/docs/misc/index.md +++ b/docs/misc/index.md @@ -24,7 +24,7 @@ Included with libreboot is a script called 'powertop.debian'. Run this as root and it will setup powertop to run with \--auto-tune at boot time. Load the file in your text editor to see how it does that. -$ **sudo ./resources/scripts/misc/powertop.debian** +\$ **sudo ./resources/scripts/misc/powertop.debian** Might want to run with \--calibrate first @@ -50,7 +50,7 @@ GRUB. These consume power. Stop using them! Be root - $ su - + \$ su - Installed powertop: @@ -99,7 +99,7 @@ USB Serial adapter. On the 2nd system, you can try this (using GNU Screen): - $ sudo screen /dev/ttyUSB0 115200 + \$ sudo screen /dev/ttyUSB0 115200 How to quit GNU Screen: Ctrl+A then release and press K, and then press Y. @@ -215,13 +215,13 @@ behaviour. Disable or enable beeps when removing/adding the charger: - $ sudo ./nvramtool -w power\_management\_beeps=Enable -$ **sudo ./nvramtool -w power\_management\_beeps=Disable** + \$ sudo ./nvramtool -w power\_management\_beeps=Enable +\$ **sudo ./nvramtool -w power\_management\_beeps=Disable** Disable or enable beeps when battery is low: - $ sudo ./nvramtool -w low\_battery\_beep=Enable -$ **sudo ./nvramtool -w low\_battery\_beep=Disable** + \$ sudo ./nvramtool -w low\_battery\_beep=Enable +\$ **sudo ./nvramtool -w low\_battery\_beep=Disable** A reboot is required, for these changes to take effect. @@ -234,11 +234,11 @@ Or look in **/sys/class/drm/card0-LVDS-1/edid** Alternatively you can use i2cdump. In Debian and Devuan, this is in the package i2c-tools. - $ sudo modprobe i2c-dev -$ **sudo i2cdump -y 5 0x50** (you might have to change the value for + \$ sudo modprobe i2c-dev +\$ **sudo i2cdump -y 5 0x50** (you might have to change the value for -y) - $ sudo rmmod i2c-dev + \$ sudo rmmod i2c-dev You'll see the panel name in the output (from the EDID dump). If neither of these options work (or they are unavailable), physically @@ -266,7 +266,7 @@ laptop. If power usage is a concern, then you should not use this. To disable c-states, do this in GNU+Linux: **for i in /sys/devices/system/cpu/cpu/cpuidle/state/disable; do echo 1 -> $i; done** +> \$i; done** You can reproduce this issue more easily by sending lots of traffic across subnets on the same interface (NIC). diff --git a/docs/misc/patch.md b/docs/misc/patch.md index 318c7428..6164986c 100644 --- a/docs/misc/patch.md +++ b/docs/misc/patch.md @@ -9,12 +9,12 @@ Apply a patch To apply a patch to a single file, do that in it's directory: - $ patch < foo.patch + \$ patch < foo.patch Assuming that the patch is distributed in unified format identifying the file the patch should be applied to, the above will work. Otherwise: - $ patch foo.txt < bar.patch + \$ patch foo.txt < bar.patch You can apply a patch to an entire directory, but note the "p level". What this means is that inside patch files will be the files that you @@ -24,7 +24,7 @@ where the patch was created. 'p' level instructs the 'patch' utility to ignore parts of the path name to identify the files correctly. Usually a p level of 1 will work, so you would use: - $ patch -p1 < baz.patch + \$ patch -p1 < baz.patch Change to the top level directory before running this. If a patch level of 1 cannot identify the files to patch, then inspect the patch file for @@ -34,7 +34,7 @@ file names. For example: and you are working in a directory that contains panic/yet.c, use: - $ patch -p5 < baz.patch + \$ patch -p5 < baz.patch You usually count one up for each path separator (forward slash) removed from the beginning of the path, until you are left with a path that @@ -42,7 +42,7 @@ exists in the current working directory. The count is the p level. Removing a patch using the -R flag - $ patch -p5 -R < baz.patch + \$ patch -p5 -R < baz.patch [Back to top of page.](#pagetop) @@ -51,15 +51,15 @@ Create a patch with diff Diff can create a patch for a single file: - $ diff -u original.c new.c > original.patch + \$ diff -u original.c new.c > original.patch For diff'ing a source tree: - $ cp -R original new + \$ cp -R original new Do whatever you want in new/ and then diff it: - $ diff -rupN original/ new/ > original.patch + \$ diff -rupN original/ new/ > original.patch [Back to top of page.](#pagetop) @@ -72,15 +72,15 @@ Note: this won't show new files created. Just make whatever changes you want to a git clone and then: - $ git diff > patch.git + \$ git diff > patch.git Note the git revision that you did this with: - $ git log + \$ git log Alternatively (better yet), commit your changes and then use: - $ git format-patch -N + \$ git format-patch -N Replace N with the number of commits that you want to show. [Back to top of page.](#pagetop) @@ -93,11 +93,11 @@ it really is. Now to apply that patch in the future, just git clone it again and do with the git revision you found from above: - $ git reset \--hard REVISIONNUMBER + \$ git reset \--hard REVISIONNUMBER Now put patch.git in the git clone directory and do: - $ git apply patch.git + \$ git apply patch.git If you use a patch from git format-patch, then use **git am patch.git** instead of **git apply patch.git**. git-am will re-create the commits diff --git a/docs/publish.sh b/docs/publish.sh new file mode 100755 index 00000000..a4ea7030 --- /dev/null +++ b/docs/publish.sh @@ -0,0 +1,10 @@ +#!/bin/sh + +# see equivalent script in libreboot-website for more info + +FILE=${1%.md} +echo $FILE +cat $FILE.md > temp.md +sed temp.md -i -e 's/.md\(#[a-z\-]*\)*)/.html\1)/g' +TOC=$(grep -q "^x-toc-enable: true$" temp.md && echo "--toc") +pandoc -t html temp.md -s --css global.css --section-divs -T Libreboot $TOC > $FILE.html |