summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2018-09-06 14:33:37 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2018-09-06 14:33:37 -0500
commit8dc8697d5215009693da2e59f669faf3ccc7a989 (patch)
tree027a96109763b7426608f824b9a64e7de7eadb6f
parent73561d3f8d447d5fa979cfa470c3fc1a34dc5a2a (diff)
downloaddocs-8dc8697d5215009693da2e59f669faf3ccc7a989.tar.gz
docs-8dc8697d5215009693da2e59f669faf3ccc7a989.tar.bz2
docs-8dc8697d5215009693da2e59f669faf3ccc7a989.tar.xz
docs-8dc8697d5215009693da2e59f669faf3ccc7a989.zip
Add Administrator's Handbook outline; rename guides to handbooks
-rw-r--r--Makefile38
-rw-r--r--src/admin/10_help.xml9
-rw-r--r--src/admin/11_quickref.xml9
-rw-r--r--src/admin/1_intro.xml9
-rw-r--r--src/admin/2_shell.xml9
-rw-r--r--src/admin/3_packages.xml9
-rw-r--r--src/admin/4_services.xml9
-rw-r--r--src/admin/5_networking.xml9
-rw-r--r--src/admin/6_security.xml9
-rw-r--r--src/admin/7_config.xml9
-rw-r--r--src/admin/8_fslayout.xml9
-rw-r--r--src/admin/9_standards.xml9
-rw-r--r--src/admin/adminbook.xml44
-rw-r--r--src/devel/develbook.xml38
-rw-r--r--src/devel/develguide.xml38
-rw-r--r--src/install/installbook.xml31
-rw-r--r--src/install/installguide.xml31
17 files changed, 237 insertions, 82 deletions
diff --git a/Makefile b/Makefile
index 2edb1a0..b5f141e 100644
--- a/Makefile
+++ b/Makefile
@@ -1,29 +1,41 @@
.POSIX:
-all: out/html/devel/index.html out/text/develguide.txt \
- out/html/install/index.html out/text/installguide.txt \
- out/html/porting/index.html out/text/portguide.txt
+all: out/html/devel/index.html out/text/develbook.txt \
+ out/html/install/index.html out/text/installbook.txt \
+ out/html/porting/index.html out/text/portguide.txt \
+ out/html/admin/index.html out/text/adminbook.txt
-out/text/develguide.txt: src/devel/*.xml
+out/text/adminbook.txt: src/admin/*.xml
@mkdir -p out/text
- @printf 'Developer Guide: Generating text...\n'
- @xmlto txt -o out/text src/devel/develguide.xml
+ @printf 'Administrator Handbook: Generating text...\n'
+ @xmlto txt -o out/text src/admin/adminbook.xml
+
+out/html/admin/index.html: src/admin/*.xml src/pretty.css
+ @mkdir -p out/html/admin
+ @printf 'Administrator Handbook: Generating HTML...\n'
+ @xmlto html -m master.xsl -o out/html/admin src/admin/adminbook.xml
+ @cp src/pretty.css out/html/admin/
+
+out/text/develbook.txt: src/devel/*.xml
+ @mkdir -p out/text
+ @printf 'Developer Handbook: Generating text...\n'
+ @xmlto txt -o out/text src/devel/develbook.xml
out/html/devel/index.html: src/devel/*.xml src/pretty.css
@mkdir -p out/html/devel
- @printf 'Developer Guide: Generating HTML...\n'
- @xmlto html -m master.xsl -o out/html/devel src/devel/develguide.xml
+ @printf 'Developer Handbook: Generating HTML...\n'
+ @xmlto html -m master.xsl -o out/html/devel src/devel/develbook.xml
@cp src/pretty.css out/html/devel/
-out/text/installguide.txt: src/install/*.xml
+out/text/installbook.txt: src/install/*.xml
@mkdir -p out/text
- @printf 'Install Guide: Generating text...\n'
- @xmlto txt -o out/text src/install/installguide.xml
+ @printf 'Installation Handbook: Generating text...\n'
+ @xmlto txt -o out/text src/install/installbook.xml
out/html/install/index.html: src/install/*.xml src/pretty.css
@mkdir -p out/html/install
- @printf 'Install Guide: Generating HTML...\n'
- @xmlto html -m master.xsl -o out/html/install src/install/installguide.xml
+ @printf 'Installation Handbook: Generating HTML...\n'
+ @xmlto html -m master.xsl -o out/html/install src/install/installbook.xml
@cp src/pretty.css out/html/install/
out/text/portguide.txt: src/porting/*.xml
diff --git a/src/admin/10_help.xml b/src/admin/10_help.xml
new file mode 100644
index 0000000..e90bd4a
--- /dev/null
+++ b/src/admin/10_help.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="10" id="help">
+ <title>If You Need Help</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/11_quickref.xml b/src/admin/11_quickref.xml
new file mode 100644
index 0000000..50fc735
--- /dev/null
+++ b/src/admin/11_quickref.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="11" id="quickref">
+ <title>Quick References</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/1_intro.xml b/src/admin/1_intro.xml
new file mode 100644
index 0000000..3c978fb
--- /dev/null
+++ b/src/admin/1_intro.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="1" id="introduction">
+ <title>Introduction</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/2_shell.xml b/src/admin/2_shell.xml
new file mode 100644
index 0000000..7bd4fb4
--- /dev/null
+++ b/src/admin/2_shell.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="2" id="shell">
+ <title>The Shell</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/3_packages.xml b/src/admin/3_packages.xml
new file mode 100644
index 0000000..1f5db5c
--- /dev/null
+++ b/src/admin/3_packages.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="3" id="packages">
+ <title>Packages</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/4_services.xml b/src/admin/4_services.xml
new file mode 100644
index 0000000..d557b0b
--- /dev/null
+++ b/src/admin/4_services.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="4" id="services">
+ <title>Services</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/5_networking.xml b/src/admin/5_networking.xml
new file mode 100644
index 0000000..acb3d62
--- /dev/null
+++ b/src/admin/5_networking.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="5" id="networking">
+ <title>Networking</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/6_security.xml b/src/admin/6_security.xml
new file mode 100644
index 0000000..140dc7d
--- /dev/null
+++ b/src/admin/6_security.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="6" id="security">
+ <title>Security</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/7_config.xml b/src/admin/7_config.xml
new file mode 100644
index 0000000..c855b69
--- /dev/null
+++ b/src/admin/7_config.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="7" id="config">
+ <title>System Configuration</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/8_fslayout.xml b/src/admin/8_fslayout.xml
new file mode 100644
index 0000000..44286bb
--- /dev/null
+++ b/src/admin/8_fslayout.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="8" id="fslayout">
+ <title>File System Layout</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/9_standards.xml b/src/admin/9_standards.xml
new file mode 100644
index 0000000..87d7b07
--- /dev/null
+++ b/src/admin/9_standards.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter label="9" id="standards">
+ <title>Standards Conformance</title>
+ <para></para>
+ <section>
+ <title></title>
+ <para></para>
+ </section>
+</chapter>
diff --git a/src/admin/adminbook.xml b/src/admin/adminbook.xml
new file mode 100644
index 0000000..a9447a6
--- /dev/null
+++ b/src/admin/adminbook.xml
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ <!ENTITY chap1 SYSTEM "1_intro.xml">
+ <!ENTITY chap2 SYSTEM "2_shell.xml">
+ <!ENTITY chap3 SYSTEM "3_packages.xml">
+ <!ENTITY chap4 SYSTEM "4_services.xml">
+ <!ENTITY chap5 SYSTEM "5_networking.xml">
+ <!ENTITY chap6 SYSTEM "6_security.xml">
+ <!ENTITY chap7 SYSTEM "7_config.xml">
+ <!ENTITY chap8 SYSTEM "8_fslayout.xml">
+ <!ENTITY chap9 SYSTEM "9_standards.xml">
+ <!ENTITY chap10 SYSTEM "10_help.xml">
+ <!ENTITY chap11 SYSTEM "11_quickref.xml">
+]>
+<book>
+ <bookinfo>
+ <title>Adélie Linux 1.0 Administrator's Handbook</title>
+ <author>
+ <personname><firstname>A.</firstname><surname>Wilcox</surname></personname>
+ </author>
+ <copyright><year>2018</year><holder>Adélie Linux</holder></copyright>
+ </bookinfo>
+ <preface>
+ <title>Preface</title>
+ <para>This Administrator's Handbook is the official comprehensive manual to administrating systems running the Adélie Linux 1.0 operating environment. It includes differences between Adélie Linux and other Linux and Unix&reg; environments, and detailed information on the design and implementation of Adélie Linux 1.0.</para>
+ <para>Many contributed to the final version of this guide. This includes .</para>
+ <para>It is assumed that you, the reader, are familiar with using a terminal or command line interface, and the use of Unix commands. If you are not yet familiar with these concepts, start with our User's Guide, which will assist you in learning them.</para>
+ <para>Please also ensure that you are comfortable and properly rested before reading this guide. This will allow you to learn quicker, and be able to recall the information you have learned easier.</para>
+ <para>It is hoped by the author that you find this guide easy to understand and read. Please feel free to contact me or the Adélie Linux community if you have any suggestions on how to make this guide better. We'd love to hear from you, and we hope you enjoy using our distribution.</para>
+ <para>– A. Wilcox, 2018</para>
+ </preface>
+ &chap1;
+ &chap2;
+ &chap3;
+ &chap4;
+ &chap5;
+ &chap6;
+ &chap7;
+ &chap8;
+ &chap9;
+ &chap10;
+ &chap11;
+</book>
diff --git a/src/devel/develbook.xml b/src/devel/develbook.xml
new file mode 100644
index 0000000..26b4435
--- /dev/null
+++ b/src/devel/develbook.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ <!ENTITY chap1 SYSTEM "1_preparing.xml">
+ <!ENTITY chap2 SYSTEM "2_nonpkg.xml">
+ <!ENTITY chap3 SYSTEM "3_git.xml">
+ <!ENTITY chap4 SYSTEM "4_hello.xml">
+ <!ENTITY chap5 SYSTEM "5_deepdive.xml">
+ <!ENTITY chap6 SYSTEM "6_security.xml">
+ <!ENTITY chap7 SYSTEM "7_misc.xml">
+ <!ENTITY chap8 SYSTEM "8_help.xml">
+]>
+<book>
+ <bookinfo>
+ <title>Adélie Linux 1.0 Developer's Handbook</title>
+ <author>
+ <personname><firstname>A.</firstname><surname>Wilcox</surname></personname>
+ </author>
+ <copyright><year>2017</year><year>2018</year><holder>Adélie Linux</holder></copyright>
+ </bookinfo>
+ <preface>
+ <title>Preface</title>
+ <para>This Developer's Handbook is the official documentation for developing the Adélie Linux 1.0 system. It is designed for developers interested in working on the distribution itself; for general information on programming your computer running the Adélie Linux system, see the User's Handbook chapter "Getting started with programming".</para>
+ <para>Many contributed to the final version of the Handbook. This includes <personname><firstname>Natanael</firstname><surname>Copa</surname></personname> and <personname><firstname>Timo</firstname><surname>Teras</surname></personname> from Alpine Linux.</para>
+ <para>It is assumed that you, the reader, are familiar with using a terminal or command line interface, the use of Unix commands, and the compilation of software. If you are not yet familiar with these concepts, start with our User's Handbook, which will assist you in learning them.</para>
+ <para>Please also ensure that you are comfortable and properly rested before reading this handbook. This will allow you to learn quicker, and be able to recall the information you have learned easier.</para>
+ <para>It is hoped by the author that you find this handbook easy to understand and read. Please feel free to contact me or the Adélie Linux community if you have any suggestions on how to make this handbook better. We'd love to hear from you, and we hope you enjoy using our distribution.</para>
+ <para>– A. Wilcox, 2018</para>
+ </preface>
+ &chap1;
+ &chap2;
+ &chap3;
+ &chap4;
+ &chap5;
+ &chap6;
+ &chap7;
+ &chap8;
+</book>
diff --git a/src/devel/develguide.xml b/src/devel/develguide.xml
deleted file mode 100644
index 8447c80..0000000
--- a/src/devel/develguide.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
- <!ENTITY chap1 SYSTEM "1_preparing.xml">
- <!ENTITY chap2 SYSTEM "2_nonpkg.xml">
- <!ENTITY chap3 SYSTEM "3_git.xml">
- <!ENTITY chap4 SYSTEM "4_hello.xml">
- <!ENTITY chap5 SYSTEM "5_deepdive.xml">
- <!ENTITY chap6 SYSTEM "6_security.xml">
- <!ENTITY chap7 SYSTEM "7_misc.xml">
- <!ENTITY chap8 SYSTEM "8_help.xml">
-]>
-<book>
- <bookinfo>
- <title>Adélie Linux 1.0 Developer's Guide</title>
- <author>
- <personname><firstname>A.</firstname><surname>Wilcox</surname></personname>
- </author>
- <copyright><year>2017</year><holder>Adélie Linux</holder></copyright>
- </bookinfo>
- <preface>
- <title>Preface</title>
- <para>This Developer's Guide is the official guide to developing the Adélie Linux 1.0 system. It is designed for developers interested in working on the distribution itself; for general information on programming your computer running the Adélie Linux system, see the User's Guide chapter "Getting started with programming".</para>
- <para>Many contributed to the final version of this guide. This includes <personname><firstname>Natanael</firstname><surname>Copa</surname></personname> and <personname><firstname>Timo</firstname><surname>Teras</surname></personname> from Alpine Linux.</para>
- <para>It is assumed that you, the reader, are familiar with using a terminal or command line interface, the use of Unix commands, and the compilation of software. If you are not yet familiar with these concepts, start with our User's Guide, which will assist you in learning them.</para>
- <para>Please also ensure that you are comfortable and properly rested before reading this guide. This will allow you to learn quicker, and be able to recall the information you have learned easier.</para>
- <para>It is hoped by the author that you find this guide easy to understand and read. Please feel free to contact me or the Adélie Linux community if you have any suggestions on how to make this guide better. We'd love to hear from you, and we hope you enjoy using our distribution.</para>
- <para>– A. Wilcox, 2017</para>
- </preface>
- &chap1;
- &chap2;
- &chap3;
- &chap4;
- &chap5;
- &chap6;
- &chap7;
- &chap8;
-</book>
diff --git a/src/install/installbook.xml b/src/install/installbook.xml
new file mode 100644
index 0000000..e7ebbf8
--- /dev/null
+++ b/src/install/installbook.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ <!ENTITY chap1 SYSTEM "1_begin.xml">
+ <!ENTITY chap2 SYSTEM "2_req.xml">
+]>
+<book>
+ <bookinfo>
+ <title>Adélie Linux 1.0 Installation Handbook</title>
+ <author>
+ <personname><firstname>A.</firstname><surname>Wilcox</surname></personname>
+ </author>
+ <copyright><year>2015</year><year>2018</year><holder>Adélie Linux</holder></copyright>
+ </bookinfo>
+ <preface>
+ <title>Preface</title>
+ <para>This Installation Handbook is the full, official documentation for installing Adélie Linux 1.0 on a supported computer, including special architecture-specific notes and a bootstrap installation from another distribution. It was initially drafted with a section outline in 2015, before the distribution itself was even created. It is hoped by the author that you find this handbook easy to understand and read.</para>
+ <para>Many contributed to the final version of the Handbook. This includes <personname><othername>[[sroracle]]</othername></personname> and <personname><othername>smauel</othername></personname> on the Adélie IRC channel, whom tested the instructions on their machines and reported omissions and corrections. <!-- more.. --></para>
+ <para>Please feel free to contact me or the Adélie Linux community if you have any suggestions on how to make this handbook better. We'd love to hear from you, and we hope you enjoy using our distribution.</para>
+ <para>– A. Wilcox, 2018</para>
+ </preface>
+ &chap1;
+ &chap2;
+ <!-- <xi:include href="3_install.xml" />
+ <xi:include href="4_options.xml" />
+ <xi:include href="5_commit.xml" />
+ <xi:include href="6_notes.xml" />
+ <xi:include href="a_arch.xml" />
+ <xi:include href="b_help.xml" />
+ <xi:include href="c_advanced.xml" /> -->
+</book>
diff --git a/src/install/installguide.xml b/src/install/installguide.xml
deleted file mode 100644
index 4aad4f5..0000000
--- a/src/install/installguide.xml
+++ /dev/null
@@ -1,31 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
- <!ENTITY chap1 SYSTEM "1_begin.xml">
- <!ENTITY chap2 SYSTEM "2_req.xml">
-]>
-<book>
- <bookinfo>
- <title>Adélie Linux 1.0 Installation Guide</title>
- <author>
- <personname><firstname>A.</firstname><surname>Wilcox</surname></personname>
- </author>
- <copyright><year>2015</year><year>2017</year><holder>Adélie Linux</holder></copyright>
- </bookinfo>
- <preface>
- <title>Preface</title>
- <para>This Installation Guide is the full, official guide to installing Adélie Linux 1.0 on a supported computer, including special architecture-specific notes and a bootstrap installation from another distribution. It was initially drafted with a section outline in 2015, before the distribution itself was even created. It is hoped by the author that you find this guide easy to understand and read.</para>
- <para>Many contributed to the final version of this guide. This includes <personname><othername>[[sroracle]]</othername></personname> and <personname><othername>smauel</othername></personname> on the Adélie IRC channel, whom tested the instructions on their machines and reported omissions and corrections. <!-- more.. --></para>
- <para>Please feel free to contact me or the Adélie Linux community if you have any suggestions on how to make this guide better. We'd love to hear from you, and we hope you enjoy using our distribution.</para>
- <para>– A. Wilcox, 2017</para>
- </preface>
- &chap1;
- &chap2;
- <!-- <xi:include href="3_install.xml" />
- <xi:include href="4_options.xml" />
- <xi:include href="5_commit.xml" />
- <xi:include href="6_notes.xml" />
- <xi:include href="a_arch.xml" />
- <xi:include href="b_help.xml" />
- <xi:include href="c_advanced.xml" /> -->
-</book>