Maurice Zhou 1fd8de8b18 Add hibernation instructions
Use ${DISK}-swap for dm name

Update archlinux live image to May 2021

Other minor improvements

reusable command for mirroring ESP

use glob for initrd keys

apply hostname to live system; use wildcard for network config

separate persistent swap and hibernation

secureboot; temp esp partition

capital letters

Secure Boot needs to be re-enabled

wording: save and reboot

wording, spurious white space

double sharp sign for comment

updates for GRUB tips

reinstall GRUB after entering system

Signed-off-by: Maurice Zhou <ja@apvc.uk>

do not use /dev/sda as example

fix formatting; add notes

update info regarding encryption

use internal links; tweak indentation

other kernel variants

install sudo before editing /etc/sudoers

use colon

use mkinitcpio for initrd generation

only use ~/.local/bin if exist

dependencies for building site

Signed-off-by: Maurice Zhou <ja@apvc.uk>
2021-05-04 00:05:52 -05:00
2021-05-04 00:05:52 -05:00
2021-02-02 03:28:38 -06:00
2020-05-27 13:12:55 -05:00
2021-03-04 04:09:14 -06:00

.. image:: docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png
.. highlight:: sh

OpenZFS Documentation
=====================

Public link: https://openzfs.github.io/openzfs-docs/

Building Locally
----------------

Install Prerequisites
~~~~~~~~~~~~~~~~~~~~~

The dependencies are available via pip::

   # For Debian based distros
   sudo apt install python3-pip
   # For RPM-based distros
   sudo yum install python3-pip
   # For openSUSE
   sudo zypper in python3-pip

   pip3 install -r docs/requirements.txt
   # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc:
   PATH=$HOME/.local/bin:$PATH

Build
~~~~~

::

   cd docs
   make html
   # HTML files will be generated in: _build/html
Description
OpenZFS Documentation
Readme 2 MiB
Languages
Python 83.7%
Shell 16.1%
Makefile 0.2%