aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/bsd/freebsd.md8
-rw-r--r--docs/bsd/netbsd.md8
-rw-r--r--docs/bsd/openbsd.md8
-rw-r--r--docs/git/index.md19
-rw-r--r--docs/gnulinux/configuring_parabola.md33
-rw-r--r--docs/gnulinux/grub_boot_installer.md8
-rw-r--r--docs/gnulinux/grub_cbfs.md15
-rw-r--r--docs/hardware/c201.md12
-rw-r--r--docs/hardware/index.md13
-rw-r--r--docs/install/c201.md35
-rw-r--r--docs/install/kcma-d8.md6
-rw-r--r--docs/install/kgpe-d16.md8
-rw-r--r--docs/install/t60_unbrick.md9
-rw-r--r--docs/install/x200_external.md12
-rw-r--r--docs/install/x60_unbrick.md9
-rw-r--r--docs/install/x60tablet_unbrick.md9
16 files changed, 33 insertions, 179 deletions
diff --git a/docs/bsd/freebsd.md b/docs/bsd/freebsd.md
index f66ca88b..f056b5b8 100644
--- a/docs/bsd/freebsd.md
+++ b/docs/bsd/freebsd.md
@@ -1,5 +1,6 @@
---
title: How to install FreeBSD on a libreboot system
+x-toc-enable: true
...
This section relates to preparing, booting and installing FreeBSD on
@@ -19,13 +20,6 @@ if it does not). Instructions are provided here, to boot and install
FreeBSD but we're not sure whether it is currently fully compatible
with libreboot.
-- [Prepare the USB drive (in FreeBSD)](#prepare)
-- [Installing FreeBSD without full disk encryption](#noencryption)
-- [Installing FreeBSD with full disk encryption](#encryption)
-- [Booting](#booting)
-- [Configuring Grub](#configuring_grub)
-- [Troubleshooting](#troubleshooting)
-
**This section is only for the GRUB payload. For depthcharge (used on
CrOS devices in libreboot), instructions have yet to be written in the
libreboot documentation.**
diff --git a/docs/bsd/netbsd.md b/docs/bsd/netbsd.md
index 39157ef6..0dceda38 100644
--- a/docs/bsd/netbsd.md
+++ b/docs/bsd/netbsd.md
@@ -1,5 +1,6 @@
---
title: How to install NetBSD on a libreboot system
+x-toc-enable: true
...
This section relates to preparing, booting and installing NetBSD on your
@@ -14,13 +15,6 @@ Thanks go to ioxcide in [this Reddit
post](https://www.reddit.com/r/BSD/comments/53jt70/libreboot_and_bsds/)
for the initial instructions.
-- [Prepare the USB drive (in NetBSD)](#prepare)
-- [Installing NetBSD without full disk encryption](#noencryption)
-- [Installing NetBSD with full disk encryption](#encryption)
-- [Booting](#booting)
-- [Configuring Grub](#configuring_grub)
-- [Troubleshooting](#troubleshooting)
-
**This section is only for the GRUB payload. For depthcharge (used on
CrOS devices in libreboot), instructions have yet to be written in the
libreboot documentation.**
diff --git a/docs/bsd/openbsd.md b/docs/bsd/openbsd.md
index 0124356e..8906ff00 100644
--- a/docs/bsd/openbsd.md
+++ b/docs/bsd/openbsd.md
@@ -1,5 +1,6 @@
---
title: How to install LibertyBSD or OpenBSD on a libreboot system
+x-toc-enable: true
...
NOTE: This guide was written for OpenBSD by the person who contributed
@@ -13,13 +14,6 @@ This section relates to preparing, booting and installing OpenBSD on
your libreboot system, using nothing more than a USB flash drive (and
*dd*). They've only been tested on a Lenovo ThinkPad x200.
-- [Prepare the USB drive (in OpenBSD)](#prepare)
-- [Installing OpenBSD without full disk encryption](#noencryption)
-- [Installing OpenBSD with full disk encryption](#encryption)
-- [Booting](#booting)
-- [Configuring Grub](#configuring_grub)
-- [Troubleshooting](#troubleshooting)
-
**This section is only for the GRUB payload. For depthcharge (used on
CrOS devices in libreboot), instructions have yet to be written in the
libreboot documentation.**
diff --git a/docs/git/index.md b/docs/git/index.md
index d8ed35a2..b3191589 100644
--- a/docs/git/index.md
+++ b/docs/git/index.md
@@ -1,5 +1,6 @@
---
title: Instructions for compiling from the source code
+x-toc-enable: true
...
Depthcharge is currently not documented, since it is in the new build
@@ -9,15 +10,7 @@ included in the BUILD\_HOWTO file in libreboot.git or \_src.
This section relates to building libreboot from source, and working with
the git repository.
-- [Install build dependencies](#build_dependencies)
-- [Get the full source code from metadata (git clone)](#build_meta)
-- [How to build "bucts" (for LenovoBIOS
- X60/X60S/X60T/T60)](#build_bucts)
-
-- [How to build "flashrom"](#build_flashrom)
-- [How to build the ROM images](#build)
-
-Install build dependencies {#build_dependencies}
+Install build dependencies
==========================
Before doing anything, you need the dependencies first. This is true if
@@ -38,7 +31,7 @@ or:
For other GNU+Linux distributions, you can adapt the existing scripts.
-Get the full source code from metadata (git clone) {#build_meta}
+Get the full source code from metadata (git clone)
==================================================
If you downloaded libreboot from git, then there are some steps to
@@ -79,7 +72,7 @@ them. Read the script in a text editor to learn more.
To build the ROM images, see [\#build](#build).
-How to build "bucts" (for LenovoBIOS X60/X60S/X60T/T60) {#build_bucts}
+How to build "bucts" (for LenovoBIOS X60/X60S/X60T/T60)
=========================================================
**This is for Lenovo BIOS users on the ThinkPad X60/X60S, X60 Tablet and
@@ -136,7 +129,7 @@ To statically compile it, do this:
The "builddeps" script in libreboot\_src also makes use of
builddeps-bucts.
-How to build "flashrom" {#build_flashrom}
+How to build "flashrom"
=========================
Flashrom is the utility for flashing/dumping ROM images. This is what
@@ -177,7 +170,7 @@ executables:
The "builddeps" script in libreboot\_src also makes use of
builddeps-flashrom.
-How to build the ROM images {#build}
+How to build the ROM images
===========================
You don't need to do much, as there are scripts already written for you
diff --git a/docs/gnulinux/configuring_parabola.md b/docs/gnulinux/configuring_parabola.md
index 29dc0243..e28b34b5 100644
--- a/docs/gnulinux/configuring_parabola.md
+++ b/docs/gnulinux/configuring_parabola.md
@@ -1,5 +1,6 @@
---
title: Configuring Parabola (post-install)
+x-toc-enable: true
...
Post-installation configuration steps for Parabola GNU+Linux-libre.
@@ -7,38 +8,6 @@ Parabola is extremely flexible; this is just an example. This example
uses LXDE because it's lightweight, but we recommend the *MATE* desktop
(which is actually about as lightweight as LXDE).
-Table of Contents
-=================
-
-- [Configuring pacman](#pacman_configure)
- - [Updating Parabola](#pacman_update)
- - [Maintaining Parabola during system updates](#pacman_maintain)
- - [Clearing package cache after updating](#pacman_cacheclean)
- - [Pacman command equivalents (compared to other package
- managers)](#pacman_commandequiv)
- - [your-freedom](#yourfreedom)
-
-- [Add a user account](#useradd)
-- [System D](#systemd)
-- [Interesting repositories](#interesting_repos)
-- [Setup a network connection in Parabola](#network)
- - [Setting hostname](#network_hostname)
- - [Network status](#network_status)
- - [Network interface names](#network_devicenames)
- - [Network setup](#network_setup)
-- [System maintenance](#system_maintain) - important!
-- [Configuring the desktop](#desktop)
- - [Install Xorg](#desktop_xorg)
- - [Xorg keyboard layout](#desktop_kblayout)
- - [Install LXDE](#desktop_lxde)
- - [LXDE - clock](#lxde_clock)
- - [LXDE - font](#lxde_font)
- - [LXDE - screenlock](#lxde_screenlock)
- - [LXDE - automounting](#lxde_automount)
- - [LXDE - disable suspend](#lxde_suspend)
- - [LXDE - battery monitor](#lxde_battery)
- - [LXDE - network manager](#lxde_network)
-
While not strictly related to the libreboot project, this guide is
intended to be useful for those interested in installing Parabola on
their libreboot system.
diff --git a/docs/gnulinux/grub_boot_installer.md b/docs/gnulinux/grub_boot_installer.md
index 228dadff..c360a666 100644
--- a/docs/gnulinux/grub_boot_installer.md
+++ b/docs/gnulinux/grub_boot_installer.md
@@ -1,18 +1,12 @@
---
title: How to install GNU+Linux on a libreboot system
+x-toc-enable: true
...
This section relates to preparing, booting and installing a GNU+Linux
distribution on your libreboot system, using nothing more than a USB
flash drive (and *dd*).
-- [Prepare the USB drive (in GNU+Linux)](#prepare)
-- [Installing GNU+Linux with full disk encryption](#encryption)
-- [Debian or Devuan net install?](#debian_netinstall)
-- [Booting ISOLINUX images (automatic method)](#parse_isolinux)
-- [Booting ISOLINUX images (manual method)](#manual_isolinux)
-- [Troubleshooting](#troubleshooting)
-
**This section is only for the GRUB payload. For depthcharge (used on
CrOS devices in libreboot), instructions have yet to be written in the
libreboot documentation.**
diff --git a/docs/gnulinux/grub_cbfs.md b/docs/gnulinux/grub_cbfs.md
index 4b58d3e5..3a13481e 100644
--- a/docs/gnulinux/grub_cbfs.md
+++ b/docs/gnulinux/grub_cbfs.md
@@ -1,5 +1,6 @@
---
title: How to replace the default GRUB configuration file
+x-toc-enable: true
...
Libreboot on x86 uses the GRUB
@@ -27,20 +28,6 @@ Here is an excellent writeup about CBFS (coreboot filesystem):
**This guide is \*only\* for the GRUB payload. If you use the
depthcharge payload, ignore this section entirely.**
-Table of Contents
-=================
-
-- [Introduction](#introduction)
-- [1st option: don't re-flash](#option1_dont_reflash)
-- [2nd option: re-flash](#option2_reflash)
- - [Acquire the necessary utilities](#tools)
- - [Acquiring the correct ROM image](#rom)
- - [Extract grubtest from the ROM image](#extract_testconfig)
- - [Re-insert the modified grubtest.cfg into the ROM
- image](#reinsert_modified_testconfig)
- - [Testing](#testing)
- - [Final steps](#final_steps)
-
Introduction
------------
diff --git a/docs/hardware/c201.md b/docs/hardware/c201.md
index 82b68fc9..59f3228e 100644
--- a/docs/hardware/c201.md
+++ b/docs/hardware/c201.md
@@ -1,5 +1,6 @@
---
title: ASUS Chromebook C201
+x-toc-enable: true
...
This is a Chromebook, using the Rockchip RK3288 SoC. It uses an ARM CPU,
@@ -16,17 +17,6 @@ confirmed to work.**
Flashing instructions can be found at
[../install/\#flashrom](../install/#flashrom)
-- [Google's intent with CrOS devices](#googlesintent)
-- [Considerations about ChromeOS and free operating systems](#os)
-- [Caution: Video acceleration requires a non-free blob, software
- rendering can be used instead.](#videoblobs)
-- [Caution: WiFi requires a non-free blob, a USB dongle can be used
- instead.](#wifiblobs)
-- [EC firmware is free software!](#ec)
-- [No microcode!](#microcode)
-- [Depthcharge payload](#depthcharge)
-- [Flash chip write protection: the screw](#thescrew)
-
Google's intent with CrOS devices {#googlesintent}
==================================
diff --git a/docs/hardware/index.md b/docs/hardware/index.md
index 2e20b680..4863332e 100644
--- a/docs/hardware/index.md
+++ b/docs/hardware/index.md
@@ -1,23 +1,12 @@
---
title: Hardware compatibility list
+x-toc-enable: true
...
This sections relates to known hardware compatibility in libreboot.
For installatation instructions, refer to [../install/](../install/).
-- [List of supported hardware](#supported_list)
- - [Desktops (x86, AMD and Intel)](#supported_desktops_x86amdintel)
- - [Servers/workstations](#supported_workstations_x86amd)
- - [Laptops (ARM)](#supported_laptops_arm)
- - [Laptops (Intel, x86)](#supported_laptops_x86intel)
-
-- NOTES:
- - [Updating the EC firmware on i945 and GM45
- (recommended)](#ecupdate)
- - [How to find what EC version you have (i945/GM45)](#ecversion)
-- [Recommended wifi chipsets](#recommended_wifi)
-
List of supported hardware {#supported_list}
--------------------------
diff --git a/docs/install/c201.md b/docs/install/c201.md
index 2e1d23b8..48b11427 100644
--- a/docs/install/c201.md
+++ b/docs/install/c201.md
@@ -1,5 +1,6 @@
---
title: ASUS Chromebook C201 installation guide
+x-toc-enable: true
...
These instructions are for installing Libreboot to the ASUS Chromebook
@@ -25,26 +26,14 @@ source code is made available by Google:
It is not distributed along with Libreboot yet. However, it is
preinstalled on the device, with ChromeOS.
-Installing Libreboot internally requires sufficient privileges on the
-system installed on the device.\
-When the device has ChromeOS installed (as it does initially), it is
-necessary to gain root privileges in ChromeOS, to be able to access a
-root shell.
-
-- [Gaining root privileges on ChromeOS](#root_chromeos)
-- [Preparing the device for the installation](#preparing_device)
- - [Configuring verified boot
- parameters](#configuring_verified_boot_parameters)
- - [Removing the write protect
- screw](#removing_write_protect_screw)
-- [Installing Libreboot to the SPI flash]()
- - [Installing Libreboot internally, from the
- device](#installing_libreboot_internally)
- - [Installing Libreboot externally, with a SPI flash
- programmer](#installing_libreboot_externally)
-- [Debian GNU+Linux is recommended for this device](#debian)
+Installing Libreboot internally requires sufficient privileges on the system
+installed on the device. When the device has ChromeOS installed (as it does
+initially), it is necessary to gain root privileges in ChromeOS, to be able to
+access a root shell.
Gaining root privileges on ChromeOS
+--------------------------------
+
In order to gain root privileges on ChromeOS, developer mode has to be
enabled from the recovery mode screen and debugging features have to be
enabled in ChromeOS.
@@ -75,7 +64,7 @@ Before installing Libreboot on the device, both its software and
hardware has to be prepared to allow the installation procedure and to
ensure that security features don't get in the way.
-Configuring verified boot parameters {#configuring_verified_boot_parameters}
+Configuring verified boot parameters
------------------------------------
It is recommended to have access to the [developer mode
@@ -89,7 +78,7 @@ parameters](../depthcharge/#configuring_verified_boot_parameters):
Those changes can be reverted later, when the device is known to be in a
working state.
-Removing the write protect screw {#removing_write_protect_screw}
+Removing the write protect screw
--------------------------------
Since part of the SPI flash is write-protected by a screw, it is
@@ -111,7 +100,7 @@ screw](images/c201/wp-screw.jpg)](images/c201/wp-screw.jpg)
The write protect screw can be put back in place later, when the device
is known to be in a working state.
-Installing Libreboot to the SPI flash {#installing_libreboot_spi_flash}
+Installing Libreboot to the SPI flash
=====================================
The SPI flash (that holds Libreboot) is divided into various partitions
@@ -119,7 +108,7 @@ that are used to implement parts of the CrOS security system. Libreboot
is installed in the *read-only* coreboot partition, that becomes
writable after removing the write-protect screw.
-Installing Libreboot internally, from the device {#installing_libreboot_internally}
+Installing Libreboot internally, from the device
------------------------------------------------
Before installing Libreboot to the SPI flash internally, the device has
@@ -153,7 +142,7 @@ You should also see within the output the following:\
Shut down. The device will now boot to Libreboot.
-Installing Libreboot externally, with a SPI flash programmer {#installing_libreboot_externally}
+Installing Libreboot externally, with a SPI flash programmer
------------------------------------------------------------
Before installing Libreboot to the SPI flash internally, the device has
diff --git a/docs/install/kcma-d8.md b/docs/install/kcma-d8.md
index 5c2f8d47..7dff9a66 100644
--- a/docs/install/kcma-d8.md
+++ b/docs/install/kcma-d8.md
@@ -1,5 +1,6 @@
---
title: KCMA-D8 external flashing instructions
+x-toc-enable: true
...
Initial flashing instructions for kcma-d8.
@@ -17,11 +18,6 @@ For more general information about this board, refer to
TODO: show photos here, and other info.
-- [kcma-d8 boards (and full systems) with libreboot
- preinstalled](#preinstall)
-
-- [External programmer](#programmer)
-
External programmer {#programmer}
===================
diff --git a/docs/install/kgpe-d16.md b/docs/install/kgpe-d16.md
index ab73cdea..a84716b8 100644
--- a/docs/install/kgpe-d16.md
+++ b/docs/install/kgpe-d16.md
@@ -1,5 +1,6 @@
---
title: KGPE-D16 external flashing instructions
+x-toc-enable: true
...
Initial flashing instructions for KGPE-D16.
@@ -17,12 +18,7 @@ For more general information about this board, refer to
TODO: show photos here, and other info.
-- [KGPE-D16 boards (and full systems) with libreboot
- preinstalled](#preinstall)
-
-- [External programmer](#programmer)
-
-External programmer {#programmer}
+External programmer
===================
Refer to [bbb\_setup.md](bbb_setup.md) for a guide on how to set up
diff --git a/docs/install/t60_unbrick.md b/docs/install/t60_unbrick.md
index 98c0be51..82600eee 100644
--- a/docs/install/t60_unbrick.md
+++ b/docs/install/t60_unbrick.md
@@ -1,18 +1,11 @@
---
title: ThinkPad T60 Recovery guide
+x-toc-enable: true
...
This section documents how to recover from a bad flash that prevents
your ThinkPad T60 from booting.
-Table of Contents
------------------
-
-- Types of brick:
- - [Brick type 1: bucts not reset](#bucts_brick)
- - [Brick type 2: bad rom (or user error), system won't
- boot](#recovery)
-
Brick type 1: bucts not reset. {#bucts_brick}
==============================
diff --git a/docs/install/x200_external.md b/docs/install/x200_external.md
index 79ca3c96..3c1d8cfc 100644
--- a/docs/install/x200_external.md
+++ b/docs/install/x200_external.md
@@ -1,5 +1,6 @@
---
title: Flashing the X200 with a BeagleBone Black
+x-toc-enable: true
...
Initial flashing instructions for X200.
@@ -8,17 +9,6 @@ This guide is for those who want libreboot on their ThinkPad X200 while
they still have the original Lenovo BIOS present. This guide can also be
followed (adapted) if you brick your X200, to know how to recover.
-- [X200 laptops with libreboot pre-installed](#preinstall)
-- [Flash chips](#flashchips)
-- [MAC address](#macaddress)
-- [Initial BBB configuration and installation procedure](#clip)
-- [Boot it!](#boot)
-- [Wifi](#wifi)
-- [wwan](#wwan)
-- [Intel Turbo Memory](#turbomem)
-- [Memory](#memory)
-- [X200S and X200 Tablet users: GPIO33 trick will not work.](#gpio33)
-
X200 laptops with libreboot pre-installed {#preinstall}
=========================================
diff --git a/docs/install/x60_unbrick.md b/docs/install/x60_unbrick.md
index e1c9098a..64488443 100644
--- a/docs/install/x60_unbrick.md
+++ b/docs/install/x60_unbrick.md
@@ -1,18 +1,11 @@
---
title: ThinkPad X60 Recovery guide
+x-toc-enable: true
...
This section documents how to recover from a bad flash that prevents
your ThinkPad X60 from booting.
-Table of Contents
-=================
-
-- Types of brick:
- - [Brick type 1: bucts not reset](#bucts_brick)
- - [Brick type 2: bad rom (or user error), system won't
- boot](#recovery)
-
Brick type 1: bucts not reset. {#bucts_brick}
==============================
diff --git a/docs/install/x60tablet_unbrick.md b/docs/install/x60tablet_unbrick.md
index d11e7cbb..5f18db8b 100644
--- a/docs/install/x60tablet_unbrick.md
+++ b/docs/install/x60tablet_unbrick.md
@@ -1,18 +1,11 @@
---
title: ThinkPad X60 Tablet Recovery guide
+x-toc-enable: true
...
This section documents how to recover from a bad flash that prevents
your ThinkPad X60 Tablet from booting.
-Table of Contents
------------------
-
-- Types of brick:
- - [Brick type 1: bucts not reset](#bucts_brick)
- - [Brick type 2: bad rom (or user error), system won't
- boot](#recovery)
-
Brick type 1: bucts not reset. {#bucts_brick}
==============================
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-11-22 11:30:35 +0000