51 lines
4.3 KiB
Plaintext
51 lines
4.3 KiB
Plaintext
|
= BDisk User and Developer Manual
|
|||
|
|
Brent Saner <bts@square-r00t.net>
|
|||
|
|
v2.0, 2018-05
|
|||
|
|
:doctype: book
|
|||
|
|
:data-uri:
|
|||
|
|
:imagesdir: images
|
|||
|
|
:sectlinks:
|
|||
|
|
:toc: preamble
|
|||
|
|
:toc2: left
|
|||
|
|
:idprefix:
|
|||
|
|
:sectnums:
|
|||
|
|
:toclevels: 2
|
|||
|
|
// So there's currently a "bug" in that the TOC will display with continued numbering across parts.
|
|||
|
|
// I essentially want the opposite of https://github.com/asciidoctor/asciidoctor/issues/979 TODO
|
|||
|
|
|
|||
|
|
[dedication]
|
|||
|
|
= Thanks
|
|||
|
|
See CREDITS in the project source for a list of thanks.
|
|||
|
|
|
|||
|
|
|
|||
|
|
[preface]
|
|||
|
|
= Preface
|
|||
|
|
=== About the Author
|
|||
|
|
I am a GNU/Linux Systems/Network Administrator/Engineer- I wear a lot of hats. I have a lot of side projects to keep me busy when I’m not working at _${dayjob}_, mostly to assist in other side projects and become more efficient and proficient at those tasks. “Shaving the yak,” footnote:[See http://catb.org/jargon/html/Y/yak-shaving.html] indeed.
|
|||
|
|
|
|||
|
|
A lot of research went into how low-level boot operations take place when writing BDisk, both in BIOS and UEFI footnote:[*Unified Extensible Firmware Interface.* UEFI is not BIOS, and BIOS is not UEFI.] (and corresponding concepts such as Secureboot, etc.) which is no easy task to understand and very commonly misunderstood. (For instance, a common misconception is that UEFI necessarily implies Secureboot. This is quite far from the truth and UEFI by itself is quite a useful replacement for BIOS). I invite you to do research into the specifications yourself; it's rather fascinating.
|
|||
|
|
|
|||
|
|
|
|||
|
|
=== What is BDisk?
|
|||
|
|
BDisk refers to both a live distribution I use in my own uses (for rescue situations, recovery, etc.) but foremost and most importantly, it also refers to the tool I use for building that distribution. In other words, it's both a complete GNU/Linux distribution you can run entirely from USB/CD/DVD/etc. (without needing to install it to your hard drive)... and also the name of a tool to create a custom GNU/Linux install. The latter is what this project and documentation refer to when the word “BDisk” is used.
|
|||
|
|
|
|||
|
|
This documentation was started when I rewrote BDisk in Python 3.x; versions 0.x-2.x of BDisk were written in Bash, and horribly inelegant and rigid. It was a valiant effort, and *mostly* worked. Until it stopped working. To my knowledge, it is (or was) in use by https://ninjaos.org[NinjaOS^] as well as a project for education purposes in Indonesia, though I imagine it's in use other places as well. Ideally it should help those wishing to offer specialized GNU/Linux live media or install CDs.
|
|||
|
|
|
|||
|
|
Version 4.x is an entire rewrite to be much more modular and implement a much more flexible structure based on feature requests that have accumulated over time. footnote:[I should take the time to note that I am still quite new to Python so expect there to be plenty of optimizations to be made and general WTF-ery from seasoned Python developers. If you encounter any bugs or improvements, please <<FURTHER.adoc#_bug_reports_feature_requests,report them>>! It'd be much appreciated.]
|
|||
|
|
|
|||
|
|
One of my main goals was to make BDisk as easy to use as possible. This is surprisingly hard to do- it’s quite challenging to try to approach software you’ve written with the mindset of someone other than you.
|
|||
|
|
|
|||
|
|
It’s my hope that by releasing this utility (and documenting it), you can use it and save some time for yourself as well (and hopefully get the chance to learn a bit more in the process!).
|
|||
|
|
|
|||
|
|
It of course is not the <<i_don_t_like_bdisk_are_there_any_other_alternatives,only live media creator>> out there, but most others only focus on remastering an existing ISO, or creating an installer ISO -- not creating a custom live-centric environment.
|
|||
|
|
|
|||
|
|
=== Copyright/Licensing
|
|||
|
|
The BDisk code is https://www.gnu.org/licenses/gpl-3.0.en.html[GPLv3-licensed^]. This means that you can use it for business reasons, personal reasons, modify it, etc. Please be sure to familiarize yourself with the full set of terms. You can find the full license in `docs/LICENSE`.
|
|||
|
|
|
|||
|
|
image::https://www.gnu.org/graphics/gplv3-127x51.png[GPLv3,align="center"]
|
|||
|
|
|
|||
|
|
This document, and all other associated author-generated documentation, are released under the http://creativecommons.org/licenses/by-sa/4.0/[Creative Commons CC-BY-SA 4.0^] copyright. It's essentially the GPL for non-software, so similar terms apply.
|
|||
|
|
|
|||
|
|
image::https://i.creativecommons.org/l/by-sa/4.0/88x31.png[CC-BY-SA_4.0,align="center"]
|
|||
|
|
|
|||
|
|
include::BODY.adoc[]
|