docs

Carbs Linux Documentation
git clone git://git.carbslinux.org/docs
Log | Files | Refs | Submodules | README

commit 93c5f112cae3eab4d1ff28f914a77e2a74d98216
parent 4bb8046231dd10eec27aff6a409e9f428ad5ac73
Author: Cem Keylan <cem@ckyln.com>
Date:   Thu, 28 Jan 2021 16:55:26 +0300

docs: update

Diffstat:
Mcarbslinux.org | 5+++--
Mcarbslinux.texi | 4++--
Mcarbslinux.txt | 31++++++++++++++++++++++++++++---
Mdefault.do | 10+++++++---
Minstall.html.do | 8+++++---
Minstall.txt | 24++++++++++--------------
Minstall.txt.do | 1+
7 files changed, 56 insertions(+), 27 deletions(-)

diff --git a/carbslinux.org b/carbslinux.org @@ -106,6 +106,7 @@ acquired as plain-text to be viewed offline with a pager from curl -sL https://carbslinux.org/docs/install.txt | less #+end_src +#+TOC: headlines 3 local ** Preparing Environment :PROPERTIES: :DESCRIPTION: Getting ready to chroot @@ -412,8 +413,8 @@ cd linux-5.9.1 :END: In order to compile the kernel you will need to install some dependencies. You -will need =libelf= to compile the kernel. If you want to configure using the -menu interface you will also need =ncurses=. +will need =libelf=, and =bison= to compile the kernel. If you want to configure +using the menu interface you will also need =ncurses=. #+BEGIN_SRC sh # The package manager asks to install if you are building more than one package, diff --git a/carbslinux.texi b/carbslinux.texi @@ -511,8 +511,8 @@ cd linux-5.9.1 @subsection Kernel dependencies In order to compile the kernel you will need to install some dependencies. You -will need @samp{libelf} to compile the kernel. If you want to configure using the -menu interface you will also need @samp{ncurses}. +will need @samp{libelf}, and @samp{bison} to compile the kernel. If you want to configure +using the menu interface you will also need @samp{ncurses}. @example # The package manager asks to install if you are building more than one package, diff --git a/carbslinux.txt b/carbslinux.txt @@ -85,6 +85,31 @@ with the info reader. It is divided into sections and easier to read. | curl -sL https://carbslinux.org/docs/install.txt | less `---- + .. 1. Preparing Environment + ..... 1. Download + ..... 2. Signature verification + ..... 3. Extracting the tarball + ..... 4. Obtain the chroot helper + .. 2. Chroot + ..... 1. Setting up repositories + ..... 2. Updating packages + ..... 3. Installing packages + ..... 4. Essential Software + ..... 5. Obtaining the documentation + .. 3. System Configuration + ..... 1. Configuring hostname + ..... 2. Hosts file + .. 4. Kernel + ..... 1. Obtaining the kernel sources + ..... 2. Kernel dependencies + ..... 3. Building the kernel + .. 5. Making your system bootable + ..... 1. Bootloader + ..... 2. Init scripts + ..... 3. Fstab + .. 6. Post-installation + ..... 1. KISS repositories + 2.1 Preparing Environment ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -389,9 +414,9 @@ with the info reader. It is divided into sections and easier to read. ------------------------- In order to compile the kernel you will need to install some - dependencies. You will need `libelf' to compile the kernel. If you - want to configure using the menu interface you will also need - `ncurses'. + dependencies. You will need `libelf', and `bison' to compile the + kernel. If you want to configure using the menu interface you will + also need `ncurses'. ,---- | # The package manager asks to install if you are building more than one package, diff --git a/default.do b/default.do @@ -26,10 +26,14 @@ case "$1" in ;; htmldocs) redo-ifchange carbslinux.org carbslinux.texi install.txt install.html - rm -f "${HTMLDIR:?}/"* - makeinfo --html -o "${HTMLDIR}" "${TEXI}" + mkdir -p "${HTMLDIR:?}" + rm -rf "$HTMLDIR/carbslinux" \ + "$HTMLDIR/carbslinux.html" \ + "$HTMLDIR/install.html" \ + "$HTMLDIR/install.txt" + makeinfo --html -o "${HTMLDIR}/carbslinux" "${TEXI}" + makeinfo --html --no-split -o "${HTMLDIR}/carbslinux.html" "${TEXI}" cp install.txt "${HTMLDIR}/install.txt" - cp install.html "${HTMLDIR}/install.html" PHONY ;; *.txt) diff --git a/install.html.do b/install.html.do @@ -3,7 +3,7 @@ exec >&2 redo-ifchange "$ORG" htmlize/htmlize.el flatui/flatui-theme.el cp "$ORG" "$3.org" -trap 'rm -f $3.org' EXIT INT +trap 'rm -f $3.html $3.org' EXIT INT # Org HTML export is a bit of a mess from the command line. I have added flatui # and htmlize repositories as a submodule so that we don't rely on packages. @@ -14,8 +14,10 @@ ${EMACS} "$3.org" --eval \ (load-theme '"'"'flatui t) (load-file "htmlize/htmlize.el") (org-mode) (replace-regexp "^* Installation" "* Carbs Linux Installation Guide") -(org-html-export-to-html nil t) +(setq org-export-with-toc nil) +(org-html-export-to-html nil t nil t) (revert-buffer nil t) )' -mv "$3.html" "$3" +printf '%s\n' "<h1>Carbs Linux Installation Guide</h1>" > "$3" +cat "$3.html" >> "$3" diff --git a/install.txt b/install.txt @@ -6,8 +6,13 @@ ________________________________ -Table of Contents -_________________ +These are the step-by-step instructions for installing Carbs Linux. It +can be acquired as plain-text to be viewed offline with a pager from +<https://carbslinux.org/docs/install.txt>. + +,---- +| curl -sL https://carbslinux.org/docs/install.txt | less +`---- 1. Preparing Environment .. 1. Download @@ -40,15 +45,6 @@ _________________ .. 1. KISS repositories -These are the step-by-step instructions for installing Carbs Linux. It -can be acquired as plain-text to be viewed offline with a pager from -<https://carbslinux.org/docs/install.txt>. - -,---- -| curl -sL https://carbslinux.org/docs/install.txt | less -`---- - - 1 Preparing Environment ======================= @@ -355,9 +351,9 @@ can be acquired as plain-text to be viewed offline with a pager from ~~~~~~~~~~~~~~~~~~~~~~~ In order to compile the kernel you will need to install some - dependencies. You will need `libelf' to compile the kernel. If you - want to configure using the menu interface you will also need - `ncurses'. + dependencies. You will need `libelf', and `bison' to compile the + kernel. If you want to configure using the menu interface you will + also need `ncurses'. ,---- | # The package manager asks to install if you are building more than one package, diff --git a/install.txt.do b/install.txt.do @@ -7,6 +7,7 @@ trap 'rm -f $3.org' EXIT INT ${EMACS} "$3.org" --eval \ '(progn (replace-regexp "^* Installation" "* Carbs Linux Installation Guide") + (setq org-export-with-toc nil) (org-ascii-export-to-ascii nil t))' mv "$3.txt" "$3"